Highcharts Core for Python Logo
v.1.0.0

Contents

  • Home
  • Quickstart: Patterns and Best Practices
  • Demos
  • Supported Visualizations
  • FAQ
  • Toolkit Components and Roadmap
  • Using Highcharts Core for Python
  • API Reference
    • API Design Patterns
    • Core Components
      • .chart
      • .global_options
      • .headless_export
      • .highcharts
      • .options
      • .utility_classes
    • Library Internals
  • Error Reference
  • Getting Help
  • Contributor Guide
  • Testing Reference
  • Release History
  • Glossary
  • License
Highcharts Core for Python
  • Highcharts Core for Python API Reference
  • .utility_classes
  • .breadcrumbs
  • Edit on GitHub
Previous Next

.breadcrumbs

Module Contents

  • class: BreadcrumbOptions

  • class: Separator

class: BreadcrumbOptions

class BreadcrumbOptions(**kwargs)[source]

Configuration for the breadcrumbs, the navigation at the top leading the way up through the drilldown levels.

Class Inheritance
Inheritance diagram of BreadcrumbOptions

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 button_spacing: int | float | Decimal | None

The default padding expressed in pixels for each button and separator in each direction.

Return type:

numeric or None

property button_theme: dict | None

A collection of attributes for the breadcrumb buttons.

The object takes SVG attributes like fill, stroke, stroke-width or r, the border radius.

The theme also supports style, a collection of CSS properties for the text. The object can also be extended with states, so you can set presentational options for hover, select, or disabled button states.

Return type:

dict

property events: BreadcrumbEvents | None

Definition of JavaScript event listeners to apply to the breadcrumbs.

Return type:

ChartEvents or None

property floating: bool | None

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

Warning

This property will not work when positioned in the middle.

Return type:

bool or None

property format: str | None

A format string for the breadcrumbs button. Variables are enclosed by curly brackets. Available values are passed in the declared point options.

Returns:

The format string to apply to the breadcrumbs.

Return type:

str or None

property formatter: CallbackFunction | None

JavaScript callback function to format the breadcrumb text.

Returns:

A JavaScript callback function.

Return type:

CallbackFunction or None

property position: Position | None

The position of the button row.

Return type:

Position or None

property relative_to: str | None

What frame the button placement should be related to. Defaults to 'plotBox'.

Accepts:

  • 'plot'

  • 'chart'

  • 'plotBox'

  • 'spacingBox'

Return type:

str or None

property rtl: bool | None

If True`, reverses the order of the buttons (commonly used for Arabic or Hebrew). Defaults to ``False.

Return type:

bool or None

property separator: Separator | None

Configuration for the breadcrumb separator.

Return type:

Separator or None

property show_full_path: bool | None

If True, shows the full breadcrumb path. If False, shows only a single breadcrumb button. Defaults to True.

Return type:

bool or None

property style: dict | None

CSS styles to apply to all breadcrumbs.

Return type:

dict or None

property use_html: bool | None

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

Defaults to False.

Returns:

Flag indicating whether to render the breadcrumbs using HTML.

Return type:

bool or None

property z_index: int | None

The Z-Index for the breadcrumbs. Defaults to 7.

Returns:

The z-index for the annotation.

Return type:

int or None

class: Separator

class Separator(**kwargs)[source]

Configuration object for the Breadcrumbs Separator.

Class Inheritance
Inheritance diagram of Separator

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 style: dict | None

CSS styles for the Breadcrumb Separator.

Return type:

dict

property text: str | None

The text to use as the separator. Defaults to '/'.

Return type:

str or None

Previous Next

© Copyright 2022, HCP LLC. Revision 738dbfaf.

Built with Sphinx using a theme provided by Read the Docs.