.bubble_legend


class: BubbleLegend

class BubbleLegend(**kwargs)[source]

The bubble legend is an additional element in legend which presents the scale of the bubble series.

Individual bubble ranges can be defined by user or calculated from series. In the case of automatically calculated ranges, a 1px margin of error is permitted.

Class Inheritance
Inheritance diagram of BubbleLegend

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 border_color: str | Gradient | Pattern | None

The color of the ranges border. Can also be defined for an individual range. Defaults to None.

Returns:

The color of the range borders.

Return type:

str, Gradient, Pattern`, or None

property border_width: int | float | Decimal | None

The border width (in pixels) applied to the range borders. Can also be defined for an individual range. Defaults to None

Returns:

The border width to apply to the range borders.

Return type:

numeric or None

property class_name: str | None

A classname to apply styling using CSS.

Returns:

The classname to apply to enable styling via CSS.

Return type:

str or None

property color: str | Gradient | Pattern | None

The main color of the bubble legend. Applies to ranges, if individual ranges are not given a color. Defaults to None.

Returns:

The main color of the bubble legend.

Return type:

str, Gradient, Pattern`, or None

property connector_class_name: str | None

An additional class name to apply to the bubble legend’s connector graphical elements. This option does not replace default class names of the graphical element. Defaults to None.

Returns:

The class name applied to the bubble legend’s connector graphical elements.

Return type:

str or None

property connector_color: str | Gradient | Pattern | None

The color applied to the connector. Can also be defined for individual ranges. Defaults to None.

Returns:

The color applied to the connector.

Return type:

str, Gradient, Pattern`, or None

property connector_distance: int | float | Decimal | None

The length of the connector in pixels. Defaults to 60.

Note

If labels are centered, the distance is automatically reduced to 0.

Returns:

The border width to apply to the range borders.

Return type:

numeric or None

property connector_width: int | float | Decimal | None

The width of the connector in pixels. Defaults to 1.

Returns:

The border width to apply to the range borders.

Return type:

numeric or None

property enabled: bool | None

If True, displays the bubble legend. If False, hides the legend. Defaults to False.

Return type:

bool or None

property labels: BubbleLegendLabelOptions | None

Options to configure the bubble legend’s labels. Defaults to None.

Return type:

BubbleLegendLabelOptions or None

property legend_index: int | None

The position of the bubble legend within the legend. Defaults to 0.

Returns:

The position of the bubble legend within the legend.

Return type:

numeric or None

property max_size: int | float | Decimal | None

The maximum bubble legend range size, in pixels. Defaults to 60.

Note

If not specified, the maximum size is determined automatically.

Returns:

The maximum bubble legend range size.

Return type:

numeric or None

property min_size: int | float | Decimal | None

The minimum bubble legend range size, in pixels. Defaults to 10.

Note

If not specified, the minimum size is determined automatically.

Returns:

The minimum bubble legend range size.

Return type:

numeric or None

property ranges: List[BubbleLegendRange] | None

Options for specific range. One range consists of bubble, label and connector.

Defaults to None

Return type:

list of BubbleLegendRange, or None

property size_by: str | None

Indicates whether the bubble legend range should be represented by the area or the width of the bubble. The default ('area') corresponds best to the human perception of the size of each bubble.

Accepts one of two possible values:

  • 'area'

  • 'width'

Return type:

str or None

property size_by_absolute_value: bool | None

If True, the absolute value of z determines the size of the bubble. This means that with the default BubbleLegend.z_threshold() of 0, a bubble of value -1 will have the same size as a bubble of value 1, while a bubble of value 0 will have a smaller size according to BubbleLegend.min_size().

Defaults to False.

Return type:

bool or None

property z_index: int | None

The visual z index of the bubble legend. Defaults to 1.

Return type:

int or None

property z_threshold: int | float | Decimal | None

Ranges with a lower z-value are skipped in the legend. Defaults to 0.

Return type:

numeric


class: BubbleLegendRange

class BubbleLegendRange(**kwargs)[source]

Options for specific range. One range consists of bubble, label and connector.

Class Inheritance
Inheritance diagram of BubbleLegendRange

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 border_color: str | Gradient | Pattern | None

The color of the range’s border. Defaults to None.

Returns:

The color of the range borders.

Return type:

str, Gradient, Pattern`, or None

property color: str | Gradient | Pattern | None

The main color of the bubble for the range. Defaults to None.

Returns:

The main color of the bubble legend.

Return type:

str, Gradient, Pattern`, or None

property connector_color: str | Gradient | Pattern | None

The color applied to the connector for the range. Defaults to None.

Returns:

The color applied to the connector.

Return type:

str, Gradient, Pattern`, or None

property value: int | float | Decimal | None

The range size value, similar to the bubble’s Z-value. Defaults to None

Return type:

numeric or None


class: BubbleLegendLabelOptions

class BubbleLegendLabelOptions(**kwargs)[source]

Options to configure the bubble legend’s labels.

Class Inheritance
Inheritance diagram of BubbleLegendLabelOptions

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 alignment of the labels relative to the bubble legend. Defaults to 'right'.

Accepts:

  • 'left'

  • 'center'

  • 'right'

Returns:

The alignment of the annotation’s label.

Return type:

str or None

property allow_overlap: bool | None

If True, data labels are allowed to overlap each other.

Defaults to False.

Returns:

Flag indicating whether to allow data labels to overlap.

Return type:

bool or None

property class_name: str | None

A classname to apply styling using CSS. Defaults to 'None'.

Returns:

The classname to apply to enable styling via CSS.

Return type:

str or None

property format: str | None

A format string to apply to the label.

Returns:

The format string to apply to the labels.

Return type:

str or None

property formatter: CallbackFunction | None

JavaScript callback function to format the bubble legend’s data labels.

Hint

In the JavaScript callback function, the this properties available are:

  • this.value - the bubble value

  • this.radius - the bubble radius

  • this.center - the y position of the bubble’s center

Returns:

A JavaScript callback function.

Return type:

CallbackFunction or None

property style: str | None

CSS styling to apply to the data labels.

Return type:

str or None

property x: int | None

The x position offset of the label relative to the connector. Defaults to 0.

Return type:

numeric or None

property y: int | None

The y position offset of the label relative to the connector. Defaults to 0.

Return type:

numeric or None