.options

• .accessibility
  • .announce_new_data
  • .keyboard_navigation
    • .focus_border
    • .series_navigation
  • .point
  • .screen_reader_section
  • .series
• .annotations
  • .animation
  • .control_point_options
  • .events
  • .label_options
  • .points
  • .shape_options
  • .stock_tools
    • .type_options
      • .crooked_line
      • .elliott_wave
      • .fibonacci
      • .line
      • .measure
      • .pitchfork
      • .points
      • .time_cycles
      • .tunnel
      • .vertical_line
• .axes
  • .accessibility
  • .breaks
  • .color_axis
  • .crosshair
  • .data_classes
  • .generic
  • .labels
  • .markers
  • .numeric
  • .parallel_axes
  • .plot_bands
  • .resize
  • .title
  • .x_axis
  • .y_axis
  • .z_axis
• .boost
• .caption
• .chart
  • .options_3d
  • .reset_zoom_button
  • .scrollable_plot_area
  • .zooming
• .scrollable_plot_area
• .data
• .defs
• .drilldown
• .exporting
  • .csv
  • .pdf_font
• .legend
  • .accessibility
  • .bubble_legend
  • .navigation
  • .title
• .loading
• .navigation
  • .bindings
• .navigator
• .no_data
• .pane
• .plot_options
  • .abands
  • .accessibility
  • .ad
  • .arcdiagram
  • .area
  • .aroon
  • .atr
  • .averages
  • .bar
  • .base
  • .bellcurve
  • .boxplot
  • .bubble
  • .bullet
  • .candlestick
  • .data_sorting
  • .dependencywheel
  • .disparity_index
  • .dmi
  • .drag_drop
  • .dumbbell
  • .flags
  • .funnel
  • .gauge
  • .generic
  • .heatmap
  • .histogram
  • .hlc
  • .indicators
  • .item
  • .levels
  • .linear_regressions
  • .link
  • .momentum
    • .ikh
    • .macd
    • .supertrend
  • .networkgraph
  • .organization
  • .oscillators
    • .ao
    • .klinger
    • .money_flow
    • .ppo
    • .stochastic
  • .packedbubble
  • .pareto
  • .pictorial
  • .pie
  • .pivot_points
  • .points
  • .polygon
  • .price_envelopes
  • .psar
  • .pyramid
  • .sankey
  • .scatter
  • .series
  • .sonification
  • .spline
  • .sunburst
  • .timeline
  • .treegraph
  • .treemap
  • .vbp
  • .vector
  • .venn
  • .wordcloud
  • .zigzag
• .responsive
• .series
  • .abands
  • .ad
  • .arcdiagram
  • .area
  • .aroon
  • .atr
  • .averages
  • .bar
  • .base
  • .bellcurve
  • .boxplot
  • .bubble
  • .bullet
  • .candlestick
  • .data
    • .accessibility
    • .arcdiagram
    • .bar
    • .base
    • .boxplot
    • .bullet
    • .candlestick
    • .cartesian
    • .connections
    • .hlc
    • .pie
    • .range
    • .single_point
    • .sunburst
    • .treegraph
    • .treemap
    • .vector
    • .venn
    • .wordcloud
  • .dependencywheel
  • .disparity_index
  • .dmi
  • .dumbbell
  • .flags
  • .funnel
  • .gauge
  • .Heatmap
  • .histogram
  • .hlc
  • .item
  • .labels
  • .linear_regressions
  • .momentum
    • .ikh
    • .macd
    • .supertrend
  • .networkgraph
  • .oscillators
    • .ao
    • .klinger
    • .money_flow
    • .ppo
    • .stochastic
  • .organization
  • .packedbubble
  • .pareto
  • .pictorial
  • .pie
  • .pivot_points
  • .polygon
  • .price_envelopes
  • .psar
  • .pyramid
  • .sankey
  • .scatter
  • .series_generator
  • .spline
  • .sunburst
  • .timeline
  • .treegraph
  • .treemap
  • .vbp
  • .vector
  • .venn
  • .wordcloud
  • .zigzag
• .options.sonification
  • .grouping
  • .mapping
  • .track_configurations
• .stock_tools
  • .definitions
• .subtitle
• .time
• .title
• .tooltips

---

class: HighchartsMaOptions

class HighchartsStockOptions(**kwargs)

The Python representation of the Highcharts Stock configuration object.

Class Inheritance

add_series(*series)

Adds series to the series property.

Parameters:

series (one or more SeriesBase or coercable) – One or more series instances (descended from SeriesBase) or an instance (e.g. dict, str, etc.) coercable to one

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

classmethod from_series(*series, kwargs=None)

Creates a new Options instance populated with series.

Parameters:

• series (one or more SeriesBase or coercable) – One or more series instances (descended from SeriesBase) or an instance (e.g. dict, str, etc.) coercable to one

• kwargs (dict) –

  Other properties to use as keyword arguments for the instance to be created.

  Warning

  If kwargs sets the .series property, that setting will be overridden by the contents of series.

Returns:

A new Options instance

Return type:

Options

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:

include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.

Return type:

list of str

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', careful_validation=False) → 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'.

• careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

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, context: str = None) → 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.

• context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None)

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.

• context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Return type:

iterable

property accessibility: Accessibility | None

Options for configuring accessibility for the chart.

Note

Requires the accessibility module to be loaded in the browser. For a description of the module and information on its features, see Highcharts Accessibility.

Returns:

The accessibility configuration for the chart or None

Return type:

Accessibility / None

Raises:

HighchartsError – if setting the value to an incompatible type

property annotations: List[Annotation] | None

A basic type of an annotation. It allows adding custom labels or shapes. The items can be tied to points, axis coordinates or chart pixel coordinates.

Returns:

A collection of the annotations applied to the chart.

Return type:

list of Annotation objects or None if no annotations are applied

property boost: Boost | None

Options for the Boost module.

The Boost module allows certain series types to be rendered by WebGL instead of the default SVG. This allows hundreds of thousands of data points to be rendered in milliseconds. In addition to the WebGL rendering it saves time by skipping processing and inspection of the data wherever possible.

Warning

This introduces some limitations to what features are available in boost mode. See the docs for details.

Returns:

The Boost object.

Return type:

Boost

property caption: Caption | None

The chart’s caption, which will render below the chart and will be part of exported charts.

Note

The caption can be updated after chart initialization through the Chart.update or Chart.caption.update JavaScript methods.

Returns:

The chart’s caption or None

Return type:

Caption / None

property chart: ChartOptions | None

General options for the chart.

Note

This property is perhaps one of the most important properties you will use when configuring your Highcharts data visualization.

Returns:

A ChartOptions configuration object or None

Return type:

ChartOptions or None

property color_axis: List[ColorAxis] | None

A color axis for series.

Visually, the color axis will appear as a gradient or as separate items inside the legend, depending on whether the axis is scalar or based on data classes.

A scalar color axis is represented by a gradient. The colors either range between the minimum_color and the maximum_color, or for more fine grained control the colors can be defined in stops. Often times, the color axis needs to be adjusted to get the right color spread for the data. In addition to stops, consider using a logarithmic axis type, or setting min and max to avoid the colors being determined by outliers.

For supported color formats, please see the documentation article about colors.

When data_classes are used, the ranges are subdivided into separate classes like categories based on their values. This can be used for ranges between two values, but also for a true category. However, when your data is categorized, it may be as convenient to add each category to a separate series.

Warning

Color axis does not work with: sankey, sunburst, dependencywheel, networkgraph, wordcloud, venn, gauge and solidgauge series types.

See the Axis object for programmatic access to the axis.

Returns:

A collection of ColorAxis objects defining the color axis to apply, or None.

Return type:

list of ColorAxis or None

property colors: List[str | Gradient | Pattern] | None

An array containing the default colors for the chart’s series.

When all colors are used, new colors are pulled from the start again.

Default colors can also be set on a series or series.type basis, see Column.colors and Pie.colors.

Warning

In styled mode, the colors option does not exist.

Instead, colors are defined in CSS and applied either through series or point class names, or through the Chart.color_count option.

Defaults to:

[
    "#7cb5ec",
    "#434348",
    "#90ed7d",
    "#f7a35c",
    "#8085e9",
    "#f15c80",
    "#e4d354",
    "#2b908f",
    "#f45b5b",
    "#91e8e1"
]

Returns:

A collection of hex color strings.

Return type:

list of str

property credits: Credits | None

Highchart by default puts a credits label in the lower right corner of the chart. This can be changed using these options.

Returns:

Credits configuration or None

Return type:

Credits or None

property data: Data | None

The data property provides a simplified interface for adding data to a chart from sources like CVS, HTML tables, or grid views. See also the tutorial article on the Data module.

Warning

It requires the modules/data.js file to be loaded in the browser / client.

Warning

Please note that the default way of adding data in Highcharts, without the need of a module, is through the series.type.data property.

Returns:

The Data object or None

Return type:

Data object or None

property defs: MarkerDefinition | None

Options for configuring markers for annotations.

Returns:

A MarkerDefinition object or None

Return type:

MarkerDefinition or None

property drilldown: Drilldown | None

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.

Returns:

The options to configure the chart’s drill down functionality.

Return type:

Drilldown or None

property exporting: Exporting | None

Options to configure the export functionality enabled for the chart.

Returns:

The configuration of the chart’s exporting functionality.

Return type:

Exporting or None

property language: Language | None

Language object which can be used to configure the specific text to use in the chart.

Note

When working in JavaScript, the lang configuration is global and it can’t be set on each chart initialization.

Instead, use Highcharts.setOptions() to set it before any chart is initialized.

Returns:

A Language object or None

Return type:

Language or None

property legend: Legend | None

The legend is a box containing a symbol and name for each series item or point item in the chart. Each series (or points in case of pie charts) is represented by a symbol and its name in the legend.

See also

It is possible to override the symbol creator function and create custom legend symbols.

Returns:

The Legend configuration or None

Return type:

Legend or None

property loading: Loading | None

The loading options control the appearance of the loading screen that covers the plot area on chart operations.

This screen only appears after an explicit call to chart.showLoading() in the browser. It is a utility for developers to communicate to the end user that something is going on, for example while retrieving new data via an XHR connection.

Hint

The “Loading…” text itself is not part of this configuration object, but is instead part of the .language configuration.

Returns:

The configuration of the loading screen or None

Return type:

Loading or None

property navigation: Navigation | None

A collection of options for buttons and menus appearing in the exporting module or in Stock Tools.

Returns:

The configuration of the navigation buttons.

Return type:

;class:Navigation or None

property navigator: Navigator | None

The navigator is a small series below the main series, displaying a view of the entire data set. It provides tools to zoom in and out on parts of the data as well as panning across the dataset.

Returns:

Configuration instructions for the Navigator functionality.

Return type:

Navigator or None

property no_data: NoData | None

Options for displaying a message like “No data to display”.

Warning

This feature requires the file no-data-to-display.js to be loaded in the page.

Tip

The actual text to display is set in the language options.

Returns:

Configuration of how to display a no data message.

Return type:

NoData or None

property pane: Pane | None

The pane serves as a container for axes and backgrounds for circular gauges and polar charts.

Returns:

The Pane configuration options.

Return type:

Pane or None

property plot_options: PlotOptions | None

A wrapper object for configurations applied to each series type.

The config objects for each series can also be overridden for each series item as given in the series array.

Configuration options for the series are given in three levels:

• Options for all series in a chart are given in the series property.

• Options for all series of a specific type are given in the corresponding property for that type, for example plot_options.line.

• Finally, options for one single series are given in the series array.

Returns:

Configurations for how series should be plotted / displayed.

Return type:

PlotOptions or None

property range_selector: RangeSelector | None

The range selector is a tool for selecting ranges to display within the chart. It provides buttons to select preconfigured ranges in the chart, like 1 day, 1 week, 1 month etc. It also provides input boxes where min and max dates can be manually input.

Returns:

Configuration instructions for the Range Selector functionality.

Return type:

RangeSelector or None

property responsive: Responsive | None

Rules to apply for different screen or chart sizes.

Note

Each rule specifies additional chart options.

Returns:

Rules to apply for different screen or chart sizes.

Return type:

Responsive or None

property scrollbar: Scrollbar | None

The scrollbar is a means of panning over the X axis of a stock chart.

Note

Scrollbars can also be applied to other types of axes.

Note

Another approach to scrollable charts is the Chart.scrollable_plot_area() option that is especially suitable for simpler cartesian charts on mobile.

In styled mode, all the presentational options for the scrollbar are replaced by the classes .highcharts-scrollbar-thumb, .highcharts-scrollbar-arrow, .highcharts-scrollbar-button, .highcharts-scrollbar-rifles and .highcharts-scrollbar-track.

Returns:

The configuration options for the Scrollbar functionality.

Return type:

Scrollbar or None

property series: List[GenericTypeOptions] | None

Series options for specific data and the data itself.

Returns:

The series to display along with configuration and data.

Return type:

Series or None

property sonification: SonificationOptions | None

Configuration of global sonification settings for the entire chart.

Return type:

SonificationOptions or None

property stock_tools: StockTools | None

Configure the stockTools GUI strings in the chart.

Warning

Requires the stockTools module <https://api.highcharts.com/highstock/>`_ to be loaded in the client/browser.

See also

For a description of the module and information on its features, see Highcharts StockTools.

Returns:

The configuration options for the StockTools functionality.

Return type:

StockTools or None

property subtitle: Subtitle | None

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.

Warning

The subtitle can be updated after chart initialization through the Chart.setTitle JavaScript method.

Returns:

Configuration of the chart’s subtitle.

Return type:

Subtitle or None

property time: Time | None

Time options that can apply globally or to individual charts. These settings affect how datetime axes are laid out, how tooltips are formatted, how series point_interval_unit <Series.point_interval_unit() works and how the Highcharts Stock range selector handles time.

Returns:

Configuration of applicable Time options.

Return type:

Time or None

property title: Title | None

Options for configuring the chart’s main title.

Returns:

Configuration of the chart’s main title.

Return type:

Title or None

property tooltip: Tooltip | None

Options for the tooltip that appears when the user hovers over a series or point.

Returns:

Configuration settings for tooltips to display above the chart.

Return type:

Tooltip or None

property x_axis: List[XAxis] | None

The X axis or category axis.

Normally this is the horizontal axis, though if the chart is inverted this is the vertical axis.

Returns:

A collection of XAxis objects

Return type:

list of XAxis or None

property y_axis: List[YAxis] | None

The Y axis or value axis.

Normally this is the vertical axis, though if the chart is inverted this is the horizontal axis.

Returns:

A collection of YAxis objects

Return type:

list of YAxis or None

property z_axis: List[ZAxis] | None

The Z axis or depth axis for 3D plots.

Returns:

A collection of ZAxis objects

Return type:

list of ZAxis or None

---

class: HighchartsOptions

class HighchartsOptions(**kwargs)

The Python representation of the Highcharts options configuration object.

Class Inheritance

add_series(*series)

Adds series to the series property.

Parameters:

series (one or more SeriesBase or coercable) – One or more series instances (descended from SeriesBase) or an instance (e.g. dict, str, etc.) coercable to one

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

classmethod from_series(*series, kwargs=None)

Creates a new Options instance populated with series.

Parameters:

• series (one or more SeriesBase or coercable) – One or more series instances (descended from SeriesBase) or an instance (e.g. dict, str, etc.) coercable to one

• kwargs (dict) –

  Other properties to use as keyword arguments for the instance to be created.

  Warning

  If kwargs sets the .series property, that setting will be overridden by the contents of series.

Returns:

A new Options instance

Return type:

Options

get_required_modules(include_extension=False) → List[str]

Return the list of URLs from which the Highcharts JavaScript modules needed to render the chart can be retrieved.

Parameters:

include_extension (bool) – if True, will return script names with the '.js' extension included. Defaults to False.

Return type:

list of str

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', careful_validation=False) → 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'.

• careful_validation – if True, will carefully validate JavaScript values

along the way using the esprima-python library. Defaults to False.

Warning

Setting this value to True will significantly degrade serialization performance, though it may prove useful for debugging purposes.

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, context: str = None) → 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.

• context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None)

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.

• context (str or None) – If provided, will inform the method of the context in which it is being run which may inform special handling cases (e.g. where empty strings may be important / allowable). Defaults to None.

Return type:

iterable

property accessibility: Accessibility | None

Options for configuring accessibility for the chart.

Note

Requires the accessibility module to be loaded in the browser. For a description of the module and information on its features, see Highcharts Accessibility.

Returns:

The accessibility configuration for the chart or None

Return type:

Accessibility / None

Raises:

HighchartsError – if setting the value to an incompatible type

property annotations: List[Annotation] | None

A basic type of an annotation. It allows adding custom labels or shapes. The items can be tied to points, axis coordinates or chart pixel coordinates.

Returns:

A collection of the annotations applied to the chart.

Return type:

list of Annotation objects or None if no annotations are applied

property boost: Boost | None

Options for the Boost module.

The Boost module allows certain series types to be rendered by WebGL instead of the default SVG. This allows hundreds of thousands of data points to be rendered in milliseconds. In addition to the WebGL rendering it saves time by skipping processing and inspection of the data wherever possible.

Warning

This introduces some limitations to what features are available in boost mode. See the docs for details.

Returns:

The Boost object.

Return type:

Boost

property caption: Caption | None

The chart’s caption, which will render below the chart and will be part of exported charts.

Note

The caption can be updated after chart initialization through the Chart.update or Chart.caption.update JavaScript methods.

Returns:

The chart’s caption or None

Return type:

Caption / None

property chart: ChartOptions | None

General options for the chart.

Note

This property is perhaps one of the most important properties you will use when configuring your Highcharts data visualization.

Returns:

A ChartOptions configuration object or None

Return type:

ChartOptions or None

property color_axis: List[ColorAxis] | None

A color axis for series.

Visually, the color axis will appear as a gradient or as separate items inside the legend, depending on whether the axis is scalar or based on data classes.

A scalar color axis is represented by a gradient. The colors either range between the minimum_color and the maximum_color, or for more fine grained control the colors can be defined in stops. Often times, the color axis needs to be adjusted to get the right color spread for the data. In addition to stops, consider using a logarithmic axis type, or setting min and max to avoid the colors being determined by outliers.

For supported color formats, please see the documentation article about colors.

When data_classes are used, the ranges are subdivided into separate classes like categories based on their values. This can be used for ranges between two values, but also for a true category. However, when your data is categorized, it may be as convenient to add each category to a separate series.

Warning

Color axis does not work with: sankey, sunburst, dependencywheel, networkgraph, wordcloud, venn, gauge and solidgauge series types.

See the Axis object for programmatic access to the axis.

Returns:

A collection of ColorAxis objects defining the color axis to apply, or None.

Return type:

list of ColorAxis or None

property colors: List[str | Gradient | Pattern] | None

An array containing the default colors for the chart’s series.

When all colors are used, new colors are pulled from the start again.

Default colors can also be set on a series or series.type basis, see Column.colors and Pie.colors.

Warning

In styled mode, the colors option does not exist.

Instead, colors are defined in CSS and applied either through series or point class names, or through the Chart.color_count option.

Defaults to:

[
    "#7cb5ec",
    "#434348",
    "#90ed7d",
    "#f7a35c",
    "#8085e9",
    "#f15c80",
    "#e4d354",
    "#2b908f",
    "#f45b5b",
    "#91e8e1"
]

Returns:

A collection of hex color strings.

Return type:

list of str

property credits: Credits | None

Highchart by default puts a credits label in the lower right corner of the chart. This can be changed using these options.

Returns:

Credits configuration or None

Return type:

Credits or None

property data: Data | None

The data property provides a simplified interface for adding data to a chart from sources like CVS, HTML tables, or grid views. See also the tutorial article on the Data module.

Warning

It requires the modules/data.js file to be loaded in the browser / client.

Warning

Please note that the default way of adding data in Highcharts, without the need of a module, is through the series.type.data property.

Returns:

The Data object or None

Return type:

Data object or None

property defs: MarkerDefinition | None

Options for configuring markers for annotations.

Returns:

A MarkerDefinition object or None

Return type:

MarkerDefinition or None

property drilldown: Drilldown | None

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.

Returns:

The options to configure the chart’s drill down functionality.

Return type:

Drilldown or None

property exporting: Exporting | None

Options to configure the export functionality enabled for the chart.

Returns:

The configuration of the chart’s exporting functionality.

Return type:

Exporting or None

property language: Language | None

Language object which can be used to configure the specific text to use in the chart.

Note

When working in JavaScript, the lang configuration is global and it can’t be set on each chart initialization.

Instead, use Highcharts.setOptions() to set it before any chart is initialized.

Returns:

A Language object or None

Return type:

Language or None

property legend: Legend | None

The legend is a box containing a symbol and name for each series item or point item in the chart. Each series (or points in case of pie charts) is represented by a symbol and its name in the legend.

See also

It is possible to override the symbol creator function and create custom legend symbols.

Returns:

The Legend configuration or None

Return type:

Legend or None

property loading: Loading | None

The loading options control the appearance of the loading screen that covers the plot area on chart operations.

This screen only appears after an explicit call to chart.showLoading() in the browser. It is a utility for developers to communicate to the end user that something is going on, for example while retrieving new data via an XHR connection.

Hint

The “Loading…” text itself is not part of this configuration object, but is instead part of the .language configuration.

Returns:

The configuration of the loading screen or None

Return type:

Loading or None

property navigation: Navigation | None

A collection of options for buttons and menus appearing in the exporting module or in Stock Tools.

Returns:

The configuration of the navigation buttons.

Return type:

;class:Navigation or None

property no_data: NoData | None

Options for displaying a message like “No data to display”.

Warning

This feature requires the file no-data-to-display.js to be loaded in the page.

Tip

The actual text to display is set in the language options.

Returns:

Configuration of how to display a no data message.

Return type:

NoData or None

property pane: Pane | None

The pane serves as a container for axes and backgrounds for circular gauges and polar charts.

Returns:

The Pane configuration options.

Return type:

Pane or None

property plot_options: PlotOptions | None

A wrapper object for configurations applied to each series type.

The config objects for each series can also be overridden for each series item as given in the series array.

Configuration options for the series are given in three levels:

• Options for all series in a chart are given in the series property.

• Options for all series of a specific type are given in the corresponding property for that type, for example plot_options.line.

• Finally, options for one single series are given in the series array.

Returns:

Configurations for how series should be plotted / displayed.

Return type:

PlotOptions or None

property responsive: Responsive | None

Rules to apply for different screen or chart sizes.

Note

Each rule specifies additional chart options.

Returns:

Rules to apply for different screen or chart sizes.

Return type:

Responsive or None

property series: List[GenericTypeOptions] | None

Series options for specific data and the data itself.

Returns:

The series to display along with configuration and data.

Return type:

Series or None

property sonification: SonificationOptions | None

Configuration of global sonification settings for the entire chart.

Return type:

SonificationOptions or None

property subtitle: Subtitle | None

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.

Warning

The subtitle can be updated after chart initialization through the Chart.setTitle JavaScript method.

Returns:

Configuration of the chart’s subtitle.

Return type:

Subtitle or None

property time: Time | None

Time options that can apply globally or to individual charts. These settings affect how datetime axes are laid out, how tooltips are formatted, how series point_interval_unit <Series.point_interval_unit() works and how the Highcharts Stock range selector handles time.

Returns:

Configuration of applicable Time options.

Return type:

Time or None

property title: Title | None

Options for configuring the chart’s main title.

Returns:

Configuration of the chart’s main title.

Return type:

Title or None

property tooltip: Tooltip | None

Options for the tooltip that appears when the user hovers over a series or point.

Returns:

Configuration settings for tooltips to display above the chart.

Return type:

Tooltip or None

property x_axis: List[XAxis] | None

The X axis or category axis.

Normally this is the horizontal axis, though if the chart is inverted this is the vertical axis.

Returns:

A collection of XAxis objects

Return type:

list of XAxis or None

property y_axis: List[YAxis] | None

The Y axis or value axis.

Normally this is the vertical axis, though if the chart is inverted this is the horizontal axis.

Returns:

A collection of YAxis objects

Return type:

list of YAxis or None

property z_axis: List[ZAxis] | None

The Z axis or depth axis for 3D plots.

Returns:

A collection of ZAxis objects

Return type:

list of ZAxis or None

---

Sub-components

Module	Classes / Functions
.options	HighchartsStockOptions HighchartsOptions Options
.options.accessibility	Accessibility CustomAccessibilityComponents
.options.accessibility.announce_new_data	AnnounceNewData
.options.accessibility.keyboard_navigation	KeyboardNavigation
.options.accessibility.keyboard_navigation.focus_border	FocusBorder FocusBorderStyle
.options.accessibility.keyboard_navigation.series_navigation	SeriesNavigation
options.accessibility.point	AccessibilityPoint
options.accessibility.screen_reader_section	ScreenReaderSection
options.accessibility.series	SeriesAccessibility
.options.annotations	Annotation
.options.annotations.animation	AnnotationAnimation
.options.annotations.control_point_options	AnnotationControlPointOption
.options.annotations.events	AnnotationEvent
.options.annotations.label_options	AnnotationLabel AnnotationLabelOptionAccessibility LabelOptions
.options.annotations.options.annotations.points	AnnotationPoint
.options.annotations.shape_options	AnnotationShape ShapeOptions
.options.annotations.stock_tools	CrookedLineAnnotation ElliottWaveAnnotation FibonacciAnnotation FibonacciTimeZonesAnnotation InfinityLineAnnotation MeasureAnnotation PitchforkAnnotation TimeCyclesAnnotation TunnelAnnotation VerticalLineAnnotation
.options.annotations.stock_tools.type_options
.options.annotations.stock_tools.type_options.crooked_line	CrookedLineTypeOptions InfinityLineTypeOptions
.options.annotations.stock_tools.type_options.elliot_wave	ElliottWaveTypeOptions
.options.annotations.stock_tools.type_options.fibonacci	FibonacciTypeOptions FibonacciTimeZonesTypeOptions
.options.annotations.stock_tools.type_options.line	LineFillOnly LineStrokeWidth LineStrokeWidthStroke
.options.annotations.stock_tools.type_options.measure	MeasureTypeOptions MeasureLabelOptions MeasureLabelStyle
.options.annotations.stock_tools.type_options.pitchfork	PitchforkTypeOptions
.options.annotations.stock_tools.type_options.points	StockToolsPoint LabeledStockToolsPoint StockToolsXPoint
.options.annotations.stock_tools.type_options.time_cycles	TimeCyclesTypeOptions
.options.annotations.stock_tools.type_options.tunnel	TunnelTypeOptions
.options.annotations.stock_tools.type_options.vertical_line	VerticalLineTypeOptions VerticalLineConnector
.options.axes
.options.axes.accessibility	AxisAccessibility
.options.axes.breaks	AxisBreak
.options.axes.color_axis	ColorAxis
.options.axes.crosshair	CrosshairOptions
.options.axes.data_classes	DataClass
.options.axes.generic	GenericAxis
.options.axes.labels	AxisLabelOptions PlotBandLabel PlotLineLabel
.options.axes.markers	AxisMarker
.options.axes.numeric	NumericAxis
.options.axes.parallel_axes	ParallelAxesOptions
.options.axes.plot_bands	PlotBand PlotLine
.options.axes.resize	ResizeOptions ControlledAxis
.options.axes.title	AxisTitle
.options.axes.x_axis	XAxis
.options.axes.y_axis	YAxis
.options.axes.z_axis	ZAxis
.options.boost	Boost BoostDebug
.options.caption	Caption
.options.chart	ChartOptions PanningOptions
.chart.options_3d	Options3D Frame PanelOptions
.options.chart.reset_zoom_button	ResetZoomButtonOptions
.chart.scrollable_plot_area	ScrollablePlotArea
.options.chart.zooming	ZoomingOptions
.options.credits	Credits CreditStyleOptions
.options.data	Data
.options.defs	MarkerDefinition MarkerASTNode MarkerAttributeObject
.options.drilldown	Drilldown
.options.exporting	Exporting ExportingAccessibilityOptions
.options.exporting.csv	ExportingCSV CSVAnnotationOptions
.options.exporting.exporting.pdf_font	PDFFontOptions
.options.legend	Legend
.options.legend.accessibility	LegendAccessibilityOptions LegendKeyboardNavigation
.options.legend.bubble_legend	BubbleLegend BubbleLegendRange BubbleLegendLabelOptions
.options.legend.navigation	LegendNavigation
.options.legend.title	LegendTitle
.options.loading	Loading
.options.navigation	Navigation
.options.navigation.bindings	Bindings RectangleAnnotationBinding LabelAnnotationBinding EllipseAnnotationBinding CircleAnnotationBinding Binding
.options.navigator	Navigator HandleOptions NavigatorAccessibilityOptions
.options.no_data	NoData
.options.pane	Pane PaneBackground
.options.plot_options	PlotOptions
.options.plot_options.abands	AbandsOptions BBOptions KeltnerChannelsOptions PCOptions AbandsStyleOptions
.options.plot_options.accessibility	TypeOptionsAccessibility SeriesKeyboardNavigation
.options.plot_options.ad	ADOptions ADParameters
.options.plot_options.arcdiagram	ArcDiagramOptions
.options.plot_options.area	AreaOptions AreaRangeOptions AreaSplineOptions AreaSplineRangeOptions LineOptions StreamGraphOptions
.options.plot_options.aroon	AroonOptions AroonLineStyleOptions
.options.plot_options.atr	ATROptions NATROptions
.options.plot_options.averages	DEMAOptions EMAOptions SMAOptions TEMAOptions VWAPOptions WMAOptions VWAPParameters
.options.plot_options.bar	BarOptions ColumnOptions ColumnPyramidOptions ColumnRangeOptions CylinderOptions VariwideOptions WaterfallOptions WindBarbOptions XRangeOptions BaseBarOptions
.options.plot_options.base	NonIndicatorOptions NavigatorIndicatorOptions StockBaseOptions
.options.plot_options.bellcurve	BellCurveOptions
.options.plot_options.boxplot	BoxPlotOptions ErrorBarOptions
.options.plot_options.bubble	BubbleOptions
.options.plot_options.bullet	BulletOptions TargetOptions
.options.plot_options.candlestick	CandlestickOptions HollowCandlestickOptions HeikinAshiOptions
.options.plot_options.data_sorting	DataSorting
.options.plot_options.dependencywheel	DependencyWheelOptions
.options.plot_options.disparity_index	DisparityIndexOptions DisparityIndexParameters
.options.plot_options.dmi	DMIOptions DMIStyleOptions
.options.plot_options.drag_drop	DragDropOptions HighLowDragDropOptions BoxPlotDragDropOptions BulletDragDropOptions GuideBox GuideBoxOptions DragHandle
.options.plot_options.dumbbell	DumbbellOptions LollipopOptions
.options.plot_options.flags	FlagsOptions
.options.plot_options.funnel	FunnelOptions Funnel3DOptions
.options.plot_options.gauge	GaugeOptions SolidGaugeOptions
.options.plot_options.generic	GenericTypeOptions
.options.plot_options.heatmap	HeatmapOptions TilemapOptions
.options.plot_options.histogram	HistogramOptions
.options.plot_options.hlc	HLCOptions OHLCOptions
.options.plot_options.indicators	IndicatorOptions ComparableIndicatorOptions ParameterBase
.options.plot_options.item	ItemOptions
.options.plot_options.levels	LevelOptions SunburstLevelOptions TreemapLevelOptions LevelSize ColorVariation BaseLevelOptions
.options.plot_options.linear_regressions	LinearRegressionOptions LinearRegressionAngleOptions LinearRegressionInterceptOptions LinearRegressionSlopeOptions TrendlineOptions LinearRegressionParameters TrendlineParameters
.options.plot_options.link	LinkOptions
.options.plot_options.momentum	MomentumOptions OBVOptions OBVParameters ROCOptions RSIOptions RSIParameters
.options.plot_options.momentum.ikh	IKHOptions IKHParameters SenkouSpanOptions IKHLineOptions
.options.plot_options.momentum.macd	MACDOptions MACDParameters MACDLineOptions
.options.plot_options.momentum.supertrend	SupertrendOptions SupertrendParameters SupertrendLineOptions
.options.plot_options.networkgraph	NetworkGraphOptions LayoutAlgorithm
.options.plot_options.organization	OrganizationOptions
.options.plot_options.oscillators	AroonOscillatorOptions APOOptions CCIOptions ChaikinOptions CMOOptions DPOOptions TRIXOptions WilliamsROptions WilliamsRParameters
.options.plot_options.oscillators.ao	AOOptions
.options.plot_options.oscillators.klinger	KlingerOptions KlingerParameters KlingerLineOptions
.options.plot_options.oscillators.money_flow	MFIOptions MFIParameters CMFOptions
.options.plot_options.oscillators.ppo	PPOOptions PPOParameters
.options.plot_options.oscillators.stochastic	StochasticOptions StochasticParameters SlowStochasticOptions SlowStochasticParameters StochasticStyleOptions
.options.plot_options.packedbubble	PackedBubbleOptions ParentNodeOptions
.options.plot_options.pareto	ParetoOptions
.options.plot_options.pictorial	PictorialOptions
.options.plot_options.pie	PieOptions VariablePieOptions
.options.plot_options.pivot_points	PivotPointsOptions PivotPointsParameters
.options.plot_options.points	Point OnPointOptions ConnectorOptions
.options.plot_options.polygon	PolygonOptions
.options.plot_options.price_envelopes	PriceEnvelopesOptions PriceEnvelopesParameters PriceEnvelopesStyleOptions
.options.plot_options.psar	PSAROptions PSARParameters
.options.plot_options.pyramid	PyramidOptions Pyramid3DOptions
.options.plot_options.sankey	SankeyOptions
.options.plot_options.scatter	ScatterOptions Scatter3DOptions
.options.plot_options.series	SeriesOptions
.options.plot_options.sonification	SeriesSonification
.options.plot_options.spline	SplineOptions
.options.plot_options.sunburst	SunburstOptions
.options.plot_options.timeline	TimelineOptions
.options.plot_options.treemap	TreemapOptions
.options.plot_options.vbp	VBPOptions VBPParameters ZoneLinesOptions VolumeDivisionOptions VolumeDivisionStyles
.options.plot_options.vector	VectorOptions
.options.plot_options.venn	VennOptions
.options.plot_options.wordcloud	WordcloudOptions RotationOptions
.options.plot_options.zigzag	ZigZagOptions ZigZagParameters
.options.responsive	Responsive ResponsiveRules Condition
.options.series
.options.series.abands	AbandsSeries BBSeries KeltnerChannelsSeries PCSeries
.options.series.ad	ADSeries
.options.series.arcdiagram	ArcDiagramSeries
.options.series.area	AreaSeries AreaRangeSeries AreaSplineSeries AreaSplineRangeSeries LineSeries StreamGraphSeries
.options.series.aroon	AroonSeries
.options.series.atr	ATRSeries NATRSeries
.options.series.averages	DEMASeries EMASeries SMASeries TEMASeries VWAPSeries WMASeries
.options.series.bar	BarSeries ColumnSeries ColumnPyramidSeries ColumnRangeSeries CylinderSeries VariwideSeries WaterfallSeries WindBarbSeries XRangeSeries BaseBarSeries
.options.series.base	SeriesBase IndicatorSeriesBase NavigatorIndicatorSeries IndicatorFactoryMixin
.options.series.bellcurve	BellCurveSeries
.options.series.boxplot	BoxPlotSeries ErrorBarSeries
.options.series.bubble	BubbleSeries
.options.series.bullet	BulletSeries
.options.series.candlestick	CandlestickSeries HollowCandlestickSeries HeikinAshiSeries
.options.series.data
.options.series.data.accessibility	DataPointAccessibility
.options.series.data.arcdiagram	ArcDiagramData
.options.series.data.bar	BarData WaterfallData WindBarbData XRangeData
.options.series.data.base	DataBase
.options.series.data.boxplot	BoxPlotData
.options.series.data.bullet	BulletData
.options.series.data.candlestick	CandlestickData
.options.series.data.cartesian	CartesianData Cartesian3DData CartesianValueData
.options.series.data.connections	ConnectionData WeightedConnectionData OutgoingWeightedConnectionData ConnectionBase
.options.series.data.hlc	HLCData OHLCData
.options.series.data.pie	PieData VariablePieData
.options.series.data.range	RangeData ConnectedRangeData
.options.series.data.single_point	SinglePointData SingleValueData SingleXData LabeledSingleXData ConnectedSingleXData SinglePointBase
.options.series.data.sunburst	SunburstData
.options.series.data.treemap	TreemapData
.options.series.data.vector	VectorData
.options.series.data.venn	VennData
.options.series.data.wordcloud	WordcloudData
.options.series.dependencywheel	DependencyWheelSeries
.options.series.disparity_index	DisparityIndexSeries
.options.series.dmi	DMISeries
.options.series.dumbbell	DumbbellSeries LollipopSeries
.options.series.flags	FlagsSeries
.options.series.funnel	FunnelSeries Funnel3DSeries
.options.series.gauge	GaugeSeries SolidGaugeSeries
.options.series.heatmap	HeatmapSeries TilemapSeries
.options.series.histogram	HistogramSeries
.options.series.hlc	HLCSeries OHLCSeries
.options.series.item	ItemSeries
.options.series.labels	SeriesLabel Box
.options.series.linear_regressions	LinearRegressionSeries LinearRegressionAngleSeries LinearRegressionInterceptSeries LinearRegressionSlopeSeries TrendlineSeries
.options.series.momentum	MomentumSeries OBVSeries ROCSeries RSISeries
.options.series.momentum.ikh	IKHSeries
.options.series.momentum.macd	MACDSeries
.options.series.momentum.supertrend	SupertrendSeries
.options.series.networkgraph	NetworkGraphSeries
.options.series.organization	OrganizationSeries
.options.series.oscillators	AroonOscillatorSeries APOSeries CCISeries ChaikinSeries CMOSeries DPOSeries TRIXSeries WilliamsRSeries
.options.series.oscillators.ao	AOSeries
.options.series.oscillators.klinger	KlingerSeries
.options.series.oscillators.money_flow	MFISeries CMFSeries
.options.series.oscillators.ppo	PPOSeries
.options.series.oscillators.stochastic	StochasticSeries SlowStochasticSeries
.options.series.packedbubble	PackedBubbleSeries
.options.series.pareto	ParetoSeries
.options.series.pictorial	PictorialSeries PictorialPaths
.options.series.pie	PieSeries VariablePieSeries
.options.series.pivot_points	PivotPointsSeries
.options.series.polygon	PolygonSeries
.options.series.price_envelopes	PriceEnvelopesSeries
.options.series.psar	PSARSeries
.options.series.pyramid	PyramidSeries Pyramid3DSeries
.options.series.sankey	SankeySeries
.options.series.scatter	ScatterSeries Scatter3DSeries
.options.series.series_generator	create_series_obj()
.options.series.spline	SplineSeries
.options.series.sunburst	SunburstSeries
.options.series.timeline	TimelineSeries
.options.series.treemap	TreemapSeries
.options.series.vbp	VBPSeries
.options.series.vector	VectorSeries
.options.series.venn	VennSeries
.options.series.wordcloud	WordcloudSeries
.options.series.zigzag	ZigZagSeries
.options.sonification	SonificationOptions
.options.sonification.grouping	PointGrouping
.options.sonification.mapping	SonificationMapping AudioParameter AudioFilter PitchParameter TremoloEffect
.options.sonification.track_configurations	InstrumentTrackConfiguration SpeechTrackConfiguration ContextTrackConfiguration TrackConfigurationBase ActiveWhen
.options.stock_tools	StockTools StockToolsGUI
.options.stock_tools.definitions	StockToolsDefinitions AdvancedDefinitions CrookedLinesDefinitions FlagsDefinitions LinesDefinitions MeasureDefinitions SimpleShapesDefinitions TypeChangeDefinitions VerticalLabelsDefinitions ZoomChangeDefinitions Definition
.options.subtitle	Subtitle
.options.time	Time
.options.title	Title
.options.tooltips	Tooltip