Class Timezone

Timezone representation.

Example

var vcalendar;
var timezoneComp = vcalendar.getFirstSubcomponent('vtimezone');
var tzid = timezoneComp.getFirstPropertyValue('tzid');

var timezone = new ICAL.Timezone({
  component: timezoneComp,
  tzid
});

Alias

ICAL.Timezone

Hierarchy

  • Timezone

Constructors

constructor

Properties

changes component expandedUntilYear icalclass latitude location longitude tzid tznames wrappedJSObject #localTimezone #utcTimezone EXTRA_COVERAGE _minimumExpansionYear

Accessors

localTimezone utcTimezone

Methods

_ensureCoverage _expandComponent _findNearbyChange fromData toString utcOffset _compare_change_fn adjustChange convertTime fromData

Constructors

constructor

  • Creates a new ICAL.Timezone instance, by passing in a tzid and component.

    Parameters

    • Optional data: Component | TimezoneData

      options for class

    Returns Timezone

Properties

Private changes

changes: Change[]

component

component: null | Component = null

The vtimezone component for this timezone.

Private expandedUntilYear

expandedUntilYear: number = 0

The year this timezone has been expanded to. All timezone transition dates until this year are known and can be used for calculation

Readonly icalclass

icalclass: "icaltimezone" = 'icaltimezone'

The class identifier.

latitude

latitude: number = 0.0

The primary latitude for the timezone.

location

location: string = ''

Timezone location

longitude

longitude: number = 0.0

The primary longitude for the timezone.

tzid

tzid: string = ''

Timezone identifier

tznames

tznames: string = ''

Alternative timezone name, for the string representation

Private wrappedJSObject

wrappedJSObject: Timezone

Static Private #localTimezone

#localTimezone: Timezone

The instance describing the local timezone

Static Private #utcTimezone

#utcTimezone: Timezone

The instance describing the UTC timezone

Static EXTRA_COVERAGE

EXTRA_COVERAGE: number = 5

Static _minimumExpansionYear

_minimumExpansionYear: number = -1

Accessors

Static localTimezone

Static utcTimezone

Methods

Private _ensureCoverage

  • _ensureCoverage(aYear): void

  • Parameters

    • aYear: number

    Returns void

Private _expandComponent

  • _expandComponent(aComponent, aYear, changes): null | Change[]

  • Parameters

    • aComponent: any
    • aYear: any
    • changes: Change[]

    Returns null | Change[]

Private _findNearbyChange

  • _findNearbyChange(change): number

  • Parameters

    • change: Change

    Returns number

fromData

  • Sets up the current instance using members from the passed data object.

    Parameters

    • Optional aData: Component | TimezoneData

      options for class

    Returns Timezone

toString

  • The string representation of this timezone.

    Returns string

utcOffset

  • Finds the utcOffset the given time would occur in this timezone.

    Parameters

    • tt: Time

      The time to check for

    Returns number

    utc offset in seconds

Static _compare_change_fn

  • _compare_change_fn(a, b): 0 | 1 | -1

  • Parameters

    • a: Change
    • b: Change

    Returns 0 | 1 | -1

Static Private adjustChange

  • Private

    Adjust a timezone change object.

    Parameters

    • change: Required<TimeData>

      The timezone change object

    • days: number

      The extra amount of days

    • hours: number

      The extra amount of hours

    • minutes: number

      The extra amount of minutes

    • seconds: number

      The extra amount of seconds

    Returns Time

Static convertTime

  • Convert the date/time from one zone to the next.

    Parameters

    • tt: Time

      The time to convert

    • fromZone: Timezone

      The source zone to convert from

    • toZone: Timezone

      The target zone to convert to

    Returns null | Time

    The converted date/time object

Static fromData

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc