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

Class LegendNavigation

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.LegendNavigation
All Implemented Interfaces:
Serializable
public class LegendNavigation extends AbstractConfigurationObject
Options for the paging or navigation appearing when the legend is overflown. Navigation works well on screen, but not in static exported images. One way of working around that is to increase the chart height in export.
See Also:

  • Constructor Details

    • LegendNavigation

      public LegendNavigation()

    • LegendNavigation

      public LegendNavigation(Boolean enabled)

  • Method Details

    • getActiveColor

      public Color getActiveColor()
      See Also:

    • setActiveColor

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

      Defaults to: #003399

    • getAnimation

      public Boolean getAnimation()
      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

    • getArrowSize

      public Number getArrowSize()
      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

    • getEnabled

      public Boolean getEnabled()
      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.

      See also the adapt chart to legend plugin for a solution to extend the chart height to make room for the legend, optionally in exported charts only.

      Defaults to: true

    • getInactiveColor

      public Color getInactiveColor()
      See Also:

    • setInactiveColor

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

      Defaults to: #cccccc

    • getStyle

      public Style getStyle()
      See Also:

    • setStyle

      public void setStyle(Style style)
      Text styles for the legend page navigation.