Class Scale

Type parameters

D
R

Hierarchy

Scale

Index

Constructors

constructor

new Scale(): Scale

- Defined in plottable.d.ts:787
A Scale is a function (in the mathematical sense) that maps values from a domain to a range.

constructor

Returns Scale

Properties

Private _autoDomainAutomatically

_autoDomainAutomatically: any

Private _callbacks

_callbacks: any

Private _domainModificationInProgress

_domainModificationInProgress: any

Private _includedValuesProviders

_includedValuesProviders: any

Methods

Protected _autoDomainIfAutomaticMode

_autoDomainIfAutomaticMode(): void

- Defined in plottable.d.ts:824
Returns void

Protected _backingScaleDomain

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

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

Protected _dispatchUpdate

_dispatchUpdate(): void

- Defined in plottable.d.ts:817
Returns void

Protected _getAllIncludedValues

_getAllIncludedValues(): D[]

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

Protected _getDomain

_getDomain(): D[]

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

Protected _getExtent

_getExtent(): D[]

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

Protected _getRange

_getRange(): R[]

- Defined in plottable.d.ts:862
Returns R[]

Protected _setDomain

_setDomain(values: D[]): void

- Defined in plottable.d.ts:846
Parameters
- values: D[]
Returns void

Protected _setRange

_setRange(values: R[]): void

- Defined in plottable.d.ts:863
Parameters
- values: R[]
Returns void

addIncludedValuesProvider

addIncludedValuesProvider(provider: IncludedValuesProvider<D>)

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

Parameters
- provider: IncludedValuesProvider<D>

autoDomain

autoDomain()

- Defined in plottable.d.ts:823
Sets the Scale's domain so that it spans the Extents of all its ExtentsProviders.

domain

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

- Defined in plottable.d.ts:837
Gets the domain.

Returns D[]

The current domain.
- Defined in plottable.d.ts:844
Sets the domain.

Parameters
- values: D[]

extentOfValues

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

- Defined in plottable.d.ts:800
Given an array of potential domain values, computes the extent of those values.

Parameters
- values: D[]
Returns D[]

The extent of the input values.

offUpdate

offUpdate(callback: ScaleCallback<void>)

- 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>)

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

Parameters
- callback: ScaleCallback<void>

range

range(): R[]
range(values: R[])

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

Returns R[]

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

Parameters
- values: R[]

removeIncludedValuesProvider

removeIncludedValuesProvider(provider: IncludedValuesProvider<D>)

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

Parameters
- provider: IncludedValuesProvider<D>

scale

scale(value: D): R

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

Parameters
- value: D
Returns R

The range value corresponding to the supplied domain value.

Generated using TypeDoc