Interface: RadialLinearScale<O>
-
↳
RadialLinearScale
• Readonly
active: boolean
Inherited from
Defined in
element.d.ts:7 (opens new window)
axis
• axis: string
Inherited from
.axis
Defined in
index.esm.d.ts:1199 (opens new window)
bottom
• bottom: number
Bottom edge of the item. Set by layout system and cannot be used in update
Inherited from
Defined in
layout.d.ts:41 (opens new window)
chart
• Readonly
chart: Chart<keyof , (number
| ScatterDataPoint | )[], unknown
>
Inherited from
Defined in
index.esm.d.ts:1189 (opens new window)
ctx
• Readonly
ctx: CanvasRenderingContext2D
Inherited from
.ctx
Defined in
index.esm.d.ts:1188 (opens new window)
fullSize
• fullSize: boolean
if true, and the item is horizontal, then push vertical boxes down
Inherited from
Defined in
layout.d.ts:17 (opens new window)
height
• height: number
Height of item. Must be valid after update()
Inherited from
Defined in
layout.d.ts:25 (opens new window)
id
• Readonly
id: string
Inherited from
.id
Defined in
index.esm.d.ts:1186 (opens new window)
labelRotation
• labelRotation: number
Inherited from
Defined in
index.esm.d.ts:1200 (opens new window)
left
• left: number
Left edge of the item. Set by layout system and cannot be used in update
Inherited from
.left
Defined in
layout.d.ts:29 (opens new window)
max
• max: number
Inherited from
.max
Defined in
index.esm.d.ts:1202 (opens new window)
maxHeight
• maxHeight: number
Inherited from
Defined in
index.esm.d.ts:1192 (opens new window)
maxWidth
• maxWidth: number
Inherited from
Defined in
index.esm.d.ts:1191 (opens new window)
min
• min: number
Inherited from
.min
Defined in
index.esm.d.ts:1201 (opens new window)
options
• Readonly
options: O
Inherited from
Defined in
element.d.ts:8 (opens new window)
paddingBottom
• paddingBottom: number
Inherited from
Defined in
index.esm.d.ts:1195 (opens new window)
paddingLeft
• paddingLeft: number
Inherited from
Defined in
index.esm.d.ts:1196 (opens new window)
paddingRight
• paddingRight: number
Inherited from
Defined in
index.esm.d.ts:1197 (opens new window)
paddingTop
• paddingTop: number
Inherited from
Defined in
index.esm.d.ts:1194 (opens new window)
position
• position: LayoutPosition
The position of the item in the chart layout. Possible values are
Inherited from
Defined in
right
• right: number
Right edge of the item. Set by layout system and cannot be used in update
Inherited from
Defined in
ticks
• ticks: []
Inherited from
Defined in
index.esm.d.ts:1203 (opens new window)
top
• top: number
Top edge of the item. Set by layout system and cannot be used in update
Inherited from
.top
Defined in
layout.d.ts:33 (opens new window)
type
• Readonly
type: string
Inherited from
.type
Defined in
index.esm.d.ts:1187 (opens new window)
weight
• weight: number
The weight used to sort the item. Higher weights are further away from the chart area
Inherited from
Defined in
layout.d.ts:13 (opens new window)
width
• width: number
Width of item. Must be valid after update()
Inherited from
Defined in
layout.d.ts:21 (opens new window)
x
• Readonly
x: number
Inherited from
.x
Defined in
element.d.ts:5 (opens new window)
y
• Readonly
y: number
Inherited from
.y
Defined in
element.d.ts:6 (opens new window)
▸ afterBuildTicks(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1283 (opens new window)
afterCalculateLabelRotation
▸ afterCalculateLabelRotation(): void
Returns
void
Inherited from
Defined in
afterDataLimits
▸ afterDataLimits(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1280 (opens new window)
afterFit
▸ afterFit(): void
Returns
void
Inherited from
Defined in
afterSetDimensions
▸ afterSetDimensions(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1277 (opens new window)
afterTickToLabelConversion
▸ afterTickToLabelConversion(): void
Returns
void
Inherited from
Defined in
afterUpdate
▸ afterUpdate(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1274 (opens new window)
beforeBuildTicks
▸ beforeBuildTicks(): void
Returns
void
Inherited from
Defined in
beforeCalculateLabelRotation
▸ beforeCalculateLabelRotation(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1287 (opens new window)
beforeDataLimits
▸ beforeDataLimits(): void
Returns
void
Inherited from
Defined in
beforeFit
▸ beforeFit(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1290 (opens new window)
beforeLayout
▸ Optional
beforeLayout(): void
Called before the layout process starts
Returns
void
Inherited from
Defined in
beforeSetDimensions
▸ beforeSetDimensions(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1275 (opens new window)
beforeTickToLabelConversion
▸ beforeTickToLabelConversion(): void
Returns
void
Inherited from
Defined in
beforeUpdate
▸ beforeUpdate(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1272 (opens new window)
buildTicks
▸ buildTicks(): Tick[]
Returns
Tick[]
Inherited from
Defined in
calculateLabelRotation
▸ calculateLabelRotation(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1288 (opens new window)
configure
▸ configure(): void
Returns
void
Inherited from
Defined in
determineDataLimits
▸ determineDataLimits(): void
Returns
void
Inherited from
Defined in
index.esm.d.ts:1279 (opens new window)
draw
▸ draw(chartArea
): void
Draws the element
Parameters
Name | Type |
---|---|
chartArea |
Returns
void
Inherited from
Defined in
drawGrid
▸ drawGrid(chartArea
): void
Parameters
Name | Type |
---|---|
chartArea | ChartArea |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1208 (opens new window)
drawLabels
▸ drawLabels(chartArea
): void
Parameters
Name | Type |
---|---|
chartArea |
Returns
void
Inherited from
Defined in
drawTitle
▸ drawTitle(chartArea
): void
Parameters
Name | Type |
---|---|
chartArea | ChartArea |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1206 (opens new window)
fit
▸ fit(): void
Returns
void
Inherited from
Defined in
generateTickLabels
▸ generateTickLabels(ticks
): void
Parameters
Name | Type |
---|---|
ticks | Tick[] |
Returns
void
Inherited from
Defined in
index.esm.d.ts:1285 (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
Inherited from
Defined in
getBasePosition
▸ getBasePosition(index
): Object
Parameters
Name | Type |
---|---|
index | number |
Returns
Object
Name | Type |
---|---|
angle | number |
x | number |
y | number |
Defined in
index.esm.d.ts:3342 (opens new window)
getBaseValue
▸ getBaseValue(): number
Returns
number
Inherited from
Defined in
▸ getDecimalForPixel(pixel
): number
Parameters
Name | Type |
---|---|
pixel | number |
Returns
number
Inherited from
Defined in
index.esm.d.ts:1214 (opens new window)
getDistanceFromCenterForValue
▸ getDistanceFromCenterForValue(value
): number
Parameters
Name | Type |
---|---|
value | number |
Returns
number
Defined in
getIndexAngle
▸ getIndexAngle(index
): number
Parameters
Name | Type |
---|---|
index | number |
Returns
number
Defined in
getLabelForValue
▸ getLabelForValue(value
): string
Used to get the label to display in the tooltip for the given value
Parameters
Returns
string
Inherited from
Defined in
getLabels
▸ getLabels(): string
[]
Returns
string
[]
Inherited from
Defined in
index.esm.d.ts:1271 (opens new window)
getLineWidthForValue
▸ getLineWidthForValue(value
): number
Returns the grid line width at given value
Parameters
Name | Type |
---|---|
value | number |
Returns
number
Inherited from
Defined in
index.esm.d.ts:1239 (opens new window)
getMatchingVisibleMetas
▸ getMatchingVisibleMetas(type?
): ChartMeta<<AnyObject
, AnyObject
>, Element<AnyObject
, AnyObject
>, keyof >[]
Parameters
Name | Type |
---|---|
type? | string |
Returns
ChartMeta<<AnyObject
, AnyObject
>, Element<AnyObject
, AnyObject
>, keyof >[]
Inherited from
Defined in
index.esm.d.ts:1204 (opens new window)
getMinMax
▸ getMinMax(canStack
): Object
Parameters
Name | Type |
---|---|
canStack | boolean |
Returns
Object
Name | Type |
---|---|
max | number |
min | number |
Inherited from
Defined in
index.esm.d.ts:1269 (opens new window)
getPadding
▸ Optional
getPadding(): ChartArea
Returns an object with padding on the edges
Returns
Inherited from
Defined in
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
Inherited from
Defined in
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
Inherited from
Defined in
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
Inherited from
Defined in
getPointLabelPosition
▸ getPointLabelPosition(index
):
Parameters
Name | Type |
---|---|
index | number |
Returns
Defined in
index.esm.d.ts:3341 (opens new window)
getPointPosition
▸ getPointPosition(index
, distanceFromCenter
): Object
Parameters
Name | Type |
---|---|
index | number |
distanceFromCenter | number |
Returns
Object
Name | Type |
---|---|
angle | number |
x | number |
y | number |
Defined in
getPointPositionForValue
▸ getPointPositionForValue(index
, ): Object
Parameters
Returns
Object
Name | Type |
---|---|
angle | number |
x | number |
y | number |
Defined in
index.esm.d.ts:3340 (opens new window)
getProps
▸ getProps<P
>(props
, final?
): Pick
<unknown
, P
[number
]>
Type parameters
Name | Type |
---|---|
P | extends never [] |
Parameters
Name | Type |
---|---|
props | P |
final? | boolean |
Returns
Pick
<unknown
, P
[number
]>
Inherited from
Defined in
getTicks
▸ getTicks(): []
Returns
[]
Inherited from
Defined in
index.esm.d.ts:1270 (opens new window)
getUserBounds
▸ getUserBounds(): Object
Returns
Object
Name | Type |
---|---|
max | number |
maxDefined | boolean |
min | number |
minDefined | boolean |
Inherited from
Defined in
getValueForDistanceFromCenter
▸ getValueForDistanceFromCenter(distance
): number
Parameters
Name | Type |
---|---|
distance | number |
Returns
number
Defined in
index.esm.d.ts:3338 (opens new window)
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
Inherited from
Defined in
index.esm.d.ts:1256 (opens new window)
hasValue
▸ hasValue(): boolean
Returns
boolean
Inherited from
Defined in
init
▸ init(options
): void
Parameters
Name | Type |
---|---|
options | O |
Returns
void
Inherited from
Defined in
isFullSize
▸ isFullSize(): boolean
Returns
boolean
Inherited from
Defined in
index.esm.d.ts:1294 (opens new window)
isHorizontal
▸ isHorizontal(): boolean
returns true if the layout item is horizontal (ie. top or bottom)
Returns
boolean
Inherited from
Defined in
parse
▸ parse(raw
, index
): unknown
Parameters
Name | Type |
---|---|
raw | unknown |
index | number |
Returns
unknown
Inherited from
Defined in
setCenterPoint
▸ setCenterPoint(leftMovement
, rightMovement
, topMovement
, bottomMovement
): void
Parameters
Name | Type |
---|---|
leftMovement | number |
rightMovement | number |
topMovement | number |
bottomMovement | number |
Returns
void
Defined in
index.esm.d.ts:3335 (opens new window)
setDimensions
▸ setDimensions(): void
Returns
void
Inherited from
Defined in
tooltipPosition
▸ tooltipPosition(useFinalPosition?
):
Parameters
Name | Type |
---|---|
useFinalPosition? | boolean |
Returns
Inherited from
Defined in
▸ update(width
, height
, margins?
): void
Takes two parameters: width and height.
Parameters
Returns
void