.point

---

class: AccessibilityPoint

class AccessibilityPoint(**kwargs)

Options for describing individual points.

Class Inheritance

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 date_format: str | None

Date format to use for points on datetime axes when describing them to screen reader users.

Defaults to the same format as in tooltip.

See also

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

Returns:

The date format to use for points on datetime axes when describing them to screen reader users.

Return type:

str or None

property date_formatter: CallbackFunction | None

JavaScript formatter function to determine the date/time format used with points on datetime axes when describing them to screen reader users.

The formatter function should receive one argument, point, referring to the point to describe. Should return a date format string compatible with AccessibilityPoint.date_format().

Returns:

Formatter function to determine date/time format used.

Return type:

CallbackFunction or None

property describe_null: bool | None

If True, will describe points with the value null to assistive technology (e.g. screen readers).

Defaults to True.

Returns:

Flag indicating whether to describe points with the value null to assistive technology.

Return type:

bool or None

property description_format: str | None

A format string to use instead of the default for point descriptions.

The context of the format string is the point instance, but as opposed to .value_description_format, this option replaces the entire description.

Defaults to None.

Return type:

str or None

property description_formatter: CallbackFunction | None

JavaScript formatter function to use instead of the default for point descriptions.

The JavaScript formatter function should receive one argument, point, referring to the point to describe. Should return a string with the description of the point for a screen reader user. If false is returned, the default formatter will be used for that point.

Tip

Best practice is to use Accessibility.value_description_format() instead if possible, as default functionality such as describing annotations will be preserved.

Returns:

The JavaScript formatter function to use for point descriptions.

Return type:

CallbackFunction or None

property value_decimals: int | None

Number of digits after the decimal point to use for the values in the point description. Uses Tooltip.value_decimals() if not provided here.

Returns:

Number of digits to use after the decimal point.

Return type:

int or None

Raises:

ValueError – if a negative number is provided

property value_description_format: str | None

Format to use for describing the values of data points to assistive technology - including screen readers. The point context is available as {{point}}.

Defaults to {xDescription}{separator}{value}

Other available context variables include {{index}}, {{value}}, and {{xDescription}}.

Note

Additionally, the series name, annotation info, and description added in Point.accessibility.description() is added by default if relevant. To override this, use the AccessibilityPoint.description_formatter() option.

Returns:

Format to use for describing the values of data points to assistive technology.

Return type:

str or None

property value_prefix: str | None

Prefix to add to the values in the point descriptions.

Note

Uses Tooltip.value_prefix() if not defined.

Returns:

Prefix to add to the values in the point description.

Return type:

str or None

property value_suffix: str | None

Suffix to add to the values in the point descriptions.

Note

Uses Tooltip.value_suffix() if not defined.

Returns:

Suffix to add to the values in the point description.

Return type:

str or None