Class QuantitativeScale

Type parameters

D

Hierarchy

Scale<D, number>
- QuantitativeScale
  - Linear
  - ModifiedLog
  - Time

Implements

TransformableScale

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new QuantitativeScale(): QuantitativeScale

Overrides Scale.constructor
- Defined in plottable.d.ts:888
A QuantitativeScale is a Scale that maps number-like values to numbers. It is invertible and continuous.

constructor

Returns QuantitativeScale

Properties

Private _domainMax

_domainMax: any

Private _domainMin

_domainMin: any

Private _padProportion

_padProportion: any

Private _paddingExceptionsProviders

_paddingExceptionsProviders: any

Private _snappingDomainEnabled

_snappingDomainEnabled: any

Private _tickGenerator

_tickGenerator: any

Static Protected _DEFAULT_NUM_TICKS

_DEFAULT_NUM_TICKS: number

Methods

Protected _autoDomainIfAutomaticMode

_autoDomainIfAutomaticMode(): void

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

Protected _backingScaleDomain

_backingScaleDomain(): D[]
_backingScaleDomain(values: D[])

Inherited from Scale._backingScaleDomain
- Defined in plottable.d.ts:847
Returns D[]
Inherited from Scale._backingScaleDomain
- Defined in plottable.d.ts:848
Parameters
- values: D[]

Protected _defaultExtent

_defaultExtent(): D[]

- Defined in plottable.d.ts:993
Returns D[]

Protected _dispatchUpdate

_dispatchUpdate(): void

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

Protected _expandSingleValueDomain

_expandSingleValueDomain(singleValueDomain: D[]): D[]

- Defined in plottable.d.ts:937
Parameters
- singleValueDomain: D[]
Returns D[]

Protected _getAllIncludedValues

_getAllIncludedValues(): D[]

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

Protected _getDomain

_getDomain(): D[]

Inherited from Scale._getDomain
- Defined in plottable.d.ts:845
Returns D[]

Protected _getExtent

_getExtent(): D[]

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

Protected _getRange

_getRange(): number[]

Inherited from Scale._getRange
- Defined in plottable.d.ts:862
Returns number[]

Protected _niceDomain

_niceDomain(domain: D[], count?: number): D[]

- Defined in plottable.d.ts:992
Given a domain, expands its domain onto "nice" values, e.g. whole numbers.

Parameters
- domain: D[]
- Optional count: number
Returns D[]

Private _padDomain

_padDomain(domain: any): any

- Defined in plottable.d.ts:928
Parameters
- domain: any
Returns any

Protected _setDomain

_setDomain(values: D[]): void

Overrides Scale._setDomain
- Defined in plottable.d.ts:977
Parameters
- values: D[]
Returns void

Protected _setRange

_setRange(values: number[]): void

Inherited from Scale._setRange
- Defined in plottable.d.ts:863
Parameters
- values: number[]
Returns void

addIncludedValuesProvider

addIncludedValuesProvider(provider: IncludedValuesProvider<D>)

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

Parameters
- provider: IncludedValuesProvider<D>

addPaddingExceptionsProvider

addPaddingExceptionsProvider(provider: PaddingExceptionsProvider<D>)

- 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<D>
  
  The provider function.

autoDomain

autoDomain()

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

defaultTicks

defaultTicks(): D[]

- Defined in plottable.d.ts:981
Gets the array of tick values generated by the default algorithm.

Returns D[]

domain

domain(): D[]
domain(values: D[])

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

domainMax

domainMax(): D
domainMax(domainMax: D)

- Defined in plottable.d.ts:964
Gets the upper end of the domain.

Returns D
- Defined in plottable.d.ts:970
Sets the upper end of the domain.

Parameters
- domainMax: D

domainMin

domainMin(): D
domainMin(domainMin: D)

- Defined in plottable.d.ts:952
Gets the lower end of the domain.

Returns D
- Defined in plottable.d.ts:958
Sets the lower end of the domain.

Parameters
- domainMin: D

extentOfValues

extentOfValues(values: D[]): D[]

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

getTransformationDomain

getTransformationDomain(): [number, number]

Implementation of TransformableScale.getTransformationDomain
- Defined in plottable.d.ts:976
Returns [number, number]

invert

invert(value: number): D

- Defined in plottable.d.ts:944
Computes the domain value corresponding to a supplied range value.

Parameters
- value: number
Returns D

The domain value corresponding to the supplied range value.

invertedTransformation

invertedTransformation(value: number): number

Implementation of TransformableScale.invertedTransformation
- Defined in plottable.d.ts:975
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)

- Defined in plottable.d.ts:918
Gets the padding proportion.

Returns number
- 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
- 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<D>)

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

Parameters
- provider: IncludedValuesProvider<D>

removePaddingExceptionsProvider

removePaddingExceptionsProvider(provider: PaddingExceptionsProvider<D>)

- Defined in plottable.d.ts:914
Removes the padding exception provider.

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

scale

scale(value: D): number

Inherited from Scale.scale
- Defined in plottable.d.ts:831
Computes the range value corresponding to a given domain value.

Parameters
- value: D
Returns number

The range value corresponding to the supplied domain value.

scaleTransformation

scaleTransformation(value: number): number

Implementation of TransformableScale.scaleTransformation
- Defined in plottable.d.ts:974
Parameters
- value: number
Returns number

snappingDomainEnabled

snappingDomainEnabled(): boolean
snappingDomainEnabled(snappingDomainEnabled: boolean)

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

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

Parameters
- snappingDomainEnabled: boolean

tickGenerator

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

- Defined in plottable.d.ts:997
Gets the TickGenerator.

Returns TickGenerator<D>
- Defined in plottable.d.ts:1004
Sets the TickGenerator

Parameters
- generator: TickGenerator<D>

ticks

ticks(): D[]

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

Returns D[]

zoom

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

Implementation of TransformableScale.zoom
- Defined in plottable.d.ts:972
Parameters
- magnifyAmount: number
- centerValue: number
Returns void

Generated using TypeDoc