All Implemented Interfaces:
Serializable

@Generated(value="This class was generated", comments="Incorrect and missing API should be reported") public class ZoomOut extends AbstractConfigurationObject
Options for the zoom out button. Properties for the zoom in and zoom out buttons are inherited from mapNavigation.buttonOptions, while individual options can be overridden. By default, the onclick, text and y options are individual.
Version:
$Id: $Id
Author:
Vaadin
See Also:
  • Constructor Details

    • ZoomOut

      public ZoomOut()

      Constructor for ZoomOut.

    • ZoomOut

      public ZoomOut(String text)

      Constructor for ZoomOut.

      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)
      The alignment of the navigation buttons.

      Defaults to: left

      Parameters:
      align - a HorizontalAlign 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.
    • getHeight

      public Number getHeight()

      Getter for the field height.

      Returns:
      a Number object.
      See Also:
    • setHeight

      public void setHeight(Number height)
      The pixel height of the map navigation buttons.

      Defaults to: 18

      Parameters:
      height - a Number 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.
    • getText

      public String getText()

      Getter for the field text.

      Returns:
      a String object.
      See Also:
    • setText

      public void setText(String text)
      The text for the button. The tooltip (title) is a language option given by lang.zoomOut.

      Defaults to: -

      Parameters:
      text - a String object.
    • getTheme

      public ButtonTheme getTheme()

      Getter for the field theme.

      Returns:
      a ButtonTheme object.
      See Also:
    • setTheme

      public void setTheme(ButtonTheme theme)
      A configuration object for the button theme. The object accepts SVG properties like stroke-width, stroke and fill. Tri-state button styles are supported by the states.hover and states.select objects.
      Parameters:
      theme - a ButtonTheme 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. Individual alignment can be adjusted by each button's y offset.

      Defaults to: bottom

      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 width of the map navigation buttons.

      Defaults to: 18

      Parameters:
      width - a Number 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.
    • getY

      public Number getY()

      Getter for the field y.

      Returns:
      a Number object.
      See Also:
    • setY

      public void setY(Number y)
      The position of the zoomOut button relative to the vertical alignment.

      Defaults to: 28

      Parameters:
      y - a Number object.