.keyboard_navigation

class: KeyboardNavigation

class KeyboardNavigation(**kwargs)[source]

Options for Keyboard Navigation.

Class Inheritancedigraph inheritance20b11f0a9b { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "metaclasses.HighchartsMeta" [URL="../../../internals.html#highcharts_stock.metaclasses.HighchartsMeta",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Metaclass that is used to define the standard interface exposed for serializable"]; "options.accessibility.keyboard_navigation.KeyboardNavigation" [URL="#highcharts_stock.options.accessibility.keyboard_navigation.KeyboardNavigation",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="Options for Keyboard Navigation."]; "metaclasses.HighchartsMeta" -> "options.accessibility.keyboard_navigation.KeyboardNavigation" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

copy(other=None, overwrite=True, **kwargs)

Copy the configuration settings from this instance to the other instance.

Parameters:

  • other (HighchartsMeta) – The target instance to which the properties of this instance should be copied. If None, will create a new instance and populate it with properties copied from self. Defaults to None.

  • overwrite (bool) – if True, properties in other that are already set will be overwritten by their counterparts in self. Defaults to True.

  • kwargs – Additional keyword arguments. Some special descendents of HighchartsMeta may have special implementations of this method which rely on additional keyword arguments.

Returns:

A mutated version of other with new property values

classmethod from_dict(as_dict: dict, allow_snake_case: bool = True)

Construct an instance of the class from a dict object.

Parameters:

  • as_dict (dict) – A dict representation of the object.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python object representation of as_dict.

Return type:

HighchartsMeta

classmethod from_js_literal(as_str_or_file, allow_snake_case: bool = True, _break_loop_on_failure: bool = False)

Return a Python object representation of a Highcharts JavaScript object literal.

Parameters:

  • as_str_or_file (str) – The JavaScript object literal, represented either as a str or as a filename which contains the JS object literal.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

  • _break_loop_on_failure (bool) – If True, will break any looping operations in the event of a failure. Otherwise, will attempt to repair the failure. Defaults to False.

Returns:

A Python object representation of the Highcharts JavaScript object literal.

Return type:

HighchartsMeta

classmethod from_json(as_json_or_file, allow_snake_case: bool = True)

Construct an instance of the class from a JSON string.

Parameters:

  • as_json_or_file – The JSON string for the object or the filename of a file that contains the JSON string.

  • allow_snake_case (bool) – If True, interprets snake_case keys as equivalent to camelCase keys. Defaults to True.

Returns:

A Python objcet representation of as_json.

Return type:

HighchartsMeta

to_dict() → dict

Generate a dict representation of the object compatible with the Highcharts JavaScript library.

Note

The dict representation has a property structure and naming convention that is intentionally consistent with the Highcharts JavaScript library. This is not Pythonic, but it makes managing the interplay between the two languages much, much simpler.

Returns:

A dict representation of the object.

Return type:

dict

to_js_literal(filename=None, encoding='utf-8') → str | None

Return the object represented as a str containing the JavaScript object literal.

Parameters:

  • filename (Path-like) – The name of a file to which the JavaScript object literal should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

Return type:

str or None

to_json(filename=None, encoding='utf-8')

Generate a JSON string/byte string representation of the object compatible with the Highcharts JavaScript library.

Note

This method will either return a standard str or a bytes object depending on the JSON serialization library you are using. For example, if your environment has orjson, the result will be a bytes representation of the string.

Parameters:

  • filename (Path-like) – The name of a file to which the JSON string should be persisted. Defaults to None

  • encoding (str) – The character encoding to apply to the resulting object. Defaults to 'utf-8'.

Returns:

A JSON representation of the object compatible with the Highcharts library.

Return type:

str or bytes

static trim_dict(untrimmed: dict, to_json: bool = False) → dict

Remove keys from untrimmed whose values are None and convert values that have .to_dict() methods.

Parameters:

  • untrimmed (dict) – The dict whose values may still be None or Python objects.

  • to_json (bool) – If True, will remove all keys from untrimmed that are not serializable to JSON. Defaults to False.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False)

Convert any EnforcedNullType values in untrimmed to 'null'.

Parameters:

  • untrimmed (iterable) – The iterable whose members may still be None or Python objects.

  • to_json (bool) – If True, will remove all members from untrimmed that are not serializable to JSON. Defaults to False.

Return type:

iterable

property enabled: bool | None

Enable keyboard navigation for the chart. Defaults to True.

Returns:

Flag indicating whether keyboard navigation is enabled for the chart.

Return type:

bool or None

property focus_border: FocusBorder | None

Options for the focus border drawn around elements while navigating through them.

Returns:

Configuration of the focus border to be drawn around elements while navigating through them using the keyboard.

Return type:

FocusBorder or None

property order: List[str] | None

Order of tab navigation in the chart.

Determines which elements are tabbed to first. Available elements are:

  • 'series'

  • 'zoom'

  • 'rangeSelector'

  • 'chartMenu'

  • 'legend'

  • 'container'.

In addition, any custom components can be added here. Adding container first in order will make the keyboard focus stop on the chart container first, requiring the user to tab again to enter the chart.

Returns:

Order of components to follow when tab navigating the chart.

Return type:

list of str or None

property series_navigation: SeriesNavigation | None

Options for the keyboard navigation of data points and series.

Returns:

Configuration for series navigation.

Return type:

SeriesNavigation or None

property wrap_around: bool | None

If True, indicates that keyboard navigation should wrap around when reaching the end of arrow-key navigation for an element in the chart.

Defaults to True.

Returns:

Flag indicating whether navigation should wrap around when reaching the end of arrow-key navigation for an element in the chart.

Return type:

boolNone

Sub-components

Module

Classes / Functions

.options.accessibility.keyboard_navigation

KeyboardNavigation

.options.accessibility.keyboard_navigation.focus_border

FocusBorder FocusBorderStyle

.options.accessibility.keyboard_navigation.series_navigation

SeriesNavigation