ilog.views.chart.renderer
Class IlvSingleBarRenderer

ilog.views.chart.IlvChartRenderer
      extended by ilog.views.chart.renderer.IlvSingleChartRenderer
          extended by ilog.views.chart.renderer.IlvSingleBarRenderer

public class IlvSingleBarRenderer
extends IlvSingleChartRenderer

Renders a data set with a bar chart.

CSS example:

ilvSingleBarRenderer {
    class : "ilog.views.chart.renderer.IlvSingleBarRenderer";
    annotation : "@#ilvDataLabelAnnotation";
    barShape : "QUADRILATERAL";
    name : "<value>";
    style : "@#ilvStyle";
    styles[0] : "@#ilvStyle1";
    styles[1] : "@#ilvStyle2";
    useCategorySpacingAtBorders : "false";
    visible : "false";
    visibleInLegend : "false";
    widthPercent : "3.0";
}


See Also:
IlvBarChartRenderer

Property Summary
 IlvDataAnnotation annotation
          
Specifies a global annotation for all the data sets displayed by this renderer.
 int barShape
          
Sets the shape of the bars.
 java.lang.String class
          
Creates a new IlvSingleBarRenderer with a default bar width and style.
 java.lang.String name
          
Sets the name of this renderer.
 IlvStyle style
          
Sets the style used by this renderer.
 IlvStyle[] styles
          
Sets the styles used by this renderer.
 boolean useCategorySpacingAtBorders
          
Determines whether the category spacing is used also at the left and right borders.
 boolean visible
          
Toggles the visibility of this renderer.
 boolean visibleInLegend
          
Indicates whether the renderer appears in the legend.
 double widthPercent
          
Sets the bar width.
 

Property Detail

class

public java.lang.String class

Creates a new IlvSingleBarRenderer with a default bar width and style.

CSS example:     class : "ilog.views.chart.renderer.IlvSingleBarRenderer";


annotation

public IlvDataAnnotation annotation

Specifies a global annotation for all the data sets displayed by this renderer. The specified annotation will also be associated with all the data sets that are connected to this renderer.

CSS example:     annotation : "@#ilvDataLabelAnnotation";

See implementing class IlvDataLabelAnnotation for an example of implementing an annotation.


barShape

public int barShape

Sets the shape of the bars. Note: This has no effect in 3D mode.

CSS example:     barShape : "QUADRILATERAL";

Allowed values:
QUADRILATERAL    In this mode, every bar has a quadrilateral (4-gon) shape.
POLYGON    In this mode, every bar has a polygonal shape that approximates the exact projected shape.
EXACT    In this mode, every bar has an exact projected rectangle shape. This means, in a polar or radar chart, every bar's boundary will contain an arc.


name

public java.lang.String name

Sets the name of this renderer.

CSS example:     name : "<value>";


style

public IlvStyle style

Sets the style used by this renderer. By default, the IlvSingleChartRenderer class makes use of a single style. If the parameter is null and the renderer has been attached to a chart, sets a default style.

Note: The Bean property style must not be specified together with the Bean property styles.

CSS example:     style : "@#ilvStyle";

See implementing class IlvStyle for an example of implementing a style.


styles

public IlvStyle[] styles

Sets the styles used by this renderer.

CSS example:    

styles[0] : "@#ilvStyle1";
styles[1] : "@#ilvStyle2";

See implementing class IlvStyle for an example of implementing a styles.


useCategorySpacingAtBorders

public boolean useCategorySpacingAtBorders

Determines whether the category spacing is used also at the left and right borders. If set to true, category spacing is not only used between bars, but also beyond the leftmost and rightmost bars. If set to false (the default), this spacing is omitted. This setting matters only if getWidthPercent is less than 100.

CSS example:     useCategorySpacingAtBorders : "false";


visible

public boolean visible

Toggles the visibility of this renderer.

CSS example:     visible : "false";


visibleInLegend

public boolean visibleInLegend

Indicates whether the renderer appears in the legend.

The default value of this property is true, which means that the renderer will automatically create and add items to the legend.

CSS example:     visibleInLegend : "false";


widthPercent

public double widthPercent

Sets the bar width.

CSS example:     widthPercent : "3.0";



Copyright © 1996-2007 ILOG S.A. All rights reserved.   Documentation homepage.