Package org.zkoss.chart

Class LabelsItem

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.LabelsItem

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class LabelsItem
extends Optionable

An option for Labels

All the options in this class support DynamicalAttribute.

Author:

RaymondChao

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
LabelsItem(String html)

Method Summary

Modifier and Type	Method	Description
String	getHtml()	Returns inner HTML or text for the label.
<K,V> Map<K,V>	getStyle()	Returns generic CSS styles for each label.
void	setHtml(String html)	Sets inner HTML or text for the label.
void	setStyle(String style)	Sets generic CSS styles for each label.
<K,V> void	setStyle(Map<K,V> style)	Sets generic CSS styles for each label.

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

LabelsItem

public LabelsItem(String html)

Method Detail

getHtml

public String getHtml()

Returns inner HTML or text for the label.

Default: null.

Returns:

html inner HTML or text for the label

setHtml

public void setHtml(String html)

Sets inner HTML or text for the label.

Parameters:

html - inner HTML or text for the label

getStyle

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

Returns generic CSS styles for each label. To position the label, use left and top like this:

 left: '100px';
 top: '100px';
 

Default: null.

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, type will be Object by default

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, type will be Object by default

setStyle

public void setStyle(String style)

Sets generic CSS styles for each label.

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 generic CSS styles for each label.

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