org.pepstock.charba.client.configuration

Class CartesianScaleLabel

java.lang.Object

org.pepstock.charba.client.configuration.CartesianScaleLabel

public class CartesianScaleLabel
extends Object

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

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
Axis	getAxis() Returns the axis instance.
IsColor	getFontColor() Returns the font color for scale label
String	getFontColorAsString() Returns the font color for scale label
String	getFontFamily() Returns the font family for the scale label, follows CSS font-family options.
int	getFontSize() Returns the font size for scale label.
FontStyle	getFontStyle() Returns the font style for the scale label, follows CSS font-style options (i.e.
String	getLabelString() Returns the text for the label.
double	getLineHeight() Returns the height of an individual line of text.
String	getLineHeightAsString() Returns the height of an individual line of text.
CartesianPadding	getPadding() Returns the padding element.
boolean	isDisplay() If true, display the axis title.
void	setDisplay(boolean display) If true, display the axis title.
void	setFontColor(IsColor fontColor) Sets the font color for scale label
void	setFontColor(String fontColor) Sets the font color for scale label
void	setFontFamily(String fontFamily) Sets the font family for the scale label, follows CSS font-family options.
void	setFontSize(int fontSize) Sets the font size for scale label.
void	setFontStyle(FontStyle fontStyle) Sets the font style for the scale label, follows CSS font-style options (i.e.
void	setLabelString(String labelString) Sets the text for the label.
void	setLineHeight(double lineHeight) Sets the height of an individual line of text.
void	setLineHeight(String lineHeight) Sets the height of an individual line of text.

Methods inherited from class java.lang.Object

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

Method Detail

getPadding

public CartesianPadding getPadding()

Returns the padding element.

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:

If true, display the axis title.

setLabelString

public void setLabelString(String labelString)

Sets the text for the label.

Parameters:

labelString - The text for the label.

getLabelString

public String getLabelString()

Returns the text for the label.

Returns:

The text for the label.

setLineHeight

public void setLineHeight(double lineHeight)

Sets the height of an individual line of text.

Parameters:

lineHeight - Height of an individual line of text.

setLineHeight

public void setLineHeight(String 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.

getLineHeightAsString

public String getLineHeightAsString()

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 label.

Parameters:

fontSize - Font size for scale label.

getFontSize

public int getFontSize()

Returns the font size for scale label.

Returns:

Font size for scale label.

setFontStyle

public void setFontStyle(FontStyle fontStyle)

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

Parameters:

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

getFontStyle

public FontStyle getFontStyle()

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

Returns:

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

setFontColor

public void setFontColor(IsColor fontColor)

Sets the font color for scale label

Parameters:

fontColor - Font color for scale label

setFontColor

public void setFontColor(String fontColor)

Sets the font color for scale label

Parameters:

fontColor - Font color for scale label

getFontColorAsString

public String getFontColorAsString()

Returns the font color for scale label

Returns:

Font color for scale label.

getFontColor

public IsColor getFontColor()

Returns the font color for scale label

Returns:

Font color for scale label.

setFontFamily

public void setFontFamily(String fontFamily)

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

Parameters:

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

getFontFamily

public String getFontFamily()

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

Returns:

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

getAxis

public final Axis getAxis()

Returns the axis instance.

Returns:

the axis