`.screen_reader_section`

class: `ScreenReaderSection`

class ScreenReaderSection(**kwargs)[source]

Accessibility options for the screen reader information sections added before and after the chart.

Class Inheritance

Inheritance diagram of ScreenReaderSection

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

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:: include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.
Return type:: list of str

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', careful_validation=False) → 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'.
careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

Return type:: str or None

to_json(filename=None, encoding='utf-8', for_export: bool = False)

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'.
for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

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, context: str = None, for_export: 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.
context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.
for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None, for_export: bool = 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.
context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.
for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Return type:

iterable

property after_chart_format: str | None

Format for the screen reader information region after the chart. Defaults to '{endOfChartMarker}'.

Supported HTML tags are:

<h1-6>
<p>
<div>
<a>
<ul>
<ol>
<li>
<button>

Attributes are not supported, except for id on <div>, <a>, and <button>.

id is required on <a> and <button> in the format <tag id="abcd">. Numbers, lower- and uppercase letters, "-" and "#" are valid characters in IDs.

The headingTagName is an auto-detected heading (h1-h6) that corresponds to the heading level below the previous heading in the DOM.

Tip

Set to empty string to remove the region altogether.

Returns:: Content to render in the screen reader information region after the chart.
Return type:: str or None

property after_chart_formatter: CallbackFunction | None

A JavaScript formatter function to create the HTML contents of the hidden screen reader information region after the chart.

The formatter function should receive one argument, chart, referring to the chart object. It should return a string with the HTML content of the region.

If None, will returns an automatic description of the chart based on ScreenReaderSection.after_chart_format().

Returns:: JavaScript formatter function for the screen reader information region after the chart.
Return type:: CallbackFunction or None

property axis_range_date_format: str | None

Date format to use to describe range of datetime axes. Defaults to %Y-%m-%d %H:%M:%S.

See also

Detailed documentation on supported format replacement codes: https://api.highcharts.com/class-reference/Highcharts.Time#dateFormat

Returns:: Date format to use to describe range of datetime axes.
Return type:: str or None

property before_chart_format: str | None

Format for the screen reader information region before the chart. Defaults to

'<{headingTagName}>{chartTitle}</{headingTagName}>
 <div>{typeDescription}</div><div>{chartSubtitle}</div>
 <div>{chartLongdesc}</div><div>{playAsSoundButton}</div>
 <div>{viewTableButton}</div><div>{xAxisDescription}</div>
 <div>{yAxisDescription}</div>
 <div>{annotationsTitle}{annotationsList}</div>'

Supported HTML tags are:

<h1-6>
<p>
<div>
<a>
<ul>
<ol>
<li>
<button>

Attributes are not supported, except for id on <div>, <a>, and <button>.

id is required on <a> and <button> in the format <tag id="abcd">. Numbers, lower- and uppercase letters, "-" and "#" are valid characters in IDs.

The headingTagName is an auto-detected heading (h1-h6) that corresponds to the heading level below the previous heading in the DOM.

Tip

Set to empty string to remove the region altogether.

Returns:: Content to render in the screen reader information region before the chart.
Return type:: str or None

property before_chart_formatter: CallbackFunction | None

A JavaScript formatter function to create the HTML contents of the hidden screen reader information region before the chart.

The formatter function should receive one argument, chart, referring to the chart object. It should return a string with the HTML content of the region.

If None, will returns an automatic description of the chart based on ScreenReaderSection.before_chart_format().

Returns:: JavaScript formatter function for the screen reader information region before the chart.
Return type:: CallbackFunction or None

property on_play_as_sound_click: CallbackFunction | None

JavaScript function to run upon clicking the “Play as sound” button in the screen reader region.

By default Highcharts will call the chart.sonify JavaScript function.

Returns:: JavaScript function to run upon clicking the “Play as sound” button in the screen reader region.
Return type:: str or None

property on_view_data_table_click: CallbackFunction | None

JavaScript 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.

Returns:: JavaScript function to run upon clicking the “View as Data Table” link in the screen reader region.
Return type:: CallbackFunction or None

.screen_reader_section

class: ScreenReaderSection

`.screen_reader_section`

class: `ScreenReaderSection`