org.pepstock.charba.client.options

Class ScaleLabel

java.lang.Object

org.pepstock.charba.client.commons.NativeObjectContainer

org.pepstock.charba.client.options.AbstractModel<P,D>

org.pepstock.charba.client.options.FontItem<Scale,IsDefaultScaleLabel>

org.pepstock.charba.client.options.ScaleLabel

All Implemented Interfaces:

IsDefaultFontItem, IsDefaultScaleLabel

public final class ScaleLabel
extends FontItem<Scale,IsDefaultScaleLabel>
implements IsDefaultScaleLabel

When creating a chart, you want to tell the viewer what data they are viewing. To do this, you need to label the axis.
The scale label configuration defines options for the scale title. Note that this only applies to cartesian axes.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
String	getLabelString() Returns the text for the scale string.
double	getLineHeight() Returns the height of an individual line of text.
ScaleLabelPadding	getPadding() Returns the padding element.
boolean	isDisplay() If true, display the axis title.
void	setDisplay(boolean display) If true, display the axis title.
void	setLabelString(String labelString) Sets the text for the scale string.
void	setLineHeight(double lineHeight) Sets the height of an individual line of text.

Methods inherited from class org.pepstock.charba.client.options.FontItem

getFontColor, getFontColorAsString, getFontFamily, getFontSize, getFontStyle, setFontColor, setFontColor, setFontFamily, setFontSize, setFontStyle

Methods inherited from class org.pepstock.charba.client.options.AbstractModel

checkAndAddToParent, getChildKey, getDefaultValues, getParent, setCallbackToModel, setEventToModel

Methods inherited from class org.pepstock.charba.client.commons.NativeObjectContainer

getArrayValue, getNativeObject, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValue, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, getValueOrArray, has, has, keys, remove, remove, removeIfExists, setArrayValue, setArrayValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, setValueOrArray, toJSON, type

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.pepstock.charba.client.defaults.IsDefaultFontItem

getFontColorAsString, getFontFamily, getFontSize, getFontStyle

Method Detail

getPadding

public ScaleLabelPadding getPadding()

Returns the padding element.

Specified by:

getPadding in interface IsDefaultScaleLabel

Returns:

the padding

setDisplay

public void setDisplay(boolean display)

If true, display the axis title.

Parameters:

display - if true, display the axis title.

isDisplay

public boolean isDisplay()

If true, display the axis title.

Specified by:

isDisplay in interface IsDefaultScaleLabel

Returns:

if true, display the axis title.

setLabelString

public void setLabelString(String labelString)

Sets the text for the scale string.

Parameters:

labelString - the text for the scale string.

getLabelString

public String getLabelString()

Returns the text for the scale string.

Specified by:

getLabelString in interface IsDefaultScaleLabel

Returns:

the text for the scale string.

setLineHeight

public void setLineHeight(double lineHeight)

Sets the height of an individual line of text.

Parameters:

lineHeight - height of an individual line of text.

getLineHeight

public double getLineHeight()

Returns the height of an individual line of text.

Specified by:

getLineHeight in interface IsDefaultScaleLabel

Returns:

the height of an individual line of text.