HighchartsTimeOptions class

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 pointIntervalUnit works and how the Highcharts Stock range selector handles time.

The common use case is that all charts in the same Highcharts object share the same time settings, in which case the global settings are set using setOptions.

Since v6.0.5, the time options were moved from the global object to the time object, and time options can be set on each individual chart.

API Docs: https://api.highcharts.com/highcharts/time

Inheritance

Constructors

HighchartsTimeOptions.new({dynamic date, String? timezone, double? timezoneOffset, String? useUTC})
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 pointIntervalUnit works and how the Highcharts Stock range selector handles time.

Properties

date ↔ dynamic
A custom Date class for advanced date handling. For example, JDate can be hooked in to handle Jalali dates.
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timezone ↔ String?
A named time zone. Supported time zone names rely on the browser implementations, as described in the mdn docs. If the given time zone is not recognized by the browser, Highcharts provides a warning and falls back to returning a 0 offset, corresponding to the UTC time zone.
getter/setter pair
timezoneOffset ↔ double?
The timezone offset in minutes. Positive values are west, negative values are east of UTC, as in the ECMAScript getTimezoneOffset method. Use this to display UTC based data in a predefined time zone.
getter/setter pair
useUTC ↔ String?
Whether to use UTC time for axis scaling, tickmark placement and time display in Highcharts.dateFormat. Advantages 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.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJSON() → String
Serializes the settings to a JSON string.
inherited
toOptionsJSON(StringBuffer buffer) → void
override
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited