Package org.zkoss.chart

Class Navigation

    • Constructor Detail

      • Navigation

        public Navigation()

    • Method Detail

      • getAnnotationsOptions

        public Annotation getAnnotationsOptions()
        Additional options to be merged into all annotations, if null, create a new one.
        Since:
        10.2.1.0

      • setAnnotationsOptions

        public void setAnnotationsOptions​(Annotation annotationsOptions)
        Additional options to be merged into all annotations.
        Since:
        10.2.1.0

      • getButtonOptions

        public NavigationButton getButtonOptions()
        Returns a collection of options for buttons appearing in the exporting module.

      • setButtonOptions

        public void setButtonOptions​(NavigationButton buttonOptions)
        Sets a collection of options for buttons appearing in the exporting module.

      • getMenuItemHoverStyle

        public <K,​V> Map<K,​V> getMenuItemHoverStyle()
        Returns CSS styles for the hover state of the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML.

        Defaults to 

         background: #4572A5;   color: #FFFFFF;
        Type Parameters:
        K - type for the key

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

        if style was set using setMenuItemHoverStyle(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 setMenuItemHoverStyle(String), type will be String

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

      • setMenuItemHoverStyle

        public void setMenuItemHoverStyle​(String menuItemHoverStyle)
        Sets CSS styles for the hover state of the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML.

        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 setMenuItemHoverStyle(Map)

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

      • setMenuItemHoverStyle

        public <K,​V> void setMenuItemHoverStyle​(Map<K,​V> menuItemHoverStyle)
        Sets CSS styles for the hover state of the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML.

        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:
        menuItemHoverStyle - the style object

      • getMenuItemStyle

        public <K,​V> Map<K,​V> getMenuItemStyle()
        Returns CSS styles for the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML.

        Defaults to 

         padding: 0 5px; background: NONE; color: #303030;
        Type Parameters:
        K - type for the key

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

        if style was set using setMenuItemStyle(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 setMenuItemStyle(String), type will be String

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

      • setMenuItemStyle

        public void setMenuItemStyle​(String menuItemStyle)
        Sets CSS styles for the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML.

        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 setMenuItemStyle(Map)

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

      • setMenuItemStyle

        public <K,​V> void setMenuItemStyle​(Map<K,​V> menuItemStyle)
        Sets CSS styles for the individual items within the popup menu appearing by default when the export icon is clicked. The menu items are rendered in HTML.

        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:
        menuItemStyle - the style object

      • getMenuStyle

        public <K,​V> Map<K,​V> getMenuStyle()
        Returns CSS styles for the popup menu appearing by default when the export icon is clicked. This menu is rendered in HTML.

        Defaults to 

         border: 1px solid #A0A0A0; background: #FFFFFF;
        Type Parameters:
        K - type for the key

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

        if style was set using setMenuStyle(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 setMenuStyle(String), type will be String

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

      • setMenuStyle

        public void setMenuStyle​(String menuStyle)
        Sets CSS styles for the popup menu appearing by default when the export icon is clicked. This menu is rendered in HTML.

        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 setMenuStyle(Map)

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

      • setMenuStyle

        public <K,​V> void setMenuStyle​(Map<K,​V> menuStyle)
        Sets CSS styles for the popup menu appearing by default when the export icon is clicked. This menu is rendered in HTML.

        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:
        menuStyle - the style object