com.vaadin.flow.component.charts.model.LegendNavigation API 16.0.5 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

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

java.lang.Object
- com.vaadin.flow.component.charts.model.AbstractConfigurationObject
- - com.vaadin.flow.component.charts.model.LegendNavigation

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 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:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

LegendNavigation()

LegendNavigation(Boolean enabled)

Method Summary

All Methods
Modifier and Type	Method and Description
`Boolean`	`getAnimation()`
`Number`	`getArrowSize()`
`Boolean`	`getEnabled()`
`void`	`setAnimation(Boolean animation)` How to animate the pages when navigating up or down.
`void`	`setArrowSize(Number arrowSize)` The pixel size of the up and down arrows in the legend paging navigation.
`void`	`setEnabled(Boolean enabled)` Whether to enable the legend navigation.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - LegendNavigation
```
public LegendNavigation()
```
  - LegendNavigation
```
public LegendNavigation(Boolean enabled)
```
- Method Detail
  - getAnimation
```
public Boolean getAnimation()
```
    See Also:
    
    setAnimation(Boolean)
  - 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(Number)
  - 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(Boolean)
  - 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