Class Accessibility

java.lang.Object
com.vaadin.componentfactory.maps.model.AbstractConfigurationObject
com.vaadin.componentfactory.maps.model.Accessibility
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 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.

Version:
$Id: $Id
Author:
Vaadin
See Also:
  • Constructor Details

    • Accessibility

      public Accessibility()

      Constructor for Accessibility.

    • Accessibility

      public Accessibility(Boolean enabled)

      Constructor for Accessibility.

      Parameters:
      enabled - a Boolean object.
  • Method Details

    • getDescribeSingleSeries

      public Boolean getDescribeSingleSeries()

      Getter for the field describeSingleSeries.

      Returns:
      a Boolean object.
      See Also:
    • setDescribeSingleSeries

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

      Defaults to: false

      Parameters:
      describeSingleSeries - a Boolean object.
    • getEnabled

      public Boolean getEnabled()

      Getter for the field enabled.

      Returns:
      a Boolean object.
      See Also:
    • setEnabled

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

      Defaults to: true

      Parameters:
      enabled - a Boolean object.
    • getKeyboardNavigation

      public KeyboardNavigation getKeyboardNavigation()

      Getter for the field keyboardNavigation.

      Returns:
      a KeyboardNavigation object.
      See Also:
    • setKeyboardNavigation

      public void setKeyboardNavigation(KeyboardNavigation keyboardNavigation)
      Options for keyboard navigation.
      Parameters:
      keyboardNavigation - a KeyboardNavigation object.
    • getOnTableAnchorClick

      public String getOnTableAnchorClick()

      getOnTableAnchorClick.

      Returns:
      a String object.
    • setOnTableAnchorClick

      public void setOnTableAnchorClick(String _fn_onTableAnchorClick)

      setOnTableAnchorClick.

      Parameters:
      _fn_onTableAnchorClick - a String object.
    • getPointDateFormat

      public String getPointDateFormat()

      Getter for the field pointDateFormat.

      Returns:
      a String object.
      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.

      Parameters:
      pointDateFormat - a String object.
    • getPointDateFormatter

      public String getPointDateFormatter()

      getPointDateFormatter.

      Returns:
      a String object.
    • setPointDateFormatter

      public void setPointDateFormatter(String _fn_pointDateFormatter)

      setPointDateFormatter.

      Parameters:
      _fn_pointDateFormatter - a String object.
    • getPointDescriptionFormatter

      public String getPointDescriptionFormatter()

      getPointDescriptionFormatter.

      Returns:
      a String object.
    • setPointDescriptionFormatter

      public void setPointDescriptionFormatter(String _fn_pointDescriptionFormatter)

      setPointDescriptionFormatter.

      Parameters:
      _fn_pointDescriptionFormatter - a String object.
    • getScreenReaderSectionFormatter

      public String getScreenReaderSectionFormatter()

      getScreenReaderSectionFormatter.

      Returns:
      a String object.
    • setScreenReaderSectionFormatter

      public void setScreenReaderSectionFormatter(String _fn_screenReaderSectionFormatter)

      setScreenReaderSectionFormatter.

      Parameters:
      _fn_screenReaderSectionFormatter - a String object.
    • getSeriesDescriptionFormatter

      public String getSeriesDescriptionFormatter()

      getSeriesDescriptionFormatter.

      Returns:
      a String object.
    • setSeriesDescriptionFormatter

      public void setSeriesDescriptionFormatter(String _fn_seriesDescriptionFormatter)

      setSeriesDescriptionFormatter.

      Parameters:
      _fn_seriesDescriptionFormatter - a String object.