ChronoUnitDatelineModel | ScheduleJS

The chrono unit dateline model is a specialization of the dateline model that works in combination with the ChronoUnit. The chrono unit basically represents standard calendar units ranging from milliseconds to thousands of years.

since: 1.0

Hierarchy

DatelineModel<ChronoUnit>
- ChronoUnitDatelineModel

Index

Constructors

constructor

Methods

Constructors

constructor

new ChronoUnitDatelineModel(): ChronoUnitDatelineModel

- Defined in model/dateline/chrono-unit-date-line-model.model.ts:12
Constructs a new dateline model with a long list of predefined resolutions of type ChronoUnitResolution.

since

1.0

Returns ChronoUnitDatelineModel

Methods

addResolution

addResolution(resolution: Resolution<ChronoUnit>): void

Inherited from DatelineModel.addResolution
- Defined in model/dateline/date-line-model.model.ts:92
Adds a resolution to the model.

since

1.0

Parameters
- resolution: Resolution<ChronoUnit>
  
  the resolution to add
Returns void

addZoneId

addZoneId(zoneId: string): void

Inherited from DatelineModel.addZoneId
- Defined in model/dateline/date-line-model.model.ts:78
Adds a ZoneId to the model.

since

1.0

Parameters
- zoneId: string
  
  the zone ID to add
Returns void

clearResolutions

clearResolutions(temporalUnit?: ChronoUnit): void

Inherited from DatelineModel.clearResolutions
- Defined in model/dateline/date-line-model.model.ts:132
Removes all resolutions for the given temporal unit.

since

1.0

Parameters
- Optional temporalUnit: ChronoUnit
  
  the temporal unit for which to remove all resolutions
Returns void

getAvailableZoneIds

getAvailableZoneIds(): Set<string>

Inherited from DatelineModel.getAvailableZoneIds
- Defined in model/dateline/date-line-model.model.ts:244
Returns all ZoneId instances that are available for the user to switch to.

since

1.0

Returns Set<string>

the available zone IDs

getMaxScaleCount

getMaxScaleCount(): number

Inherited from DatelineModel.getMaxScaleCount
- Defined in model/dateline/date-line-model.model.ts:204
Returns the maximum scale count.

since

1.0

Returns number

the maximum scale count

getMinScaleCount

getMinScaleCount(): number

Inherited from DatelineModel.getMinScaleCount
- Defined in model/dateline/date-line-model.model.ts:224
Returns the minimum scale count.

since

1.0

Returns number

the minimum scale count

getResolutions

getResolutions(temporalUnit: ChronoUnit): Resolution<ChronoUnit>[]

Inherited from DatelineModel.getResolutions
- Defined in model/dateline/date-line-model.model.ts:150
Returns all resolutions that are available for the given temporal unit.

since

1.0

Parameters
- temporalUnit: ChronoUnit
  
  the temporal unit for which resolutions are looked up
Returns Resolution<ChronoUnit>[]

the available resolutions for the given temporal unit

getScaleCount

getScaleCount(): number

Inherited from DatelineModel.getScaleCount
- Defined in model/dateline/date-line-model.model.ts:184
Returns the number of currently visible scales.

since

1.0

Returns number

the scale count

getTemporalUnits

getTemporalUnits(): ChronoUnit[]

Inherited from DatelineModel.getTemporalUnits
- Defined in model/dateline/date-line-model.model.ts:174
Returns all temporal units that are being used by the model.

since

1.0

Returns ChronoUnit[]

the list of temporal units used by the model

nextTemporalUnit

nextTemporalUnit(unit: ChronoUnit): ChronoUnit

Overrides DatelineModel.nextTemporalUnit
- Defined in model/dateline/chrono-unit-date-line-model.model.ts:99
Returns the next larger temporal unit for the given temporal unit, e.g. when passing ChronoUnit.HOURS this method might return ChronoUnit.DAYS.

since

1.0

Parameters
- unit: ChronoUnit
  
  the unit for which to return the next higher unit
Returns ChronoUnit

the next higher temporal unit

removeResolution

removeResolution(resolution: Resolution<ChronoUnit>): void

Inherited from DatelineModel.removeResolution
- Defined in model/dateline/date-line-model.model.ts:115
Removes a resolution from the model.

since

1.0

Parameters
- resolution: Resolution<ChronoUnit>
  
  the resolution that will be removed
Returns void

setMaxScaleCount

setMaxScaleCount(count: number): void

Inherited from DatelineModel.setMaxScaleCount
- Defined in model/dateline/date-line-model.model.ts:214
Sets the maximum scale count.

since

1.0

Parameters
- count: number
  
  the new maximum scale count
Returns void

setMinScaleCount

setMinScaleCount(count: number): void

Inherited from DatelineModel.setMinScaleCount
- Defined in model/dateline/date-line-model.model.ts:234
Sets the minimum scale count.

since

1.0

Parameters
- count: number
  
  the new minimum scale count
Returns void

setScaleCount

setScaleCount(count: number): void

Inherited from DatelineModel.setScaleCount
- Defined in model/dateline/date-line-model.model.ts:194
Sets the number of currently visible scales.

since

1.0

Parameters
- count: number
  
  the new scale count
Returns void