com.github.fluorumlabs.disconnect.highcharts.AccessibilityKeyboardNavigationOptions Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of disconnect-highcharts Show documentation
Show all versions of disconnect-highcharts Show documentation
Highcharts API bindings for Disconnect Zero
package com.github.fluorumlabs.disconnect.highcharts;
import javax.annotation.Nullable;
import js.extras.JsEnum;
import js.lang.Any;
import org.teavm.jso.JSProperty;
/**
* (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
*
*/
public interface AccessibilityKeyboardNavigationOptions extends Any {
/**
* (Highcharts, Highstock, Highmaps) Enable keyboard navigation for the
* chart.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.enabled
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.enabled
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
boolean getEnabled();
/**
* (Highcharts, Highstock, Highmaps) Enable keyboard navigation for the
* chart.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.enabled
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.enabled
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.enabled
*
* @implspec enabled?: boolean;
*
*/
@JSProperty("enabled")
void setEnabled(boolean value);
/**
* (Highcharts, Highstock, Highmaps) Options for the focus border drawn
* around elements while navigating through them.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.focusBorder
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.focusBorder
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.focusBorder
*
* @implspec focusBorder?: AccessibilityKeyboardNavigationFocusBorderOptions;
*
*/
@JSProperty("focusBorder")
@Nullable
AccessibilityKeyboardNavigationFocusBorderOptions getFocusBorder();
/**
* (Highcharts, Highstock, Highmaps) Options for the focus border drawn
* around elements while navigating through them.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.focusBorder
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.focusBorder
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.focusBorder
*
* @implspec focusBorder?: AccessibilityKeyboardNavigationFocusBorderOptions;
*
*/
@JSProperty("focusBorder")
void setFocusBorder(AccessibilityKeyboardNavigationFocusBorderOptions value);
/**
* (Highcharts, Highstock, Highmaps) Set the keyboard navigation mode for
* the chart. Can be "normal" or "serialize". In normal mode, left/right
* arrow keys move between points in a series, while up/down arrow keys move
* between series. Up/down navigation acts intelligently to figure out which
* series makes sense to move to from any given point.
*
* In "serialize" mode, points are instead navigated as a single list.
* Left/right behaves as in "normal" mode. Up/down arrow keys will behave
* like left/right. This is useful for unifying navigation behavior
* with/without screen readers enabled.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.mode
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.mode
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.mode
*
* @implspec mode?: ("normal"|"serialize");
*
*/
@JSProperty("mode")
@Nullable
Mode getMode();
/**
* (Highcharts, Highstock, Highmaps) Set the keyboard navigation mode for
* the chart. Can be "normal" or "serialize". In normal mode, left/right
* arrow keys move between points in a series, while up/down arrow keys move
* between series. Up/down navigation acts intelligently to figure out which
* series makes sense to move to from any given point.
*
* In "serialize" mode, points are instead navigated as a single list.
* Left/right behaves as in "normal" mode. Up/down arrow keys will behave
* like left/right. This is useful for unifying navigation behavior
* with/without screen readers enabled.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.mode
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.mode
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.mode
*
* @implspec mode?: ("normal"|"serialize");
*
*/
@JSProperty("mode")
void setMode(Mode value);
/**
* (Highcharts, Highstock, Highmaps) Skip null points when navigating
* through points with the keyboard.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.skipNullPoints
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.skipNullPoints
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.skipNullPoints
*
* @implspec skipNullPoints?: boolean;
*
*/
@JSProperty("skipNullPoints")
boolean getSkipNullPoints();
/**
* (Highcharts, Highstock, Highmaps) Skip null points when navigating
* through points with the keyboard.
*
* @see https://api.highcharts.com/highcharts/accessibility.keyboardNavigation.skipNullPoints
* @see https://api.highcharts.com/highstock/accessibility.keyboardNavigation.skipNullPoints
* @see https://api.highcharts.com/highmaps/accessibility.keyboardNavigation.skipNullPoints
*
* @implspec skipNullPoints?: boolean;
*
*/
@JSProperty("skipNullPoints")
void setSkipNullPoints(boolean value);
/**
*/
abstract class Mode extends JsEnum {
public static final Mode NORMAL = JsEnum.of("normal");
public static final Mode SERIALIZE = JsEnum.of("serialize");
}
}