Class Linear

Hierarchy

QuantitativeScale<number>
- Linear

Implements

TransformableScale

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Linear(): Linear

Overrides QuantitativeScale.constructor
- Defined in plottable.d.ts:1009
constructor

Returns Linear

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(): number[]
_backingScaleDomain(values: number[])

Overrides Scale._backingScaleDomain
- Defined in plottable.d.ts:1021
Returns number[]
Overrides Scale._backingScaleDomain
- Defined in plottable.d.ts:1022
Parameters
- values: number[]

Protected _defaultExtent

_defaultExtent(): number[]

Overrides QuantitativeScale._defaultExtent
- Defined in plottable.d.ts:1014
Returns number[]

Protected _dispatchUpdate

_dispatchUpdate(): void

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

Protected _expandSingleValueDomain

_expandSingleValueDomain(singleValueDomain: number[]): number[]

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

Protected _getAllIncludedValues

_getAllIncludedValues(): number[]

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

Protected _getDomain

_getDomain(): number[]

Overrides Scale._getDomain
- Defined in plottable.d.ts:1020
Returns number[]

Protected _getExtent

_getExtent(): number[]

Inherited from QuantitativeScale._getExtent

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

Protected _getRange

_getRange(): number[]

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

Protected _niceDomain

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

Overrides QuantitativeScale._niceDomain
- Defined in plottable.d.ts:1027
Parameters
- domain: number[]
- Optional count: number
Returns number[]

Protected _setDomain

_setDomain(values: number[]): void

Inherited from QuantitativeScale._setDomain

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

Protected _setRange

_setRange(values: number[]): void

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

addIncludedValuesProvider

addIncludedValuesProvider(provider: IncludedValuesProvider<number>)

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

Parameters
- provider: IncludedValuesProvider<number>

addPaddingExceptionsProvider

addPaddingExceptionsProvider(provider: PaddingExceptionsProvider<number>)

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

autoDomain

autoDomain()

Inherited from QuantitativeScale.autoDomain

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

defaultTicks

defaultTicks(): number[]

Overrides QuantitativeScale.defaultTicks
- Defined in plottable.d.ts:1026
Returns number[]

domain

domain(): number[]
domain(values: number[])

Inherited from QuantitativeScale.domain

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

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

domainMax

domainMax(): number
domainMax(domainMax: number)

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

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

Parameters
- domainMax: number

domainMin

domainMin(): number
domainMin(domainMin: number)

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

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

Parameters
- domainMin: number

extentOfValues

extentOfValues(values: number[]): number[]

Inherited from QuantitativeScale.extentOfValues

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

getTransformationDomain

getTransformationDomain(): [number, number]

Implementation of TransformableScale.getTransformationDomain

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

invert

invert(value: number): number

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

invertedTransformation

invertedTransformation(value: number): number

Implementation of TransformableScale.invertedTransformation

Overrides QuantitativeScale.invertedTransformation
- Defined in plottable.d.ts:1018
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<number>)

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

Parameters
- provider: IncludedValuesProvider<number>

removePaddingExceptionsProvider

removePaddingExceptionsProvider(provider: PaddingExceptionsProvider<number>)

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

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

scale

scale(value: number): number

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

scaleTransformation

scaleTransformation(value: number): number

Implementation of TransformableScale.scaleTransformation

Overrides QuantitativeScale.scaleTransformation
- Defined in plottable.d.ts:1017
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<number>
tickGenerator(generator: TickGenerator<number>)

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

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

Parameters
- generator: TickGenerator<number>

ticks

ticks(): number[]

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

Returns number[]

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

Generated using TypeDoc