.navigation

---

class: NavigationLanguageOptions

class NavigationLanguageOptions(**kwargs)

The Popup strings used in the chart.

Note

Requires the annotations.js or annotations-advanced.src.js module to be loaded.

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

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', for_export: bool = False)

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'.

• for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

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, for_export: 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.

• 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.

• for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None, for_export: bool = 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.

• 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.

• for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Return type:

iterable

property popup: PopupLanguageOptions | None

Translations for all field names used in popup.

Return type:

PopupLanguageOptions or None

---

class: PopupLanguageOptions

class PopupLanguageOptions(**kwargs)

Translations for all field names used in popup.

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

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', for_export: bool = False)

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'.

• for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

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, for_export: 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.

• 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.

• for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Returns:

Trimmed dict

Return type:

dict

static trim_iterable(untrimmed, to_json=False, context: str = None, for_export: bool = 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.

• 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.

• for_export (bool) – If True, indicates that the method is being run to produce a JSON for consumption by the export server. Defaults to False.

Return type:

iterable

property add_button: str | None

Defaults to 'add'.

Return type:

str or None

property algorithm: str | None

Defaults to 'Algorithm'.

Return type:

str or None

property arrow_infinity_line: str | None

Defaults to 'Arrow line'.

Return type:

str or None

property arrow_ray: str | None

Defaults to 'Arrow ray'.

Return type:

str or None

property arrow_segment: str | None

Defaults to 'Arrow segment'.

Return type:

str or None

property average: str | None

Defaults to 'Average'.

Return type:

str or None

property background: str | None

Defaults to 'Background'.

Return type:

str or None

property background_color: str | None

Defaults to 'Background color'.

Return type:

str or None

property background_colors: str | None

Defaults to 'Background colors'.

Return type:

str or None

property border_color: str | None

Defaults to 'Border color'.

Return type:

str or None

property border_radius: str | None

Defaults to 'Border radius'.

Return type:

str or None

property border_width: str | None

Defaults to 'Border width'.

Return type:

str or None

property bottom_band: str | None

Defaults to 'Bottom band'.

Return type:

str or None

property circle: str | None

Defaults to 'Circle'.

Return type:

str or None

property clear_filter: str | None

Defaults to 'X Clear Filter'.

Return type:

str or None

property color: str | None

Defaults to 'Color'.

Return type:

str or None

property connector: str | None

Defaults to 'Connector'.

Return type:

str or None

property crooked3: str | None

Defaults to 'Crooked 3 line'.

Return type:

str or None

property crooked5: str | None

Defaults to 'Crooked 5 line'.

Return type:

str or None

property crosshairX: str | None

Defaults to 'Crosshair X'.

Return type:

str or None

property crosshairY: str | None

Defaults to 'Crosshair Y'.

Return type:

str or None

property decimals: str | None

Defaults to 'Decimals.

Return type:

str or None

property deviation: str | None

Defaults to 'Deviation'.

Return type:

str or None

property edit_button: str | None

Defaults to 'edit'.

Return type:

str or None

property elliott3: str | None

Defaults to 'Elliott 3 line'.

Return type:

str or None

property elliott5: str | None

Defaults to 'Elliott 5 line'.

Return type:

str or None

property ellipse: str | None

Defaults to 'Ellipse.

Return type:

str or None

property factor: str | None

Defaults to 'Factor.

Return type:

str or None

property fast_avg_period: str | None

Defaults to 'Fast average period'.

Return type:

str or None

property fibonacci: str | None

Defaults to 'Fibonacci.

Return type:

str or None

property fibonacci_time_zones: str | None

Defaults to 'Fibonacci Time Zones'.

Return type:

str or None

property fill: str | None

Defaults to 'Fill.

Return type:

str or None

property flags: str | None

Defaults to 'Flags.

Return type:

str or None

property font_size: str | None

Defaults to 'Font size'.

Return type:

str or None

property format: str | None

Defaults to 'Text'.

Return type:

str or None

property height: str | None

Defaults to 'Height.

Return type:

str or None

property high_index: str | None

Defaults to 'High index'.

Return type:

str or None

property horizontal_line: str | None

Defaults to 'Horizontal line'.

Return type:

str or None

property increment: str | None

Defaults to 'Increment.

Return type:

str or None

property index: str | None

Defaults to 'Index.

Return type:

str or None

property infinity_line: str | None

Defaults to 'Infinity line'.

Return type:

str or None

property initial_acceleration_factor: str | None

Defaults to 'Initial acceleration factor'.

Return type:

str or None

property inner_background: str | None

Defaults to 'Inner background'.

Return type:

str or None

property label: str | None

Defaults to 'Label.

Return type:

str or None

property label_options: str | None

Defaults to 'Label options'.

Return type:

str or None

property labels: str | None

Defaults to 'Labels.

Return type:

str or None

property line: str | None

Defaults to 'Line.

Return type:

str or None

property lines: str | None

Defaults to 'Lines.

Return type:

str or None

property long_period: str | None

Defaults to 'Long period'.

Return type:

str or None

property low_index: str | None

Defaults to 'Low index'.

Return type:

str or None

property max_acceleration_factor: str | None

Defaults to 'Max acceleration factor'.

Return type:

str or None

property measure: str | None

Defaults to 'Measure.

Return type:

str or None

property measure_x: str | None

Defaults to 'Measure X'.

Return type:

str or None

property measure_xy: str | None

Defaults to 'Measure XY'.

Return type:

str or None

property measure_y: str | None

Defaults to 'Measure Y'.

Return type:

str or None

property multiplier: str | None

Defaults to 'Multiplier.

Return type:

str or None

property multiplier_atr: str | None

Defaults to 'ATR multiplier'.

Return type:

str or None

property name: str | None

Defaults to 'Name.

Return type:

str or None

property no_filter_match: str | None

Defaults to 'No match'.

Return type:

str or None

property outer_background: str | None

Defaults to 'Outer background'.

Return type:

str or None

property padding: str | None

Defaults to 'Padding.

Return type:

str or None

property parallel_channel: str | None

Defaults to 'Parallel channel'.

Return type:

str or None

property period: str | None

Defaults to 'Period.

Return type:

str or None

property period_atr: str | None

Defaults to 'ATR period'.

Return type:

str or None

property period_senkou_span_b: str | None

Defaults to 'Senkou Span B period'.

Return type:

str or None

property period_tenkan: str | None

Defaults to 'Tenkan period'.

Return type:

str or None

property periods: str | None

Defaults to 'Periods.

Return type:

str or None

property pitchfork: str | None

Defaults to 'Pitchfork.

Return type:

str or None

property ranges: str | None

Defaults to 'Ranges.

Return type:

str or None

property ray: str | None

Defaults to 'Ray.

Return type:

str or None

property rectangle: str | None

Defaults to 'Rectangle.

Return type:

str or None

property remove_button: str | None

Defaults to 'remove'.

Return type:

str or None

property save_button: str | None

Defaults to 'save'.

Return type:

str or None

property search_indicators: str | None

Defaults to 'Search Indicators'.

Return type:

str or None

property segment: str | None

Defaults to 'Segment.

Return type:

str or None

property series: str | None

Defaults to 'Series.

Return type:

str or None

property shape_options: str | None

Defaults to 'Shape options'.

Return type:

str or None

property shapes: str | None

Defaults to 'Shapes.

Return type:

str or None

property short_period: str | None

Defaults to 'Short period'.

Return type:

str or None

property signal_period: str | None

Defaults to 'Signal period'.

Return type:

str or None

property simple_shapes: str | None

Defaults to 'Simple shapes'.

Return type:

str or None

property slow_avg_period: str | None

Defaults to 'Slow average period'.

Return type:

str or None

property standard_deviation: str | None

Defaults to 'Standard deviation'.

Return type:

str or None

property stroke: str | None

Defaults to 'Line color'.

Return type:

str or None

property stroke_width: str | None

Defaults to 'Line width'.

Return type:

str or None

property style: str | dict | None

Defaults to 'Style.

Return type:

str or dict or None

property time_cycles: str | None

Defaults to 'Time Cycles'.

Return type:

str or None

property title: str | None

Defaults to 'Title.

Return type:

str or None

property top_band: str | None

Defaults to 'Top band'.

Return type:

str or None

property tunnel: str | None

Defaults to 'Tunnel.

Return type:

str or None

property type_options: str | None

Defaults to 'Details'.

Return type:

str or None

property vertical_arrow: str | None

Defaults to 'Vertical arrow'.

Return type:

str or None

property vertical_counter: str | None

Defaults to 'Vertical counter'.

Return type:

str or None

property vertical_label: str | None

Defaults to 'Vertical label'.

Return type:

str or None

property vertical_line: str | None

Defaults to 'Vertical line'.

Return type:

str or None

property volume: str | None

Defaults to 'Volume'.

Return type:

str or None

property x_axis_unit: str | None

Defaults to 'x-axis unit'.

Return type:

str or None