Class: Time

// Apply time settings globally
Highcharts.setOptions({
    time: {
        timezone: 'Europe/London'
    }
});

// Apply time settings by instance
let chart = Highcharts.chart('container', {
    time: {
        timezone: 'America/New_York'
    },
    series: [{
        data: [1, 4, 3, 5]
    }]
});

// Use the Time object
console.log(
       'Current time in New York',
       chart.time.dateFormat('%Y-%m-%d %H:%M:%S', Date.now())
);

Methods

dateFormat(format [, timestamp] [, capitalize])

Formats a JavaScript date timestamp (milliseconds since Jan 1st 1970) into a human readable date string. The available format keys are listed below. Additional formats can be given in the Highcharts.dateFormats hook.

Supported format keys:

• %a: Short weekday, like 'Mon'
• %A: Long weekday, like 'Monday'
• %d: Two digit day of the month, 01 to 31
• %e: Day of the month, 1 through 31
• %w: Day of the week, 0 through 6
• %b: Short month, like 'Jan'
• %B: Long month, like 'January'
• %m: Two digit month number, 01 through 12
• %y: Two digits year, like 09 for 2009
• %Y: Four digits year, like 2009
• %H: Two digits hours in 24h format, 00 through 23
• %k: Hours in 24h format, 0 through 23
• %I: Two digits hours in 12h format, 00 through 11
• %l: Hours in 12h format, 1 through 12
• %M: Two digits minutes, 00 through 59
• %p: Upper case AM or PM
• %P: Lower case AM or PM
• %S: Two digits seconds, 00 through 59
• %L: Milliseconds (naming from Ruby)

Parameters:

Name	Type	Argument	Default	Description
format	string			The desired format where various time representations are prefixed with %.
timestamp	number	<optional>		The JavaScript timestamp.
capitalize	boolean	<optional>	false	Upper case first letter in the return.

Returns:

string .

The formatted date.

Example

const time = new Highcharts.Time();
const s = time.dateFormat('%Y-%m-%d %H:%M:%S', Date.UTC(2020, 0, 1));
console.log(s); // => 2020-01-01 00:00:00

get(unit, date)

Get the value of a date object in given units, and subject to the Time object's current timezone settings. This function corresponds directly to JavaScripts Date.getXXX / Date.getUTCXXX, so instead of calling date.getHours() or date.getUTCHours() we will call time.get('Hours').

Parameters:

Name	Type	Description
unit	Highcharts.TimeUnitValue
date	Date

Returns:

number .

The given time unit

getTimeTicks(normalizedInterval [, min] [, max] [, startOfWeek])

Return an array with time positions distributed on round time values right and right after min and max. Used in datetime axes as well as for grouping data on a datetime axis.

Parameters:

Name	Type	Argument	Default	Description
normalizedInterval	Highcharts.TimeNormalizedObject			The interval in axis values (ms) and the count
min	number	<optional>		The minimum in axis values
max	number	<optional>		The maximum in axis values
startOfWeek	number	<optional>	1

Returns:

Highcharts.AxisTickPositionsArray .

Time positions

getTimezoneOffset(timestamp)

Get the time zone offset based on the current timezone information as set in the global options.

Parameters:

Name	Type	Description
timestamp	number	The JavaScript timestamp to inspect.

Returns:

number .

The timezone offset in minutes compared to UTC.

makeTime(year, month [, date] [, hours] [, minutes] [, seconds])

Make a time and returns milliseconds. Interprets the inputs as UTC time, local time or a specific timezone time depending on the current time settings.

Parameters:

Name	Type	Argument	Default	Description
year	number			The year
month	number			The month. Zero-based, so January is 0.
date	number	<optional>	1	The day of the month
hours	number	<optional>	0	The hour of the day, 0-23.
minutes	number	<optional>	0	The minutes
seconds	number	<optional>	0	The seconds

Returns:

number .

The time in milliseconds since January 1st 1970.

set(unit, date, value)

Set the value of a date object in given units, and subject to the Time object's current timezone settings. This function corresponds directly to JavaScripts Date.setXXX / Date.setUTCXXX, so instead of calling date.setHours(0) or date.setUTCHours(0) we will call time.set('Hours', 0).

Parameters:

Name	Type	Description
unit	Highcharts.TimeUnitValue
date	Date
value	number

Returns:

number .

The epoch milliseconds of the updated date