Package com.storedobject.chart

Class BarChart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

com.storedobject.chart.AbstractChart

com.storedobject.chart.XYChart

com.storedobject.chart.BarChart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis

public class BarChart
extends XYChart

Bar chart.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.chart.Chart

Chart.Emphasis, Chart.Label, Chart.LabelPosition

Constructor Summary

Constructors

Constructor	Description
BarChart()	Constructor.
BarChart(AbstractDataProvider<?> xData, AbstractDataProvider<?> yData)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
final int	getBarCategoryGap()	Get the gap between the categories of the same bar chart.
final int	getBarGap()	Get the gap between bars when multiple bar charts are displayed on the same coordinate system.
final int	getBarWidth()	Get the width of the bar.
final MarkArea	getMarkArea(boolean create)	This chart doesn't support mark area and this method always returns null.
final boolean	isRoundCap()	Is round-cap feature set?
void	setBarCategoryGap(int barCategoryGap)	Set the gap between the categories of the same bar chart.
void	setBarGap(int barGap)	Set the gap between bars when multiple bar charts are displayed on the same coordinate system.
void	setBarWidth(int barWidth)	Set the width of the bar.
final void	setMarkArea(MarkArea markArea)	This chart doesn't support mark area and this method does nothing.
void	setRoundCap(boolean roundCap)	Set round-cap feature.

Methods inherited from class com.storedobject.chart.XYChart

setStackName, setXData, setYData

Methods inherited from class com.storedobject.chart.AbstractChart

setData, setData, setType, validate

Methods inherited from class com.storedobject.chart.Chart

addEvent, addParts, dataToEmbed, dataValue, dataValueIndex, declareData, getAnimation, getCoordinateSystem, getData, getEmphasis, getEvents, getItemStyle, getLabel, getLabelName, getMax, getMin, getName, getTooltip, getType, plotOn, plotOn, setAnimation, setColors, setCustomRenderer, setEmphasis, setItemStyle, setLabel, setName, setTooltip, typeValue

Methods inherited from class com.storedobject.chart.AbstractPart

equals, getId, getLabelTag, getSerial, getZ, hashCode, hasId, setSerial, setZ

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.storedobject.chart.ComponentPart

className, getId, getRenderingIndex, getSerial, setRenderingIndex, setSerial

Constructor Details

BarChart

public BarChart()

Constructor. (Data can be set later).

BarChart

public BarChart(AbstractDataProvider<?> xData,
 AbstractDataProvider<?> yData)

Constructor.

Parameters:

xData - Data for X axis.

yData - Data for Y axis.

Method Details

encodeJSON

public void encodeJSON(StringBuilder sb)

Description copied from interface: ComponentProperty

Encode the JSON string with the properties of this.

Specified by:

encodeJSON in interface ComponentProperty

Overrides:

encodeJSON in class XYChart

Parameters:

sb - Encoded JSON string to be appended to this.

isRoundCap

public final boolean isRoundCap()

Is round-cap feature set?

Returns:

True/false.

setRoundCap

public void setRoundCap(boolean roundCap)

Set round-cap feature. If set it to true, the ending portion of the bar will be rounded. This will be effective only when plotting this chart on PolarCoordinates.

Parameters:

roundCap - Round-cap feature.

getBarGap

public final int getBarGap()

Get the gap between bars when multiple bar charts are displayed on the same coordinate system.

Returns:

Gap as a percentage value. Negative values are supported to enable overlapping.

setBarGap

public void setBarGap(int barGap)

Set the gap between bars when multiple bar charts are displayed on the same coordinate system. Need to set only on one of the bar charts and it will be shared by all bar charts on the same coordinate system. If you set different values on different bar charts, only the one set in the last one will be used.

Parameters:

barGap - Gap as a percentage value. Negative values are supported to enable overlapping.

getBarCategoryGap

public final int getBarCategoryGap()

Get the gap between the categories of the same bar chart.

Returns:

Gap as a percentage value. Negative values are supported to enable overlapping.

setBarCategoryGap

public void setBarCategoryGap(int barCategoryGap)

Set the gap between the categories of the same bar chart.

Parameters:

barCategoryGap - Gap as a percentage value. Negative values are supported to enable overlapping.

getBarWidth

public final int getBarWidth()

Get the width of the bar.

Returns:

Width of the bar in pixels.

setBarWidth

public void setBarWidth(int barWidth)

Set the width of the bar.

Parameters:

barWidth - Width of the bar in pixels.

getMarkArea

public final MarkArea getMarkArea(boolean create)

This chart doesn't support mark area and this method always returns null.

Overrides:

getMarkArea in class Chart

Parameters:

create - If passed true, a new MarkArea is created if not exists.

Returns:

Null

setMarkArea

public final void setMarkArea(MarkArea markArea)

This chart doesn't support mark area and this method does nothing.

Overrides:

setMarkArea in class Chart

Parameters:

markArea - Mark area to set.