`.bar`

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:

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:

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 accessibility: DataPointAccessibility | None

Accessibility options for a data point.

Return type:: DataPointAccessibility or None

property border_color: str | Gradient | Pattern | None

The color of the border surrounding each column or bar. Defaults to None

Return type:: str or None

property border_width: int | float | Decimal | None

The width of the border surrounding each column or bar. Defaults to None.

Return type:: numeric or None

property class_name: str | None

The additional CSS class name to apply to the data point’s graphical elements.

Return type:: str or None

property color: str | Gradient | Pattern | None

The color of the individual data point. Defaults to None.

Return type:: None, Gradient, Pattern, or str

property color_index: int | None

When operating in styled mode, a specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}. Defaults to None.

Tip

New in version Highcharts: (JS) v.11

With Highcharts (JS) v.11, using CSS variables of the form --highcharts-color-{n} make changing the color scheme very simple.

Return type:: int or None

property custom: JavaScriptDict | None

A reserved subspace to store options and values for customized functionality.

Here you can add additional data for your own event callbacks and formatter callbacks.

Return type:: dict or None

property dash_style: str | None

Name of the dash style to use for bar or column. Defaults to None.

Accepts one of the following values:

‘Dash’,

‘DashDot’,

‘Dot’,

‘LongDash’,

‘LongDashDot’,

‘LongDashDotDot’,

‘ShortDash’,

‘ShortDashDot’,

‘ShortDashDotDot’,

‘ShortDot’,

‘Solid’

Return type:: str or None

property data_labels: DataLabel | None

Individual data label for the data point.

Return type:: DataLabel or None

property description: str | None

A description of the data point to add to the screen reader information about the data point.

Return type:: str

property drag_drop: DragDropOptions | None

The draggable-points module allows points to be moved around or modified in the chart.

In addition to the options mentioned under the dragDrop API structure, the module fires three (JavaScript) events:

point.dragStart

point.drag

point.drop

Return type:: DragDropOptions or None

property drilldown: str | None

The id of a series in the drilldown.series array to use as a drilldown destination for this point. Defaults to None.

Return type:: str or None

property events: PointEvents | None

Event handlers for individual data points.

Return type:: PointEvents or None

property id: str | None

The id of the data point. Defaults to None.

Note

This can be used (in JavaScript) after render time to get a pointer to the point object through chart.get().

Return type:: str or None

property label_rank: int | float | Decimal | None

The rank for this point’s data label in the case of collision. Defaults to None.

Note

If two data labels are about to overlap, the data label for the point with the highest label_rank will be shown.

Return type:: numeric or None

property marker: Marker | None

Options for the point markers of line-like series.

Return type:: Marker or None

property name: str | None

The name to display for the point in data labels, tooltips, in legends, etc. Defaults to None.

Return type:: str or None

property point_width: int | float | Decimal | None

A pixel value specifying a fixed width for the column or bar. Defaults to None.

Note

If specified, overrides the point_width provided for the series as a whole.

Note

The point_width affects the dimension that is not based on the point value.

Return type:: numeric or None

property selected: bool | None

If True, indicates that the data point is initially selected. Defaults to None, which behaves as False.

Return type:: bool or None

The point’s location on the x-axis. Defaults to None.

If None, the point’s position on the x-axis will be automatically determined based on its position in the series’ data array. The first point will be given an x value of 0, or the series’ point_start value. Each subsequent point will be incremented either by 1 or the value of point_interval.

Return type:: numeric or str or date or datetime or None

property y: int | float | Decimal | None | EnforcedNullType

The position of the data point on the Y-axis. Defaults to None.

Return type:: numeric or EnforcedNullType or None

class: `WaterfallData`

class WaterfallData(**kwargs)[source]

Variant of CartesianData which is used for data points in a waterfall chart.

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_array(value)

Creates a collection of data point instances, parsing the contents of value as an array (iterable). This method is specifically used to parse data that is input to Highcharts for Python without property names, in an array-organized structure as described in the Highcharts JS documentation.

See also

The specific structure of the expected array is highly dependent on the type of data point that the series needs, which itself is dependent on the series type itself.

Please review the detailed series documentation for series type-specific details of relevant array structures.

Note

An example of how this works for a simple LineSeries (which uses CartesianData data points) would be:

my_series = LineSeries()

# A simple array of numerical values which correspond to the Y value of the
# data point
my_series.data = [0, 5, 3, 5]

# An array containing 2-member arrays (corresponding to the X and Y values
# of the data point)
my_series.data = [
    [0, 0],
    [1, 5],
    [2, 3],
    [3, 5]
]

# An array of dict with named values
my_series.data = [
  {
      'x': 0,
      'y': 0,
      'name': 'Point1',
      'color': '#00FF00'
  },
  {
      'x': 1,
      'y': 5,
      'name': 'Point2',
      'color': '#CCC'
  },
  {
      'x': 2,
      'y': 3,
      'name': 'Point3',
      'color': '#999'
  },
  {
      'x': 3,
      'y': 5,
      'name': 'Point4',
      'color': '#000'
  }
]

Parameters:

value (iterable) –

The value that should contain the data which will be converted into data point instances.

Note

If value is not an iterable, it will be converted into an iterable to be further de-serialized correctly.

Returns:

Collection of data point instances (descended from DataBase)

Return type:

list of DataBase descendant instances

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:

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:

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:

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 accessibility: DataPointAccessibility | None

Accessibility options for a data point.

Return type:: DataPointAccessibility or None

property class_name: str | None

The additional CSS class name to apply to the data point’s graphical elements.

Return type:: str or None

property color: str | Gradient | Pattern | None

The color of the individual data point. Defaults to None.

Return type:: None, Gradient, Pattern, or str

property color_index: int | None

When operating in styled mode, a specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}. Defaults to None.

Tip

New in version Highcharts: (JS) v.11

With Highcharts (JS) v.11, using CSS variables of the form --highcharts-color-{n} make changing the color scheme very simple.

Return type:: int or None

property custom: JavaScriptDict | None

A reserved subspace to store options and values for customized functionality.

Here you can add additional data for your own event callbacks and formatter callbacks.

Return type:: dict or None

property data_labels: DataLabel | None

Individual data label for the data point.

Return type:: DataLabel or None

property description: str | None

A description of the data point to add to the screen reader information about the data point.

Return type:: str

property drag_drop: DragDropOptions | None

The draggable-points module allows points to be moved around or modified in the chart.

In addition to the options mentioned under the dragDrop API structure, the module fires three (JavaScript) events:

point.dragStart

point.drag

point.drop

Return type:: DragDropOptions or None

property drilldown: str | None

The id of a series in the drilldown.series array to use as a drilldown destination for this point. Defaults to None.

Return type:: str or None

property events: PointEvents | None

Event handlers for individual data points.

Return type:: PointEvents or None

property id: str | None

The id of the data point. Defaults to None.

Note

This can be used (in JavaScript) after render time to get a pointer to the point object through chart.get().

Return type:: str or None

property is_intermediate_sum: bool | None

When True, the point acts as a summary column for the values added or subtracted since the last intermediate sum, or since the start of the series. Defaults to None, which is interpreted as False.

Warning

The y value is ignored.

Return type:: bool or None

property is_sum: bool | None

When True, the point displays the total sum across the entire series. Defaults to None, which is interpreted as False.

Warning

The y value is ignored.

Return type:: bool or None

property label_rank: int | float | Decimal | None

The rank for this point’s data label in the case of collision. Defaults to None.

Note

If two data labels are about to overlap, the data label for the point with the highest label_rank will be shown.

Return type:: numeric or None

property marker: Marker | None

Options for the point markers of line-like series.

Return type:: Marker or None

property name: str | None

The name to display for the point in data labels, tooltips, in legends, etc. Defaults to None.

Return type:: str or None

property selected: bool | None

If True, indicates that the data point is initially selected. Defaults to None, which behaves as False.

Return type:: bool or None

The point’s location on the x-axis. Defaults to None.

If None, the point’s position on the x-axis will be automatically determined based on its position in the series’ data array. The first point will be given an x value of 0, or the series’ point_start value. Each subsequent point will be incremented either by 1 or the value of point_interval.

Return type:: numeric or str or date or datetime or None

property y: int | float | Decimal | None | EnforcedNullType

The position of the data point on the Y-axis. Defaults to None.

Return type:: numeric or EnforcedNullType or None

class: `WindBarbData`

class WindBarbData(**kwargs)[source]

Variant of CartesianData which is used for data points in a windbarb chart.

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_array(value)[source]

Creates a collection of data point instances, parsing the contents of value as an array (iterable). This method is specifically used to parse data that is input to Highcharts for Python without property names, in an array-organized structure as described in the Highcharts JS documentation.

See also

The specific structure of the expected array is highly dependent on the type of data point that the series needs, which itself is dependent on the series type itself.

Please review the detailed series documentation for series type-specific details of relevant array structures.

Note

An example of how this works for a simple LineSeries (which uses CartesianData data points) would be:

my_series = LineSeries()

# A simple array of numerical values which correspond to the Y value of the
# data point
my_series.data = [0, 5, 3, 5]

# An array containing 2-member arrays (corresponding to the X and Y values
# of the data point)
my_series.data = [
    [0, 0],
    [1, 5],
    [2, 3],
    [3, 5]
]

# An array of dict with named values
my_series.data = [
  {
      'x': 0,
      'y': 0,
      'name': 'Point1',
      'color': '#00FF00'
  },
  {
      'x': 1,
      'y': 5,
      'name': 'Point2',
      'color': '#CCC'
  },
  {
      'x': 2,
      'y': 3,
      'name': 'Point3',
      'color': '#999'
  },
  {
      'x': 3,
      'y': 5,
      'name': 'Point4',
      'color': '#000'
  }
]

Parameters:

value (iterable) –

The value that should contain the data which will be converted into data point instances.

Note

If value is not an iterable, it will be converted into an iterable to be further de-serialized correctly.

Returns:

Collection of data point instances (descended from DataBase)

Return type:

list of DataBase descendant instances

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:

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:

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:

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 accessibility: DataPointAccessibility | None

Accessibility options for a data point.

Return type:: DataPointAccessibility or None

property class_name: str | None

The additional CSS class name to apply to the data point’s graphical elements.

Return type:: str or None

property color: str | Gradient | Pattern | None

The color of the individual data point. Defaults to None.

Return type:: None, Gradient, Pattern, or str

property color_index: int | None

When operating in styled mode, a specific color index to use for the point, so its graphic representations are given the class name highcharts-color-{n}. Defaults to None.

Tip

New in version Highcharts: (JS) v.11

With Highcharts (JS) v.11, using CSS variables of the form --highcharts-color-{n} make changing the color scheme very simple.

Return type:: int or None

property custom: JavaScriptDict | None

A reserved subspace to store options and values for customized functionality.

Here you can add additional data for your own event callbacks and formatter callbacks.

Return type:: dict or None

property data_labels: DataLabel | None

Individual data label for the data point.

Return type:: DataLabel or None

property description: str | None

A description of the data point to add to the screen reader information about the data point.

Return type:: str

property direction: int | float | Decimal | None

The windirection in degrees, where 0 is north (pointing towards south). Defaults to None.

Return type:: numeric or None

property drag_drop: DragDropOptions | None

The draggable-points module allows points to be moved around or modified in the chart.

In addition to the options mentioned under the dragDrop API structure, the module fires three (JavaScript) events:

point.dragStart

point.drag

point.drop

Return type:: DragDropOptions or None

property drilldown: str | None

The id of a series in the drilldown.series array to use as a drilldown destination for this point. Defaults to None.

Return type:: str or None

property events: PointEvents | None

Event handlers for individual data points.

Return type:: PointEvents or None

property id: str | None

The id of the data point. Defaults to None.

Note

This can be used (in JavaScript) after render time to get a pointer to the point object through chart.get().

Return type:: str or None

property label_rank: int | float | Decimal | None

The rank for this point’s data label in the case of collision. Defaults to None.

Note

If two data labels are about to overlap, the data label for the point with the highest label_rank will be shown.

Return type:: numeric or None

property marker: Marker | None

Options for the point markers of line-like series.

Return type:: Marker or None

property name: str | None

The name to display for the point in data labels, tooltips, in legends, etc. Defaults to None.

Return type:: str or None

property selected: bool | None

If True, indicates that the data point is initially selected. Defaults to None, which behaves as False.

Return type:: bool or None

property value: int | float | Decimal | None

The wind speed in meters per second. Defaults to None.

Return type:: numeric or None

The point’s location on the x-axis. Defaults to None.

If None, the point’s position on the x-axis will be automatically determined based on its position in the series’ data array. The first point will be given an x value of 0, or the series’ point_start value. Each subsequent point will be incremented either by 1 or the value of point_interval.

Return type:: numeric or str or date or datetime or None

property y: int | float | Decimal | None | EnforcedNullType

The position of the data point on the Y-axis. Defaults to None.

Return type:: numeric or EnforcedNullType or None

class: `XRangeData`

class XRangeData(**kwargs)[source]

Variant of CartesianData which is used for data points in an X-Range series.

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_array(value)[source]

Creates a collection of data point instances, parsing the contents of value as an array (iterable). This method is specifically used to parse data that is input to Highcharts for Python without property names, in an array-organized structure as described in the Highcharts JS documentation.

See also

The specific structure of the expected array is highly dependent on the type of data point that the series needs, which itself is dependent on the series type itself.

Please review the detailed series documentation for series type-specific details of relevant array structures.

Note

An example of how this works for a simple LineSeries (which uses CartesianData data points) would be:

my_series = LineSeries()

# A simple array of numerical values which correspond to the Y value of the
# data point
my_series.data = [0, 5, 3, 5]

# An array containing 2-member arrays (corresponding to the X and Y values
# of the data point)
my_series.data = [
    [0, 0],
    [1, 5],
    [2, 3],
    [3, 5]
]

# An array of dict with named values
my_series.data = [
  {
      'x': 0,
      'y': 0,
      'name': 'Point1',
      'color': '#00FF00'
  },
  {
      'x': 1,
      'y': 5,
      'name': 'Point2',
      'color': '#CCC'
  },
  {
      'x': 2,
      'y': 3,
      'name': 'Point3',
      'color': '#999'
  },
  {
      'x': 3,
      'y': 5,
      'name': 'Point4',
      'color': '#000'
  }
]

Parameters:

value (iterable) –

The value that should contain the data which will be converted into data point instances.

Note

If value is not an iterable, it will be converted into an iterable to be further de-serialized correctly.

Returns:

Collection of data point instances (descended from DataBase)

Return type:

list of DataBase descendant instances

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:

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:

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: