Package org.zkoss.chart

Class ExportingButton

    • Constructor Detail

      • ExportingButton

        public ExportingButton()

    • Method Detail

      • getAlign

        public String getAlign()
        Returns alignment for the buttons.

        Default: right

      • setAlign

        public void setAlign​(String align)
        Sets alignment for the buttons.

      • isEnabled

        public boolean isEnabled()
        Returns whether to enable buttons.

        Default: true

      • setEnabled

        public void setEnabled​(boolean enabled)
        Sets whether to enable buttons.

      • getHeight

        public Number getHeight()
        Returns pixel height of the buttons.

        Default: 20

      • setHeight

        public void setHeight​(Number height)
        Sets pixel height of the buttons.

      • setMenuItems

        public void setMenuItems​(List<?> menuItems)
        Sets a collection of config options for the menu items. Each options object consists of a text option which is a string to show in the menu item, as well as an onclick parameter which is a callback function to run on click. By default, there is the "Print" menu item plus one menu item for each of the available export types. Menu items can be customized by defining a new array of items and assigning null to unwanted positions. Since 7.2.2.0, it can be List<String> or List<MenuItem>.
        Parameters:
        menuItems -

      • getMenuItems

        public List<?> getMenuItems()
        Sets a collection of config options for the menu items. Each options object consists of a text option which is a string to show in the menu item, as well as an onclick parameter which is a callback function to run on click. By default, there is the "Print" menu item plus one menu item for each of the available export types. Menu items can be customized by defining a new array of items and assigning null to unwanted positions.

      • getSymbol

        public String getSymbol()
        Returns the symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The default exportIcon function is part of the exporting module.

        Default: "menu"

      • setSymbol

        public void setSymbol​(String symbol)
        Sets the symbol for the button. Points to a definition function in the Highcharts.Renderer.symbols collection. The default exportIcon function is part of the exporting module.

        Default: "menu"

      • getSymbolFill

        public Color getSymbolFill()
        Returns fill color for the symbol within the button.

        Default: "#A8BF77"

      • setSymbolFill

        public void setSymbolFill​(Color color)
        Sets fill color for the symbol within the button.

      • setSymbolFill

        public void setSymbolFill​(String color)
        Sets fill color for the symbol within the button.

      • setSymbolFill

        public void setSymbolFill​(LinearGradient color)
        Sets fill color for the symbol within the button.

      • setSymbolFill

        public void setSymbolFill​(RadialGradient color)
        Sets fill color for the symbol within the button.

      • getSymbolSize

        public Number getSymbolSize()
        Returns the pixel size of the symbol on the button.

        Default: 14

      • setSymbolSize

        public void setSymbolSize​(Number symbolSize)
        Sets the pixel size of the symbol on the button.

      • getSymbolStroke

        public Color getSymbolStroke()
        Returns the color of the symbol's stroke or line.

        Default: "#666"

      • setSymbolStroke

        public void setSymbolStroke​(Color color)
        Sets the color of the symbol's stroke or line.

      • setSymbolStroke

        public void setSymbolStroke​(String color)
        Sets the color of the symbol's stroke or line.

      • setSymbolStroke

        public void setSymbolStroke​(LinearGradient color)
        Sets the color of the symbol's stroke or line.

      • setSymbolStroke

        public void setSymbolStroke​(RadialGradient color)
        Sets the color of the symbol's stroke or line.

      • getSymbolStrokeWidth

        public Number getSymbolStrokeWidth()
        Returns the pixel stroke width of the symbol on the button.

        Default: 1

      • setSymbolStrokeWidth

        public void setSymbolStrokeWidth​(Number symbolStrokeWidth)
        Sets the pixel stroke width of the symbol on the button.

      • getSymbolX

        public Number getSymbolX()
        Returns the x position of the center of the symbol inside the button.

        Default: 12.5

      • setSymbolX

        public void setSymbolX​(Number symbolX)
        Sets the x position of the center of the symbol inside the button.

      • getSymbolY

        public Number getSymbolY()
        Returns the y position of the center of the symbol inside the button.

        Default: 10.5

      • setSymbolY

        public void setSymbolY​(Number symbolY)
        Sets the y position of the center of the symbol inside the button.

      • getText

        public String getText()
        Returns a text string to add to the individual button.

        Default: null

      • setText

        public void setText​(String text)
        Sets a text string to add to the individual button.

      • 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

      • getVerticalAlign

        public String getVerticalAlign()
        Returns the vertical alignment of the buttons. Can be one of "top", "middle" or "bottom".

        Default: top

      • setVerticalAlign

        public void setVerticalAlign​(String verticalAlign)
        Sets the vertical alignment of the buttons. Can be one of "top", "middle" or "bottom".

      • getWidth

        public Number getWidth()
        Returns the pixel width of the button.

        Default: 24

      • setWidth

        public void setWidth​(Number width)
        Sets the pixel width of the button.

      • getX

        public Number getX()
        Returns the horizontal position of the button relative to the align option

        Default: -10

      • setX

        public void setX​(Number x)
        Sets the horizontal position of the button relative to the align option.

      • getY

        public Number getY()
        Returns the vertical offset of the button's position relative to its verticalAlign.

        Default: 0

      • setY

        public void setY​(Number y)
        Sets the vertical offset of the button's position relative to its verticalAlign.