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

Class Accessibility

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.Accessibility
All Implemented Interfaces:
Serializable
public class Accessibility extends AbstractConfigurationObject

Options for configuring accessibility for the chart. Requires the accessibility module to be loaded. For a description of the module and information on its features, see Highcharts Accessibility.

See Also:

  • Constructor Details

    • Accessibility

      public Accessibility()

    • Accessibility

      public Accessibility(Boolean enabled)

  • Method Details

    • getDescribeSingleSeries

      public Boolean getDescribeSingleSeries()
      See Also:

    • setDescribeSingleSeries

      public void setDescribeSingleSeries(Boolean describeSingleSeries)
      Whether or not to add series descriptions to charts with a single series.

      Defaults to: false

    • getEnabled

      public Boolean getEnabled()
      See Also:

    • setEnabled

      public void setEnabled(Boolean enabled)
      Enable accessibility features for the chart.

      Defaults to: true

    • getKeyboardNavigation

      public KeyboardNavigation getKeyboardNavigation()
      See Also:

    • setKeyboardNavigation

      public void setKeyboardNavigation(KeyboardNavigation keyboardNavigation)
      Options for keyboard navigation.

    • getOnTableAnchorClick

      public String getOnTableAnchorClick()

    • setOnTableAnchorClick

      public void setOnTableAnchorClick(String _fn_onTableAnchorClick)

    • getPointDateFormat

      public String getPointDateFormat()
      See Also:

    • setPointDateFormat

      public void setPointDateFormat(String pointDateFormat)

      Date format to use for points on datetime axes when describing them to screen reader users.

      Defaults to the same format as in tooltip.

      For an overview of the replacement codes, see dateFormat.

    • getPointDateFormatter

      public String getPointDateFormatter()

    • setPointDateFormatter

      public void setPointDateFormatter(String _fn_pointDateFormatter)

    • getPointDescriptionFormatter

      public String getPointDescriptionFormatter()

    • setPointDescriptionFormatter

      public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

    • getScreenReaderSectionFormatter

      public String getScreenReaderSectionFormatter()

    • setScreenReaderSectionFormatter

      public void setScreenReaderSectionFormatter(String _fn_screenReaderSectionFormatter)

    • getSeriesDescriptionFormatter

      public String getSeriesDescriptionFormatter()

    • setSeriesDescriptionFormatter

      public void setSeriesDescriptionFormatter(String _fn_seriesDescriptionFormatter)