• Home
• com.github.fluorumlabs.disconnect
• disconnect-highcharts
• 0.1.0-alpha1
• source code
• AccessibilityOptions.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

com.github.fluorumlabs.disconnect.highcharts.AccessibilityOptions Maven / Gradle / Ivy

package com.github.fluorumlabs.disconnect.highcharts;

import java.lang.FunctionalInterface;
import java.lang.String;
import javax.annotation.Nullable;
import js.lang.Any;
import js.lang.Unknown;
import org.teavm.jso.JSFunctor;
import org.teavm.jso.JSProperty;

/**
 * (Highcharts, Highstock, Highmaps) 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 https://api.highcharts.com/highcharts/accessibility
 * @see https://api.highcharts.com/highstock/accessibility
 * @see https://api.highcharts.com/highmaps/accessibility
 *
 */
public interface AccessibilityOptions extends Any {
  /**
   * (Highcharts, Highstock, Highmaps) Whether or not to add series
   * descriptions to charts with a single series.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.describeSingleSeries
   * @see https://api.highcharts.com/highstock/accessibility.describeSingleSeries
   * @see https://api.highcharts.com/highmaps/accessibility.describeSingleSeries
   *
   * @implspec describeSingleSeries?: boolean;
   *
   */
  @JSProperty("describeSingleSeries")
  boolean getDescribeSingleSeries();

  /**
   * (Highcharts, Highstock, Highmaps) Whether or not to add series
   * descriptions to charts with a single series.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.describeSingleSeries
   * @see https://api.highcharts.com/highstock/accessibility.describeSingleSeries
   * @see https://api.highcharts.com/highmaps/accessibility.describeSingleSeries
   *
   * @implspec describeSingleSeries?: boolean;
   *
   */
  @JSProperty("describeSingleSeries")
  void setDescribeSingleSeries(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) Enable accessibility features for the
   * chart.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.enabled
   * @see https://api.highcharts.com/highstock/accessibility.enabled
   * @see https://api.highcharts.com/highmaps/accessibility.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  boolean getEnabled();

  /**
   * (Highcharts, Highstock, Highmaps) Enable accessibility features for the
   * chart.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.enabled
   * @see https://api.highcharts.com/highstock/accessibility.enabled
   * @see https://api.highcharts.com/highmaps/accessibility.enabled
   *
   * @implspec enabled?: boolean;
   *
   */
  @JSProperty("enabled")
  void setEnabled(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) Options for keyboard navigation.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation
   * @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation
   * @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation
   *
   * @implspec keyboardNavigation?: AccessibilityKeyboardNavigationOptions;
   *
   */
  @JSProperty("keyboardNavigation")
  @Nullable
  AccessibilityKeyboardNavigationOptions getKeyboardNavigation();

  /**
   * (Highcharts, Highstock, Highmaps) Options for keyboard navigation.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation
   * @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation
   * @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation
   *
   * @implspec keyboardNavigation?: AccessibilityKeyboardNavigationOptions;
   *
   */
  @JSProperty("keyboardNavigation")
  void setKeyboardNavigation(AccessibilityKeyboardNavigationOptions value);

  /**
   * (Highcharts, Highstock, Highmaps) Function to run upon clicking the "View
   * as Data Table" link in the screen reader region.
   *
   * By default Highcharts will insert and set focus to a data table
   * representation of the chart.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.onTableAnchorClick
   * @see https://api.highcharts.com/highstock/accessibility.onTableAnchorClick
   * @see https://api.highcharts.com/highmaps/accessibility.onTableAnchorClick
   *
   * @implspec onTableAnchorClick?: () => void;
   *
   */
  @JSProperty("onTableAnchorClick")
  @Nullable
  OnTableAnchorClick getOnTableAnchorClick();

  /**
   * (Highcharts, Highstock, Highmaps) Function to run upon clicking the "View
   * as Data Table" link in the screen reader region.
   *
   * By default Highcharts will insert and set focus to a data table
   * representation of the chart.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.onTableAnchorClick
   * @see https://api.highcharts.com/highstock/accessibility.onTableAnchorClick
   * @see https://api.highcharts.com/highmaps/accessibility.onTableAnchorClick
   *
   * @implspec onTableAnchorClick?: () => void;
   *
   */
  @JSProperty("onTableAnchorClick")
  void setOnTableAnchorClick(OnTableAnchorClick value);

  /**
   * (Highcharts, Highstock, Highmaps) 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.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDateFormat
   * @see https://api.highcharts.com/highstock/accessibility.pointDateFormat
   * @see https://api.highcharts.com/highmaps/accessibility.pointDateFormat
   *
   * @implspec pointDateFormat?: string;
   *
   */
  @JSProperty("pointDateFormat")
  @Nullable
  String getPointDateFormat();

  /**
   * (Highcharts, Highstock, Highmaps) 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.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDateFormat
   * @see https://api.highcharts.com/highstock/accessibility.pointDateFormat
   * @see https://api.highcharts.com/highmaps/accessibility.pointDateFormat
   *
   * @implspec pointDateFormat?: string;
   *
   */
  @JSProperty("pointDateFormat")
  void setPointDateFormat(String value);

  /**
   * (Highcharts, Highstock, Highmaps) Formatter function to determine the
   * date/time format used with points on datetime axes when describing them
   * to screen reader users. Receives one argument, point, referring to the
   * point to describe. Should return a date format string compatible with
   * dateFormat.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDateFormatter
   * @see https://api.highcharts.com/highstock/accessibility.pointDateFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.pointDateFormatter
   *
   * @implspec pointDateFormatter?: () => void;
   *
   */
  @JSProperty("pointDateFormatter")
  @Nullable
  PointDateFormatter getPointDateFormatter();

  /**
   * (Highcharts, Highstock, Highmaps) Formatter function to determine the
   * date/time format used with points on datetime axes when describing them
   * to screen reader users. Receives one argument, point, referring to the
   * point to describe. Should return a date format string compatible with
   * dateFormat.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDateFormatter
   * @see https://api.highcharts.com/highstock/accessibility.pointDateFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.pointDateFormatter
   *
   * @implspec pointDateFormatter?: () => void;
   *
   */
  @JSProperty("pointDateFormatter")
  void setPointDateFormatter(PointDateFormatter value);

  /**
   * (Highcharts, Highstock, Highmaps) Formatter function to use instead of
   * the default for point descriptions. Receives one argument, point,
   * referring to the point to describe. Should return a String with the
   * description of the point for a screen reader user.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDescriptionFormatter
   * @see https://api.highcharts.com/highstock/accessibility.pointDescriptionFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.pointDescriptionFormatter
   *
   * @implspec pointDescriptionFormatter?: () => void;
   *
   */
  @JSProperty("pointDescriptionFormatter")
  @Nullable
  PointDescriptionFormatter getPointDescriptionFormatter();

  /**
   * (Highcharts, Highstock, Highmaps) Formatter function to use instead of
   * the default for point descriptions. Receives one argument, point,
   * referring to the point to describe. Should return a String with the
   * description of the point for a screen reader user.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDescriptionFormatter
   * @see https://api.highcharts.com/highstock/accessibility.pointDescriptionFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.pointDescriptionFormatter
   *
   * @implspec pointDescriptionFormatter?: () => void;
   *
   */
  @JSProperty("pointDescriptionFormatter")
  void setPointDescriptionFormatter(PointDescriptionFormatter value);

  /**
   * (Highcharts, Highstock, Highmaps) When a series contains more points than
   * this, we no longer expose information about individual points to screen
   * readers.
   *
   * Set to false to disable.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDescriptionThreshold
   * @see https://api.highcharts.com/highstock/accessibility.pointDescriptionThreshold
   * @see https://api.highcharts.com/highmaps/accessibility.pointDescriptionThreshold
   *
   * @implspec pointDescriptionThreshold?: (false|number);
   *
   */
  @JSProperty("pointDescriptionThreshold")
  @Nullable
  Unknown getPointDescriptionThreshold();

  /**
   * (Highcharts, Highstock, Highmaps) When a series contains more points than
   * this, we no longer expose information about individual points to screen
   * readers.
   *
   * Set to false to disable.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDescriptionThreshold
   * @see https://api.highcharts.com/highstock/accessibility.pointDescriptionThreshold
   * @see https://api.highcharts.com/highmaps/accessibility.pointDescriptionThreshold
   *
   * @implspec pointDescriptionThreshold?: (false|number);
   *
   */
  @JSProperty("pointDescriptionThreshold")
  void setPointDescriptionThreshold(boolean value);

  /**
   * (Highcharts, Highstock, Highmaps) When a series contains more points than
   * this, we no longer expose information about individual points to screen
   * readers.
   *
   * Set to false to disable.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.pointDescriptionThreshold
   * @see https://api.highcharts.com/highstock/accessibility.pointDescriptionThreshold
   * @see https://api.highcharts.com/highmaps/accessibility.pointDescriptionThreshold
   *
   * @implspec pointDescriptionThreshold?: (false|number);
   *
   */
  @JSProperty("pointDescriptionThreshold")
  void setPointDescriptionThreshold(double value);

  /**
   * (Highcharts, Highstock, Highmaps) A formatter function to create the HTML
   * contents of the hidden screen reader information region. Receives one
   * argument, chart, referring to the chart object. Should return a String
   * with the HTML content of the region.
   *
   * The link to view the chart as a data table will be added automatically
   * after the custom HTML content.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.screenReaderSectionFormatter
   * @see https://api.highcharts.com/highstock/accessibility.screenReaderSectionFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.screenReaderSectionFormatter
   *
   * @implspec screenReaderSectionFormatter?: () => void;
   *
   */
  @JSProperty("screenReaderSectionFormatter")
  @Nullable
  ScreenReaderSectionFormatter getScreenReaderSectionFormatter();

  /**
   * (Highcharts, Highstock, Highmaps) A formatter function to create the HTML
   * contents of the hidden screen reader information region. Receives one
   * argument, chart, referring to the chart object. Should return a String
   * with the HTML content of the region.
   *
   * The link to view the chart as a data table will be added automatically
   * after the custom HTML content.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.screenReaderSectionFormatter
   * @see https://api.highcharts.com/highstock/accessibility.screenReaderSectionFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.screenReaderSectionFormatter
   *
   * @implspec screenReaderSectionFormatter?: () => void;
   *
   */
  @JSProperty("screenReaderSectionFormatter")
  void setScreenReaderSectionFormatter(ScreenReaderSectionFormatter value);

  /**
   * (Highcharts, Highstock, Highmaps) Formatter function to use instead of
   * the default for series descriptions. Receives one argument, series,
   * referring to the series to describe. Should return a String with the
   * description of the series for a screen reader user.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.seriesDescriptionFormatter
   * @see https://api.highcharts.com/highstock/accessibility.seriesDescriptionFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.seriesDescriptionFormatter
   *
   * @implspec seriesDescriptionFormatter?: () => void;
   *
   */
  @JSProperty("seriesDescriptionFormatter")
  @Nullable
  SeriesDescriptionFormatter getSeriesDescriptionFormatter();

  /**
   * (Highcharts, Highstock, Highmaps) Formatter function to use instead of
   * the default for series descriptions. Receives one argument, series,
   * referring to the series to describe. Should return a String with the
   * description of the series for a screen reader user.
   *
   * @see https://api.highcharts.com/highcharts/accessibility.seriesDescriptionFormatter
   * @see https://api.highcharts.com/highstock/accessibility.seriesDescriptionFormatter
   * @see https://api.highcharts.com/highmaps/accessibility.seriesDescriptionFormatter
   *
   * @implspec seriesDescriptionFormatter?: () => void;
   *
   */
  @JSProperty("seriesDescriptionFormatter")
  void setSeriesDescriptionFormatter(SeriesDescriptionFormatter value);

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface OnTableAnchorClick extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface PointDateFormatter extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface PointDescriptionFormatter extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface ScreenReaderSectionFormatter extends Any {
    void apply();
  }

  /**
   */
  @JSFunctor
  @FunctionalInterface
  interface SeriesDescriptionFormatter extends Any {
    void apply();
  }
}