Package com.storedobject.chart

Class Chart.Label

java.lang.Object

com.storedobject.chart.TextStyle

com.storedobject.chart.AbstractLabel

com.storedobject.chart.Label

com.storedobject.chart.Chart.Label

All Implemented Interfaces:

ComponentProperty

Enclosing class:

Chart

public static class Chart.Label
extends Label

Value-label that can be customized for a chart.

Author:

Syam

Field Summary

Fields inherited from class com.storedobject.chart.Label

doNotEscapeFormat, formatParser, formatter

Constructor Summary

Constructors

Constructor	Description
Label()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	encodeJSON(StringBuilder sb)	Encode the JSON string with the properties of this.
protected String	getGapName()	Name of the gap to be used when rendering (It is different when different parts are used).
Chart.LabelPosition	getPosition()	Get the position indicator of this label.
void	setFormatter(String formatter)	Set the label formatter.
void	setLabelProvider(AbstractDataProvider<?> labels)	Instead of specifying the format for the label via setFormatter(String), it is possible to set the labels directly from an AbstractDataProvider using this method.

Methods inherited from class com.storedobject.chart.Label

getFormatter, getRotation, isInside, setInside, setRotation

Methods inherited from class com.storedobject.chart.AbstractLabel

getGap, hide, setGap, show

Methods inherited from class com.storedobject.chart.TextStyle

getAlignment, getBackground, getBorder, getColor, getFontStyle, getPadding, getRichTextStyle, getTextBorder, setAlignment, setBackground, setBorder, setColor, setFontStyle, setPadding, setRichTextStyle, setTextBorder

Methods inherited from class java.lang.Object

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

Constructor Details

Label

public Label()

Constructor.

Method Details

getGapName

protected String getGapName()

Description copied from class: AbstractLabel

Name of the gap to be used when rendering (It is different when different parts are used).

Overrides:

getGapName in class AbstractLabel

Returns:

Name of the gap.

setFormatter

public void setFormatter(String formatter)

Set the label formatter.

Format template may contain patterns like {n} where "n" is the index of the axis. So {0} represents the x-axis value and {1} represents the y-axis value for an XYChart. If 2 y-axes are there, it will be {1} and {2} respectively. There can be many axes and the index value will increase accordingly. The index indicates the order in which the axes were added to the chart.

You could also use {D:data name} to specify any data set so that the labels will be taken from the data set specified. This mechanism is useful when you have a confusing set of axes and could not precisely determine the index number of the axis. Also, please see if you can use setLabelProvider(AbstractDataProvider) instead of this.

 Examples:
 "{0}, {1}" => Produces labels like "Rice 20" where "Rice" is the x-value and 20 is the y-value.
 "{1} kg" => Produces labels like "20 kg" where 20 is the y-value.
 "{1} kg/year of {chart}" => Produces labels like "4000 kg/year of Rice" where 4000 is the y-value
 and "Rice" is the name of the chart.
 

Specified by:

setFormatter in class Label

Parameters:

formatter - Label formatter to be set.

setLabelProvider

public void setLabelProvider(AbstractDataProvider<?> labels)

Instead of specifying the format for the label via setFormatter(String), it is possible to set the labels directly from an AbstractDataProvider using this method. Such an AbstractDataProvider may be created from the one or more of the AbstractDataProviders involved via one of the create methods: AbstractDataProvider.create(DataType, Function) or AbstractDataProvider.create(DataType, BiFunction)

Parameters:

labels - Labels to be set from the elements of this data provider. (Typically a CategoryData is used).

getPosition

public Chart.LabelPosition getPosition()

Get the position indicator of this label.

Returns:

Label position.

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 Label

Parameters:

sb - Encoded JSON string to be appended to this.