com.vaadin.flow.component.charts.model.Time Maven / Gradle / Ivy
/**
* Copyright 2000-2024 Vaadin Ltd.
*
* This program is available under Vaadin Commercial License and Service Terms.
*
* See {@literal } for the full
* license.
*/
package com.vaadin.flow.component.charts.model;
/**
* These settings affect how datetime axes are laid out, how tooltips are
* formatted, how series pointIntervalUnit works and how the Highstock range
* selector handles time.
*/
public class Time extends AbstractConfigurationObject {
private Number timezoneOffset;
private Boolean useUTC;
public Time() {
}
/**
* @see #setTimezoneOffset(Number)
*/
public Number getTimezoneOffset() {
return timezoneOffset;
}
/**
* 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.
*
* Defaults to: 0
*/
public void setTimezoneOffset(Number timezoneOffset) {
this.timezoneOffset = timezoneOffset;
}
/**
* @see #setUseUTC(Boolean)
*/
public Boolean getUseUTC() {
return useUTC;
}
/**
* 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.
*
* Defaults to: true
*/
public void setUseUTC(Boolean useUTC) {
this.useUTC = useUTC;
}
}