Package org.zkoss.chart

Class DrillUpButton

java.lang.Object

org.zkoss.chart.Optionable

org.zkoss.chart.DrillUpButton

All Implemented Interfaces:

Serializable, OptionDataListener, org.zkoss.json.JSONAware

public class DrillUpButton
extends Optionable

Options for the drill up button that appears when drilling down on a series. The text for the button is defined in Lang.getDrillUpText().

Author:

jumperchen, RaymondChao

See Also:

Serialized Form

Field Summary

Fields inherited from class org.zkoss.chart.Optionable

NOT_NULL_VALUE, options

Constructor Summary

Constructors

Constructor	Description
DrillUpButton()

Method Summary

Modifier and Type	Method	Description
Position	getPosition()	Returns positioning options for the button within the relativeTo box.
String	getRelativeTo()	Returns what box to align the button to.
<K,V> Map<K,V>	getTheme()	Returns a collection of attributes for the button.
void	setPosition(Position position)	Sets positioning options for the button within the relativeTo box.
void	setRelativeTo(String relativeTo)	Sets what box to align the button to.
<K,V> void	setTheme(Map<K,V> theme)	Sets a collection of attributes for the button.

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

DrillUpButton

public DrillUpButton()

Method Detail

getPosition

public Position getPosition()

Returns positioning options for the button within the relativeTo box. Available properties are x, y, align and verticalAlign.

Default: null

setPosition

public void setPosition(Position position)

Sets positioning options for the button within the relativeTo box. Available properties are x, y, align and verticalAlign.

getRelativeTo

public String getRelativeTo()

Returns what box to align the button to. Can be either "plotBox" or "spacingBox".

Default: plotBox

setRelativeTo

public void setRelativeTo(String relativeTo)

Sets what box to align the button to. Can be either "plotBox" or "spacingBox".

Default: plotBox

getTheme

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

Returns a collection of attributes for the button. The object takes SVG attributes like fill, stroke, stroke-width or r, the border radius. The theme also supports style, a collection of CSS properties for the text. Equivalent attributes for the hover state are given in theme.states.hover.

Type Parameters:

K - type for the key

if style was set using setTheme(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 setTheme(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

setTheme

public <K,V> void setTheme(Map<K,V> theme)

Sets a collection of attributes for the button. The object takes SVG attributes like fill, stroke, stroke-width or r, the border radius. The theme also supports style, a collection of CSS properties for the text. Equivalent attributes for the hover state are given in theme.states.hover.

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:

theme - the theme object