Package com.storedobject.chart

Class BoxplotChart

java.lang.Object

com.storedobject.chart.AbstractPart

com.storedobject.chart.Chart

com.storedobject.chart.AbstractChart

com.storedobject.chart.XYChart

com.storedobject.chart.BoxplotChart

All Implemented Interfaces:

Component, ComponentPart, ComponentProperty, HasAnimation, HasData, HasEmphasis

public class BoxplotChart
extends XYChart

Boxplot 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
BoxplotChart(AbstractDataProvider<BoxplotData.Boxplot> xData, CategoryData yData)	Constructs a BoxplotChart with the specified data for the X and Y axes.
BoxplotChart(CategoryData xData, AbstractDataProvider<BoxplotData.Boxplot> yData)	Constructs a new BoxplotChart with the specified category data for the X-axis and boxplot data for the Y-axis.

Method Summary

Modifier and Type	Method	Description
protected AbstractDataProvider<?>	dataToEmbed()	Get the data to embed.
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
void	validate()	This method is invoked by SOChart to check if the component or part is valid or not.

Methods inherited from class com.storedobject.chart.XYChart

setStackName, setXData, setYData

Methods inherited from class com.storedobject.chart.AbstractChart

setData, setData, setType

Methods inherited from class com.storedobject.chart.Chart

addParts, dataValue, dataValueIndex, declareData, getAnimation, getCoordinateSystem, getData, getEmphasis, getItemStyle, getLabel, getLabelName, getMarkArea, getMax, getMin, getName, getTooltip, getType, mainData, plotOn, plotOn, setAnimation, setColors, setCustomRenderer, setEmphasis, setItemStyle, setLabel, setMarkArea, 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

BoxplotChart

public BoxplotChart(CategoryData xData,
 AbstractDataProvider<BoxplotData.Boxplot> yData)

Constructs a new BoxplotChart with the specified category data for the X-axis and boxplot data for the Y-axis.

Parameters:

xData - the categorical data to be used as the X-axis values

yData - the boxplot data to be used as the Y-axis values, containing the statistical values necessary for the boxplot (lower, Q1, median, Q3, upper)

BoxplotChart

public BoxplotChart(AbstractDataProvider<BoxplotData.Boxplot> xData,
 CategoryData yData)

Constructs a BoxplotChart with the specified data for the X and Y axes.

Parameters:

xData - Data provider for the X-axis. This should provide Boxplot data represented as BoxplotData.Boxplot.

yData - Data provider for the Y-axis. This should be categorized data represented as CategoryData.

Method Details

dataToEmbed

protected AbstractDataProvider<?> dataToEmbed()

Description copied from class: Chart

Get the data to embed. This is useful only for those special charts that embed data in the chart itself rather than pointing to the dataset. Example: TreeChart, GaugeChart etc. If null is returned from this method, no data will be embedded.

Overrides:

dataToEmbed in class Chart

Returns:

Data to embed.

validate

public void validate()
              throws ChartException

Description copied from interface: ComponentPart

This method is invoked by SOChart to check if the component or part is valid or not.

Specified by:

validate in interface ComponentPart

Overrides:

validate in class AbstractChart

Throws:

ChartException - Raises exception if the component or part is not valid.

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.