com.vaadin.flow.component.charts.model

Class Global

java.lang.Object

com.vaadin.flow.component.charts.model.AbstractConfigurationObject

com.vaadin.flow.component.charts.model.Global

All Implemented Interfaces:

Serializable

@Generated(value="This class is generated and shouldn\'t be modified",
           comments="Incorrect and missing API should be reported to https://github.com/vaadin/vaadin-charts-flow/issues/new")
public class Global
extends AbstractConfigurationObject

Global options that don't apply to each chart. These options, like the lang options, must be set using the Highcharts.setOptions method.

 Highcharts.setOptions({
        global: {
                useUTC: false
        }
 });
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Global()

Method Summary

Modifier and Type	Method and Description
String	getTimezone()
Number	getTimezoneOffset()
Boolean	getUseUTC()
String	getVMLRadialGradientURL()
void	setTimezone(String timezone) Requires moment.js.
void	setTimezoneOffset(Number timezoneOffset) The timezone offset in minutes.
void	setUseUTC(Boolean useUTC) Whether to use UTC time for axis scaling, tickmark placement and time display in Highcharts.dateFormat.
void	setVMLRadialGradientURL(String VMLRadialGradientURL) Path to the pattern image required by VML browsers in order to draw radial gradients.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Global

public Global()

Method Detail

getVMLRadialGradientURL

public String getVMLRadialGradientURL()

See Also:

setVMLRadialGradientURL(String)

setVMLRadialGradientURL

public void setVMLRadialGradientURL(String VMLRadialGradientURL)

Path to the pattern image required by VML browsers in order to draw radial gradients.

Defaults to: http://code.highcharts.com/{version}/gfx/vml-radial-gradient.png

getTimezone

public String getTimezone()

See Also:

setTimezone(String)

setTimezone

public void setTimezone(String timezone)

Requires moment.js. If the timezone option is specified, it creates a default getTimezoneOffset function that looks up the specified timezone in moment.js. If moment.js is not included, this throws a Highcharts error in the console, but does not crash the chart.

Defaults to: undefined

getTimezoneOffset

public Number getTimezoneOffset()

See Also:

setTimezoneOffset(Number)

setTimezoneOffset

public void setTimezoneOffset(Number 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

getUseUTC

public Boolean getUseUTC()

See Also:

setUseUTC(Boolean)

setUseUTC

public void setUseUTC(Boolean 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