# Class: Scale<O>
# Type parameters
Name | Type | Default |
---|---|---|
O | CoreScaleOptions | CoreScaleOptions |
# Hierarchy
# Constructors
# constructor
+ new Scale<O>(cfg
: { chart
: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown> ; ctx
: CanvasRenderingContext2D ; id
: string ; type
: string }): Scale<O>
# Type parameters:
Name | Type | Default |
---|---|---|
O | CoreScaleOptions | CoreScaleOptions |
# Parameters:
Name | Type |
---|---|
cfg | object |
cfg.chart | Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown> |
cfg.ctx | CanvasRenderingContext2D |
cfg.id | string |
cfg.type | string |
Returns: Scale<O>
Inherited from: void
Defined in: index.esm.d.ts:1251 (opens new window)
# Properties
# active
• Readonly
active: boolean
Inherited from: void
Defined in: element.d.ts:6 (opens new window)
# axis
• axis: string
Defined in: index.esm.d.ts:1154 (opens new window)
# bottom
• bottom: number
Bottom edge of the item. Set by layout system and cannot be used in update
Inherited from: LayoutItem.bottom
Defined in: layout.d.ts:41 (opens new window)
# chart
• Readonly
chart: Chart<bar | line | scatter | bubble | pie | doughnut | polarArea | radar, (number | ScatterDataPoint | BubbleDataPoint)[], unknown>
Defined in: index.esm.d.ts:1144 (opens new window)
# ctx
• Readonly
ctx: CanvasRenderingContext2D
Defined in: index.esm.d.ts:1143 (opens new window)
# fullSize
• fullSize: boolean
if true, and the item is horizontal, then push vertical boxes down
Inherited from: LayoutItem.fullSize
Defined in: layout.d.ts:17 (opens new window)
# height
• height: number
Height of item. Must be valid after update()
Inherited from: LayoutItem.height
Defined in: layout.d.ts:25 (opens new window)
# id
• Readonly
id: string
Defined in: index.esm.d.ts:1141 (opens new window)
# labelRotation
• labelRotation: number
Defined in: index.esm.d.ts:1155 (opens new window)
# left
• left: number
Left edge of the item. Set by layout system and cannot be used in update
Inherited from: LayoutItem.left
Defined in: layout.d.ts:29 (opens new window)
# max
• max: number
Defined in: index.esm.d.ts:1157 (opens new window)
# maxHeight
• maxHeight: number
Defined in: index.esm.d.ts:1147 (opens new window)
# maxWidth
• maxWidth: number
Defined in: index.esm.d.ts:1146 (opens new window)
# min
• min: number
Defined in: index.esm.d.ts:1156 (opens new window)
# options
• Readonly
options: O
Inherited from: void
Defined in: element.d.ts:7 (opens new window)
# paddingBottom
• paddingBottom: number
Defined in: index.esm.d.ts:1150 (opens new window)
# paddingLeft
• paddingLeft: number
Defined in: index.esm.d.ts:1151 (opens new window)
# paddingRight
• paddingRight: number
Defined in: index.esm.d.ts:1152 (opens new window)
# paddingTop
• paddingTop: number
Defined in: index.esm.d.ts:1149 (opens new window)
# position
• position: LayoutPosition
The position of the item in the chart layout. Possible values are
Inherited from: LayoutItem.position
Defined in: layout.d.ts:9 (opens new window)
# right
• right: number
Right edge of the item. Set by layout system and cannot be used in update
Inherited from: LayoutItem.right
Defined in: layout.d.ts:37 (opens new window)
# ticks
• ticks: Tick[]
Defined in: index.esm.d.ts:1158 (opens new window)
# top
• top: number
Top edge of the item. Set by layout system and cannot be used in update
Inherited from: LayoutItem.top
Defined in: layout.d.ts:33 (opens new window)
# type
• Readonly
type: string
Defined in: index.esm.d.ts:1142 (opens new window)
# weight
• weight: number
The weight used to sort the item. Higher weights are further away from the chart area
Inherited from: LayoutItem.weight
Defined in: layout.d.ts:13 (opens new window)
# width
• width: number
Width of item. Must be valid after update()
Inherited from: LayoutItem.width
Defined in: layout.d.ts:21 (opens new window)
# x
• Readonly
x: number
Inherited from: void
Defined in: element.d.ts:4 (opens new window)
# y
• Readonly
y: number
Inherited from: void
Defined in: element.d.ts:5 (opens new window)
# Methods
# afterBuildTicks
▸ afterBuildTicks(): void
Returns: void
Defined in: index.esm.d.ts:1238 (opens new window)
# afterCalculateLabelRotation
▸ afterCalculateLabelRotation(): void
Returns: void
Defined in: index.esm.d.ts:1244 (opens new window)
# afterDataLimits
▸ afterDataLimits(): void
Returns: void
Defined in: index.esm.d.ts:1235 (opens new window)
# afterFit
▸ afterFit(): void
Returns: void
Defined in: index.esm.d.ts:1247 (opens new window)
# afterSetDimensions
▸ afterSetDimensions(): void
Returns: void
Defined in: index.esm.d.ts:1232 (opens new window)
# afterTickToLabelConversion
▸ afterTickToLabelConversion(): void
Returns: void
Defined in: index.esm.d.ts:1241 (opens new window)
# afterUpdate
▸ afterUpdate(): void
Returns: void
Defined in: index.esm.d.ts:1229 (opens new window)
# beforeBuildTicks
▸ beforeBuildTicks(): void
Returns: void
Defined in: index.esm.d.ts:1236 (opens new window)
# beforeCalculateLabelRotation
▸ beforeCalculateLabelRotation(): void
Returns: void
Defined in: index.esm.d.ts:1242 (opens new window)
# beforeDataLimits
▸ beforeDataLimits(): void
Returns: void
Defined in: index.esm.d.ts:1233 (opens new window)
# beforeFit
▸ beforeFit(): void
Returns: void
Defined in: index.esm.d.ts:1245 (opens new window)
# beforeLayout
▸ Optional
beforeLayout(): void
Called before the layout process starts
Returns: void
Inherited from: LayoutItem
Defined in: layout.d.ts:46 (opens new window)
# beforeSetDimensions
▸ beforeSetDimensions(): void
Returns: void
Defined in: index.esm.d.ts:1230 (opens new window)
# beforeTickToLabelConversion
▸ beforeTickToLabelConversion(): void
Returns: void
Defined in: index.esm.d.ts:1239 (opens new window)
# beforeUpdate
▸ beforeUpdate(): void
Returns: void
Defined in: index.esm.d.ts:1227 (opens new window)
# buildTicks
▸ buildTicks(): Tick[]
Returns: Tick[]
Defined in: index.esm.d.ts:1237 (opens new window)
# calculateLabelRotation
▸ calculateLabelRotation(): void
Returns: void
Defined in: index.esm.d.ts:1243 (opens new window)
# configure
▸ configure(): void
Returns: void
Defined in: index.esm.d.ts:1228 (opens new window)
# determineDataLimits
▸ determineDataLimits(): void
Returns: void
Defined in: index.esm.d.ts:1234 (opens new window)
# draw
▸ draw(chartArea
: ChartArea): void
Draws the element
# Parameters:
Name | Type |
---|---|
chartArea | ChartArea |
Returns: void
Inherited from: LayoutItem
Defined in: layout.d.ts:50 (opens new window)
# drawGrid
▸ drawGrid(chartArea
: ChartArea): void
# Parameters:
Name | Type |
---|---|
chartArea | ChartArea |
Returns: void
Defined in: index.esm.d.ts:1163 (opens new window)
# drawLabels
▸ drawLabels(chartArea
: ChartArea): void
# Parameters:
Name | Type |
---|---|
chartArea | ChartArea |
Returns: void
Defined in: index.esm.d.ts:1162 (opens new window)
# drawTitle
▸ drawTitle(chartArea
: ChartArea): void
# Parameters:
Name | Type |
---|---|
chartArea | ChartArea |
Returns: void
Defined in: index.esm.d.ts:1161 (opens new window)
# fit
▸ fit(): void
Returns: void
Defined in: index.esm.d.ts:1246 (opens new window)
# generateTickLabels
▸ generateTickLabels(ticks
: Tick[]): void
# Parameters:
Name | Type |
---|---|
ticks | Tick[] |
Returns: void
Defined in: index.esm.d.ts:1240 (opens new window)
# 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: index.esm.d.ts:1219 (opens new window)
# getBaseValue
▸ getBaseValue(): number
Returns: number
Defined in: index.esm.d.ts:1213 (opens new window)
# getDecimalForPixel
▸ getDecimalForPixel(pixel
: number): number
# Parameters:
Name | Type |
---|---|
pixel | number |
Returns: number
Defined in: index.esm.d.ts:1169 (opens new window)
# getLabelForValue
▸ getLabelForValue(value
: number): string
Used to get the label to display in the tooltip for the given value
# Parameters:
Name | Type |
---|---|
value | number |
Returns: string
Defined in: index.esm.d.ts:1189 (opens new window)
# getLabels
▸ getLabels(): string[]
Returns: string[]
Defined in: index.esm.d.ts:1226 (opens new window)
# getLineWidthForValue
▸ getLineWidthForValue(value
: number): number
Returns the grid line width at given value
# Parameters:
Name | Type |
---|---|
value | number |
Returns: number
Defined in: index.esm.d.ts:1194 (opens new window)
# getMatchingVisibleMetas
▸ getMatchingVisibleMetas(type?
: string): ChartMeta<Element<{}, {}>, Element<{}, {}>>[]
# Parameters:
Name | Type |
---|---|
type? | string |
Returns: ChartMeta<Element<{}, {}>, Element<{}, {}>>[]
Defined in: index.esm.d.ts:1159 (opens new window)
# getMinMax
▸ getMinMax(canStack
: boolean): object
# Parameters:
Name | Type |
---|---|
canStack | boolean |
Returns: object
Name | Type |
---|---|
max | number |
min | number |
Defined in: index.esm.d.ts:1224 (opens new window)
# getPadding
▸ Optional
getPadding(): ChartArea
Returns an object with padding on the edges
Returns: ChartArea
Inherited from: LayoutItem
Defined in: layout.d.ts:54 (opens new window)
# getPixelForDecimal
▸ getPixelForDecimal(decimal
: number): 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: index.esm.d.ts:1176 (opens new window)
# getPixelForTick
▸ getPixelForTick(index
: number): 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: index.esm.d.ts:1183 (opens new window)
# getPixelForValue
▸ getPixelForValue(value
: number, index
: number): 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: index.esm.d.ts:1203 (opens new window)
# getProps
▸ getProps<P>(props
: [P], final?
: boolean): Pick<{}, P>
# Type parameters:
Name | Type |
---|---|
P | never |
# Parameters:
Name | Type |
---|---|
props | [P] |
final? | boolean |
Returns: Pick<{}, P>
Inherited from: void
Defined in: element.d.ts:11 (opens new window)
▸ getProps<P, P2>(props
: [P, P2], final?
: boolean): Pick<{}, P | P2>
# Type parameters:
Name | Type |
---|---|
P | never |
P2 | never |
# Parameters:
Name | Type |
---|---|
props | [P, P2] |
final? | boolean |
Returns: Pick<{}, P | P2>
Inherited from: void
Defined in: element.d.ts:12 (opens new window)
▸ getProps<P, P2, P3>(props
: [P, P2, P3], final?
: boolean): Pick<{}, P | P2 | P3>
# Type parameters:
Name | Type |
---|---|
P | never |
P2 | never |
P3 | never |
# Parameters:
Name | Type |
---|---|
props | [P, P2, P3] |
final? | boolean |
Returns: Pick<{}, P | P2 | P3>
Inherited from: void
Defined in: element.d.ts:13 (opens new window)
▸ getProps<P, P2, P3, P4>(props
: [P, P2, P3, P4], final?
: boolean): Pick<{}, P | P2 | P3 | P4>
# Type parameters:
Name | Type |
---|---|
P | never |
P2 | never |
P3 | never |
P4 | never |
# Parameters:
Name | Type |
---|---|
props | [P, P2, P3, P4] |
final? | boolean |
Returns: Pick<{}, P | P2 | P3 | P4>
Inherited from: void
Defined in: element.d.ts:17 (opens new window)
▸ getProps<P, P2, P3, P4, P5>(props
: [P, P2, P3, P4, P5], final?
: boolean): Pick<{}, P | P2 | P3 | P4 | P5>
# Type parameters:
Name | Type |
---|---|
P | never |
P2 | never |
P3 | never |
P4 | never |
P5 | never |
# Parameters:
Name | Type |
---|---|
props | [P, P2, P3, P4, P5] |
final? | boolean |
Returns: Pick<{}, P | P2 | P3 | P4 | P5>
Inherited from: void
Defined in: element.d.ts:21 (opens new window)
▸ getProps(props
: never[], final?
: boolean): object
# Parameters:
Name | Type |
---|---|
props | never[] |
final? | boolean |
Returns: object
Inherited from: void
Defined in: element.d.ts:25 (opens new window)
# getTicks
▸ getTicks(): Tick[]
Returns: Tick[]
Defined in: index.esm.d.ts:1225 (opens new window)
# getUserBounds
▸ getUserBounds(): object
Returns: object
Name | Type |
---|---|
max | number |
maxDefined | boolean |
min | number |
minDefined | boolean |
Defined in: index.esm.d.ts:1223 (opens new window)
# getValueForPixel
▸ getValueForPixel(pixel
: number): 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: index.esm.d.ts:1211 (opens new window)
# hasValue
▸ hasValue(): boolean
Returns: boolean
Inherited from: void
Defined in: element.d.ts:10 (opens new window)
# init
▸ init(options
: O): void
# Parameters:
Name | Type |
---|---|
options | O |
Returns: void
Defined in: index.esm.d.ts:1221 (opens new window)
# isFullSize
▸ isFullSize(): boolean
Returns: boolean
Defined in: index.esm.d.ts:1249 (opens new window)
# isHorizontal
▸ isHorizontal(): boolean
returns true if the layout item is horizontal (ie. top or bottom)
Returns: boolean
Inherited from: LayoutItem
Defined in: layout.d.ts:58 (opens new window)
# parse
▸ parse(raw
: unknown, index
: number): unknown
# Parameters:
Name | Type |
---|---|
raw | unknown |
index | number |
Returns: unknown
Defined in: index.esm.d.ts:1222 (opens new window)
# setDimensions
▸ setDimensions(): void
Returns: void
Defined in: index.esm.d.ts:1231 (opens new window)
# tooltipPosition
▸ tooltipPosition(useFinalPosition?
: boolean): Point
# Parameters:
Name | Type |
---|---|
useFinalPosition? | boolean |
Returns: Point
Inherited from: void
Defined in: element.d.ts:9 (opens new window)
# update
▸ update(width
: number, height
: number, margins?
: ChartArea): void
Takes two parameters: width and height.
# Parameters:
Name | Type |
---|---|
width | number |
height | number |
margins? | ChartArea |
Returns: void
Inherited from: LayoutItem
Defined in: layout.d.ts:64 (opens new window)