Package com.vaadin.componentfactory.maps.model

Class ButtonOptions

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.ButtonOptions
All Implemented Interfaces:
Serializable
@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class ButtonOptions extends AbstractConfigurationObject

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

The examples below are using basic Highcharts, but the syntax is exactly the same for Highmaps.

Version:
$Id: $Id
Author:
Vaadin
See Also:

  • Constructor Details

    • ButtonOptions

      public ButtonOptions()

      Constructor for ButtonOptions.

    • ButtonOptions

      public ButtonOptions(Boolean enabled)

      Constructor for ButtonOptions.

      Parameters:
      enabled - a Boolean object.

    • ButtonOptions

      public ButtonOptions(String text)

      Constructor for ButtonOptions.

      Parameters:
      text - a String object.

  • Method Details

    • getAlign

      public HorizontalAlign getAlign()

      Getter for the field align.

      Returns:
      a HorizontalAlign object.
      See Also:

    • setAlign

      public void setAlign(HorizontalAlign align)
      Alignment for the buttons.

      Defaults to: right

      Parameters:
      align - a HorizontalAlign object.

    • getEnabled

      public Boolean getEnabled()

      Getter for the field enabled.

      Returns:
      a Boolean object.
      See Also:

    • setEnabled

      public void setEnabled(Boolean enabled)
      Whether to enable buttons.

      Defaults to: true

      Parameters:
      enabled - a Boolean object.

    • getHeight

      public Number getHeight()

      Getter for the field height.

      Returns:
      a Number object.
      See Also:

    • setHeight

      public void setHeight(Number height)
      Pixel height of the buttons.

      Defaults to: 20

      Parameters:
      height - a Number object.

    • getSymbolFill

      public Color getSymbolFill()

      Getter for the field symbolFill.

      Returns:
      a Color object.
      See Also:

    • setSymbolFill

      public void setSymbolFill(Color symbolFill)
      Fill color for the symbol within the button.

      Defaults to: #E0E0E0

      Parameters:
      symbolFill - a Color object.

    • getSymbolSize

      public Number getSymbolSize()

      Getter for the field symbolSize.

      Returns:
      a Number object.
      See Also:

    • setSymbolSize

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

      Defaults to: 14

      Parameters:
      symbolSize - a Number object.

    • getSymbolStroke

      public Color getSymbolStroke()

      Getter for the field symbolStroke.

      Returns:
      a Color object.
      See Also:

    • setSymbolStroke

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

      Defaults to: #666

      Parameters:
      symbolStroke - a Color object.

    • getSymbolStrokeWidth

      public Number getSymbolStrokeWidth()

      Getter for the field symbolStrokeWidth.

      Returns:
      a Number object.
      See Also:

    • setSymbolStrokeWidth

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

      Defaults to: 1

      Parameters:
      symbolStrokeWidth - a Number object.

    • getSymbolX

      public Number getSymbolX()

      Getter for the field symbolX.

      Returns:
      a Number object.
      See Also:

    • setSymbolX

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

      Defaults to: 12.5

      Parameters:
      symbolX - a Number object.

    • getSymbolY

      public Number getSymbolY()

      Getter for the field symbolY.

      Returns:
      a Number object.
      See Also:

    • setSymbolY

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

      Defaults to: 10.5

      Parameters:
      symbolY - a Number object.

    • getText

      public String getText()

      Getter for the field text.

      Returns:
      a String object.
      See Also:

    • setText

      public void setText(String text)
      A text string to add to the individual button.

      Defaults to: null

      Parameters:
      text - a String object.

    • getVerticalAlign

      public VerticalAlign getVerticalAlign()

      Getter for the field verticalAlign.

      Returns:
      a VerticalAlign object.
      See Also:

    • setVerticalAlign

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

      Defaults to: top

      Parameters:
      verticalAlign - a VerticalAlign object.

    • getWidth

      public Number getWidth()

      Getter for the field width.

      Returns:
      a Number object.
      See Also:

    • setWidth

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

      Defaults to: 24

      Parameters:
      width - a Number object.

    • getY

      public Number getY()

      Getter for the field y.

      Returns:
      a Number object.
      See Also:

    • setY

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

      Defaults to: 0

      Parameters:
      y - a Number object.

    • getAlignTo

      public String getAlignTo()

      Getter for the field alignTo.

      Returns:
      a String object.
      See Also:

    • setAlignTo

      public void setAlignTo(String alignTo)
      What box to align the buttons to. Possible values are plotBox and spacingBox.

      Defaults to: plotBox

      Parameters:
      alignTo - a String object.

    • getStyle

      public Style getStyle()

      Getter for the field style.

      Returns:
      a Style object.
      See Also:

    • setStyle

      public void setStyle(Style style)
      Text styles for the map navigation buttons. Defaults to 
       {
           fontSize: '15px',
           fontWeight: 'bold',
           textAlign: 'center'
        }
      Parameters:
      style - a Style object.

    • getX

      public Number getX()

      Getter for the field x.

      Returns:
      a Number object.
      See Also:

    • setX

      public void setX(Number x)
      The X offset of the buttons relative to its align setting.

      Defaults to: 0

      Parameters:
      x - a Number object.