ilog.views.chart.renderer

Class IlvSingleBarRenderer

java.lang.Object

ilog.views.chart.IlvChartRenderer

ilog.views.chart.renderer.IlvSingleChartRenderer

ilog.views.chart.renderer.IlvSingleBarRenderer

All Implemented Interfaces:

IlvChartAreaAccessible, IlvChart3DSupport, IlvVariableWidthRenderer, Serializable

public class IlvSingleBarRenderer
extends IlvSingleChartRenderer
implements IlvVariableWidthRenderer

Renders a data set with a bar chart.

Since:

JViews 5.0

See Also:

IlvBarChartRenderer, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	SHAPE_EXACT In this mode, every bar has an exact projected rectangle shape.
static int	SHAPE_POLYGON In this mode, every bar has a polygonal shape that approximates the exact projected shape.
static int	SHAPE_QUADRILATERAL In this mode, every bar has a quadrilateral (4-gon) shape.

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
IlvSingleBarRenderer() Creates a new IlvSingleBarRenderer with a default bar width and style.
IlvSingleBarRenderer(IlvStyle style) Creates a new IlvSingleBarRenderer with the specified style.
IlvSingleBarRenderer(IlvStyle style, double barPercent) Creates a new IlvSingleBarRenderer with the specified style and bar size.

Method Summary

Modifier and Type	Method and Description
Point	computeDataLabelLocation(IlvDisplayPoint dp, Dimension size) Computes the location of the data label associated with the specified point.
int	getBarShape() Returns the shape of the bars.
double[]	getDepths() Returns the front and back depths of the renderer.
double	getSpecWidthPercent() Returns the specified bar width.
static int	getStrokeThreshold() Returns the minimum width of a bar, under which the stroke of a rendering style is not used.
double	getWidth() Returns the bar width in the data space.
double	getWidthPercent() Returns the bar width.
String	getZAnnotationText() Returns the text displayed along the depth axis.
boolean	has3DSupport() Indicates whether this renderer supports three-dimensional drawing.
boolean	isUseCategorySpacingAtBorders() Returns true if the category spacing is used also at the left and right borders.
void	setBarShape(int barShape) Sets the shape of the bars.
void	setParent(IlvChartRenderer parent) Connects this renderer to the specified parent.
static void	setStrokeThreshold(int threshold) Specifies the minimum width of a bar, under which the stroke of a rendering style is not used.
void	setUseCategorySpacingAtBorders(boolean useCategorySpacingAtBorders) Determines whether the category spacing is used also at the left and right borders.
void	setWidthPercent(double percent) Sets the bar width.

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

addImageMapAreas, applyDataSetStyle, applyStyles, chartConnected, createLegendItems, dataSetContentsChanged, dataSetPropertyChanged, dataSetsAdded, dataSetsRemoved, draw, draw, drawAnnotations, drawIntoHitmap, drawLegendSymbol, drawSelectionHandles, drawSelectionHandles, getAnnotation, getBounds, getBounds, getDefaultLegendText, getDisplayItem, getDisplayPoint, getDisplayStyle, getLegendText, getNearestItem, getNearestPoint, getPreferredMargins, getRenderingHint, getRenderingHint, getStyle, getStyle, getStyles, getXRange, getYRange, getYRange, holdsAnnotations, isFilled, makeDefaultStyle, set3D, setAnnotation, setAnnotation, setDataPoint, setDisplayPoint, setRenderingHint, setRenderingHint, setStyle, setStyles, toDisplay, toDisplay

Methods inherited from class ilog.views.chart.IlvChartRenderer

applyStyles, applyStyles, collectDisplayItems, computeDataLabel, create, createRenderer, dataSetsChangesBatchEnding, dataSetsChangesBatchStarting, dispose, drawSelectionHandles, drawSelectionHandles, endRendererChanges, findAppropriateColor, fireTreemapFocusEvent, getAnnotation, getBounds, getChart, getChild, getChildCount, getChildIterator, getChildren, getClipRect, getCoordinateSystem, getDataLabeling, getDataLabelLayout, getDataLabelling, getDataSetIndex, getDataSetMainIndex, getDataSetMainRenderer, getDataSource, getDefaultColors, getDefaultLegendTitle, getDisplayItem, getDisplayItems, getLegendStyle, getMinDataSetCount, getName, getNearestItem, getNearestPoint, getParent, getPlotRect, getRenderingHint, getStyle, getVirtualDataSet, getXShift, getYAxisIdx, isDisplayingDataSet, isViewable, isVisible, isVisibleInLegend, reDraw, register, setAnnotation, setDataLabeling, setDataLabelLayout, setDataLabelling, setDataSource, setName, setRenderingHint, setRenderingHintWithNoDraw, setStyle, setVisible, setVisibleInLegend, setXShift, setYAxisIdx, startRendererChanges, toData, triggerChange

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SHAPE_QUADRILATERAL

public static final int SHAPE_QUADRILATERAL

In this mode, every bar has a quadrilateral (4-gon) shape.

Since:

JViews 8.1

See Also:

Constant Field Values

SHAPE_POLYGON

public static final int SHAPE_POLYGON

In this mode, every bar has a polygonal shape that approximates the exact projected shape.

Since:

JViews 8.1

See Also:

Constant Field Values

SHAPE_EXACT

public static final int 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.

Since:

JViews 8.1

See Also:

Constant Field Values

Constructor Detail

IlvSingleBarRenderer

public IlvSingleBarRenderer()

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

IlvSingleBarRenderer

public IlvSingleBarRenderer(IlvStyle style)

Creates a new IlvSingleBarRenderer with the specified style.

IlvSingleBarRenderer

public IlvSingleBarRenderer(IlvStyle style,
                            double barPercent)

Creates a new IlvSingleBarRenderer with the specified style and bar size.

See Also:

setWidthPercent(double)

Method Detail

getStrokeThreshold

public static int getStrokeThreshold()

Returns the minimum width of a bar, under which the stroke of a rendering style is not used.

See Also:

setStrokeThreshold(int)

setStrokeThreshold

public static void setStrokeThreshold(int threshold)

Specifies the minimum width of a bar, under which the stroke of a rendering style is not used.

The default value is 6.

Parameters:

threshold - The new threshold in pixel. Bars with a width smaller than this threshold will not be rendered with a stroke, unless they are not filled.

See Also:

getStrokeThreshold()

getSpecWidthPercent

public double getSpecWidthPercent()

Returns the specified bar width.

Since:

JViews 8.0

See Also:

setWidthPercent(double)

setWidthPercent

public void setWidthPercent(double percent)

Sets the bar width.

Specified by:

setWidthPercent in interface IlvVariableWidthRenderer

Parameters:

percent - A value from 0 to 100 that specifies the amount of the available space covered by the bar.

See Also:

getWidthPercent(), getSpecWidthPercent()

getWidthPercent

public double getWidthPercent()

Returns the bar width.

Specified by:

getWidthPercent in interface IlvVariableWidthRenderer

See Also:

setWidthPercent(double)

getWidth

public double getWidth()

Returns the bar width in the 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 3D mode.

Parameters:

barShape - One of SHAPE_QUADRILATERAL, SHAPE_POLYGON, SHAPE_EXACT.

Since:

JViews 8.1

See Also:

getBarShape()

setParent

public void setParent(IlvChartRenderer parent)

Connects this renderer to the specified parent. This method should not be called directly.

Overrides:

setParent in class IlvChartRenderer

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

getDepths

public double[] getDepths()

Returns the front and back depths of the renderer.

Overrides:

getDepths in class IlvChartRenderer

Returns:

An array containing the front (maximum) depth and back (minimum) depth. The returned array is null if has3DSupport() returns false, or if the renderer is not added to a chart.

Since:

JViews 5.5

See Also:

IlvChart3DView.getFrontDepth(), IlvChart3DView.getBackDepth(), IlvChart3DView.setDepthGap(int)

getZAnnotationText

public String getZAnnotationText()

Returns the text displayed along the depth axis.

Overrides:

getZAnnotationText in class IlvSingleChartRenderer

Returns:

null if the bar is a child of a stacked IlvBarChartRenderer. Otherwise, returns the string computed by the IlvSingleChartRenderer.getDefaultLegendText() method.

Since:

JViews 5.5

See Also:

IlvChart3DView.setZAnnotationVisible(boolean)

computeDataLabelLocation

public Point computeDataLabelLocation(IlvDisplayPoint dp,
                                      Dimension size)

Computes the location of the data label associated with the specified point. This method is used by the IlvDataLabelAnnotation class.

Overrides:

computeDataLabelLocation in class IlvChartRenderer

Parameters:

dp - The considered display point.

size - The size of the label.

Returns:

The location of the center of the label.

See Also:

IlvChartRenderer.setDataLabeling(int)