org.pepstock.charba.client.options.scales

Class CartesianScaleLabel

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.scales.CartesianScaleLabel

public class CartesianScaleLabel
extends ChartContainer

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
IsColor	getFontColor() Returns the font color for scale title
java.lang.String	getFontColorAsString() Returns the font color for scale title
java.lang.String	getFontFamily() Returns the font family for the scale title, follows CSS font-family options.
int	getFontSize() Returns the font size for scale title.
FontStyle	getFontStyle() Returns the font style for the scale title, follows CSS font-style options (i.e.
java.lang.String	getLabelString() Returns the text for the title.
double	getLineHeight() Returns the height of an individual line of text.
Padding	getPadding()
boolean	isDisplay() f true, display the axis title.
void	setDisplay(boolean display) f true, display the axis title.
void	setFontColor(IsColor fontColor) Sets the font color for scale title
void	setFontColor(java.lang.String fontColor) Sets the font color for scale title
void	setFontFamily(java.lang.String fontFamily) Sets the font family for the scale title, follows CSS font-family options.
void	setFontSize(int fontSize) Sets the font size for scale title.
void	setFontStyle(FontStyle fontStyle) Sets the font style for the scale title, follows CSS font-style options (i.e.
void	setLabelString(java.lang.String labelString) Sets the text for the title.
void	setLineHeight(double lineHeight) Sets the height of an individual line of text.

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

getChart

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)

f true, display the axis title.

Parameters:

display - f true, display the axis title.

isDisplay

public boolean isDisplay()

f true, display the axis title.

Returns:

f true, display the axis title.

setLabelString

public void setLabelString(java.lang.String labelString)

Sets the text for the title.

Parameters:

labelString - The text for the title.

getLabelString

public java.lang.String getLabelString()

Returns the text for the title.

Returns:

The text for the title.

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.

setFontSize

public void setFontSize(int fontSize)

Sets the font size for scale title.

Parameters:

fontSize - Font size for scale title.

getFontSize

public int getFontSize()

Returns the font size for scale title.

Returns:

Font size for scale title.

setFontStyle

public void setFontStyle(FontStyle fontStyle)

Sets the font style for the scale title, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Parameters:

fontStyle - Font style for the scale title, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

See Also:

FontStyle

getFontStyle

public FontStyle getFontStyle()

Returns the font style for the scale title, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Returns:

the font style for the scale title, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

See Also:

FontStyle

setFontColor

public void setFontColor(IsColor fontColor)

Sets the font color for scale title

Parameters:

fontColor - Font color for scale title

setFontColor

public void setFontColor(java.lang.String fontColor)

Sets the font color for scale title

Parameters:

fontColor - Font color for scale title

getFontColorAsString

public java.lang.String getFontColorAsString()

Returns the font color for scale title

Returns:

Font color for scale title.

getFontColor

public IsColor getFontColor()

Returns the font color for scale title

Returns:

Font color for scale title.

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

Sets the font family for the scale title, follows CSS font-family options.

Parameters:

fontFamily - Font family for the scale title, follows CSS font-family options.

getFontFamily

public java.lang.String getFontFamily()

Returns the font family for the scale title, follows CSS font-family options.

Returns:

Font family for the scale title, follows CSS font-family options.