IlvBarChartRenderer (Rogue Wave JViews 9.2 API)

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

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, IlvSuperimposedRenderer, IlvVariableWidthRenderer, Serializable
```
public class IlvBarChartRenderer
extends IlvSimpleCompositeChartRenderer
implements IlvVariableWidthRenderer, IlvSuperimposedRenderer
```
A renderer displaying bars. This renderer creates an instance of IlvSingleBarRenderer for every data set in the connected data source. An IlvBarChartRenderer supports three representation modes:
- Superimposed: bars are drawn on top of each other, and their width is computed so that a bar is only partly covered. This mode corresponds to the SUPERIMPOSED constant.
- Clustered: bars are laid out in clusters, each cluster represents the set of y-values corresponding to a given x-value. This mode corresponds to the CLUSTERED constant.
- Stacked: bars 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`	`CLUSTERED` Mode type for clustered bars.
`static int`	`STACKED` Mode type for stacked bars.
`static int`	`SUPERIMPOSED` Mode type for superimposed bars.

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 inherited from interface ilog.views.chart.renderer.IlvVariableWidthRenderer
DEFAULT_WIDTH

Constructor Summary

Constructors
Constructor and Description
`IlvBarChartRenderer()` Creates a new `IlvBarChartRenderer`, with a default bar width and the `CLUSTERED` mode.
`IlvBarChartRenderer(double barWidth, int mode)` Creates a new `IlvBarChartRenderer`, with the specified bar width and mode.
`IlvBarChartRenderer(int mode)` Creates a new `IlvBarChartRenderer`, with a default bar width and 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 `IlvSingleBarRenderer` 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.
`IlvSingleBarRenderer`	`getBar(IlvDataSet dataSet)` Returns the child bar renderer displaying the specified data set.
`int`	`getBarShape()` Returns the shape of the bars.
`double`	`getClusterWidth()` Returns the cluster width.
`int`	`getMode()` Returns the mode of this renderer.
`double`	`getOverlap()` Returns the overlapping amount.
`double`	`getWidth()` Returns the width of the graphical representation of a data point along the x-axis.
`double`	`getWidthPercent()` Returns the width of the graphical representation of a data point.
`boolean`	`has3DSupport()` Indicates whether this renderer supports three-dimensional drawing.
`boolean`	`isAutoTransparency()` Returns whether this renderer should use transparent default colors.
`boolean`	`isDiverging()` Returns true if negative values are stacked separately from positive values.
`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.
`boolean`	`isUseCategorySpacingAtBorders()` Returns `true` if the category spacing is used also at the left and right borders.
`void`	`setAutoTransparency(boolean transparent)` Sets whether this renderer should use transparent default colors.
`void`	`setBarShape(int barShape)` Sets the shape of the bars.
`void`	`setClusterWidth(double width)` Modifies the cluster width.
`void`	`setDiverging(boolean diverging)` Specifies whether negative values are stacked separately from positive values.
`void`	`setMode(int mode)` Sets the mode of this renderer.
`void`	`setOverlap(double overlap)` Modifies the overlapping amount.
`void`	`setStacked100Percent(boolean stacked100)` Specifies the stacking mode.
`void`	`setStackedByIndex(boolean stackedByIndex)` Specifies whether the stacking is based on data set indices rather than on X values.
`void`	`setUseCategorySpacingAtBorders(boolean useCategorySpacingAtBorders)` Determines whether the category spacing is used also at the left and right borders.
`void`	`setWidthPercent(double percent)` Sets the width of the graphical representation of a data point.
`protected void`	`updateChildren()` Updates the layout of the child bars.

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

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 bars. Superimposed bars are drawn on top of each other. The width of each bar is computed automatically so that only part of the bars is covered.
    
    See Also:
    
    setMode(int), Constant Field Values
  - CLUSTERED
```
public static final int CLUSTERED
```
    Mode type for clustered bars. Bars are laid out in clusters, according to two criteria:
    - The cluster width, which specifies the amount of space available for each cluster.
    - The overlap, which specifies the amount by which bars overlap within a cluster.
    See Also:
    
    setMode(int), setOverlap(double), setClusterWidth(double), Constant Field Values
  - STACKED
```
public static final int STACKED
```
    Mode type for stacked bars.
    Two stacking modes are available:
    - Default mode: All the y-values for a given x-value are summed.
    - 100% mode: Each bar 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.
    See Also:
    
    setMode(int), setStacked100Percent(boolean), setStackedByIndex(boolean), Constant Field Values
- Constructor Detail
  - IlvBarChartRenderer
```
public IlvBarChartRenderer()
```
    Creates a new IlvBarChartRenderer, with a default bar width and the CLUSTERED mode.
  - IlvBarChartRenderer
```
public IlvBarChartRenderer(int mode)
```
    Creates a new IlvBarChartRenderer, with a default bar width and specified mode.
  - IlvBarChartRenderer
```
public IlvBarChartRenderer(double barWidth,
                           int mode)
```
    Creates a new IlvBarChartRenderer, with the specified bar width and mode. The bar width will be used to create the child bars. Each bar can be accessed and customized with the getBar(IlvDataSet) method. Note that if the mode of the renderer is SUPERIMPOSED, bar widths are computed automatically.
    
    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 bars are laid out.
    
    See Also:
    
    SUPERIMPOSED, STACKED, CLUSTERED
  - 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
  - isStacked100Percent
```
public boolean isStacked100Percent()
```
    Indicates whether the stacking is scaled to 100. This method is meaningful only 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 the stacking mode. 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 meaningful only 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)
  - isDiverging
```
public boolean isDiverging()
```
    Returns true if negative values are stacked separately from positive values. This method is meaningful only when the mode of the renderer is set to STACKED.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setDiverging(boolean)
  - setDiverging
```
public void setDiverging(boolean diverging)
```
    Specifies whether negative values are stacked separately from positive values. This method is meaningful only when the mode of the renderer is set to STACKED.
    If diverging is set to true, positive y values will be stacked together in a bar towards positive values, and negative y values will be stacked together in a bar in the opposite direction. This rendering mode makes it easy to visually understand negative values.
    Warning: This mode assumes that there is no particular order among the data sets; the data points belonging to negative y values are reordered, as if they all came before the positive y values.
    Warning: Also, in this mode, the largest displayed y value is no longer the sum of all y values; rather, it is the sum of all positive y values. This can be confusing for the user.
    Note: In this release, this mode has no effect when the stackedByIndex property is set to true or when the stacked100Percent property is set to true.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    isDiverging()
  - getOverlap
```
public double getOverlap()
```
    Returns the overlapping amount. This method is meaningful only when the mode of the renderer is set to CLUSTERED.
    
    See Also:
    
    setOverlap(double)
  - setOverlap
```
public void setOverlap(double overlap)
```
    Modifies the overlapping amount. The overlap parameter can take values between 0 and 100. It specifies the amount by which bars overlap. This method is meaningful only when the mode of the renderer is set to CLUSTERED.
  - getClusterWidth
```
public final double getClusterWidth()
```
    Returns the cluster width. This method is meaningful only when the mode of the renderer is set to CLUSTERED.
    
    See Also:
    
    setClusterWidth(double)
  - setClusterWidth
```
public final void setClusterWidth(double width)
```
    Modifies the cluster width. The cluster width determines the amount of space available for each cluster. This method is meaningful only when the mode of the renderer is set to CLUSTERED.
  - getWidthPercent
```
public double getWidthPercent()
```
    Returns the width of the graphical representation of a data point.
    
    Specified by:
    
    getWidthPercent in interface IlvVariableWidthRenderer
    
    See Also:
    
    IlvVariableWidthRenderer.setWidthPercent(double)
  - setWidthPercent
```
public void setWidthPercent(double percent)
```
    Sets the width of the graphical representation of a data point.
    
    Specified by:
    
    setWidthPercent in interface IlvVariableWidthRenderer
    
    Parameters:
    
    percent - The new percentage. Valid values are between 0 and 100.
  - getWidth
```
public double getWidth()
```
    Returns the width of the graphical representation of a data point along the x-axis. The returned size is expressed in data space.
    
    Specified by:
    
    getWidth in interface IlvVariableWidthRenderer
  - isUseCategorySpacingAtBorders
```
public boolean isUseCategorySpacingAtBorders()
```
    Returns true if the category spacing is used also at the left and right borders.
    
    Specified by:
    
    isUseCategorySpacingAtBorders in interface IlvVariableWidthRenderer
    
    Since:
    
    JViews 8.0
  - setUseCategorySpacingAtBorders
```
public void setUseCategorySpacingAtBorders(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.
    
    Specified by:
    
    setUseCategorySpacingAtBorders in interface IlvVariableWidthRenderer
    
    Since:
    
    JViews 8.0
  - getBarShape
```
public int getBarShape()
```
    Returns the shape of the bars.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    setBarShape(int)
  - setBarShape
```
public void setBarShape(int barShape)
```
    Sets the shape of the bars. Note: This has no effect in 3-D mode.
    
    Parameters:
    
    barShape - One of IlvSingleBarRenderer.SHAPE_QUADRILATERAL, IlvSingleBarRenderer.SHAPE_POLYGON, IlvSingleBarRenderer.SHAPE_EXACT.
    
    Since:
    
    JViews 8.1
    
    See Also:
    
    getBarShape()
  - updateChildren
```
protected void updateChildren()
```
    Updates the layout of the child bars.
    
    Overrides:
    
    updateChildren in class IlvCompositeChartRenderer
  - 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()
  - getBar
```
public IlvSingleBarRenderer getBar(IlvDataSet dataSet)
```
    Returns the child bar renderer displaying the specified data set.
  - createChild
```
protected IlvChartRenderer createChild(IlvDataSet dataSet)
```
    Creates an instance of IlvSingleBarRenderer 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.
  - 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
  - isSuperimposed
```
public boolean isSuperimposed()
```
    Returns whether this renderer is in a superimposed configuration.
    
    Specified by:
    
    isSuperimposed in interface IlvSuperimposedRenderer
    
    Since:
    
    JViews 6.0

Class IlvBarChartRenderer

Field Summary

Fields inherited from class ilog.views.chart.IlvChartRenderer

Fields inherited from interface ilog.views.chart.renderer.IlvVariableWidthRenderer

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

CLUSTERED

STACKED

Constructor Detail

IlvBarChartRenderer

IlvBarChartRenderer

IlvBarChartRenderer

Method Detail

getMode

setMode

has3DSupport

isStacked100Percent

setStacked100Percent

isStackedByIndex

setStackedByIndex

isDiverging

setDiverging

getOverlap

setOverlap

getClusterWidth

setClusterWidth

getWidthPercent

setWidthPercent

getWidth

isUseCategorySpacingAtBorders

setUseCategorySpacingAtBorders

getBarShape

setBarShape

updateChildren

dataSetsAdded

dataSetsRemoved

dataSetsChangesBatchStarting

dataSetsChangesBatchEnding

getBar

createChild

isAutoTransparency

setAutoTransparency

isSuperimposed