Package org.zkoss.chart

Class Credits

  • All Implemented Interfaces:
    Serializable, OptionDataListener, org.zkoss.json.JSONAware
    public class Credits
extends Optionable
    A credits option to put a credits label in the lower right corner of the chart. This can be changed using these options.

    All the options in this class support DynamicalAttribute.

    Author:
    jumperchen, RaymondChao
    See Also:
    Serialized Form

    • Constructor Detail

      • Credits

        public Credits()

    • Method Detail

      • isEnabled

        public boolean isEnabled()
        Returns whether to show the credits text.

        Default: false

      • setEnabled

        public void setEnabled​(boolean enabled)
        Sets whether to show the credits text.

      • getHref

        public String getHref()
        Returns the URL for the credits label.

        Default: "https://www.highcharts.com"

      • setHref

        public void setHref​(String href)
        Sets the URL for the credits label.

      • getPosition

        public Position getPosition()
        Returns position configuration for the credtis label. Supported properties are align, verticalAlign, x and y. Defaults to 
         position: {
        align: 'right',
        x: -10,
        verticalAlign: 'bottom',
        y: -5
 }

      • setPosition

        public void setPosition​(Position position)
        Sets position configuration for the credtis label. Supported properties are align, verticalAlign, x and y. Defaults to 
         position: {
        align: 'right',
        x: -10,
        verticalAlign: 'bottom',
        y: -5
 }

      • getStyle

        public <K,​V> Map<K,​V> getStyle()
        Returns the CSS styles for the credits label. Defaults to: 
         cursor: pointer; color: #909090; fontSize: 10px;
        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 the CSS styles for the credits label. Defaults to:

        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 the CSS styles for the credits label. Defaults to:

        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 text for the credits label.

        Default: "Highcharts.com"

      • setText

        public void setText​(String text)
        Sets the text for the credits label.