.subtitle

class: Subtitle

class Subtitle(**kwargs)[source]

The chart’s subtitle.

Note

This can be used both to display a subtitle below the main title, and to display random text anywhere in the chart.

Class Inheritance
Inheritance diagram of Subtitle

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

The horizontal alignment of the subtitle. Defaults to 'center'.

Accepts:

  • 'left'

  • 'center'

  • 'right'

Returns:

The alignment of the subtitle.

Return type:

str

property floating: bool | None

If True`, sets the subtitle to floating. When the subtitle is floating, the plot area will not move to make space for it. Defaults to ``False.

Return type:

bool

property style: str | None

CSS styling to apply to the subtitle. Defaults to '{"color": "#666666"}'.

Return type:

str or None

property text: str | None

The text of the subtitle. Defaults to an empty string ('').

Return type:

str

property use_html: bool | None

If True, will use HTML to render the subtitle. If False, will use SVG or WebGL as applicable.

Defaults to False.

Returns:

Flag indicating whether to render the subtitle using HTML.

Return type:

bool

property vertical_align: str | None

The vertical alignment of the subtitle. Defaults to None.

Accepts:

  • 'bottom'

  • 'middle'

  • 'top'

Note

When set to 'middle', the subtitle behaves as if Subtitle.floating() were set to True.

Return type:

str

property width_adjust: int | float | Decimal | None

Adjustment made to the subtitle width, normally to reserve space for the export hamburger menu. Defaults to -44.

Return type:

numeric or None

property x: int | float | Decimal | None

The x position of the subtitle relative to the alignment within Options.chart.spacing_left() and Option.chart.spacing_right(). Defaults to 0.

Return type:

numeric or None

property y: int | float | Decimal | None

The y position of the subtitle relative to the alignment within Options.chart.spacing_top() and Option.chart.spacing_bottom(). Defaults to None, which positions the subtitle below the title (unless the title is floating).

Return type:

numeric or None