Package com.inet.report.chart.plot
Class BarPlot
java.lang.Object
com.inet.report.chart.plot.AbstractPlot
com.inet.report.chart.plot.StandardPlot
com.inet.report.chart.plot.BarPlot
- All Implemented Interfaces:
ChartPlot
,Serializable
A general class for plotting data of groups of values. This plot can
use data from any class that implements the
BaseDataset
interface.- Since:
- 8.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.inet.report.chart.plot.AbstractPlot
AbstractPlot.GradientSetting
-
Field Summary
Modifier and TypeFieldDescriptionstatic final double
The default bar margin percentage.static final double
The default bar width.static final BarStyle
Default chart style with this plot.static final int
A auto label alignment, is default.static final int
A horizontal label alignment.static final int
A vertical label alignment.Fields inherited from class com.inet.report.chart.plot.StandardPlot
ITEM_LABEL_POSITION_BASE, ITEM_LABEL_POSITION_CENTER, ITEM_LABEL_POSITION_INSIDE_OF_MAX, ITEM_LABEL_POSITION_OUTSIDE_OF_MAX
Fields inherited from class com.inet.report.chart.plot.AbstractPlot
DEFAULT_COLOR_SEQUENCE, DEFAULT_FOREGROUND_ALPHA, DEFAULT_ITEM_LABEL_COLOR, DEFAULT_ITEM_LABEL_FONT, DEFAULT_OUTLINE_COLOR, DEFAULT_OUTLINE_STYLE, DEFAULT_OUTLINE_WIDTH, TOKEN_PLOT
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptiondouble
Returns the bar margin in percent where 0.10 is 10 percent.double
Returns the maximum bar width in percent where 0.10 is 10 percent.int
Returns the label alignment displayed on the items of this plot.getStyle()
Returns the style of this chart, ie. the general category this plot belongs to.protected StringBuilder
getSubProperties
(int depth) Returns the serialized simple properties of subclasses.boolean
Returns the flag that controls whether or not the totals will be showed for each bar.void
readProperties
(Element element, Chart2 chart) Reads the chart properties from the DOMParser Element.void
setBarMarginPercent
(double barMarginPercent) Sets the bar margin (space between the bars).void
setBarWidth
(double barWidth) Sets the maximum bar width, which is specified as a percentage of the available space for all bars,void
setCategoryAxis
(GroupAxis categoryAxis) Sets the axis for categories of this plot.void
setDataAxis
(ContinuousNumberAxis dataAxis) Sets the axis for data of this plot.void
setItemLabelAlignment
(int itemLabelAlignment) Sets the item label alignment.void
setShowTotal
(boolean showTotal) Sets the flag that controls whether or not the totals will be showed for each bar.
Note: this property works only for stacked chart with showing absolute values.void
Sets a chart style of this bar plot.Methods inherited from class com.inet.report.chart.plot.StandardPlot
getCategoryAxis, getDataAxis, getDataset, getItemLabelPosition, getReferencedObject, isShowCumulativeValues, refreshAutoTitles, saveSubProperties, setCategoryAxis, setDataAxis, setDataset, setItemLabelPosition, setShowCumulativeValues
Methods inherited from class com.inet.report.chart.plot.AbstractPlot
getBackColor, getColorFormula, getColorSequence, getForegroundAlpha, getGradientSetting, getItemLabelColor, getItemLabelFont, getItemLabelFormat, getItemLabelFormatFormula, getItemShape, getOutlineColor, getOutlineStyle, getOutlineWidth, isColorBySeries, isDrawOutline, isSameColorsForSameGroups, isShowLabel, isShowValue, saveProperties, setBackColor, setColorBySeries, setColorFormula, setColorSequence, setDrawOutline, setForegroundAlpha, setGradientSetting, setItemLabelColor, setItemLabelFont, setItemLabelFormat, setItemLabelFormatFormula, setItemShape, setOutlineColor, setOutlineStyle, setOutlineWidth, setSameColorsForSameGroups, setShowLabel, setShowValue
-
Field Details
-
DEFAULT_STYLE
Default chart style with this plot. -
ITEM_LABEL_ALIGNMENT_AUTO
public static final int ITEM_LABEL_ALIGNMENT_AUTOA auto label alignment, is default.- See Also:
-
ITEM_LABEL_ALIGNMENT_VERTICAL
public static final int ITEM_LABEL_ALIGNMENT_VERTICALA vertical label alignment.- See Also:
-
ITEM_LABEL_ALIGNMENT_HORIZONTAL
public static final int ITEM_LABEL_ALIGNMENT_HORIZONTALA horizontal label alignment.- See Also:
-
DEFAULT_BAR_MARGIN_PERCENT
public static final double DEFAULT_BAR_MARGIN_PERCENTThe default bar margin percentage.- See Also:
-
DEFAULT_BAR_WIDTH
public static final double DEFAULT_BAR_WIDTHThe default bar width.- See Also:
-
-
Constructor Details
-
BarPlot
public BarPlot()Creates a bar plot with default properties.- Since:
- 8.0
-
BarPlot
Creates a bar plot with defined chart style. Initializes all properties with default values.- Parameters:
style
- the chart style (null
not permitted)- Since:
- 8.0
- See Also:
-
-
Method Details
-
setCategoryAxis
Sets the axis for categories of this plot. The category axis shows the values of the first group field.- Parameters:
categoryAxis
- the category axis (null
not permitted)- Since:
- 8.0
- See Also:
-
setDataAxis
Sets the axis for data of this plot. The data axis shows the summarized values of the data fields.- Parameters:
dataAxis
- the data axis (null
not permitted)- Since:
- 8.0
- See Also:
-
getStyle
Returns the style of this chart, ie. the general category this plot belongs to.- Specified by:
getStyle
in classStandardPlot
- Returns:
- the style
- See Also:
-
setStyle
Sets a chart style of this bar plot.- Parameters:
style
- the bar style (null
not permitted)- Since:
- 8.0
- See Also:
-
getItemLabelAlignment
public int getItemLabelAlignment()Returns the label alignment displayed on the items of this plot.- Returns:
- the alignment.
- Since:
- 8.0
- See Also:
-
setItemLabelAlignment
public void setItemLabelAlignment(int itemLabelAlignment) Sets the item label alignment. An item label is a label with name and value on each chart item. Default alignment isITEM_LABEL_ALIGNMENT_AUTO
.- Parameters:
itemLabelAlignment
- the item label alignment- Throws:
IllegalArgumentException
- by unknown alignment.- Since:
- 8.0
- See Also:
-
isShowTotal
public boolean isShowTotal()Returns the flag that controls whether or not the totals will be showed for each bar.- Returns:
- the flag.
- Since:
- 8.0
- See Also:
-
setShowTotal
public void setShowTotal(boolean showTotal) Sets the flag that controls whether or not the totals will be showed for each bar.
Note: this property works only for stacked chart with showing absolute values.- Parameters:
showTotal
- the flag- Since:
- 8.0
- See Also:
-
getBarMarginPercent
public double getBarMarginPercent()Returns the bar margin in percent where 0.10 is 10 percent.- Returns:
- the margin
- Since:
- 14.1
- See Also:
-
setBarMarginPercent
public void setBarMarginPercent(double barMarginPercent) Sets the bar margin (space between the bars). The value is expressed as a percentage of the available plot width.- Parameters:
barMarginPercent
- the margin (where 0.10 is ten percent)- Since:
- 14.1
-
getBarWidth
public double getBarWidth()Returns the maximum bar width in percent where 0.10 is 10 percent.- Returns:
- the bar width
- Since:
- 11.0
- See Also:
-
setBarWidth
public void setBarWidth(double barWidth) Sets the maximum bar width, which is specified as a percentage of the available space for all bars,- Parameters:
barWidth
- the width (where 0.10 is ten percent)- Since:
- 11.0
- See Also:
-
getSubProperties
Returns the serialized simple properties of subclasses.- Overrides:
getSubProperties
in classStandardPlot
- Parameters:
depth
- the depth of XML indent- Returns:
- the properties.
-
readProperties
Reads the chart properties from the DOMParser Element.- Specified by:
readProperties
in interfaceChartPlot
- Overrides:
readProperties
in classStandardPlot
- Parameters:
element
- the DOMParser Elementchart
- the chart
-