Package com.vaadin.componentfactory.maps.model

Class LegendNavigation

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

Options for the paging or navigation appearing when the legend is overflown. When legend.useHTML is enabled, navigation is disabled.

For demo cases, see the legend.navigation options for basic Highcharts.

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

  • Constructor Details

    • LegendNavigation

      public LegendNavigation()

      Constructor for LegendNavigation.

    • LegendNavigation

      public LegendNavigation(Boolean enabled)

      Constructor for LegendNavigation.

      Parameters:
      enabled - a Boolean object.

  • Method Details

    • getActiveColor

      public Color getActiveColor()

      Getter for the field activeColor.

      Returns:
      a Color object.
      See Also:

    • setActiveColor

      public void setActiveColor(Color activeColor)
      The color for the active up or down arrow in the legend page navigation.

      Defaults to: #3E576F

      Parameters:
      activeColor - a Color object.

    • getAnimation

      public Boolean getAnimation()

      Getter for the field animation.

      Returns:
      a Boolean object.
      See Also:

    • setAnimation

      public void setAnimation(Boolean animation)
      How to animate the pages when navigating up or down. A value of true applies the default navigation given in the chart.animation option. Additional options can be given as an object containing values for easing and duration. .

      Defaults to: true

      Parameters:
      animation - a Boolean object.

    • getArrowSize

      public Number getArrowSize()

      Getter for the field arrowSize.

      Returns:
      a Number object.
      See Also:

    • setArrowSize

      public void setArrowSize(Number arrowSize)
      The pixel size of the up and down arrows in the legend paging navigation. .

      Defaults to: 12

      Parameters:
      arrowSize - a Number 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 the legend navigation. In most cases, disabling the navigation results in an unwanted overflow.

      Defaults to: true

      Parameters:
      enabled - a Boolean object.

    • getInactiveColor

      public Color getInactiveColor()

      Getter for the field inactiveColor.

      Returns:
      a Color object.
      See Also:

    • setInactiveColor

      public void setInactiveColor(Color inactiveColor)
      The color of the inactive up or down arrow in the legend page navigation. .

      Defaults to: #CCC

      Parameters:
      inactiveColor - a Color 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 legend page navigation.
      Parameters:
      style - a Style object.