ilog.views.chart.renderer
Class IlvSingleHiLoRenderer

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

public class IlvSingleHiLoRenderer
extends IlvSingleChartRenderer

Renders two data sets with High/Low items. An IlvSingleHiLoRenderer can be of 4 types: BAR, ARROW, MARKED and STICK. The only difference among these modes is the way the renderer is drawn. The following figure shows the different types:

This renderer uses two rendering styles to draw the data points:


CSS example:

ilvSingleHiLoRenderer {
    class : "ilog.views.chart.renderer.IlvSingleHiLoRenderer";
    annotation : "@#ilvDataLabelAnnotation";
    fallStyle : "@#ilvStyle";
    name : "<value>";
    riseStyle : "@#ilvStyle";
    style : "@#ilvStyle";
    styles[0] : "@#ilvStyle1";
    styles[1] : "@#ilvStyle2";
    type : "STICK";
    visible : "false";
    visibleInLegend : "false";
    widthPercent : "3.0";
}


Property Summary
 IlvDataAnnotation annotation
          
Specifies a global annotation for all the data sets displayed by this renderer.
 java.lang.String class
          
Creates a new HiLo renderer.
 IlvStyle fallStyle
          
Sets the fall style.
 java.lang.String name
          
Sets the name of this renderer.
 IlvStyle riseStyle
          
Sets the rise style.
 IlvStyle style
          
Sets the style used by this renderer.
 IlvStyle[] styles
          
Sets the styles used by this renderer.
 int type
          
Sets the type of this renderer.
 boolean visible
          
Toggles the visibility of this renderer.
 boolean visibleInLegend
          
Indicates whether the renderer appears in the legend.
 double widthPercent
          
Sets the width of the graphical representation of a data point along the x-axis.
 

Property Detail

class

public java.lang.String class

Creates a new HiLo renderer.

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


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.


fallStyle

public IlvStyle fallStyle

Sets the fall style.

CSS example:     fallStyle : "@#ilvStyle";

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


name

public java.lang.String name

Sets the name of this renderer.

CSS example:     name : "<value>";


riseStyle

public IlvStyle riseStyle

Sets the rise style.

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

CSS example:     riseStyle : "@#ilvStyle";

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


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.


type

public int type

Sets the type of this renderer. This method triggers a ChartRendererEvent.STYLE_CHANGED event.

CSS example:     type : "STICK";

Allowed values:
STICK    Stick renderer type.
BAR    Bar renderer type.
ARROW    Arrow renderer type.
MARKED    Marked renderer type.


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 width of the graphical representation of a data point along the x-axis. The size is specified as a percentage of the difference between the x-values of two consecutive data points. It is assumed that all the data points are evenly spaced along the x-axis, and that the resulting size is the same for all the data points.

CSS example:     widthPercent : "3.0";



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