Class CartesianScales

Hierarchy (view full)

Service
- CartesianScales

Index

Constructors

Properties

domainAxisPosition dualAxes model orientation rangeAxisPosition scales scaleTypes secondaryDomainAxisPosition secondaryRangeAxisPosition services

Methods

createScale determineAxisDuality determineOrientation extendsDomain findDomainAndRangeAxes findDomainAndRangeAxesPositions findHorizontalAxesPositions findVerticalAxesPositions getAxisOptions getBoundedScaledValues getCustomDomainValuesByposition getDomainAxisOptions getDomainAxisPosition getDomainAxisScaleType getDomainIdentifier getDomainLabel getDomainLowerBound getDomainScale getDomainValue getHighestDomainThreshold getHighestRangeThreshold getMainXAxisPosition getMainXScale getMainXScaleType getMainYAxisPosition getMainYScale getMainYScaleType getOrientation getRangeAxisOptions getRangeAxisPosition getRangeAxisScaleType getRangeIdentifier getRangeLabel getRangeScale getRangeValue getScaleByPosition getScaleDomain getScaleLabel getScaleTypeByPosition getValueFromScale getValueThroughAxisPosition init isDualAxes setModel setServices update

Constructors

constructor

new CartesianScales(model, services): CartesianScales
Parameters
- model: ChartModel
- services: Services
Returns CartesianScales
Inherited from Service.constructor
- Defined in packages/core/src/services/service.ts:8

Properties

`Protected`domainAxisPosition

domainAxisPosition: AxisPositions

`Protected`dualAxes

dualAxes: boolean

`Protected`model

model: ChartModel

`Protected`orientation

orientation: CartesianOrientations

`Protected`rangeAxisPosition

rangeAxisPosition: AxisPositions

`Protected`scales

scales: {
    bottom: ScaleLinear<number, number, never>;
    left: ScaleLinear<number, number, never>;
    right: ScaleLinear<number, number, never>;
    top: ScaleLinear<number, number, never>;
} = ...

`Protected`scaleTypes

scaleTypes: {
    bottom: ScaleTypes;
    left: ScaleTypes;
    right: ScaleTypes;
    top: ScaleTypes;
} = ...

`Protected`secondaryDomainAxisPosition

secondaryDomainAxisPosition: AxisPositions

`Protected`secondaryRangeAxisPosition

secondaryRangeAxisPosition: AxisPositions

`Protected`services

services: Services

Methods

`Protected`createScale

createScale(axisPosition): ScaleFunction
Parameters
- axisPosition: AxisPositions
Returns ScaleFunction
- Defined in packages/core/src/services/scales-cartesian.ts:612

determineAxisDuality

determineAxisDuality(): void
Returns void
- Defined in packages/core/src/services/scales-cartesian.ts:193

determineOrientation

determineOrientation(): void
Returns void
- Defined in packages/core/src/services/scales-cartesian.ts:174

extendsDomain

extendsDomain(axisPosition, domain): number[] | Date[]
Parameters
- axisPosition: AxisPositions
- domain: any
Returns number[] | Date[]
- Defined in packages/core/src/services/scales-cartesian.ts:372

findDomainAndRangeAxes

findDomainAndRangeAxes(): void
Returns void
- Defined in packages/core/src/services/scales-cartesian.ts:154

`Protected`findDomainAndRangeAxesPositions

findDomainAndRangeAxesPositions(verticalAxesPositions, horizontalAxesPositions): {
    primaryDomainAxisPosition: AxisPositions;
    primaryRangeAxisPosition: AxisPositions;
    secondaryDomainAxisPosition: AxisPositions;
    secondaryRangeAxisPosition: AxisPositions;
}
Parameters
- verticalAxesPositions: any
- horizontalAxesPositions: any
Returns {
    primaryDomainAxisPosition: AxisPositions;
    primaryRangeAxisPosition: AxisPositions;
    secondaryDomainAxisPosition: AxisPositions;
    secondaryRangeAxisPosition: AxisPositions;
}
- primaryDomainAxisPosition: AxisPositions
- primaryRangeAxisPosition: AxisPositions
- secondaryDomainAxisPosition: AxisPositions
- secondaryRangeAxisPosition: AxisPositions
- Defined in packages/core/src/services/scales-cartesian.ts:425

`Protected`findHorizontalAxesPositions

findHorizontalAxesPositions(): {
primary: AxisPositions;
secondary: AxisPositions;
}
Returns {
primary: AxisPositions;
secondary: AxisPositions;
}
- primary: AxisPositions
- secondary: AxisPositions
- Defined in packages/core/src/services/scales-cartesian.ts:404

`Protected`findVerticalAxesPositions

findVerticalAxesPositions(): {
primary: AxisPositions;
secondary: AxisPositions;
}
Returns {
primary: AxisPositions;
secondary: AxisPositions;
}
- primary: AxisPositions
- secondary: AxisPositions
- Defined in packages/core/src/services/scales-cartesian.ts:383

getAxisOptions

getAxisOptions(position): any
Parameters
- position: AxisPositions
Returns any
- Defined in packages/core/src/services/scales-cartesian.ts:104

getBoundedScaledValues

getBoundedScaledValues(datum): number[]
Parameters
- datum: any
Returns number[]
- Defined in packages/core/src/services/scales-cartesian.ts:310

getCustomDomainValuesByposition

getCustomDomainValuesByposition(axisPosition): any
Parameters
- axisPosition: AxisPositions
Returns any
- Defined in packages/core/src/services/scales-cartesian.ts:210

getDomainAxisOptions

getDomainAxisOptions(): any
Returns any
- Defined in packages/core/src/services/scales-cartesian.ts:108

getDomainAxisPosition

getDomainAxisPosition(__namedParameters?): AxisPositions
Parameters
- __namedParameters: {
  datum?: any;
  } = {}
  - Optionaldatum?: any
Returns AxisPositions
- Defined in packages/core/src/services/scales-cartesian.ts:67

getDomainAxisScaleType

getDomainAxisScaleType(): ScaleTypes
Returns ScaleTypes
- Defined in packages/core/src/services/scales-cartesian.ts:246

getDomainIdentifier

getDomainIdentifier(datum?): any
Parameters
- Optionaldatum: any
Returns any
- Defined in packages/core/src/services/scales-cartesian.ts:362

getDomainLabel

getDomainLabel(): string
Returns string
- Defined in packages/core/src/services/scales-cartesian.ts:130

getDomainLowerBound

getDomainLowerBound(position): number
Parameters
- position: any
Returns number
- Defined in packages/core/src/services/scales-cartesian.ts:639

getDomainScale

getDomainScale(): ScaleLinear<number, number, never>
Returns ScaleLinear<number, number, never>
- Defined in packages/core/src/services/scales-cartesian.ts:256

getDomainValue

getDomainValue(d): number
Parameters
- d: string | object
Returns number
- Defined in packages/core/src/services/scales-cartesian.ts:344

getHighestDomainThreshold

getHighestDomainThreshold(): {
scaleValue: number;
threshold: ThresholdOptions;
}
Returns {
scaleValue: number;
threshold: ThresholdOptions;
}
- scaleValue: number
- threshold: ThresholdOptions
- Defined in packages/core/src/services/scales-cartesian.ts:660

getHighestRangeThreshold

getHighestRangeThreshold(): {
scaleValue: number;
threshold: ThresholdOptions;
}
Returns {
scaleValue: number;
threshold: ThresholdOptions;
}
- scaleValue: number
- threshold: ThresholdOptions
- Defined in packages/core/src/services/scales-cartesian.ts:692

getMainXAxisPosition

getMainXAxisPosition(): AxisPositions
Returns AxisPositions
- Defined in packages/core/src/services/scales-cartesian.ts:265

getMainXScale

getMainXScale(): ScaleLinear<number, number, never>
Returns ScaleLinear<number, number, never>
- Defined in packages/core/src/services/scales-cartesian.ts:282

getMainXScaleType

getMainXScaleType(): ScaleTypes
Returns ScaleTypes
- Defined in packages/core/src/services/scales-cartesian.ts:354

getMainYAxisPosition

getMainYAxisPosition(): AxisPositions
Returns AxisPositions
- Defined in packages/core/src/services/scales-cartesian.ts:274

getMainYScale

getMainYScale(): ScaleLinear<number, number, never>
Returns ScaleLinear<number, number, never>
- Defined in packages/core/src/services/scales-cartesian.ts:286

getRangeAxisPosition

getRangeAxisPosition(__namedParameters?): AxisPositions
Parameters
- __namedParameters: {
  datum?: any;
  groups?: any;
  } = {}
  - Optionaldatum?: any
  - Optionalgroups?: any
Returns AxisPositions
- Defined in packages/core/src/services/scales-cartesian.ts:83

getRangeAxisScaleType

getRangeAxisScaleType(): ScaleTypes
Returns ScaleTypes
- Defined in packages/core/src/services/scales-cartesian.ts:251

getRangeIdentifier

getRangeIdentifier(datum?): any
Parameters
- Optionaldatum: any
Returns any
- Defined in packages/core/src/services/scales-cartesian.ts:367

getRangeLabel

getRangeLabel(): string
Returns string
- Defined in packages/core/src/services/scales-cartesian.ts:134

getRangeScale

getRangeScale(): ScaleLinear<number, number, never>
Returns ScaleLinear<number, number, never>
- Defined in packages/core/src/services/scales-cartesian.ts:260

getRangeValue

getRangeValue(d): number
Parameters
- d: string | number | object
Returns number
- Defined in packages/core/src/services/scales-cartesian.ts:349

getScaleByPosition

getScaleByPosition(axisPosition): ScaleLinear<number, number, never>
Parameters
- axisPosition: AxisPositions
Returns ScaleLinear<number, number, never>
- Defined in packages/core/src/services/scales-cartesian.ts:238

getScaleDomain

getScaleDomain(axisPosition): any
Parameters
- axisPosition: AxisPositions
Returns any
- Defined in packages/core/src/services/scales-cartesian.ts:470

getScaleLabel

getScaleLabel(position): string
Parameters
- position: AxisPositions
Returns string
- Defined in packages/core/src/services/scales-cartesian.ts:118

getScaleTypeByPosition

getScaleTypeByPosition(axisPosition): ScaleTypes
Parameters
- axisPosition: AxisPositions
Returns ScaleTypes
- Defined in packages/core/src/services/scales-cartesian.ts:242

getValueFromScale

getValueFromScale(scale, scaleType, axisPosition, datum): number
Parameters
- scale: any
- scaleType: ScaleTypes
- axisPosition: AxisPositions
- datum: any
Returns number
- Defined in packages/core/src/services/scales-cartesian.ts:290

getValueThroughAxisPosition

getValueThroughAxisPosition(axisPosition, datum): number
Parameters
- axisPosition: AxisPositions
- datum: any
Returns number
- Defined in packages/core/src/services/scales-cartesian.ts:337

init

init(): void
Returns void
Inherited from Service.init
- Defined in packages/core/src/services/service.ts:15

isDualAxes

isDualAxes(): boolean
Returns boolean
- Defined in packages/core/src/services/scales-cartesian.ts:187

setModel

setModel(newObj): void
Parameters
- newObj: ChartModel
Returns void
Inherited from Service.setModel
- Defined in packages/core/src/services/service.ts:24

setServices

setServices(newObj): void
Parameters
- newObj: Services
Returns void
Inherited from Service.setServices
- Defined in packages/core/src/services/service.ts:29

update

update(): void
Returns void
Overrides Service.update
- Defined in packages/core/src/services/scales-cartesian.ts:138

Class CartesianScales

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CartesianScales

Properties

ProtecteddomainAxisPosition

ProtecteddualAxes

Protectedmodel

Protectedorientation

ProtectedrangeAxisPosition

Protectedscales

ProtectedscaleTypes

ProtectedsecondaryDomainAxisPosition

ProtectedsecondaryRangeAxisPosition

Protectedservices

Methods

ProtectedcreateScale

Parameters

Returns ScaleFunction

determineAxisDuality

Returns void

determineOrientation

Returns void

extendsDomain

Parameters

Returns number[] | Date[]

findDomainAndRangeAxes

Returns void

ProtectedfindDomainAndRangeAxesPositions

Parameters

Returns { primaryDomainAxisPosition: AxisPositions; primaryRangeAxisPosition: AxisPositions; secondaryDomainAxisPosition: AxisPositions; secondaryRangeAxisPosition: AxisPositions; }

primaryDomainAxisPosition: AxisPositions

primaryRangeAxisPosition: AxisPositions

secondaryDomainAxisPosition: AxisPositions

secondaryRangeAxisPosition: AxisPositions

ProtectedfindHorizontalAxesPositions

Returns { primary: AxisPositions; secondary: AxisPositions; }

primary: AxisPositions

secondary: AxisPositions

ProtectedfindVerticalAxesPositions

Returns { primary: AxisPositions; secondary: AxisPositions; }

primary: AxisPositions

secondary: AxisPositions

getAxisOptions

Parameters

Returns any

getBoundedScaledValues

Parameters

Returns number[]

getCustomDomainValuesByposition

Parameters

Returns any

getDomainAxisOptions

Returns any

getDomainAxisPosition

Parameters

Optionaldatum?: any

Returns AxisPositions

getDomainAxisScaleType

Returns ScaleTypes

getDomainIdentifier

Parameters

Returns any

getDomainLabel

Returns string

getDomainLowerBound

Parameters

Returns number

getDomainScale

Returns ScaleLinear<number, number, never>

getDomainValue

Parameters

Returns number

getHighestDomainThreshold

`Protected`domainAxisPosition

`Protected`dualAxes

`Protected`model

`Protected`orientation

`Protected`rangeAxisPosition

`Protected`scales

`Protected`scaleTypes

`Protected`secondaryDomainAxisPosition

`Protected`secondaryRangeAxisPosition

`Protected`services

`Protected`createScale

`Protected`findDomainAndRangeAxesPositions

Returns {
primaryDomainAxisPosition: AxisPositions;
primaryRangeAxisPosition: AxisPositions;
secondaryDomainAxisPosition: AxisPositions;
secondaryRangeAxisPosition: AxisPositions;
}

`Protected`findHorizontalAxesPositions

Returns {
primary: AxisPositions;
secondary: AxisPositions;
}

`Protected`findVerticalAxesPositions

Returns {
primary: AxisPositions;
secondary: AxisPositions;
}

`Optional`datum?: any

Returns {
scaleValue: number;
threshold: ThresholdOptions;
}

Returns {
scaleValue: number;
threshold: ThresholdOptions;
}

`Optional`datum?: any

`Optional`groups?: any