Class Time

Hierarchy

QuantitativeScale<Date>
- Time

Implements

TransformableScale

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Time(): Time

Overrides QuantitativeScale.constructor
- Defined in plottable.d.ts:1255
A Time Scale maps Date objects to numbers.

constructor

Returns Time

Properties

Private _d3Scale

_d3Scale: any

Static Protected _DEFAULT_NUM_TICKS

_DEFAULT_NUM_TICKS: number

Methods

Protected _autoDomainIfAutomaticMode

_autoDomainIfAutomaticMode(): void

Inherited from QuantitativeScale._autoDomainIfAutomaticMode

Overrides Scale._autoDomainIfAutomaticMode
- Defined in plottable.d.ts:897
Returns void

Protected _backingScaleDomain

_backingScaleDomain(): Date[]
_backingScaleDomain(values: Date[])

Overrides Scale._backingScaleDomain
- Defined in plottable.d.ts:1278
Returns Date[]
Overrides Scale._backingScaleDomain
- Defined in plottable.d.ts:1279
Parameters
- values: Date[]

Protected _defaultExtent

_defaultExtent(): Date[]

Overrides QuantitativeScale._defaultExtent
- Defined in plottable.d.ts:1271
Returns Date[]

Protected _dispatchUpdate

_dispatchUpdate(): void

Inherited from Scale._dispatchUpdate
- Defined in plottable.d.ts:817
Returns void

Protected _expandSingleValueDomain

_expandSingleValueDomain(singleValueDomain: Date[]): Date[]

Overrides QuantitativeScale._expandSingleValueDomain
- Defined in plottable.d.ts:1272
Parameters
- singleValueDomain: Date[]
Returns Date[]

Protected _getAllIncludedValues

_getAllIncludedValues(): Date[]

Inherited from Scale._getAllIncludedValues
- Defined in plottable.d.ts:801
Returns Date[]

Protected _getDomain

_getDomain(): Date[]

Overrides Scale._getDomain
- Defined in plottable.d.ts:1277
Returns Date[]

Protected _getExtent

_getExtent(): Date[]

Inherited from QuantitativeScale._getExtent

Overrides Scale._getExtent
- Defined in plottable.d.ts:898
Returns Date[]

Protected _getRange

_getRange(): number[]

Overrides Scale._getRange
- Defined in plottable.d.ts:1280
Returns number[]

Protected _niceDomain

_niceDomain(domain: Date[]): Date[]

Overrides QuantitativeScale._niceDomain
- Defined in plottable.d.ts:1284
Parameters
- domain: Date[]
Returns Date[]

Protected _setDomain

_setDomain(values: Date[]): void

Overrides QuantitativeScale._setDomain
- Defined in plottable.d.ts:1270
Parameters
- values: Date[]
Returns void

Protected _setRange

_setRange(values: number[]): void

Overrides Scale._setRange
- Defined in plottable.d.ts:1281
Parameters
- values: number[]
Returns void

addIncludedValuesProvider

addIncludedValuesProvider(provider: IncludedValuesProvider<Date>)

Inherited from Scale.addIncludedValuesProvider
- Defined in plottable.d.ts:870
Adds an IncludedValuesProvider to the Scale.

Parameters
- provider: IncludedValuesProvider<Date>

addPaddingExceptionsProvider

addPaddingExceptionsProvider(provider: PaddingExceptionsProvider<Date>)

Inherited from QuantitativeScale.addPaddingExceptionsProvider
- Defined in plottable.d.ts:907
Adds a padding exception provider. If one end of the domain is set to an excepted value as a result of autoDomain()-ing, that end of the domain will not be padded.

Parameters
- provider: PaddingExceptionsProvider<Date>
  
  The provider function.

autoDomain

autoDomain()

Inherited from QuantitativeScale.autoDomain

Overrides Scale.autoDomain
- Defined in plottable.d.ts:896

defaultTicks

defaultTicks(): Date[]

Overrides QuantitativeScale.defaultTicks
- Defined in plottable.d.ts:1283
Returns Date[]

domain

domain(): Date[]
domain(values: Date[])

Inherited from QuantitativeScale.domain

Overrides Scale.domain
- Defined in plottable.d.ts:945
Returns Date[]
Inherited from QuantitativeScale.domain

Overrides Scale.domain
- Defined in plottable.d.ts:946
Parameters
- values: Date[]

domainMax

domainMax(): Date
domainMax(domainMax: Date)

Inherited from QuantitativeScale.domainMax
- Defined in plottable.d.ts:964
Gets the upper end of the domain.

Returns Date
Inherited from QuantitativeScale.domainMax
- Defined in plottable.d.ts:970
Sets the upper end of the domain.

Parameters
- domainMax: Date

domainMin

domainMin(): Date
domainMin(domainMin: Date)

Inherited from QuantitativeScale.domainMin
- Defined in plottable.d.ts:952
Gets the lower end of the domain.

Returns Date
Inherited from QuantitativeScale.domainMin
- Defined in plottable.d.ts:958
Sets the lower end of the domain.

Parameters
- domainMin: Date

extentOfValues

extentOfValues(values: Date[]): Date[]

Inherited from QuantitativeScale.extentOfValues

Overrides Scale.extentOfValues
- Defined in plottable.d.ts:971
Parameters
- values: Date[]
Returns Date[]

getTransformationDomain

getTransformationDomain(): [number, number]

Implementation of TransformableScale.getTransformationDomain

Overrides QuantitativeScale.getTransformationDomain
- Defined in plottable.d.ts:1276
Returns [number, number]

invert

invert(value: number): Date

Overrides QuantitativeScale.invert
- Defined in plottable.d.ts:1282
Parameters
- value: number
Returns Date

invertedTransformation

invertedTransformation(value: number): number

Implementation of TransformableScale.invertedTransformation

Overrides QuantitativeScale.invertedTransformation
- Defined in plottable.d.ts:1275
Parameters
- value: number
Returns number

offUpdate

offUpdate(callback: ScaleCallback<void>)

Inherited from Scale.offUpdate
- Defined in plottable.d.ts:816
Removes a callback that would be called when the Scale updates.

Parameters
- callback: ScaleCallback<void>

onUpdate

onUpdate(callback: ScaleCallback<void>)

Inherited from Scale.onUpdate
- Defined in plottable.d.ts:809
Adds a callback to be called when the Scale updates.

Parameters
- callback: ScaleCallback<void>

padProportion

padProportion(): number
padProportion(padProportion: number)

Inherited from QuantitativeScale.padProportion
- Defined in plottable.d.ts:918
Gets the padding proportion.

Returns number
Inherited from QuantitativeScale.padProportion
- Defined in plottable.d.ts:927
Sets the padding porportion. When autoDomain()-ing, the computed domain will be expanded by this proportion, then rounded to human-readable values.

Parameters
- padProportion: number
  
  The padding proportion. Passing 0 disables padding.

pan

pan(translateAmount: number): void

Implementation of TransformableScale.pan

Inherited from QuantitativeScale.pan
- Defined in plottable.d.ts:973
Parameters
- translateAmount: number
Returns void

range

range(): number[]
range(values: number[])

Inherited from Scale.range
- Defined in plottable.d.ts:854
Gets the range.

Returns number[]

The current range.
Inherited from Scale.range
- Defined in plottable.d.ts:861
Sets the range.

Parameters
- values: number[]

removeIncludedValuesProvider

removeIncludedValuesProvider(provider: IncludedValuesProvider<Date>)

Inherited from Scale.removeIncludedValuesProvider
- Defined in plottable.d.ts:877
Removes the IncludedValuesProvider from the Scale.

Parameters
- provider: IncludedValuesProvider<Date>

removePaddingExceptionsProvider

removePaddingExceptionsProvider(provider: PaddingExceptionsProvider<Date>)

Inherited from QuantitativeScale.removePaddingExceptionsProvider
- Defined in plottable.d.ts:914
Removes the padding exception provider.

Parameters
- provider: PaddingExceptionsProvider<Date>
  
  The provider function.

scale

scale(value: Date): number

Overrides Scale.scale
- Defined in plottable.d.ts:1273
Parameters
- value: Date
Returns number

scaleTransformation

scaleTransformation(value: number): number

Implementation of TransformableScale.scaleTransformation

Overrides QuantitativeScale.scaleTransformation
- Defined in plottable.d.ts:1274
Parameters
- value: number
Returns number

snappingDomainEnabled

snappingDomainEnabled(): boolean
snappingDomainEnabled(snappingDomainEnabled: boolean)

Inherited from QuantitativeScale.snappingDomainEnabled
- Defined in plottable.d.ts:932
Gets whether or not the scale snaps its domain to nice values.

Returns boolean
Inherited from QuantitativeScale.snappingDomainEnabled
- Defined in plottable.d.ts:936
Sets whether or not the scale snaps its domain to nice values.

Parameters
- snappingDomainEnabled: boolean

tickGenerator

tickGenerator(): TickGenerator<Date>
tickGenerator(generator: TickGenerator<Date>)

Inherited from QuantitativeScale.tickGenerator
- Defined in plottable.d.ts:997
Gets the TickGenerator.

Returns TickGenerator<Date>
Inherited from QuantitativeScale.tickGenerator
- Defined in plottable.d.ts:1004
Sets the TickGenerator

Parameters
- generator: TickGenerator<Date>

tickInterval

tickInterval(interval: string, step?: number): Date[]

- Defined in plottable.d.ts:1269
Returns an array of ticks values separated by the specified interval.

Parameters
- interval: string
  
  A string specifying the interval unit.
- Optional step: number
Returns Date[]

ticks

ticks(): Date[]

Inherited from QuantitativeScale.ticks
- Defined in plottable.d.ts:987
Gets an array of tick values spanning the domain.

Returns Date[]

zoom

zoom(magnifyAmount: number, centerValue: number): void

Implementation of TransformableScale.zoom

Inherited from QuantitativeScale.zoom
- Defined in plottable.d.ts:972
Parameters
- magnifyAmount: number
- centerValue: number
Returns void

Static timeIntervalToD3Time

timeIntervalToD3Time(timeInterval: string): Interval

- Defined in plottable.d.ts:1289
Transforms the Plottable TimeInterval string into a d3 time interval equivalent. If the provided TimeInterval is incorrect, the default is d3.time.year

Parameters
- timeInterval: string
Returns Interval

Generated using TypeDoc