com.vaadin.flow.component.charts.model.

Class ButtonOptions

  • All Implemented Interfaces:

    Serializable


    @Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class ButtonOptions
extends AbstractConfigurationObject

    A collection of options for buttons appearing in the exporting module.

    In styled mode, the buttons are styled with the .highcharts-contextbutton and .highcharts-button-symbol class.

    See Also:

    Serialized Form

    • Constructor Detail

      • ButtonOptions

        public ButtonOptions()

      • ButtonOptions

        public ButtonOptions(Boolean enabled)

      • ButtonOptions

        public ButtonOptions(String text)

    • Method Detail

      • setAlign

        public void setAlign(HorizontalAlign align)

        Alignment for the buttons.

        Defaults to: right

      • setEnabled

        public void setEnabled(Boolean enabled)

        Whether to enable buttons.

        Defaults to: true

      • setHeight

        public void setHeight(Number height)

        Pixel height of the buttons.

        Defaults to: 20

      • setSymbolSize

        public void setSymbolSize(Number symbolSize)

        The pixel size of the symbol on the button.

        Defaults to: 14

      • setSymbolStrokeWidth

        public void setSymbolStrokeWidth(Number symbolStrokeWidth)

        The pixel stroke width of the symbol on the button.

        Defaults to: 1

      • setSymbolX

        public void setSymbolX(Number symbolX)

        The x position of the center of the symbol inside the button.

        Defaults to: 12.5

      • setSymbolY

        public void setSymbolY(Number symbolY)

        The y position of the center of the symbol inside the button.

        Defaults to: 10.5

      • setText

        public void setText(String text)

        A text string to add to the individual button.

        Defaults to: null

      • setVerticalAlign

        public void setVerticalAlign(VerticalAlign verticalAlign)

        The vertical alignment of the buttons. Can be one of "top", "middle" or "bottom".

        Defaults to: top

      • setWidth

        public void setWidth(Number width)

        The pixel width of the button.

        Defaults to: 24

      • setY

        public void setY(Number y)

        The vertical offset of the button's position relative to its verticalAlign. .

        Defaults to: 0