# Class: Scale<O>
# Type parameters
| Name | Type |
|---|---|
O | extends CoreScaleOptions = CoreScaleOptions |
# Hierarchy
default<unknown,O>-
↳
Scale↳↳
TimeScale
# Constructors
# constructor
• new Scale<O>(cfg)
# Type parameters
| Name | Type |
|---|---|
O | extends CoreScaleOptions = CoreScaleOptions |
# Parameters
| Name | Type |
|---|---|
cfg | Object |
cfg.chart | Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> |
cfg.ctx | CanvasRenderingContext2D |
cfg.id | string |
cfg.type | string |
# Inherited from
Element<unknown, O>.constructor
# Defined in
types/index.d.ts:1375
# Properties
# $animations
• $animations: Record<never, Animation>
# Inherited from
Element.$animations
# Defined in
core/core.element.ts:15
# active
• active: boolean = false
# Inherited from
Element.active
# Defined in
core/core.element.ts:13
# axis
• axis: string
# Defined in
types/index.d.ts:1276
# bottom
• bottom: number
Bottom edge of the item. Set by layout system and cannot be used in update
# Inherited from
# Defined in
types/layout.d.ts:41
# chart
• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
# Defined in
types/index.d.ts:1266
# ctx
• Readonly ctx: CanvasRenderingContext2D
# Defined in
types/index.d.ts:1265
# fullSize
• fullSize: boolean
if true, and the item is horizontal, then push vertical boxes down
# Inherited from
# Defined in
types/layout.d.ts:17
# height
• height: number
Height of item. Must be valid after update()
# Inherited from
# Defined in
types/layout.d.ts:25
# id
• Readonly id: string
# Defined in
types/index.d.ts:1263
# labelRotation
• labelRotation: number
# Defined in
types/index.d.ts:1277
# left
• left: number
Left edge of the item. Set by layout system and cannot be used in update
# Inherited from
# Defined in
types/layout.d.ts:29
# max
• max: number
# Defined in
types/index.d.ts:1279
# maxHeight
• maxHeight: number
# Defined in
types/index.d.ts:1269
# maxWidth
• maxWidth: number
# Defined in
types/index.d.ts:1268
# min
• min: number
# Defined in
types/index.d.ts:1278
# options
• options: O
# Inherited from
Element.options
# Defined in
core/core.element.ts:14
# paddingBottom
• paddingBottom: number
# Defined in
types/index.d.ts:1272
# paddingLeft
• paddingLeft: number
# Defined in
types/index.d.ts:1273
# paddingRight
• paddingRight: number
# Defined in
types/index.d.ts:1274
# paddingTop
• paddingTop: number
# Defined in
types/index.d.ts:1271
# position
• position: LayoutPosition
The position of the item in the chart layout. Possible values are
# Inherited from
# Defined in
types/layout.d.ts:9
# right
• right: number
Right edge of the item. Set by layout system and cannot be used in update
# Inherited from
# Defined in
types/layout.d.ts:37
# ticks
• ticks: Tick[]
# Defined in
types/index.d.ts:1280
# top
• top: number
Top edge of the item. Set by layout system and cannot be used in update
# Inherited from
# Defined in
types/layout.d.ts:33
# type
• Readonly type: string
# Defined in
types/index.d.ts:1264
# weight
• weight: number
The weight used to sort the item. Higher weights are further away from the chart area
# Inherited from
# Defined in
types/layout.d.ts:13
# width
• width: number
Width of item. Must be valid after update()
# Inherited from
# Defined in
types/layout.d.ts:21
# x
• x: number
# Inherited from
Element.x
# Defined in
core/core.element.ts:11
# y
• y: number
# Inherited from
Element.y
# Defined in
core/core.element.ts:12
# Methods
# afterBuildTicks
▸ afterBuildTicks(): void
# Returns
void
# Defined in
types/index.d.ts:1361
# afterCalculateLabelRotation
▸ afterCalculateLabelRotation(): void
# Returns
void
# Defined in
types/index.d.ts:1367
# afterDataLimits
▸ afterDataLimits(): void
# Returns
void
# Defined in
types/index.d.ts:1358
# afterFit
▸ afterFit(): void
# Returns
void
# Defined in
types/index.d.ts:1370
# afterSetDimensions
▸ afterSetDimensions(): void
# Returns
void
# Defined in
types/index.d.ts:1355
# afterTickToLabelConversion
▸ afterTickToLabelConversion(): void
# Returns
void
# Defined in
types/index.d.ts:1364
# afterUpdate
▸ afterUpdate(): void
# Returns
void
# Defined in
types/index.d.ts:1352
# beforeBuildTicks
▸ beforeBuildTicks(): void
# Returns
void
# Defined in
types/index.d.ts:1359
# beforeCalculateLabelRotation
▸ beforeCalculateLabelRotation(): void
# Returns
void
# Defined in
types/index.d.ts:1365
# beforeDataLimits
▸ beforeDataLimits(): void
# Returns
void
# Defined in
types/index.d.ts:1356
# beforeFit
▸ beforeFit(): void
# Returns
void
# Defined in
types/index.d.ts:1368
# beforeLayout
▸ Optional beforeLayout(): void
Called before the layout process starts
# Returns
void
# Inherited from
# Defined in
types/layout.d.ts:46
# beforeSetDimensions
▸ beforeSetDimensions(): void
# Returns
void
# Defined in
types/index.d.ts:1353
# beforeTickToLabelConversion
▸ beforeTickToLabelConversion(): void
# Returns
void
# Defined in
types/index.d.ts:1362
# beforeUpdate
▸ beforeUpdate(): void
# Returns
void
# Defined in
types/index.d.ts:1350
# buildTicks
▸ buildTicks(): Tick[]
# Returns
Tick[]
# Defined in
types/index.d.ts:1360
# calculateLabelRotation
▸ calculateLabelRotation(): void
# Returns
void
# Defined in
types/index.d.ts:1366
# configure
▸ configure(): void
# Returns
void
# Defined in
types/index.d.ts:1351
# determineDataLimits
▸ determineDataLimits(): void
# Returns
void
# Defined in
types/index.d.ts:1357
# draw
▸ draw(chartArea): void
Draws the element
# Parameters
| Name | Type |
|---|---|
chartArea | ChartArea |
# Returns
void
# Inherited from
# Defined in
types/layout.d.ts:50
# drawGrid
▸ drawGrid(chartArea): void
# Parameters
| Name | Type |
|---|---|
chartArea | ChartArea |
# Returns
void
# Defined in
types/index.d.ts:1285
# drawLabels
▸ drawLabels(chartArea): void
# Parameters
| Name | Type |
|---|---|
chartArea | ChartArea |
# Returns
void
# Defined in
types/index.d.ts:1284
# drawTitle
▸ drawTitle(chartArea): void
# Parameters
| Name | Type |
|---|---|
chartArea | ChartArea |
# Returns
void
# Defined in
types/index.d.ts:1283
# fit
▸ fit(): void
# Returns
void
# Defined in
types/index.d.ts:1369
# generateTickLabels
▸ generateTickLabels(ticks): void
# Parameters
| Name | Type |
|---|---|
ticks | Tick[] |
# Returns
void
# Defined in
types/index.d.ts:1363
# getBasePixel
▸ getBasePixel(): number
Returns the pixel for the minimum chart value The coordinate (0, 0) is at the upper-left corner of the canvas
# Returns
number
# Defined in
types/index.d.ts:1341
# getBaseValue
▸ getBaseValue(): number
# Returns
number
# Defined in
types/index.d.ts:1335
# getDecimalForPixel
▸ getDecimalForPixel(pixel): number
# Parameters
| Name | Type |
|---|---|
pixel | number |
# Returns
number
# Defined in
types/index.d.ts:1291
# getLabelForValue
▸ getLabelForValue(value): string
Used to get the label to display in the tooltip for the given value
# Parameters
| Name | Type |
|---|---|
value | number |
# Returns
string
# Defined in
types/index.d.ts:1311
# getLabelItems
▸ getLabelItems(chartArea?): LabelItem[]
# Parameters
| Name | Type |
|---|---|
chartArea? | ChartArea |
# Returns
# Defined in
types/index.d.ts:1349
# getLabels
▸ getLabels(): string[]
# Returns
string[]
# Defined in
types/index.d.ts:1348
# getLineWidthForValue
▸ getLineWidthForValue(value): number
Returns the grid line width at given value
# Parameters
| Name | Type |
|---|---|
value | number |
# Returns
number
# Defined in
types/index.d.ts:1316
# getMatchingVisibleMetas
▸ getMatchingVisibleMetas(type?): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]
# Parameters
| Name | Type |
|---|---|
type? | string |
# Returns
ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]
# Defined in
types/index.d.ts:1281
# getMinMax
▸ getMinMax(canStack): Object
# Parameters
| Name | Type |
|---|---|
canStack | boolean |
# Returns
Object
| Name | Type |
|---|---|
max | number |
min | number |
# Defined in
types/index.d.ts:1346
# getPadding
▸ Optional getPadding(): ChartArea
Returns an object with padding on the edges
# Returns
# Inherited from
# Defined in
types/layout.d.ts:54
# getPixelForDecimal
▸ getPixelForDecimal(decimal): number
Utility for getting the pixel location of a percentage of scale The coordinate (0, 0) is at the upper-left corner of the canvas
# Parameters
| Name | Type |
|---|---|
decimal | number |
# Returns
number
# Defined in
types/index.d.ts:1298
# getPixelForTick
▸ getPixelForTick(index): number
Returns the location of the tick at the given index The coordinate (0, 0) is at the upper-left corner of the canvas
# Parameters
| Name | Type |
|---|---|
index | number |
# Returns
number
# Defined in
types/index.d.ts:1305
# getPixelForValue
▸ getPixelForValue(value, index?): number
Returns the location of the given data point. Value can either be an index or a numerical value The coordinate (0, 0) is at the upper-left corner of the canvas
# Parameters
| Name | Type |
|---|---|
value | number |
index? | number |
# Returns
number
# Defined in
types/index.d.ts:1325
# getProps
▸ getProps<P>(props, final?): Pick<unknown, P[number]>
Gets the current or final value of each prop. Can return extra properties (whole object).
# Type parameters
| Name | Type |
|---|---|
P | extends never[] |
# Parameters
| Name | Type | Description |
|---|---|---|
props | P | properties to get |
final? | boolean | get the final value (animation target) |
# Returns
Pick<unknown, P[number]>
# Inherited from
Element.getProps
# Defined in
core/core.element.ts:31
▸ getProps<P>(props, final?): Partial<Record<P, unknown>>
# Type parameters
| Name | Type |
|---|---|
P | extends string |
# Parameters
| Name | Type |
|---|---|
props | P[] |
final? | boolean |
# Returns
Partial<Record<P, unknown>>
# Inherited from
Element.getProps
# Defined in
core/core.element.ts:32
# getTicks
▸ getTicks(): Tick[]
# Returns
Tick[]
# Defined in
types/index.d.ts:1347
# getUserBounds
▸ getUserBounds(): Object
# Returns
Object
| Name | Type |
|---|---|
max | number |
maxDefined | boolean |
min | number |
minDefined | boolean |
# Defined in
types/index.d.ts:1345
# getValueForPixel
▸ getValueForPixel(pixel): number
Used to get the data value from a given pixel. This is the inverse of getPixelForValue The coordinate (0, 0) is at the upper-left corner of the canvas
# Parameters
| Name | Type |
|---|---|
pixel | number |
# Returns
number
# Defined in
types/index.d.ts:1333
# hasValue
▸ hasValue(): boolean
# Returns
boolean
# Inherited from
Element.hasValue
# Defined in
core/core.element.ts:22
# init
▸ init(options): void
# Parameters
| Name | Type |
|---|---|
options | O |
# Returns
void
# Defined in
types/index.d.ts:1343
# isFullSize
▸ isFullSize(): boolean
# Returns
boolean
# Defined in
types/index.d.ts:1372
# isHorizontal
▸ isHorizontal(): boolean
returns true if the layout item is horizontal (ie. top or bottom)
# Returns
boolean
# Inherited from
# Defined in
types/layout.d.ts:58
# parse
▸ parse(raw, index?): unknown
# Parameters
| Name | Type |
|---|---|
raw | unknown |
index? | number |
# Returns
unknown
# Defined in
types/index.d.ts:1344
# setDimensions
▸ setDimensions(): void
# Returns
void
# Defined in
types/index.d.ts:1354
# tooltipPosition
▸ tooltipPosition(useFinalPosition): Point
# Parameters
| Name | Type |
|---|---|
useFinalPosition | boolean |
# Returns
# Inherited from
Element.tooltipPosition
# Defined in
core/core.element.ts:17
# update
▸ update(width, height, margins?): void
Takes two parameters: width and height.
# Parameters
| Name | Type |
|---|---|
width | number |
height | number |
margins? | ChartArea |
# Returns
void
# Inherited from
# Defined in
types/layout.d.ts:64