.time

class: Time

class Time(**kwargs)[source]

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.

Class Inheritance
Inheritance diagram of Time

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 Date: JavaScriptClass | None

A custom JavaScript Date class for more sophisticated date handling. For example, JDate can be used to handle Jalali dates. Defaults to None.

Return type:

JavaScriptClass or None

property get_timezone_offset: CallbackFunction | None

A JavaScript callback function that returns the time zone offset for a given datetime. Defaults to None.

The function is expected to take a Unix timestamp (as number of milliseconds since January 1, 1970) as an argument and return the timezone offset in minutes.

Hint

This provides a hook for drawing time based charts in specific time zones using their local DST crossover dates, with the help of external libraries.

Warning

If Time.timezone() is specified, then this custom function will be overridden by an automatic function leveraging the moment.js library.

Return type:

CallbackFunction or None

property moment: CallbackFunction | None

A JavaScript function that can be used to manually load the moment.js library when initializing a chart, rather than loading it from within window or a <script/> tag. Defaults to None.

Note

The function expects no arguments and returns no result.

Warning

If loading moment.js is loaded from within a <script/> tag on the page, this setting can be left as None. Highcharts will still be able to access and use the library.

Return type:

CallbackFunction or None

property timezone: str | None

Indicates the timezone in which to render the chart. Defaults to None.

If this value is provided, Highcharts will override the setting for Time.get_timezone_offset() with a default function leveraging the moment.js library.

Warning

Requires moment.js to work properly. If moment.js is not available, this will throw a Highcharts error in the JavaScript console but will not prevent the chart from rendering.

Return type:

str or None

property timezone_offset: int | None

The timezone offset to apply in minutes. Defaults to 0.

Hint

Use this to display UTC data in a predefined timezone.

Note

Positive values are west of UTC. Negative values are east of UTC, as in the ECMAScript getTimezoneOffset() method.

Return type:

int or None

property use_utc: bool | None

If True, use UTC time for axis scaling, tickmark placement, and time display. Defaults to True.

Hint

The advantage of using UTC is that the time displays equally regardless of the user agent’s time zone settings. Local time can be used when the data is loaded in real time or when correct Daylight Saving Time transitions are required.

Return type:

bool or None