# Interface: RadialLinearScale<O>

# Type parameters

Name Type Default
O RadialLinearScaleOptions RadialLinearScaleOptions

# Hierarchy

  • Scale<O>

    RadialLinearScale

# Properties

# active

Readonly active: boolean

Inherited from: Scale.active

Defined in: element.d.ts:6 (opens new window)


# axis

axis: string

Inherited from: Scale.axis

Defined in: index.esm.d.ts:1160 (opens new window)


# bottom

bottom: number

Bottom edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.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>

Inherited from: Scale.chart

Defined in: index.esm.d.ts:1150 (opens new window)


# ctx

Readonly ctx: CanvasRenderingContext2D

Inherited from: Scale.ctx

Defined in: index.esm.d.ts:1149 (opens new window)


# fullSize

fullSize: boolean

if true, and the item is horizontal, then push vertical boxes down

Inherited from: Scale.fullSize

Defined in: layout.d.ts:17 (opens new window)


# height

height: number

Height of item. Must be valid after update()

Inherited from: Scale.height

Defined in: layout.d.ts:25 (opens new window)


# id

Readonly id: string

Inherited from: Scale.id

Defined in: index.esm.d.ts:1147 (opens new window)


# labelRotation

labelRotation: number

Inherited from: Scale.labelRotation

Defined in: index.esm.d.ts:1161 (opens new window)


# left

left: number

Left edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.left

Defined in: layout.d.ts:29 (opens new window)


# max

max: number

Inherited from: Scale.max

Defined in: index.esm.d.ts:1163 (opens new window)


# maxHeight

maxHeight: number

Inherited from: Scale.maxHeight

Defined in: index.esm.d.ts:1153 (opens new window)


# maxWidth

maxWidth: number

Inherited from: Scale.maxWidth

Defined in: index.esm.d.ts:1152 (opens new window)


# min

min: number

Inherited from: Scale.min

Defined in: index.esm.d.ts:1162 (opens new window)


# options

Readonly options: O

Inherited from: Scale.options

Defined in: element.d.ts:7 (opens new window)


# paddingBottom

paddingBottom: number

Inherited from: Scale.paddingBottom

Defined in: index.esm.d.ts:1156 (opens new window)


# paddingLeft

paddingLeft: number

Inherited from: Scale.paddingLeft

Defined in: index.esm.d.ts:1157 (opens new window)


# paddingRight

paddingRight: number

Inherited from: Scale.paddingRight

Defined in: index.esm.d.ts:1158 (opens new window)


# paddingTop

paddingTop: number

Inherited from: Scale.paddingTop

Defined in: index.esm.d.ts:1155 (opens new window)


# position

position: LayoutPosition

The position of the item in the chart layout. Possible values are

Inherited from: Scale.position

Defined in: layout.d.ts:9 (opens new window)


right: number

Right edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.right

Defined in: layout.d.ts:37 (opens new window)


# ticks

ticks: Tick[]

Inherited from: Scale.ticks

Defined in: index.esm.d.ts:1164 (opens new window)


# top

top: number

Top edge of the item. Set by layout system and cannot be used in update

Inherited from: Scale.top

Defined in: layout.d.ts:33 (opens new window)


# type

Readonly type: string

Inherited from: Scale.type

Defined in: index.esm.d.ts:1148 (opens new window)


# weight

weight: number

The weight used to sort the item. Higher weights are further away from the chart area

Inherited from: Scale.weight

Defined in: layout.d.ts:13 (opens new window)


# width

width: number

Width of item. Must be valid after update()

Inherited from: Scale.width

Defined in: layout.d.ts:21 (opens new window)


# x

Readonly x: number

Inherited from: Scale.x

Defined in: element.d.ts:4 (opens new window)


# y

Readonly y: number

Inherited from: Scale.y

Defined in: element.d.ts:5 (opens new window)

# Methods

# afterBuildTicks

afterBuildTicks(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1244 (opens new window)


# afterCalculateLabelRotation

afterCalculateLabelRotation(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1250 (opens new window)


# afterDataLimits

afterDataLimits(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1241 (opens new window)


# afterFit

afterFit(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1253 (opens new window)


# afterSetDimensions

afterSetDimensions(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1238 (opens new window)


# afterTickToLabelConversion

afterTickToLabelConversion(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1247 (opens new window)


# afterUpdate

afterUpdate(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1235 (opens new window)


# beforeBuildTicks

beforeBuildTicks(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1242 (opens new window)


# beforeCalculateLabelRotation

beforeCalculateLabelRotation(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1248 (opens new window)


# beforeDataLimits

beforeDataLimits(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1239 (opens new window)


# beforeFit

beforeFit(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1251 (opens new window)


# beforeLayout

OptionalbeforeLayout(): void

Called before the layout process starts

Returns: void

Inherited from: Scale

Defined in: layout.d.ts:46 (opens new window)


# beforeSetDimensions

beforeSetDimensions(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1236 (opens new window)


# beforeTickToLabelConversion

beforeTickToLabelConversion(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1245 (opens new window)


# beforeUpdate

beforeUpdate(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1233 (opens new window)


# buildTicks

buildTicks(): Tick[]

Returns: Tick[]

Inherited from: Scale

Defined in: index.esm.d.ts:1243 (opens new window)


# calculateLabelRotation

calculateLabelRotation(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1249 (opens new window)


# configure

configure(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1234 (opens new window)


# determineDataLimits

determineDataLimits(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1240 (opens new window)


# draw

draw(chartArea: ChartArea): void

Draws the element

# Parameters:

Name Type
chartArea ChartArea

Returns: void

Inherited from: Scale

Defined in: layout.d.ts:50 (opens new window)


# drawGrid

drawGrid(chartArea: ChartArea): void

# Parameters:

Name Type
chartArea ChartArea

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1169 (opens new window)


# drawLabels

drawLabels(chartArea: ChartArea): void

# Parameters:

Name Type
chartArea ChartArea

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1168 (opens new window)


# drawTitle

drawTitle(chartArea: ChartArea): void

# Parameters:

Name Type
chartArea ChartArea

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1167 (opens new window)


# fit

fit(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1252 (opens new window)


# generateTickLabels

generateTickLabels(ticks: Tick[]): void

# Parameters:

Name Type
ticks Tick[]

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1246 (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

Inherited from: Scale

Defined in: index.esm.d.ts:1225 (opens new window)


# getBasePosition

getBasePosition(index: number): object

# Parameters:

Name Type
index number

Returns: object

Name Type
angle number
x number
y number

Defined in: index.esm.d.ts:3172 (opens new window)


# getBaseValue

getBaseValue(): number

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1219 (opens new window)


# getDecimalForPixel

getDecimalForPixel(pixel: number): number

# Parameters:

Name Type
pixel number

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1175 (opens new window)


# getDistanceFromCenterForValue

getDistanceFromCenterForValue(value: number): number

# Parameters:

Name Type
value number

Returns: number

Defined in: index.esm.d.ts:3167 (opens new window)


# getIndexAngle

getIndexAngle(index: number): number

# Parameters:

Name Type
index number

Returns: number

Defined in: index.esm.d.ts:3166 (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

Inherited from: Scale

Defined in: index.esm.d.ts:1195 (opens new window)


# getLabels

getLabels(): string[]

Returns: string[]

Inherited from: Scale

Defined in: index.esm.d.ts:1232 (opens new window)


# getLineWidthForValue

getLineWidthForValue(value: number): number

Returns the grid line width at given value

# Parameters:

Name Type
value number

Returns: number

Inherited from: Scale

Defined in: index.esm.d.ts:1200 (opens new window)


# getMatchingVisibleMetas

getMatchingVisibleMetas(type?: string): ChartMeta<Element<{}, {}>, Element<{}, {}>>[]

# Parameters:

Name Type
type? string

Returns: ChartMeta<Element<{}, {}>, Element<{}, {}>>[]

Inherited from: Scale

Defined in: index.esm.d.ts:1165 (opens new window)


# getMinMax

getMinMax(canStack: boolean): object

# Parameters:

Name Type
canStack boolean

Returns: object

Name Type
max number
min number

Inherited from: Scale

Defined in: index.esm.d.ts:1230 (opens new window)


# getPadding

OptionalgetPadding(): ChartArea

Returns an object with padding on the edges

Returns: ChartArea

Inherited from: Scale

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

Inherited from: Scale

Defined in: index.esm.d.ts:1182 (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

Inherited from: Scale

Defined in: index.esm.d.ts:1189 (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

Inherited from: Scale

Defined in: index.esm.d.ts:1209 (opens new window)


# getPointLabelPosition

getPointLabelPosition(index: number): ChartArea

# Parameters:

Name Type
index number

Returns: ChartArea

Defined in: index.esm.d.ts:3171 (opens new window)


# getPointPosition

getPointPosition(index: number, distanceFromCenter: number): object

# Parameters:

Name Type
index number
distanceFromCenter number

Returns: object

Name Type
angle number
x number
y number

Defined in: index.esm.d.ts:3169 (opens new window)


# getPointPositionForValue

getPointPositionForValue(index: number, value: number): object

# Parameters:

Name Type
index number
value number

Returns: object

Name Type
angle number
x number
y number

Defined in: index.esm.d.ts:3170 (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: Scale

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: Scale

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: Scale

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: Scale

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: Scale

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: Scale

Defined in: element.d.ts:25 (opens new window)


# getTicks

getTicks(): Tick[]

Returns: Tick[]

Inherited from: Scale

Defined in: index.esm.d.ts:1231 (opens new window)


# getUserBounds

getUserBounds(): object

Returns: object

Name Type
max number
maxDefined boolean
min number
minDefined boolean

Inherited from: Scale

Defined in: index.esm.d.ts:1229 (opens new window)


# getValueForDistanceFromCenter

getValueForDistanceFromCenter(distance: number): number

# Parameters:

Name Type
distance number

Returns: number

Defined in: index.esm.d.ts:3168 (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

Inherited from: Scale

Defined in: index.esm.d.ts:1217 (opens new window)


# hasValue

hasValue(): boolean

Returns: boolean

Inherited from: Scale

Defined in: element.d.ts:10 (opens new window)


# init

init(options: O): void

# Parameters:

Name Type
options O

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1227 (opens new window)


# isFullSize

isFullSize(): boolean

Returns: boolean

Inherited from: Scale

Defined in: index.esm.d.ts:1255 (opens new window)


# isHorizontal

isHorizontal(): boolean

returns true if the layout item is horizontal (ie. top or bottom)

Returns: boolean

Inherited from: Scale

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

Inherited from: Scale

Defined in: index.esm.d.ts:1228 (opens new window)


# setCenterPoint

setCenterPoint(leftMovement: number, rightMovement: number, topMovement: number, bottomMovement: number): void

# Parameters:

Name Type
leftMovement number
rightMovement number
topMovement number
bottomMovement number

Returns: void

Defined in: index.esm.d.ts:3165 (opens new window)


# setDimensions

setDimensions(): void

Returns: void

Inherited from: Scale

Defined in: index.esm.d.ts:1237 (opens new window)


# tooltipPosition

tooltipPosition(useFinalPosition?: boolean): Point

# Parameters:

Name Type
useFinalPosition? boolean

Returns: Point

Inherited from: Scale

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: Scale

Defined in: layout.d.ts:64 (opens new window)