Package org.zkoss.chart

Class Caption

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.Caption

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class Caption
extends Optionable

The chart's caption, which will render below the chart and will be part of exported charts.

All the options in this class support DynamicalAttribute.

Since:

7.2.1.0

Author:

rudyhuang

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
Caption()

Method Summary

Modifier and Type	Method	Description
String	getAlign()	Returns the horizontal alignment of the caption.
<K,V> Map<K,V>	getStyle()	Returns CSS styles for the caption.
String	getText()	Returns the caption text of the chart.
String	getVerticalAlign()	Returns the vertical alignment of the caption.
Number	getX()	Returns the x position of the caption relative to the alignment within Chart.setSpacingLeft(Number) and Chart.setSpacingRight(Number).
Number	getY()	Returns the y position of the caption relative to the alignment within Chart.setSpacingTop(Number) and Chart.setSpacingBottom(Number).
boolean	isFloating()	Returns when the caption is floating, the plot area will not move to make space for it.
boolean	isUseHTML()	Returns whether to use HTML to render the text.
void	setAlign(String align)	Sets the horizontal alignment of the caption.
void	setFloating(boolean floating)	Sets when the caption is floating, the plot area will not move to make space for it.
void	setStyle(String style)	Sets CSS styles for the caption.
<K,V> void	setStyle(Map<K,V> style)	Sets CSS styles for the caption.
void	setText(String text)	Sets the caption text of the chart.
void	setUseHTML(boolean useHTML)	Sets whether to use HTML to render the text.
void	setVerticalAlign(String verticalAlign)	Sets the vertical alignment of the caption.
void	setX(Number x)	Sets the x position of the caption relative to the alignment within Chart.setSpacingLeft(Number) and Chart.setSpacingRight(Number).
void	setY(Number y)	Sets the y position of the caption relative to the alignment within Chart.setSpacingTop(Number) and Chart.setSpacingBottom(Number).

Methods inherited from class org.zkoss.chart.Optionable

addExtraAttr, addOptionDataListener, clearOptonDataListener, clone, containsKey, fireEvent, fireEvent, fireEvent, fireEvent, fireEvent, getAttr, getAttr, getClientState, getExtraAttr, merge, onChange, removeExtraAttr, removeKey, removeOptionDataListener, setAttr, setAttr, setAttr, setAttr, toJSONString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Caption

public Caption()

Method Detail

getAlign

public String getAlign()

Returns the horizontal alignment of the caption. Can be one of "left", "center" and "right".

Default: "left".

setAlign

public void setAlign(String align)

Sets the horizontal alignment of the caption. Can be one of "left", "center" and "right".

isFloating

public boolean isFloating()

Returns when the caption is floating, the plot area will not move to make space for it.

Default: false.

setFloating

public void setFloating(boolean floating)

Sets when the caption is floating, the plot area will not move to make space for it.

getStyle

public <K,V> Map<K,V> getStyle()

Returns CSS styles for the caption.

Defaults to:

 color: #666666;
 

Type Parameters:

K - type for the key

if style was set using setStyle(String), type will be String

if style was set using setStyle(Map), type will be the same as the type from the key of the map

if style was not set, default style will be applied, and type will be String

V - type for the value

if style was set using setStyle(String), type will be String

if style was set using setStyle(Map), type will be the same as the type from the key of the map

if style was not set, default style will be applied, and type will be String

setStyle

public void setStyle(String style)

Sets CSS styles for the caption.

This method allows simple settings like

 label.setStyle("fontWeight: 'bold'; color: 'white'; textShadow: '0px 1px 2px black'");
 

In the format of CSS key:value, and ";" separating multiple key:value pairs, if you have more a complex CSS styling, we recommend using setStyle(Map)

Parameters:

style - one or many CSS key:value pairs in a single line string format

setStyle

public <K,V> void setStyle(Map<K,V> style)

Sets CSS styles for the caption.

This method allows complex styling like:

 
 Map<String, Object> styles = new HashMap<String, Object>();
 styles.put("fill", "#E8E8EA");
 styles.put("stroke", "#6E6E78");
 styles.put("stroke-width", "1");
 styles.put("r", "0");
 Map<String, Object> states = new HashMap<String, Object>();
 Map<String, String> hover = new HashMap<String, String>();
 hover.put("fill", "#F4F4F6");
 hover.put("stroke", "#6E6E78");
 hover.put("stroke-width", "1");
 hover.put("r", "0");
 states.put("hover", hover);
 styles.put("states", states);
 Map<String, String> style = new HashMap<String, String>();
 style.put("color", "#4D5663");
 style.put("fontSize", "12px");
 style.put("fontFamily", "'Arial'");
 style.put("fontWeight", "normal");
 style.put("padding", "10px");
 styles.put("style", style);
 

which will generate the final results like:

 {
     "fill": "#E8E8EA",
     "stroke": "#6E6E78",
     "stroke-width": "1",
     "r": "0",
     "states":
     {
         "hover":
         {
             "fill": "#F4F4F6",
             "stroke": "#6E6E78",
             "stroke-width": "1",
             "r": "0"
         }
     },
     "style":
     {
         "color": "#4D5663",
         "fontSize": "12px",
         "fontFamily": "'Arial'",
         "fontWeight": "normal",
         "padding": "10px"
     }
 }
 

Type Parameters:

K - Type for the key, usually String

V - Type for the value, usually String. For nested maps, use Object or any other type.

Parameters:

style - the style object

getText

public String getText()

Returns the caption text of the chart.

Default: "".

setText

public void setText(String text)

Sets the caption text of the chart.

isUseHTML

public boolean isUseHTML()

Returns whether to use HTML to render the text.

Default: false.

setUseHTML

public void setUseHTML(boolean useHTML)

Sets whether to use HTML to render the text.

getVerticalAlign

public String getVerticalAlign()

Returns the vertical alignment of the caption. Can be one of "top", "middle" and "bottom". When middle, the caption behaves as floating.

Default: bottom.

setVerticalAlign

public void setVerticalAlign(String verticalAlign)

Sets the vertical alignment of the caption. Can be one of "top", "middle" and "bottom". When middle, the caption behaves as floating.

getX

public Number getX()

Returns the x position of the caption relative to the alignment within Chart.setSpacingLeft(Number) and Chart.setSpacingRight(Number).

Default: 0.

setX

public void setX(Number x)

Sets the x position of the caption relative to the alignment within Chart.setSpacingLeft(Number) and Chart.setSpacingRight(Number).

getY

public Number getY()

Returns the y position of the caption relative to the alignment within Chart.setSpacingTop(Number) and Chart.setSpacingBottom(Number).

Default: null.

setY

public void setY(Number y)

Sets the y position of the caption relative to the alignment within Chart.setSpacingTop(Number) and Chart.setSpacingBottom(Number).