IlvPolylineChartRenderer (Perforce JViews 10.0 API)

java.lang.Object
- ilog.views.chart.IlvChartRenderer
- - ilog.views.chart.renderer.IlvCompositeChartRenderer
  - - ilog.views.chart.renderer.IlvSimpleCompositeChartRenderer
    - - ilog.views.chart.renderer.IlvPolylineChartRenderer

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, IlvSuperimposedRenderer, Serializable

Direct Known Subclasses:

IlvAreaChartRenderer, IlvStairChartRenderer
```
public class IlvPolylineChartRenderer
extends IlvSimpleCompositeChartRenderer
implements IlvSuperimposedRenderer
```
A renderer displaying polylines. This renderer creates an instance of IlvSinglePolylineRenderer for every data set in the connected data source. An IlvPolylineRenderer supports two representation modes:
- Superimposed: polylines are drawn on top of each other. This mode corresponds to the SUPERIMPOSED constant.
- Stacked: polylines are stacked, so that each one displays the contribution of an y-value in a set of several y-values. This mode corresponds to the STACKED constant.
The following figure illustrates these representation modes:
Since:

JViews 5.0

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static int STACKED
Mode type for stacked polylines.

static int SUPERIMPOSED
Mode type for superimposed polylines.
- Fields inherited from class ilog.views.chart.IlvChartRenderer
  AREA, BAR, BUBBLE, CANDLE, CENTERED_LABEL_LAYOUT, COMBO, DATA_LABEL, DEFAULT_LABEL_LAYOUT, DEFAULT_LABELING, HILO, HILO_ARROW, HILO_STICK, HLOC, OUTSIDE_LABEL_LAYOUT, PERCENT_LABEL, PIE, POLYLINE, SCATTER, STACKED_AREA, STACKED_BAR, STACKED_DIVERGING_BAR, STACKED_POLYLINE, STACKED_STAIR, STACKED100_AREA, STACKED100_BAR, STACKED100_POLYLINE, STACKED100_STAIR, STAIR, SUMMED_STAIR, SUPERIMPOSED_BAR, TREEMAP, X_VALUE_LABEL, XY_VALUES_LABEL, Y_VALUE_LABEL

Fields
Modifier and Type	Field and Description
`static int`	`STACKED` Mode type for stacked polylines.
`static int`	`SUPERIMPOSED` Mode type for superimposed polylines.

Constructor Summary

Constructors
Constructor and Description
`IlvPolylineChartRenderer()` Creates a new polyline chart renderer with the `SUPERIMPOSED` mode.
`IlvPolylineChartRenderer(int mode)` Creates a new polyline chart renderer with the specified mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected IlvChartRenderer`	`createChild(IlvDataSet dataSet)` Creates an instance of `IlvSinglePolylineRenderer` to display the specified data set.
`protected void`	`dataSetsAdded(int firstIdx, int lastIdx, IlvDataSet[] oldDataSets)` Called when data sets are connected to this renderer.
`protected void`	`dataSetsChangesBatchEnding()` Called when a series of data sets insertions or removals is terminating.
`protected void`	`dataSetsChangesBatchStarting()` Called when a series of data sets insertions or removals is starting.
`protected void`	`dataSetsRemoved(int firstIdx, int lastIdx, IlvDataSet[] oldDataSets)` Called when data sets are disconnected from this renderer.
`IlvMarker`	`getMarker()` Returns the marker used to create child polyline renderers.
`int`	`getMarkerSize()` Returns the marker size used to create child polyline renderers.
`int`	`getMode()` Returns the mode of this renderer.
`IlvSinglePolylineRenderer`	`getPolyline(IlvDataSet dataSet)` Returns the child polyline renderer displaying the specified data set.
`IlvSinglePolylineRenderer`	`getPolyline(int idx)` Returns the child polyline renderer displaying the data set at the specified index.
`boolean`	`has3DSupport()` Indicates whether this renderer supports three-dimensional drawing.
`boolean`	`isAutoTransparency()` Returns whether this renderer should use transparent default colors.
`boolean`	`isStacked100Percent()` Indicates whether the stacking is scaled to `100`.
`boolean`	`isStackedByIndex()` Indicates whether the stacking is based on data set indices rather than on X values.
`boolean`	`isSuperimposed()` Returns whether this renderer is in a superimposed configuration.
`void`	`setAutoTransparency(boolean transparent)` Sets whether this renderer should use transparent default colors.
`void`	`setMarker(IlvMarker marker)` Specifies a marker for the child polyline renderers.
`void`	`setMarker(IlvMarker marker, int size)` Specifies a marker and its size for the child polyline renderers.
`void`	`setMarkerSize(int size)` Specifies a marker size for the child polyline renderers.
`void`	`setMode(int mode)` Sets the mode of this renderer.
`void`	`setStacked100Percent(boolean stacked100)` Specifies whether the stacking is scaled to `100`.
`void`	`setStackedByIndex(boolean stackedByIndex)` Specifies whether the stacking is based on data set indices rather than on X values.

Methods inherited from class ilog.views.chart.renderer.IlvCompositeChartRenderer
addImageMapAreas, collectDisplayItems, createLegendItems, draw, draw, drawAnnotations, drawIntoHitmap, drawLegendSymbol, drawSelectionHandles, getAnnotation, getBounds, getBounds, getChild, getChild, getChild, getChildCount, getChildIterator, getChildren, getDisplayItem, getDisplayPoint, getLegendText, getNearestItem, getNearestPoint, getRenderingHint, getRenderingHint, getStyle, getStyles, getXRange, getYRange, getYRange, holdsAnnotations, isViewable, setAnnotation, setAnnotation, setDataPoint, setDisplayPoint, setRenderingHint, setRenderingHint, setStyles, updateChildren

Methods inherited from class ilog.views.chart.IlvChartRenderer
applyStyles, applyStyles, applyStyles, chartConnected, computeDataLabel, computeDataLabelLocation, create, createRenderer, dispose, drawSelectionHandles, drawSelectionHandles, drawSelectionHandles, endRendererChanges, findAppropriateColor, fireTreemapFocusEvent, getAnnotation, getBounds, getChart, getClipRect, getCoordinateSystem, getDataLabeling, getDataLabelLayout, getDataLabelling, getDataSetIndex, getDataSetMainIndex, getDataSetMainRenderer, getDataSource, getDefaultColors, getDefaultLegendTitle, getDepths, getDisplayItem, getDisplayItems, getLegendStyle, getMinDataSetCount, getName, getNearestItem, getNearestPoint, getParent, getPlotRect, getPreferredMargins, getRenderingHint, getStyle, getVirtualDataSet, getXShift, getYAxisIdx, isDisplayingDataSet, isVisible, isVisibleInLegend, reDraw, register, set3D, setAnnotation, setDataLabeling, setDataLabelLayout, setDataLabelling, setDataSource, setName, setParent, setRenderingHint, setRenderingHintWithNoDraw, setStyle, setVisible, setVisibleInLegend, setXShift, setYAxisIdx, startRendererChanges, toData, toDisplay, toDisplay, triggerChange

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SUPERIMPOSED
```
public static final int SUPERIMPOSED
```
    Mode type for superimposed polylines.
    
    See Also:
    
    setMode(int), Constant Field Values
  - STACKED
```
public static final int STACKED
```
    Mode type for stacked polylines.
    Two stacking modes are available:
    - Default mode: All the y-values for a given x-value are summed.
    - 100% mode: Each point represents the percentage it contributes to the sum of all the y-values for a given x-value.
    You can switch between the two modes with the setStacked100Percent(boolean) method.
    Note: This mode works best with data sets whose x-series are sorted in ascending order (see IlvDataSet.isXValuesSorted()). If stacking is performed according to same x values (see setStackedByIndex(boolean)), data sets that are not sorted this way will be implicitly sorted for display, like the class IlvXSortedDataSet does.
    See Also:
    
    setMode(int), setStacked100Percent(boolean), setStackedByIndex(boolean), Constant Field Values
- Constructor Detail
  - IlvPolylineChartRenderer
```
public IlvPolylineChartRenderer()
```
    Creates a new polyline chart renderer with the SUPERIMPOSED mode.
    
    See Also:
    
    setMode(int)
  - IlvPolylineChartRenderer
```
public IlvPolylineChartRenderer(int mode)
```
    Creates a new polyline chart renderer with the specified mode.
    
    See Also:
    
    setMode(int)
- Method Detail
  - getMode
```
public final int getMode()
```
    Returns the mode of this renderer.
    
    See Also:
    
    setMode(int)
  - setMode
```
public void setMode(int mode)
```
    Sets the mode of this renderer. The mode describes how polylines are laid out.
    
    See Also:
    
    SUPERIMPOSED, STACKED
  - getMarker
```
public final IlvMarker getMarker()
```
    Returns the marker used to create child polyline renderers.
    
    See Also:
    
    setMarker(ilog.views.chart.graphic.IlvMarker), setMarker(ilog.views.chart.graphic.IlvMarker, int)
  - setMarker
```
public void setMarker(IlvMarker marker)
```
    Specifies a marker for the child polyline renderers.
    Note: The existing child renderers are not modified by this method. Only subsequent calls to createChild(ilog.views.chart.data.IlvDataSet) will take the specified marker into account.
    
    Since:
    
    JViews 8.0
  - getMarkerSize
```
public final int getMarkerSize()
```
    Returns the marker size used to create child polyline renderers.
    
    See Also:
    
    setMarkerSize(int), setMarker(ilog.views.chart.graphic.IlvMarker, int)
  - setMarkerSize
```
public void setMarkerSize(int size)
```
    Specifies a marker size for the child polyline renderers.
    Note: The existing child renderers are not modified by this method. Only subsequent calls to createChild(ilog.views.chart.data.IlvDataSet) will take the specified marker into account.
    
    Since:
    
    JViews 8.0
  - setMarker
```
public void setMarker(IlvMarker marker,
                      int size)
```
    Specifies a marker and its size for the child polyline renderers.
    Note: The existing child renderers are not modified by this method. Only subsequent calls to createChild(ilog.views.chart.data.IlvDataSet) will take the specified marker and size into account.
    
    See Also:
    
    setMarker(ilog.views.chart.graphic.IlvMarker), setMarkerSize(int)
  - isAutoTransparency
```
public boolean isAutoTransparency()
```
    Returns whether this renderer should use transparent default colors.
    
    Specified by:
    
    isAutoTransparency in interface IlvSuperimposedRenderer
    
    Since:
    
    JViews 6.0
  - setAutoTransparency
```
public void setAutoTransparency(boolean transparent)
```
    Sets whether this renderer should use transparent default colors.
    
    Specified by:
    
    setAutoTransparency in interface IlvSuperimposedRenderer
    
    Since:
    
    JViews 6.0
  - isStacked100Percent
```
public boolean isStacked100Percent()
```
    Indicates whether the stacking is scaled to 100. This method is only meaningful when the mode of the renderer is set to STACKED.
    
    Returns:
    
    The stacking mode.
    
    See Also:
    
    setStacked100Percent(boolean), setMode(int)
  - setStacked100Percent
```
public void setStacked100Percent(boolean stacked100)
```
    Specifies whether the stacking is scaled to 100. If stacked100 is set to true, the sum of all the y-values for a given x-value is scaled to 100. Each bar represents the percentage it contributes to this sum. This method is only meaningful when the mode of the renderer is set to STACKED.
    
    Parameters:
    
    stacked100 - The new stacking mode.
    
    See Also:
    
    isStacked100Percent(), setMode(int)
  - isStackedByIndex
```
public boolean isStackedByIndex()
```
    Indicates whether the stacking is based on data set indices rather than on X values. This method is meaningful only when the mode of the renderer is set to STACKED.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setStackedByIndex(boolean), setMode(int)
  - setStackedByIndex
```
public void setStackedByIndex(boolean stackedByIndex)
```
    Specifies whether the stacking is based on data set indices rather than on X values. If stackedByIndex is set to true, the Y values are computed by accumulating the Y values with the same index, regardless of their X values, and the X values of the second, third, etc. data sets are ignored. If stackedByIndex is set to false, the Y values are computed by accumulating the Y values with the same X value, regardless of their index in the data set. This method is meaningful only when the mode of the renderer is set to STACKED.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    isStackedByIndex(), setMode(int)
  - has3DSupport
```
public boolean has3DSupport()
```
    Indicates whether this renderer supports three-dimensional drawing.
    
    Specified by:
    
    has3DSupport in interface IlvChart3DSupport
    
    Overrides:
    
    has3DSupport in class IlvChartRenderer
    
    Returns:
    
    true
    
    Since:
    
    JViews 5.5
  - dataSetsAdded
```
protected void dataSetsAdded(int firstIdx,
                             int lastIdx,
                             IlvDataSet[] oldDataSets)
```
    Called when data sets are connected to this renderer.
    
    Overrides:
    
    dataSetsAdded in class IlvSimpleCompositeChartRenderer
    
    Parameters:
    
    firstIdx - The index of the first data set.
    
    lastIdx - The index of the last data set.
    
    oldDataSets - The data sets previously connected to this renderer.
    
    See Also:
    
    IlvCompositeChartRenderer.createChild(ilog.views.chart.data.IlvDataSet)
  - dataSetsRemoved
```
protected void dataSetsRemoved(int firstIdx,
                               int lastIdx,
                               IlvDataSet[] oldDataSets)
```
    Called when data sets are disconnected from this renderer.
    
    Overrides:
    
    dataSetsRemoved in class IlvSimpleCompositeChartRenderer
    
    Parameters:
    
    firstIdx - The index of the first data set.
    
    lastIdx - The index of the last data set.
    
    oldDataSets - The data sets previously connected to this renderer.
    
    See Also:
    
    IlvChartRenderer.isViewable()
  - dataSetsChangesBatchStarting
```
protected void dataSetsChangesBatchStarting()
```
    Called when a series of data sets insertions or removals is starting.
    
    Overrides:
    
    dataSetsChangesBatchStarting in class IlvChartRenderer
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    IlvChartRenderer.dataSetsChangesBatchEnding()
  - dataSetsChangesBatchEnding
```
protected void dataSetsChangesBatchEnding()
```
    Called when a series of data sets insertions or removals is terminating.
    
    Overrides:
    
    dataSetsChangesBatchEnding in class IlvChartRenderer
    
    Since:
    
    JViews 8.5
    
    See Also:
    
    IlvChartRenderer.dataSetsChangesBatchStarting()
  - getPolyline
```
public IlvSinglePolylineRenderer getPolyline(IlvDataSet dataSet)
```
    Returns the child polyline renderer displaying the specified data set.
  - getPolyline
```
public IlvSinglePolylineRenderer getPolyline(int idx)
```
    Returns the child polyline renderer displaying the data set at the specified index.
  - createChild
```
protected IlvChartRenderer createChild(IlvDataSet dataSet)
```
    Creates an instance of IlvSinglePolylineRenderer to display the specified data set.
    
    Specified by:
    
    createChild in class IlvCompositeChartRenderer
    
    Returns:
    
    A freshly created renderer that is connected to an empty data source. It will be connected to dataSet by the caller.
  - isSuperimposed
```
public boolean isSuperimposed()
```
    Returns whether this renderer is in a superimposed configuration.
    
    Specified by:
    
    isSuperimposed in interface IlvSuperimposedRenderer
    
    Since:
    
    JViews 6.0

Class IlvPolylineChartRenderer

Field Summary

Fields inherited from class ilog.views.chart.IlvChartRenderer

Constructor Summary

Method Summary

Methods inherited from class ilog.views.chart.renderer.IlvCompositeChartRenderer

Methods inherited from class ilog.views.chart.IlvChartRenderer

Methods inherited from class java.lang.Object

Field Detail

SUPERIMPOSED

STACKED

Constructor Detail

IlvPolylineChartRenderer

IlvPolylineChartRenderer

Method Detail

getMode

setMode

getMarker

setMarker

getMarkerSize

setMarkerSize

setMarker

isAutoTransparency

setAutoTransparency

isStacked100Percent

setStacked100Percent

isStackedByIndex

setStackedByIndex

has3DSupport

dataSetsAdded

dataSetsRemoved

dataSetsChangesBatchStarting

dataSetsChangesBatchEnding

getPolyline

getPolyline

createChild

isSuperimposed