org.pepstock.charba.client.defaults.scale

Class ScaleLabel

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.defaults.AbstractItem

org.pepstock.charba.client.defaults.FontItem

org.pepstock.charba.client.defaults.scale.ScaleLabel

public final class ScaleLabel
extends FontItem

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
java.lang.String	getLabelString() Returns the text for the scale string.
double	getLineHeight() Returns the height of an individual line of text.
Padding	getPadding()
boolean	isDisplay() If true, display the axis title.
void	setDisplay(boolean display) If true, display the axis title.
void	setLabelString(java.lang.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.defaults.FontItem

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

Methods inherited from class org.pepstock.charba.client.defaults.AbstractItem

checkAndAddToParent, hasProperty

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

checkAndGetDoubleValues, checkAndGetEnumValues, checkAndGetIntegerValues, checkAndGetStringValues, checkAndSetDoubleValues, checkAndSetEnumValues, checkAndSetIntegerValues, checkAndSetStringValues, getDoubleArray, getIntegerArray, getJavaScriptObject, getObjectArray, getStringArray, getValue, getValue, getValue, getValue, getValue, getValue, getValue, has, has, hasToBeRegistered, isEmpty, keys, remove, remove, removeIfExists, setDoubleArray, setEnumValueArray, setIntegerArray, setObjectArray, setStringArray, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, toString, type

Methods inherited from class java.lang.Object

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

Method Detail

getPadding

public Padding getPadding()

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.

Returns:

f true, display the axis title. Default is false

setLabelString

public void setLabelString(java.lang.String labelString)

Sets the text for the scale string.

Parameters:

labelString - The text for the scale string.

getLabelString

public java.lang.String getLabelString()

Returns the text for the scale string.

Returns:

The text for the scale string. Default is "".

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.

Returns:

the height of an individual line of text. Default is 1.2