Class Loading
- java.lang.Object
-
- org.zkoss.chart.Optionable
-
- org.zkoss.chart.Loading
-
- All Implemented Interfaces:
Serializable
,OptionDataListener
,org.zkoss.json.JSONAware
public class Loading extends Optionable
The loading options control the appearance of the loading screen that covers the plot area on chart operations. This screen only appears after an explicit call toCharts.showLoading(String)
.All the options in this class support
DynamicalAttribute
.- Author:
- jumperchen
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class org.zkoss.chart.Optionable
NOT_NULL_VALUE, options
-
-
Constructor Summary
Constructors Constructor Description Loading()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Number
getHideDuration()
Returns the duration in milliseconds of the fade out effect.<K,V>
Map<K,V>getLabelStyle()
Returns CSS styles for the loading label span.Number
getShowDuration()
Returns the duration in milliseconds of the fade in effect.<K,V>
Map<K,V>getStyle()
Returns CSS styles for the label.void
setHideDuration(Number hideDuration)
Sets the duration in milliseconds of the fade out effect.void
setLabelStyle(String labelStyle)
Sets CSS styles for the loading label span.<K,V>
voidsetLabelStyle(Map<K,V> labelStyle)
Sets CSS styles for the loading label span.void
setShowDuration(Number showDuration)
Sets the duration in milliseconds of the fade in effect.void
setStyle(String style)
Sets CSS styles for the loading screen that covers the plot area.<K,V>
voidsetStyle(Map<K,V> style)
Sets CSS styles for the loading screen that covers the plot area.-
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
-
-
-
-
Method Detail
-
setHideDuration
public void setHideDuration(Number hideDuration)
Sets the duration in milliseconds of the fade out effect.Defaults to 100.
- Parameters:
hideDuration
-
-
getHideDuration
public Number getHideDuration()
Returns the duration in milliseconds of the fade out effect.Defaults to 100.
-
setLabelStyle
public void setLabelStyle(String labelStyle)
Sets CSS styles for the loading label span.This method allows simple settings like
loading.setLabelStyle("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
setLabelStyle(Map)
- Parameters:
labelStyle
- one or many CSS key:value pairs in a single line string format
-
setLabelStyle
public <K,V> void setLabelStyle(Map<K,V> labelStyle)
Sets CSS styles for the loading label span.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);
{ "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 StringV
- Type for the value, usually String. For nested maps, use Object or any other type.- Parameters:
labelStyle
- the style object
-
getLabelStyle
public <K,V> Map<K,V> getLabelStyle()
Returns CSS styles for the loading label span. Defaults tofontWeight: 'bold'; position: 'relative'; top: '45%';
- Type Parameters:
K
- type for the keyif style was set using
setLabelStyle(String)
, type will be Stringif style was set using
setLabelStyle(Map)
, type will be the same as the type from the key of the mapif style was not set, default style will be applied, and type will be String
V
- type for the valueif style was set using
setLabelStyle(String)
, type will be Stringif style was set using
setLabelStyle(Map)
, type will be the same as the type from the key of the mapif style was not set, default style will be applied, and type will be String
-
setShowDuration
public void setShowDuration(Number showDuration)
Sets the duration in milliseconds of the fade in effect.Defaults to 100.
- Parameters:
showDuration
-
-
getShowDuration
public Number getShowDuration()
Returns the duration in milliseconds of the fade in effect.Defaults to 100.
-
getStyle
public <K,V> Map<K,V> getStyle()
Returns CSS styles for the label. When labels are rotated they are rendered using vector graphic techniques and not all styles are applicable. Default:position: 'absolute'; backgroundColor: 'white'; opacity: 0.5; textAlign: 'center'
- Type Parameters:
K
- type for the keyif style was set using
setStyle(String)
, type will be Stringif style was set using
setStyle(Map)
, type will be the same as the type from the key of the mapif style was not set, default style will be applied, and type will be String
V
- type for the valueif style was set using
setStyle(String)
, type will be Stringif style was set using
setStyle(Map)
, type will be the same as the type from the key of the mapif style was not set, default style will be applied, and type will be String
- Returns:
- style CSS styles for the label
-
setStyle
public void setStyle(String style)
Sets CSS styles for the loading screen that covers the plot area.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 loading screen that covers the plot area.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);
{ "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 StringV
- Type for the value, usually String. For nested maps, use Object or any other type.- Parameters:
style
- the style object
-
-