org.pepstock.charba.client.options

Class Title

java.lang.Object

org.pepstock.charba.client.commons.JavaScriptObjectContainer

org.pepstock.charba.client.commons.ChartContainer

org.pepstock.charba.client.options.Title

public final class Title
extends ChartContainer

Configures the chart title which defines text to draw at the top of the chart.

Author:

Andrea "Stock" Stocchero

Method Summary

Modifier and Type	Method and Description
IsColor	getFontColor() Returns the font color for title
java.lang.String	getFontColorAsString() Returns the font color for title
java.lang.String	getFontFamily() Returns the font family for title, follows CSS font-family options.
int	getFontSize() Returns the font size for title.
FontStyle	getFontStyle() Returns the font style for title, follows CSS font-style options (i.e.
double	getLineHeight() Returns the height of an individual line of text.
int	getPadding() Returns the padding to apply around title.
Position	getPosition() Returns the position of title.
java.util.List<java.lang.String>	getText() Returns the title text to display, as a list of strings.
boolean	isDisplay() Returns if the title is shown.
boolean	isFullWidth() Returns if marks that this box should take the full width of the canvas (pushing down other boxes)
void	setDisplay(boolean display) Sets if the title is shown.
void	setFontColor(IsColor fontColor) Sets the font color for title
void	setFontColor(java.lang.String fontColor) Sets the font color for title
void	setFontFamily(java.lang.String fontFamily) Sets the font family for title, follows CSS font-family options.
void	setFontSize(int fontSize) Sets the font size for title.
void	setFontStyle(FontStyle fontStyle) Sets the font style for title, follows CSS font-style options (i.e.
void	setFullWidth(boolean fullWidth) Marks that this box should take the full width of the canvas (pushing down other boxes).
void	setLineHeight(double lineHeight) Sets the height of an individual line of text.
void	setPadding(int padding) Sets the padding to apply around title.
void	setPosition(Position position) Sets the position of title.
void	setText(java.lang.String... text) Sets the title text to display.

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

setFontSize

public void setFontSize(int fontSize)

Sets the font size for title.

Parameters:

fontSize - Font size for title.

getFontSize

public int getFontSize()

Returns the font size for title.

Returns:

Font size for title. For default value, see Options.getTitle().

setFontStyle

public void setFontStyle(FontStyle fontStyle)

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

Parameters:

fontStyle - Font style for 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 title, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).

Returns:

the font style for title, follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit). For default value, see Options.getTitle().

See Also:

FontStyle

setFontColor

public void setFontColor(IsColor fontColor)

Sets the font color for title

Parameters:

fontColor - Font color for title

setFontColor

public void setFontColor(java.lang.String fontColor)

Sets the font color for title

Parameters:

fontColor - Font color for title

getFontColorAsString

public java.lang.String getFontColorAsString()

Returns the font color for title

Returns:

Font color for title. For default value, see Options.getTitle().

getFontColor

public IsColor getFontColor()

Returns the font color for title

Returns:

Font color for title. For default value, see Options.getTitle().

setFontFamily

public void setFontFamily(java.lang.String fontFamily)

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

Parameters:

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

getFontFamily

public java.lang.String getFontFamily()

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

Returns:

Font family for title, follows CSS font-family options. For default value, see Options.getTitle().

setDisplay

public void setDisplay(boolean display)

Sets if the title is shown.

Parameters:

display - if the title is shown.

isDisplay

public boolean isDisplay()

Returns if the title is shown.

Returns:

if the title is shown. For default value, see Options.getTitle().

setText

public void setText(java.lang.String... text)

Sets the title text to display. If specified as an array, text is rendered on multiple lines.

Parameters:

text - the title text to display. If specified as an array, text is rendered on multiple lines.

getText

public java.util.List<java.lang.String> getText()

Returns the title text to display, as a list of strings.

Returns:

a list of strings

setPosition

public void setPosition(Position position)

Sets the position of title.

Parameters:

position - the position of title.

See Also:

Position

getPosition

public Position getPosition()

Returns the position of title.

Returns:

the position of title. For default value, see Options.getTitle().

See Also:

Position

setPadding

public void setPadding(int padding)

Sets the padding to apply around title. Only top and bottom are implemented.

Parameters:

padding - Padding to apply around title. Only top and bottom are implemented.

getPadding

public int getPadding()

Returns the padding to apply around title. Only top and bottom are implemented.

Returns:

Padding to apply around title. Only top and bottom are implemented. For default value, see Options.getTitle().

setFullWidth

public void setFullWidth(boolean fullWidth)

Marks that this box should take the full width of the canvas (pushing down other boxes).

Parameters:

fullWidth - Marks that this box should take the full width of the canvas (pushing down other boxes)

isFullWidth

public boolean isFullWidth()

Returns if marks that this box should take the full width of the canvas (pushing down other boxes)

Returns:

Marks that this box should take the full width of the canvas (pushing down other boxes). For default see Options.getTitle().

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:

height of an individual line of text. For default see Options.getTitle().