Package com.vaadin.flow.component.charts.model

Class Time

java.lang.Object
com.vaadin.flow.component.charts.model.AbstractConfigurationObject
com.vaadin.flow.component.charts.model.Time
All Implemented Interfaces:
Serializable
public class Time extends AbstractConfigurationObject
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.
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Time()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getTimezone()
     
    Number
    getTimezoneOffset()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This property is deprecated and should not be used in new code.
    Boolean
    getUseUTC()
    Deprecated, for removal: This API element is subject to removal in a future version.
    This property is deprecated and should not be used in new code.
    void
    setTimezone(String timezone)
    A named time zone.
    void
    setTimezoneOffset(Number timezoneOffset)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This property is deprecated and should not be used in new code.
    void
    setUseUTC(Boolean useUTC)
    Deprecated, for removal: This API element is subject to removal in a future version.
    This property is deprecated and should not be used in new code.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Time

      public Time()

  • Method Details

    • getTimezone

      public String getTimezone()
      See Also:

    • setTimezone

      public void setTimezone(String timezone)
      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.

      The time zone affects axis scaling, tickmark placement and time display in Highcharts.dateFormat.

      Setting timezone to null falls back to the default browser timezone setting. Setting it to "UTC" is equivalent to setting useUTC to true.

      Parameters:
      timezone -

    • getTimezoneOffset

      @Deprecated(since="25.0", forRemoval=true) public Number getTimezoneOffset()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This property is deprecated and should not be used in new code. Use setTimezone(String) instead.
      See Also:

    • setTimezoneOffset

      @Deprecated(since="25.0", forRemoval=true) public void setTimezoneOffset(Number timezoneOffset)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This property is deprecated and should not be used in new code. Use setTimezone(String) instead.
      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

      @Deprecated(since="25.0", forRemoval=true) public Boolean getUseUTC()
      Deprecated, for removal: This API element is subject to removal in a future version.
      This property is deprecated and should not be used in new code. Use setTimezone(String) instead.
      See Also:

    • setUseUTC

      @Deprecated(since="25.0", forRemoval=true) public void setUseUTC(Boolean useUTC)
      Deprecated, for removal: This API element is subject to removal in a future version.
      This property is deprecated and should not be used in new code. Use setTimezone(String) instead.
      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