.drilldown

---

class: Drilldown

class Drilldown(**kwargs)

Options to configure drilldown functionality in the chart, which enables users to inspect increasingly high resolution data by clicking on chart items like columns or pie slices.

Note

The drilldown feature requires the drilldown.js file to be loaded in the browser/client. This file is found in the modules directory of the download package, or online at code.highcharts.com/modules/drilldown.js.

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

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 active_axis_label_style: dict | None

Additional styles to apply to the X axis label for a point that has drilldown data. By default, it is underlined and blue to invite to interaction.

Defaults to:

{
    "cursor": "pointer",
    "color": "#003399",
    "fontWeight": "bold",
    "textDecoration": "underline"
}

In styled mode, active label styles can be set with the .highcharts-drilldown-axis-label class.

Return type:

dict

property active_data_label_style: dict | None

Additional styles to apply to the data label of a point that has drilldown data. By default, it is underlined and blue to invite to interaction.

Defaults to:

{
    'color': '#003399',
    'cursor': 'pointer',
    'fontWeight': 'bold',
    'textDecoration': 'underline'
}

In styled mode, active label styles can be set with the .highcharts-drilldown-data-label class.

Return type:

dict

property allow_point_drilldown: bool | None

If False, clicking a single point will drill down all points in the same category, equivalent to clicking the X axis label. If True, clicking a single point will drill down on that specific point.

Defaults to True.

Returns:

Flag which determines whether to enable or disable point drilldown.

Return type:

bool or None

property animation: bool | AnimationOptions | None

Configures the animation for all drilldown. Animation of a drilldown occurs when drilling between a column point and a column series, or a pie slice and a full pie series. Drilldown can still be used between series and points of different types, but animation will not occur.

The animation can be configured as either a boolean or a AnimationOptions object. If True, it will apply the 'swing' jQuery easing and a duration of 500 ms by default. If used as a AnimationOptions instance, you have more fine-grianed configuration control.

Returns:

Settings for the animation of image patterns.

Return type:

AnimationOptions or None

property breadcrumbs: BreadcrumbOptions | None

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

Return type:

BreadcrumbOptions or None

property series: List[SeriesBase] | None

An array of series configurations for the drilldown. These drilldown series are hidden by default. The drilldown series is linked to the parent series’ point by its id.

Return type:

list of SeriesBase