.accessibility

class: AccessibilityLanguageOptions

class AccessibilityLanguageOptions(**kwargs)[source]

Configuration of accessibility strings in the chart.

Note

Requires the accessibility module to be loaded.

For a description of the module and information on its features, see Accessibility.

Class Inheritancedigraph inheritancef0bbd8b2e0 { bgcolor=transparent; rankdir=TB; size="8.0, 12.0"; "global_options.language.accessibility.AccessibilityLanguageOptions" [URL="#highcharts_stock.global_options.language.accessibility.AccessibilityLanguageOptions",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="Configuration of accessibility strings in the chart."]; "metaclasses.HighchartsMeta" -> "global_options.language.accessibility.AccessibilityLanguageOptions" [arrowsize=0.5,style="setlinewidth(0.5)"]; "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"]; }

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 announce_new_data: AnnounceNewDataLanguageOptions | None

Default announcement for new data in charts.

Note

If (JavaScript) addPoint() or addSeries() is used, and only one series/point is added, the AnnounceNewDataLanguageOptions.new_point_announce() and AnnounceNewdata.new_series_announce() strings are used.

The ...single versions will be used if there is only one chart on the page, and the ...multiple versions will be used if there are multiple charts on the page. For all other new data events, the AnnounceNewData.new_data_announce() string will be used.

Return type:

AnnounceNewDataLanguageOptions or None

property axis: AxisLanguageOptions | None

Axis description strings.

Return type:

AxisLanguageOptions or None

property chart_container_label: str | None

Label applied to the chart container. Defaults to '{title}. Highcharts interactive chart.'.

Return type:

str or None

property chart_types: ChartTypesLanguageOptions | None

Chart type description strings.

Note

This is added to the chart information region.

If there is only a single series type used in the chart, we use the format string for the series type, or default if missing. There is one format string for cases where there is only a single series in the chart, and one for multiple series of the same type.

Return type:

ChartTypesLanguageOptions or None

property credits: str | None

Content of the credits section. Defaults to: 'Chart credits: {creditsStr}'.

Return type:

str or None

property default_chart_title: str | None

The default title applied ot the chart. Defaults to 'Chart'.

Return type:

str or None

property drillup_button: str | None

String for the drill-up button. Defaults to '{buttonText}'.

Return type:

str or None

property exporting: ExportingLanguageOptions | None

Exporting menu format strings for use in the accessibility module.

Return type:

ExportingLanguageOptions or None

property graphic_container_label: str | None

Set a label on the container wrapping the SVG. Defaults to '' (an empty string).

Return type:

str or None

property legend: LegendLanguageOptions | None

Language options for the legend when used in accessibility mode.

Return type:

LegendLanguageOptions or None

property range_selector: RangeSelectorLanguageOptions | None

Language options for range selectors when used in accessibility mode.

Return type:

RangeSelectorLanguageOptions or None

property screen_reader_section: ScreenReaderSectionLanguageOptions | None

Language options for the screen reader information sections added before and after the chart when used in accessibility mode.

Return type:

ScreenReaderSectionLanguageOptions or None

property series: SeriesLanguageOptions | None

Language configuration for different series types.

Hint

For more dynamic control over the series element descriptions, see Accessibility.series_description_formatter().

Return type:

SeriesLanguageOptions or None

property series_type_descriptions: SeriesTypeDescriptions | None

Descriptions of lesser known series types. The relevant description is added to the screen reader information region when these series types are used.

Return type:

SeriesTypeDescriptions or None

property sonification: SonificationLanguageOptions | None

Language options for the sonification functionality when used in accessibility mode.

Return type:

SonificationLanguageOptions or None

property svg_container_label: str | None

Set a label on the container wrapping the SVG. Defaults to 'Interactive chart'.

Return type:

str or None

property svg_container_title: str | None

Title element text for the chart SVG element. Defaults to '' (an empty string).

Note

Leave this empty to disable adding the title element. Browsers will display this content when hovering over elements in the chart. Assistive technology may use this element to label the chart.

Return type:

str or None

property table: TableLanguageOptions | None

Language options for the table functionality when used in accessibility mode.

Return type:

TableLanguageOptions or None

property thousands_separator: EnforcedNullType | str | None

Thousands separator to use when formatting numbers for screen readers. Defaults to ','.

Set to None or to an EnforcedNullType to use the separator defined in Language.thousands_separator().

Note

Note that many screen readers will not handle an empty space as a thousands separator, and will consider “11 700” as two numbers.

Return type:

str or EnforcedNullType or None

property zoom: ZoomLanguageOptions | None

Language options for the zoom functionality when used in accessibility mode.

Return type:

ZoomLanguageOptions or None

Sub-components

Module

Classes / Functions

.global_options.language.accessibility

AccessibilityLanguageOptions

.global_options.language.accessibility.announce_new_data

AnnounceNewDataLanguageOptions

.global_options.language.accessibility.axis

AxisLanguageOptions

global_options.language.accessibility.chart_types

ChartTypesLanguageOptions

global_options.language.accessibility.exporting

ExportingLanguageOptions

global_options.language.accessibility.legend

LegendLanguageOptions

global_options.language.accessibility.range_selector

RangeSelectorLanguageOptions

global_options.language.accessibility.screen_reader_section

ScreenReaderSectionLanguageOptions ScreenReaderSectionAnnotationLanguage

global_options.language.accessibility.series

SeriesLanguageOptions SeriesSummaryLanguageOptions SeriesTypeDescriptions

global_options.language.accessibility.sonification

SonificationLanguageOptions

global_options.language.accessibility.table

TableLanguageOptions

global_options.language.accessibility.zoom

ZoomLanguageOptions