diff --git a/docs/master/404.html b/docs/master/404.html index 3fb3943865..4ab91ee659 100644 --- a/docs/master/404.html +++ b/docs/master/404.html @@ -7,11 +7,11 @@ - +
- + diff --git a/docs/master/api/classes/Animation.html b/docs/master/api/classes/Animation.html index 5ac1e6e070..50a6bdd09f 100644 --- a/docs/master/api/classes/Animation.html +++ b/docs/master/api/classes/Animation.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: Animation

# Constructors

# constructor

• new Animation(cfg, target, prop, to?)

# Parameters

Name Type
cfg AnyObject
target AnyObject
prop string
to? unknown

# Defined in

types/animation.d.ts:5 (opens new window)

# Properties

# _to

• Readonly _to: unknown

# Defined in

types/animation.d.ts:10 (opens new window)

# Methods

# active

▸ active(): boolean

# Returns

boolean

# Defined in

types/animation.d.ts:6 (opens new window)

# cancel

▸ cancel(): void

# Returns

void

# Defined in

types/animation.d.ts:8 (opens new window)

# tick

▸ tick(date): void

# Parameters

Name Type
date number

# Returns

void

# Defined in

types/animation.d.ts:9 (opens new window)

# update

▸ update(cfg, to, date): void

# Parameters

Name Type
cfg AnyObject
to unknown
date number

# Returns

void

# Defined in

types/animation.d.ts:7 (opens new window)

+ (opens new window)

# Class: Animation

# Constructors

# constructor

• new Animation(cfg, target, prop, to?)

# Parameters

Name Type
cfg AnyObject
target AnyObject
prop string
to? unknown

# Defined in

types/animation.d.ts:5 (opens new window)

# Properties

# _to

• Readonly _to: unknown

# Defined in

types/animation.d.ts:10 (opens new window)

# Methods

# active

▸ active(): boolean

# Returns

boolean

# Defined in

types/animation.d.ts:6 (opens new window)

# cancel

▸ cancel(): void

# Returns

void

# Defined in

types/animation.d.ts:8 (opens new window)

# tick

▸ tick(date): void

# Parameters

Name Type
date number

# Returns

void

# Defined in

types/animation.d.ts:9 (opens new window)

# update

▸ update(cfg, to, date): void

# Parameters

Name Type
cfg AnyObject
to unknown
date number

# Returns

void

# Defined in

types/animation.d.ts:7 (opens new window)

← →

- + diff --git a/docs/master/api/classes/Animations.html b/docs/master/api/classes/Animations.html index eb98220a73..920d9c5d3f 100644 --- a/docs/master/api/classes/Animations.html +++ b/docs/master/api/classes/Animations.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: Animations

# Constructors

# constructor

• new Animations(chart, animations)

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
animations AnyObject

# Defined in

types/animation.d.ts:31 (opens new window)

# Methods

# configure

▸ configure(animations): void

# Parameters

Name Type
animations AnyObject

# Returns

void

# Defined in

types/animation.d.ts:32 (opens new window)

# update

▸ update(target, values): boolean

# Parameters

Name Type
target AnyObject
values AnyObject

# Returns

boolean

# Defined in

types/animation.d.ts:33 (opens new window)

+ (opens new window)

# Class: Animations

# Constructors

# constructor

• new Animations(chart, animations)

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
animations AnyObject

# Defined in

types/animation.d.ts:31 (opens new window)

# Methods

# configure

▸ configure(animations): void

# Parameters

Name Type
animations AnyObject

# Returns

void

# Defined in

types/animation.d.ts:32 (opens new window)

# update

▸ update(target, values): boolean

# Parameters

Name Type
target AnyObject
values AnyObject

# Returns

boolean

# Defined in

types/animation.d.ts:33 (opens new window)

← →

- + diff --git a/docs/master/api/classes/Animator.html b/docs/master/api/classes/Animator.html index 0787435862..984c3c5cae 100644 --- a/docs/master/api/classes/Animator.html +++ b/docs/master/api/classes/Animator.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: Animator

# Constructors

# constructor

• new Animator()

# Methods

# add

▸ add(chart, items): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
items readonly Animation[]

# Returns

void

# Defined in

types/animation.d.ts:22 (opens new window)

# has

▸ has(chart): boolean

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

boolean

# Defined in

types/animation.d.ts:23 (opens new window)

# listen

▸ listen(chart, event, cb): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
event "progress" | "complete"
cb (event: AnimationEvent) => void

# Returns

void

# Defined in

types/animation.d.ts:21 (opens new window)

# remove

▸ remove(chart): boolean

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

boolean

# Defined in

types/animation.d.ts:27 (opens new window)

# running

▸ running(chart): boolean

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

boolean

# Defined in

types/animation.d.ts:25 (opens new window)

# start

▸ start(chart): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/animation.d.ts:24 (opens new window)

# stop

▸ stop(chart): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/animation.d.ts:26 (opens new window)

+ (opens new window)

# Class: Animator

# Constructors

# constructor

• new Animator()

# Methods

# add

▸ add(chart, items): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
items readonly Animation[]

# Returns

void

# Defined in

types/animation.d.ts:22 (opens new window)

# has

▸ has(chart): boolean

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

boolean

# Defined in

types/animation.d.ts:23 (opens new window)

# listen

▸ listen(chart, event, cb): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
event "progress" | "complete"
cb (event: AnimationEvent) => void

# Returns

void

# Defined in

types/animation.d.ts:21 (opens new window)

# remove

▸ remove(chart): boolean

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

boolean

# Defined in

types/animation.d.ts:27 (opens new window)

# running

▸ running(chart): boolean

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

boolean

# Defined in

types/animation.d.ts:25 (opens new window)

# start

▸ start(chart): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/animation.d.ts:24 (opens new window)

# stop

▸ stop(chart): void

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/animation.d.ts:26 (opens new window)

← →

- + diff --git a/docs/master/api/classes/ArcElement.html b/docs/master/api/classes/ArcElement.html index 1b8a575d1e..d81a48653a 100644 --- a/docs/master/api/classes/ArcElement.html +++ b/docs/master/api/classes/ArcElement.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: ArcElement

# Hierarchy

# Constructors

# constructor

• new ArcElement(cfg)

# Parameters

Name Type
cfg any

# Overrides

Element<ArcProps, ArcOptions&gt;.constructor

# Defined in

elements/element.arc.ts:298 (opens new window)

# Properties

# $animations

• $animations: Record<keyof ArcProps, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# circumference

• circumference: number

# Defined in

elements/element.arc.ts:290 (opens new window)

# endAngle

• endAngle: number

# Defined in

elements/element.arc.ts:291 (opens new window)

# fullCircles

• fullCircles: number

# Defined in

elements/element.arc.ts:292 (opens new window)

# innerRadius

• innerRadius: number

# Defined in

elements/element.arc.ts:293 (opens new window)

# options

• options: ArcOptions

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# outerRadius

• outerRadius: number

# Defined in

elements/element.arc.ts:294 (opens new window)

# pixelMargin

• pixelMargin: number

# Defined in

elements/element.arc.ts:295 (opens new window)

# startAngle

• startAngle: number

# Defined in

elements/element.arc.ts:296 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# defaultRoutes

▪ Static defaultRoutes: Object

# Type declaration

Name Type
backgroundColor string

# Overrides

Element.defaultRoutes

# Defined in

elements/element.arc.ts:281 (opens new window)

# defaults

▪ Static defaults: Object

# Type declaration

Name Type
angle any
borderAlign string
borderColor string
borderDash any[]
borderDashOffset number
borderJoinStyle any
borderRadius number
borderWidth number
circular boolean
offset number
spacing number

# Overrides

Element.defaults

# Defined in

elements/element.arc.ts:267 (opens new window)

# descriptors

▪ Static descriptors: Object

# Type declaration

Name Type
_indexable (name: any) => boolean
_scriptable boolean

# Defined in

elements/element.arc.ts:285 (opens new window)

# id

▪ Static id: string = 'arc'

# Defined in

elements/element.arc.ts:265 (opens new window)

# Methods

# draw

▸ draw(ctx): void

# Parameters

Name Type
ctx CanvasRenderingContext2D

# Returns

void

# Defined in

elements/element.arc.ts:355 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition): Object

# Parameters

Name Type
useFinalPosition boolean

# Returns

Object

Name Type
x number
y number

# Defined in

elements/element.arc.ts:333 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<ArcProps, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof ArcProps[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<ArcProps, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(chartX, chartY, useFinalPosition): boolean

# Parameters

Name Type
chartX number
chartY number
useFinalPosition boolean

# Returns

boolean

# Defined in

elements/element.arc.ts:315 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Object

# Parameters

Name Type
useFinalPosition boolean

# Returns

Object

Name Type
x number
y number

# Overrides

Element.tooltipPosition

# Defined in

elements/element.arc.ts:351 (opens new window)

+ (opens new window)

# Class: ArcElement

# Hierarchy

# Constructors

# constructor

• new ArcElement(cfg)

# Parameters

Name Type
cfg any

# Overrides

Element<ArcProps, ArcOptions&gt;.constructor

# Defined in

elements/element.arc.ts:298 (opens new window)

# Properties

# $animations

• $animations: Record<keyof ArcProps, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# circumference

• circumference: number

# Defined in

elements/element.arc.ts:290 (opens new window)

# endAngle

• endAngle: number

# Defined in

elements/element.arc.ts:291 (opens new window)

# fullCircles

• fullCircles: number

# Defined in

elements/element.arc.ts:292 (opens new window)

# innerRadius

• innerRadius: number

# Defined in

elements/element.arc.ts:293 (opens new window)

# options

• options: ArcOptions

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# outerRadius

• outerRadius: number

# Defined in

elements/element.arc.ts:294 (opens new window)

# pixelMargin

• pixelMargin: number

# Defined in

elements/element.arc.ts:295 (opens new window)

# startAngle

• startAngle: number

# Defined in

elements/element.arc.ts:296 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# defaultRoutes

▪ Static defaultRoutes: Object

# Type declaration

Name Type
backgroundColor string

# Overrides

Element.defaultRoutes

# Defined in

elements/element.arc.ts:281 (opens new window)

# defaults

▪ Static defaults: Object

# Type declaration

Name Type
angle any
borderAlign string
borderColor string
borderDash any[]
borderDashOffset number
borderJoinStyle any
borderRadius number
borderWidth number
circular boolean
offset number
spacing number

# Overrides

Element.defaults

# Defined in

elements/element.arc.ts:267 (opens new window)

# descriptors

▪ Static descriptors: Object

# Type declaration

Name Type
_indexable (name: any) => boolean
_scriptable boolean

# Defined in

elements/element.arc.ts:285 (opens new window)

# id

▪ Static id: string = 'arc'

# Defined in

elements/element.arc.ts:265 (opens new window)

# Methods

# draw

▸ draw(ctx): void

# Parameters

Name Type
ctx CanvasRenderingContext2D

# Returns

void

# Defined in

elements/element.arc.ts:355 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition): Object

# Parameters

Name Type
useFinalPosition boolean

# Returns

Object

Name Type
x number
y number

# Defined in

elements/element.arc.ts:333 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<ArcProps, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof ArcProps[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<ArcProps, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(chartX, chartY, useFinalPosition): boolean

# Parameters

Name Type
chartX number
chartY number
useFinalPosition boolean

# Returns

boolean

# Defined in

elements/element.arc.ts:315 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Object

# Parameters

Name Type
useFinalPosition boolean

# Returns

Object

Name Type
x number
y number

# Overrides

Element.tooltipPosition

# Defined in

elements/element.arc.ts:351 (opens new window)

← →

- + diff --git a/docs/master/api/classes/BasePlatform.html b/docs/master/api/classes/BasePlatform.html index 50c7a93bb7..7bdd0ee4f5 100644 --- a/docs/master/api/classes/BasePlatform.html +++ b/docs/master/api/classes/BasePlatform.html @@ -7,7 +7,7 @@ - + @@ -40,8 +40,8 @@ (opens new window) GitHub (opens new window)

# Class: BasePlatform

# Hierarchy

# Constructors

# constructor

• new BasePlatform()

# Methods

# acquireContext

▸ acquireContext(canvas, options?): CanvasRenderingContext2D

Called at chart construction time, returns a context2d instance implementing -the [W3C Canvas 2D Context API standard]https://www.w3.org/TR/2dcontext/ (opens new window).

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas from which to acquire context (platform specific)
options? CanvasRenderingContext2DSettings The chart options

# Returns

CanvasRenderingContext2D

# Defined in

types/index.d.ts:2147 (opens new window)

# addEventListener

▸ addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to listen for event
type string The (ChartEvent) type to listen for
listener (e: ChartEvent) => void Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs.

# Returns

void

# Defined in

types/index.d.ts:2165 (opens new window)

# getDevicePixelRatio

▸ getDevicePixelRatio(): number

# Returns

number

the current devicePixelRatio of the device this platform is connected to.

# Defined in

types/index.d.ts:2176 (opens new window)

# getMaximumSize

▸ getMaximumSize(canvas, width?, height?, aspectRatio?): Object

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas for which to calculate the maximum size
width? number Parent element's content width
height? number Parent element's content height
aspectRatio? number The aspect ratio to maintain

# Returns

Object

the maximum size available.

Name Type
height number
width number

# Defined in

types/index.d.ts:2184 (opens new window)

# isAttached

▸ isAttached(canvas): boolean

# Parameters

Name Type
canvas HTMLCanvasElement

# Returns

boolean

true if the canvas is attached to the platform, false if not.

# Defined in

types/index.d.ts:2189 (opens new window)

# releaseContext

▸ releaseContext(context): boolean

Called at chart destruction time, releases any resources associated to the context -previously returned by the acquireContext() method.

# Parameters

Name Type Description
context CanvasRenderingContext2D The context2d instance

# Returns

boolean

true if the method succeeded, else false

# Defined in

types/index.d.ts:2157 (opens new window)

# removeEventListener

▸ removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to remove the listener
type string The (ChartEvent) type to remove
listener (e: ChartEvent) => void The listener function to remove from the event target.

# Returns

void

# Defined in

types/index.d.ts:2172 (opens new window)

# updateConfig

▸ updateConfig(config): void

Updates config with platform specific requirements

# Parameters

Name Type
config ChartConfiguration<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/index.d.ts:2194 (opens new window)

+the [W3C Canvas 2D Context API standard]https://www.w3.org/TR/2dcontext/ (opens new window).

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas from which to acquire context (platform specific)
options? CanvasRenderingContext2DSettings The chart options

# Returns

CanvasRenderingContext2D

# Defined in

types/index.d.ts:2147 (opens new window)

# addEventListener

▸ addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to listen for event
type string The (ChartEvent) type to listen for
listener (e: ChartEvent) => void Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs.

# Returns

void

# Defined in

types/index.d.ts:2165 (opens new window)

# getDevicePixelRatio

▸ getDevicePixelRatio(): number

# Returns

number

the current devicePixelRatio of the device this platform is connected to.

# Defined in

types/index.d.ts:2176 (opens new window)

# getMaximumSize

▸ getMaximumSize(canvas, width?, height?, aspectRatio?): Object

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas for which to calculate the maximum size
width? number Parent element's content width
height? number Parent element's content height
aspectRatio? number The aspect ratio to maintain

# Returns

Object

the maximum size available.

Name Type
height number
width number

# Defined in

types/index.d.ts:2184 (opens new window)

# isAttached

▸ isAttached(canvas): boolean

# Parameters

Name Type
canvas HTMLCanvasElement

# Returns

boolean

true if the canvas is attached to the platform, false if not.

# Defined in

types/index.d.ts:2189 (opens new window)

# releaseContext

▸ releaseContext(context): boolean

Called at chart destruction time, releases any resources associated to the context +previously returned by the acquireContext() method.

# Parameters

Name Type Description
context CanvasRenderingContext2D The context2d instance

# Returns

boolean

true if the method succeeded, else false

# Defined in

types/index.d.ts:2157 (opens new window)

# removeEventListener

▸ removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to remove the listener
type string The (ChartEvent) type to remove
listener (e: ChartEvent) => void The listener function to remove from the event target.

# Returns

void

# Defined in

types/index.d.ts:2172 (opens new window)

# updateConfig

▸ updateConfig(config): void

Updates config with platform specific requirements

# Parameters

Name Type
config ChartConfiguration<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/index.d.ts:2194 (opens new window)

← →

- + diff --git a/docs/master/api/classes/BasicPlatform.html b/docs/master/api/classes/BasicPlatform.html index 0a323521c1..46cc39ef0d 100644 --- a/docs/master/api/classes/BasicPlatform.html +++ b/docs/master/api/classes/BasicPlatform.html @@ -7,7 +7,7 @@ - + @@ -40,8 +40,8 @@ (opens new window) GitHub (opens new window)

# Class: BasicPlatform

# Hierarchy

# Constructors

# constructor

• new BasicPlatform()

# Inherited from

BasePlatform.constructor

# Methods

# acquireContext

▸ acquireContext(canvas, options?): CanvasRenderingContext2D

Called at chart construction time, returns a context2d instance implementing -the [W3C Canvas 2D Context API standard]https://www.w3.org/TR/2dcontext/ (opens new window).

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas from which to acquire context (platform specific)
options? CanvasRenderingContext2DSettings The chart options

# Returns

CanvasRenderingContext2D

# Inherited from

BasePlatform.acquireContext

# Defined in

types/index.d.ts:2147 (opens new window)

# addEventListener

▸ addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to listen for event
type string The (ChartEvent) type to listen for
listener (e: ChartEvent) => void Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs.

# Returns

void

# Inherited from

BasePlatform.addEventListener

# Defined in

types/index.d.ts:2165 (opens new window)

# getDevicePixelRatio

▸ getDevicePixelRatio(): number

# Returns

number

the current devicePixelRatio of the device this platform is connected to.

# Inherited from

BasePlatform.getDevicePixelRatio

# Defined in

types/index.d.ts:2176 (opens new window)

# getMaximumSize

▸ getMaximumSize(canvas, width?, height?, aspectRatio?): Object

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas for which to calculate the maximum size
width? number Parent element's content width
height? number Parent element's content height
aspectRatio? number The aspect ratio to maintain

# Returns

Object

the maximum size available.

Name Type
height number
width number

# Inherited from

BasePlatform.getMaximumSize

# Defined in

types/index.d.ts:2184 (opens new window)

# isAttached

▸ isAttached(canvas): boolean

# Parameters

Name Type
canvas HTMLCanvasElement

# Returns

boolean

true if the canvas is attached to the platform, false if not.

# Inherited from

BasePlatform.isAttached

# Defined in

types/index.d.ts:2189 (opens new window)

# releaseContext

▸ releaseContext(context): boolean

Called at chart destruction time, releases any resources associated to the context -previously returned by the acquireContext() method.

# Parameters

Name Type Description
context CanvasRenderingContext2D The context2d instance

# Returns

boolean

true if the method succeeded, else false

# Inherited from

BasePlatform.releaseContext

# Defined in

types/index.d.ts:2157 (opens new window)

# removeEventListener

▸ removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to remove the listener
type string The (ChartEvent) type to remove
listener (e: ChartEvent) => void The listener function to remove from the event target.

# Returns

void

# Inherited from

BasePlatform.removeEventListener

# Defined in

types/index.d.ts:2172 (opens new window)

# updateConfig

▸ updateConfig(config): void

Updates config with platform specific requirements

# Parameters

Name Type
config ChartConfiguration<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

BasePlatform.updateConfig

# Defined in

types/index.d.ts:2194 (opens new window)

+the [W3C Canvas 2D Context API standard]https://www.w3.org/TR/2dcontext/ (opens new window).

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas from which to acquire context (platform specific)
options? CanvasRenderingContext2DSettings The chart options

# Returns

CanvasRenderingContext2D

# Inherited from

BasePlatform.acquireContext

# Defined in

types/index.d.ts:2147 (opens new window)

# addEventListener

▸ addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to listen for event
type string The (ChartEvent) type to listen for
listener (e: ChartEvent) => void Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs.

# Returns

void

# Inherited from

BasePlatform.addEventListener

# Defined in

types/index.d.ts:2165 (opens new window)

# getDevicePixelRatio

▸ getDevicePixelRatio(): number

# Returns

number

the current devicePixelRatio of the device this platform is connected to.

# Inherited from

BasePlatform.getDevicePixelRatio

# Defined in

types/index.d.ts:2176 (opens new window)

# getMaximumSize

▸ getMaximumSize(canvas, width?, height?, aspectRatio?): Object

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas for which to calculate the maximum size
width? number Parent element's content width
height? number Parent element's content height
aspectRatio? number The aspect ratio to maintain

# Returns

Object

the maximum size available.

Name Type
height number
width number

# Inherited from

BasePlatform.getMaximumSize

# Defined in

types/index.d.ts:2184 (opens new window)

# isAttached

▸ isAttached(canvas): boolean

# Parameters

Name Type
canvas HTMLCanvasElement

# Returns

boolean

true if the canvas is attached to the platform, false if not.

# Inherited from

BasePlatform.isAttached

# Defined in

types/index.d.ts:2189 (opens new window)

# releaseContext

▸ releaseContext(context): boolean

Called at chart destruction time, releases any resources associated to the context +previously returned by the acquireContext() method.

# Parameters

Name Type Description
context CanvasRenderingContext2D The context2d instance

# Returns

boolean

true if the method succeeded, else false

# Inherited from

BasePlatform.releaseContext

# Defined in

types/index.d.ts:2157 (opens new window)

# removeEventListener

▸ removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to remove the listener
type string The (ChartEvent) type to remove
listener (e: ChartEvent) => void The listener function to remove from the event target.

# Returns

void

# Inherited from

BasePlatform.removeEventListener

# Defined in

types/index.d.ts:2172 (opens new window)

# updateConfig

▸ updateConfig(config): void

Updates config with platform specific requirements

# Parameters

Name Type
config ChartConfiguration<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

BasePlatform.updateConfig

# Defined in

types/index.d.ts:2194 (opens new window)

← →

- + diff --git a/docs/master/api/classes/Chart.html b/docs/master/api/classes/Chart.html index a82ea7d6cf..34b48e808d 100644 --- a/docs/master/api/classes/Chart.html +++ b/docs/master/api/classes/Chart.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: Chart<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Constructors

# constructor

• new Chart<TType, TData, TLabel>(item, config)

# Type parameters

Name Type
TType extends keyof ChartTypeRegistry = keyof ChartTypeRegistry
TData DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>
TLabel unknown

# Parameters

Name Type
item ChartItem
config ChartConfiguration<TType, TData, TLabel> | ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel>

# Defined in

types/index.d.ts:509 (opens new window)

# Properties

# aspectRatio

• Readonly aspectRatio: number

# Defined in

types/index.d.ts:496 (opens new window)

# attached

• Readonly attached: boolean

# Defined in

types/index.d.ts:501 (opens new window)

# boxes

• Readonly boxes: LayoutItem[]

# Defined in

types/index.d.ts:497 (opens new window)

# canvas

• Readonly canvas: HTMLCanvasElement

# Defined in

types/index.d.ts:491 (opens new window)

# chartArea

• Readonly chartArea: ChartArea

# Defined in

types/index.d.ts:499 (opens new window)

# config

• Readonly config: ChartConfiguration<TType, TData, TLabel> | ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel>

# Defined in

types/index.d.ts:493 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Defined in

types/index.d.ts:492 (opens new window)

# currentDevicePixelRatio

• Readonly currentDevicePixelRatio: number

# Defined in

types/index.d.ts:498 (opens new window)

# data

• data: ChartData<TType, TData, TLabel>

# Defined in

types/index.d.ts:506 (opens new window)

# height

• Readonly height: number

# Defined in

types/index.d.ts:495 (opens new window)

# id

• Readonly id: string

# Defined in

types/index.d.ts:490 (opens new window)

# legend

• Optional Readonly legend: LegendElement<TType>

# Defined in

types/index.d.ts:503 (opens new window)

# options

• options: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Defined in

types/index.d.ts:507 (opens new window)

# platform

• Readonly platform: BasePlatform

# Defined in

types/index.d.ts:489 (opens new window)

# scales

• Readonly scales: Object

# Index signature

▪ [key: string]: Scale

# Defined in

types/index.d.ts:500 (opens new window)

# tooltip

• Optional Readonly tooltip: TooltipModel<TType>

# Defined in

types/index.d.ts:504 (opens new window)

# width

• Readonly width: number

# Defined in

types/index.d.ts:494 (opens new window)

# defaults

▪ Static Readonly defaults: Defaults

# Defined in

types/index.d.ts:551 (opens new window)

# instances

▪ Static Readonly instances: Object

# Index signature

▪ [key: string]: Chart

# Defined in

types/index.d.ts:554 (opens new window)

# overrides

▪ Static Readonly overrides: Overrides

# Defined in

types/index.d.ts:552 (opens new window)

# registry

▪ Static Readonly registry: Registry

# Defined in

types/index.d.ts:555 (opens new window)

# version

▪ Static Readonly version: string

# Defined in

types/index.d.ts:553 (opens new window)

# Methods

# bindEvents

▸ bindEvents(): void

# Returns

void

# Defined in

types/index.d.ts:541 (opens new window)

# buildOrUpdateControllers

▸ buildOrUpdateControllers(): void

# Returns

void

# Defined in

types/index.d.ts:517 (opens new window)

# buildOrUpdateScales

▸ buildOrUpdateScales(): void

# Returns

void

# Defined in

types/index.d.ts:516 (opens new window)

# clear

▸ clear(): Chart<TType, TData, TLabel>

# Returns

Chart<TType, TData, TLabel>

# Defined in

types/index.d.ts:511 (opens new window)

# destroy

▸ destroy(): void

# Returns

void

# Defined in

types/index.d.ts:539 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Defined in

types/index.d.ts:521 (opens new window)

# ensureScalesHaveIDs

▸ ensureScalesHaveIDs(): void

# Returns

void

# Defined in

types/index.d.ts:515 (opens new window)

# getActiveElements

▸ getActiveElements(): ActiveElement[]

# Returns

ActiveElement[]

# Defined in

types/index.d.ts:536 (opens new window)

# getContext

▸ getContext(): Object

# Returns

Object

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
type string

# Defined in

types/index.d.ts:549 (opens new window)

# getDataVisibility

▸ getDataVisibility(index): boolean

# Parameters

Name Type
index number

# Returns

boolean

# Defined in

types/index.d.ts:532 (opens new window)

# getDatasetMeta

▸ getDatasetMeta(datasetIndex): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Parameters

Name Type
datasetIndex number

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Defined in

types/index.d.ts:527 (opens new window)

# getElementsAtEventForMode

▸ getElementsAtEventForMode(e, mode, options, useFinalPosition): InteractionItem[]

# Parameters

Name Type
e Event
mode string
options InteractionOptions
useFinalPosition boolean

# Returns

InteractionItem[]

# Defined in

types/index.d.ts:524 (opens new window)

# getSortedVisibleDatasetMetas

▸ getSortedVisibleDatasetMetas(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]

# Defined in

types/index.d.ts:526 (opens new window)

# getVisibleDatasetCount

▸ getVisibleDatasetCount(): number

# Returns

number

# Defined in

types/index.d.ts:528 (opens new window)

# hide

▸ hide(datasetIndex, dataIndex?): void

# Parameters

Name Type
datasetIndex number
dataIndex? number

# Returns

void

# Defined in

types/index.d.ts:533 (opens new window)

# isDatasetVisible

▸ isDatasetVisible(datasetIndex): boolean

# Parameters

Name Type
datasetIndex number

# Returns

boolean

# Defined in

types/index.d.ts:529 (opens new window)

# isPluginEnabled

▸ isPluginEnabled(pluginId): boolean

# Parameters

Name Type
pluginId string

# Returns

boolean

# Defined in

types/index.d.ts:547 (opens new window)

# isPointInArea

▸ isPointInArea(point): boolean

# Parameters

Name Type
point Point

# Returns

boolean

# Defined in

types/index.d.ts:523 (opens new window)

# notifyPlugins

▸ notifyPlugins(hook, args?): boolean | void

# Parameters

Name Type
hook string
args? AnyObject

# Returns

boolean | void

# Defined in

types/index.d.ts:545 (opens new window)

# render

▸ render(): void

# Returns

void

# Defined in

types/index.d.ts:520 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Defined in

types/index.d.ts:518 (opens new window)

# resize

▸ resize(width?, height?): void

# Parameters

Name Type
width? number
height? number

# Returns

void

# Defined in

types/index.d.ts:514 (opens new window)

# setActiveElements

▸ setActiveElements(active): void

# Parameters

Name Type
active ActiveDataPoint[]

# Returns

void

# Defined in

types/index.d.ts:537 (opens new window)

# setDatasetVisibility

▸ setDatasetVisibility(datasetIndex, visible): void

# Parameters

Name Type
datasetIndex number
visible boolean

# Returns

void

# Defined in

types/index.d.ts:530 (opens new window)

# show

▸ show(datasetIndex, dataIndex?): void

# Parameters

Name Type
datasetIndex number
dataIndex? number

# Returns

void

# Defined in

types/index.d.ts:534 (opens new window)

# stop

▸ stop(): Chart<TType, TData, TLabel>

# Returns

Chart<TType, TData, TLabel>

# Defined in

types/index.d.ts:512 (opens new window)

# toBase64Image

▸ toBase64Image(type?, quality?): string

# Parameters

Name Type
type? string
quality? unknown

# Returns

string

# Defined in

types/index.d.ts:540 (opens new window)

# toggleDataVisibility

▸ toggleDataVisibility(index): void

# Parameters

Name Type
index number

# Returns

void

# Defined in

types/index.d.ts:531 (opens new window)

# unbindEvents

▸ unbindEvents(): void

# Returns

void

# Defined in

types/index.d.ts:542 (opens new window)

# update

▸ update(mode?): void

# Parameters

Name Type
mode? "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | (ctx: { datasetIndex: number }) => "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:519 (opens new window)

# updateHoverStyle

▸ updateHoverStyle(items, mode, enabled): void

# Parameters

Name Type
items InteractionItem[]
mode "dataset"
enabled boolean

# Returns

void

# Defined in

types/index.d.ts:543 (opens new window)

# getChart

▸ Static getChart(key): Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Parameters

Name Type
key string | HTMLCanvasElement | CanvasRenderingContext2D

# Returns

Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:556 (opens new window)

# register

▸ Static register(...items): void

# Parameters

Name Type
...items ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:557 (opens new window)

# unregister

▸ Static unregister(...items): void

# Parameters

Name Type
...items ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:558 (opens new window)

+ (opens new window)

# Class: Chart<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Constructors

# constructor

• new Chart<TType, TData, TLabel>(item, config)

# Type parameters

Name Type
TType extends keyof ChartTypeRegistry = keyof ChartTypeRegistry
TData DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>
TLabel unknown

# Parameters

Name Type
item ChartItem
config ChartConfiguration<TType, TData, TLabel> | ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel>

# Defined in

types/index.d.ts:509 (opens new window)

# Properties

# aspectRatio

• Readonly aspectRatio: number

# Defined in

types/index.d.ts:496 (opens new window)

# attached

• Readonly attached: boolean

# Defined in

types/index.d.ts:501 (opens new window)

# boxes

• Readonly boxes: LayoutItem[]

# Defined in

types/index.d.ts:497 (opens new window)

# canvas

• Readonly canvas: HTMLCanvasElement

# Defined in

types/index.d.ts:491 (opens new window)

# chartArea

• Readonly chartArea: ChartArea

# Defined in

types/index.d.ts:499 (opens new window)

# config

• Readonly config: ChartConfiguration<TType, TData, TLabel> | ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel>

# Defined in

types/index.d.ts:493 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Defined in

types/index.d.ts:492 (opens new window)

# currentDevicePixelRatio

• Readonly currentDevicePixelRatio: number

# Defined in

types/index.d.ts:498 (opens new window)

# data

• data: ChartData<TType, TData, TLabel>

# Defined in

types/index.d.ts:506 (opens new window)

# height

• Readonly height: number

# Defined in

types/index.d.ts:495 (opens new window)

# id

• Readonly id: string

# Defined in

types/index.d.ts:490 (opens new window)

# legend

• Optional Readonly legend: LegendElement<TType>

# Defined in

types/index.d.ts:503 (opens new window)

# options

• options: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Defined in

types/index.d.ts:507 (opens new window)

# platform

• Readonly platform: BasePlatform

# Defined in

types/index.d.ts:489 (opens new window)

# scales

• Readonly scales: Object

# Index signature

▪ [key: string]: Scale

# Defined in

types/index.d.ts:500 (opens new window)

# tooltip

• Optional Readonly tooltip: TooltipModel<TType>

# Defined in

types/index.d.ts:504 (opens new window)

# width

• Readonly width: number

# Defined in

types/index.d.ts:494 (opens new window)

# defaults

▪ Static Readonly defaults: Defaults

# Defined in

types/index.d.ts:551 (opens new window)

# instances

▪ Static Readonly instances: Object

# Index signature

▪ [key: string]: Chart

# Defined in

types/index.d.ts:554 (opens new window)

# overrides

▪ Static Readonly overrides: Overrides

# Defined in

types/index.d.ts:552 (opens new window)

# registry

▪ Static Readonly registry: Registry

# Defined in

types/index.d.ts:555 (opens new window)

# version

▪ Static Readonly version: string

# Defined in

types/index.d.ts:553 (opens new window)

# Methods

# bindEvents

▸ bindEvents(): void

# Returns

void

# Defined in

types/index.d.ts:541 (opens new window)

# buildOrUpdateControllers

▸ buildOrUpdateControllers(): void

# Returns

void

# Defined in

types/index.d.ts:517 (opens new window)

# buildOrUpdateScales

▸ buildOrUpdateScales(): void

# Returns

void

# Defined in

types/index.d.ts:516 (opens new window)

# clear

▸ clear(): Chart<TType, TData, TLabel>

# Returns

Chart<TType, TData, TLabel>

# Defined in

types/index.d.ts:511 (opens new window)

# destroy

▸ destroy(): void

# Returns

void

# Defined in

types/index.d.ts:539 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Defined in

types/index.d.ts:521 (opens new window)

# ensureScalesHaveIDs

▸ ensureScalesHaveIDs(): void

# Returns

void

# Defined in

types/index.d.ts:515 (opens new window)

# getActiveElements

▸ getActiveElements(): ActiveElement[]

# Returns

ActiveElement[]

# Defined in

types/index.d.ts:536 (opens new window)

# getContext

▸ getContext(): Object

# Returns

Object

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
type string

# Defined in

types/index.d.ts:549 (opens new window)

# getDataVisibility

▸ getDataVisibility(index): boolean

# Parameters

Name Type
index number

# Returns

boolean

# Defined in

types/index.d.ts:532 (opens new window)

# getDatasetMeta

▸ getDatasetMeta(datasetIndex): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Parameters

Name Type
datasetIndex number

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Defined in

types/index.d.ts:527 (opens new window)

# getElementsAtEventForMode

▸ getElementsAtEventForMode(e, mode, options, useFinalPosition): InteractionItem[]

# Parameters

Name Type
e Event
mode string
options InteractionOptions
useFinalPosition boolean

# Returns

InteractionItem[]

# Defined in

types/index.d.ts:524 (opens new window)

# getSortedVisibleDatasetMetas

▸ getSortedVisibleDatasetMetas(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>[]

# Defined in

types/index.d.ts:526 (opens new window)

# getVisibleDatasetCount

▸ getVisibleDatasetCount(): number

# Returns

number

# Defined in

types/index.d.ts:528 (opens new window)

# hide

▸ hide(datasetIndex, dataIndex?): void

# Parameters

Name Type
datasetIndex number
dataIndex? number

# Returns

void

# Defined in

types/index.d.ts:533 (opens new window)

# isDatasetVisible

▸ isDatasetVisible(datasetIndex): boolean

# Parameters

Name Type
datasetIndex number

# Returns

boolean

# Defined in

types/index.d.ts:529 (opens new window)

# isPluginEnabled

▸ isPluginEnabled(pluginId): boolean

# Parameters

Name Type
pluginId string

# Returns

boolean

# Defined in

types/index.d.ts:547 (opens new window)

# isPointInArea

▸ isPointInArea(point): boolean

# Parameters

Name Type
point Point

# Returns

boolean

# Defined in

types/index.d.ts:523 (opens new window)

# notifyPlugins

▸ notifyPlugins(hook, args?): boolean | void

# Parameters

Name Type
hook string
args? AnyObject

# Returns

boolean | void

# Defined in

types/index.d.ts:545 (opens new window)

# render

▸ render(): void

# Returns

void

# Defined in

types/index.d.ts:520 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Defined in

types/index.d.ts:518 (opens new window)

# resize

▸ resize(width?, height?): void

# Parameters

Name Type
width? number
height? number

# Returns

void

# Defined in

types/index.d.ts:514 (opens new window)

# setActiveElements

▸ setActiveElements(active): void

# Parameters

Name Type
active ActiveDataPoint[]

# Returns

void

# Defined in

types/index.d.ts:537 (opens new window)

# setDatasetVisibility

▸ setDatasetVisibility(datasetIndex, visible): void

# Parameters

Name Type
datasetIndex number
visible boolean

# Returns

void

# Defined in

types/index.d.ts:530 (opens new window)

# show

▸ show(datasetIndex, dataIndex?): void

# Parameters

Name Type
datasetIndex number
dataIndex? number

# Returns

void

# Defined in

types/index.d.ts:534 (opens new window)

# stop

▸ stop(): Chart<TType, TData, TLabel>

# Returns

Chart<TType, TData, TLabel>

# Defined in

types/index.d.ts:512 (opens new window)

# toBase64Image

▸ toBase64Image(type?, quality?): string

# Parameters

Name Type
type? string
quality? unknown

# Returns

string

# Defined in

types/index.d.ts:540 (opens new window)

# toggleDataVisibility

▸ toggleDataVisibility(index): void

# Parameters

Name Type
index number

# Returns

void

# Defined in

types/index.d.ts:531 (opens new window)

# unbindEvents

▸ unbindEvents(): void

# Returns

void

# Defined in

types/index.d.ts:542 (opens new window)

# update

▸ update(mode?): void

# Parameters

Name Type
mode? "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" | (ctx: { datasetIndex: number }) => "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:519 (opens new window)

# updateHoverStyle

▸ updateHoverStyle(items, mode, enabled): void

# Parameters

Name Type
items InteractionItem[]
mode "dataset"
enabled boolean

# Returns

void

# Defined in

types/index.d.ts:543 (opens new window)

# getChart

▸ Static getChart(key): Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Parameters

Name Type
key string | HTMLCanvasElement | CanvasRenderingContext2D

# Returns

Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:556 (opens new window)

# register

▸ Static register(...items): void

# Parameters

Name Type
...items ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:557 (opens new window)

# unregister

▸ Static unregister(...items): void

# Parameters

Name Type
...items ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:558 (opens new window)

← →

- + diff --git a/docs/master/api/classes/DatasetController.html b/docs/master/api/classes/DatasetController.html index 6b1ef305a4..d355b6c03a 100644 --- a/docs/master/api/classes/DatasetController.html +++ b/docs/master/api/classes/DatasetController.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: DatasetController<TType, TElement, TDatasetElement, TParsedData>

# Type parameters

Name Type
TType extends ChartType = ChartType
TElement extends Element = Element
TDatasetElement extends Element = Element
TParsedData ParsedDataType<TType>

# Hierarchy

# Constructors

# constructor

• new DatasetController<TType, TElement, TDatasetElement, TParsedData>(chart, datasetIndex)

# Type parameters

Name Type
TType extends keyof ChartTypeRegistry = keyof ChartTypeRegistry
TElement extends default<AnyObject, AnyObject, TElement> = default<AnyObject, AnyObject>
TDatasetElement extends default<AnyObject, AnyObject, TDatasetElement> = default<AnyObject, AnyObject>
TParsedData ParsedDataType<TType>

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
datasetIndex number

# Defined in

types/index.d.ts:588 (opens new window)

# Properties

# _cachedMeta

• Readonly _cachedMeta: ChartMeta<TType, TElement, TDatasetElement>

# Defined in

types/index.d.ts:592 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:590 (opens new window)

# enableOptionSharing

• enableOptionSharing: boolean

# Defined in

types/index.d.ts:593 (opens new window)

# index

• Readonly index: number

# Defined in

types/index.d.ts:591 (opens new window)

# supportsDecimation

• supportsDecimation: boolean

# Defined in

types/index.d.ts:597 (opens new window)

# Methods

# addElements

▸ addElements(): void

# Returns

void

# Defined in

types/index.d.ts:613 (opens new window)

# applyStack

▸ Protected applyStack(scale, parsed): number

# Parameters

Name Type
scale Scale<CoreScaleOptions>
parsed unknown[]

# Returns

number

# Defined in

types/index.d.ts:649 (opens new window)

# buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

# Parameters

Name Type
resetNewElements? boolean

# Returns

void

# Defined in

types/index.d.ts:614 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Defined in

types/index.d.ts:611 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Defined in

types/index.d.ts:606 (opens new window)

# getAllParsedValues

▸ getAllParsedValues(scale): number[]

# Parameters

Name Type
scale Scale<CoreScaleOptions>

# Returns

number[]

# Defined in

types/index.d.ts:600 (opens new window)

# getDataset

▸ getDataset(): ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Returns

ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Defined in

types/index.d.ts:608 (opens new window)

# getLabelAndValue

▸ Protected getLabelAndValue(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
label string
value string

# Defined in

types/index.d.ts:601 (opens new window)

# getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

# Returns

number | boolean

# Defined in

types/index.d.ts:605 (opens new window)

# getMeta

▸ getMeta(): ChartMeta<TType, TElement, TDatasetElement>

# Returns

ChartMeta<TType, TElement, TDatasetElement>

# Defined in

types/index.d.ts:609 (opens new window)

# getMinMax

▸ Protected getMinMax(scale, canStack?): Object

# Parameters

Name Type
scale Scale<CoreScaleOptions>
canStack? boolean

# Returns

Object

Name Type
max number
min number

# Defined in

types/index.d.ts:656 (opens new window)

# getParsed

▸ Protected getParsed(index): TParsedData

# Parameters

Name Type
index number

# Returns

TParsedData

# Defined in

types/index.d.ts:648 (opens new window)

# getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

# Parameters

Name Type
scaleID string

# Returns

Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:610 (opens new window)

# getSharedOptions

▸ Protected getSharedOptions(options): AnyObject

Utility for checking if the options are shared and should be animated separately.

# Parameters

Name Type
options AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:623 (opens new window)

# getStyle

▸ getStyle(index, active): AnyObject

# Parameters

Name Type
index number
active boolean

# Returns

AnyObject

# Defined in

types/index.d.ts:616 (opens new window)

# includeOptions

▸ Protected includeOptions(mode, sharedOptions): boolean

Utility for determining if options should be included in the updated properties

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
sharedOptions AnyObject

# Returns

boolean

# Defined in

types/index.d.ts:628 (opens new window)

# initialize

▸ initialize(): void

# Returns

void

# Defined in

types/index.d.ts:612 (opens new window)

# linkScales

▸ linkScales(): void

# Returns

void

# Defined in

types/index.d.ts:599 (opens new window)

# parse

▸ parse(start, count): void

# Parameters

Name Type
start number
count number

# Returns

void

# Defined in

types/index.d.ts:644 (opens new window)

# parseArrayData

▸ Protected parseArrayData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<TType, TElement, TDatasetElement>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Defined in

types/index.d.ts:646 (opens new window)

# parseObjectData

▸ Protected parseObjectData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<TType, TElement, TDatasetElement>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Defined in

types/index.d.ts:647 (opens new window)

# parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<TType, TElement, TDatasetElement>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Defined in

types/index.d.ts:645 (opens new window)

# removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element TElement
datasetIndex number
index number

# Returns

void

# Defined in

types/index.d.ts:641 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Defined in

types/index.d.ts:607 (opens new window)

# resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): AnyObject

# Parameters

Name Type
index number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Defined in

types/index.d.ts:618 (opens new window)

# resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): AnyObject

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Defined in

types/index.d.ts:617 (opens new window)

# setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element TElement
datasetIndex number
index number

# Returns

void

# Defined in

types/index.d.ts:642 (opens new window)

# update

▸ update(mode): void

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:603 (opens new window)

# updateElement

▸ Protected updateElement(element, index, properties, mode): void

Utility for updating an element with new properties, using animations when appropriate.

# Parameters

Name Type
element TElement | TDatasetElement
index number
properties AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:634 (opens new window)

# updateElements

▸ updateElements(elements, start, count, mode): void

# Parameters

Name Type
elements TElement[]
start number
count number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:602 (opens new window)

# updateIndex

▸ updateIndex(datasetIndex): void

# Parameters

Name Type
datasetIndex number

# Returns

void

# Defined in

types/index.d.ts:604 (opens new window)

# updateRangeFromParsed

▸ Protected updateRangeFromParsed(range, scale, parsed, stack): void

# Parameters

Name Type
range Object
range.max number
range.min number
scale Scale<CoreScaleOptions>
parsed unknown[]
stack string | boolean

# Returns

void

# Defined in

types/index.d.ts:650 (opens new window)

# updateSharedOptions

▸ Protected updateSharedOptions(sharedOptions, mode, newOptions): void

Utility to animate the shared options, that are potentially affecting multiple elements.

# Parameters

Name Type
sharedOptions AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
newOptions AnyObject

# Returns

void

# Defined in

types/index.d.ts:640 (opens new window)

+ (opens new window)

# Class: DatasetController<TType, TElement, TDatasetElement, TParsedData>

# Type parameters

Name Type
TType extends ChartType = ChartType
TElement extends Element = Element
TDatasetElement extends Element = Element
TParsedData ParsedDataType<TType>

# Hierarchy

# Constructors

# constructor

• new DatasetController<TType, TElement, TDatasetElement, TParsedData>(chart, datasetIndex)

# Type parameters

Name Type
TType extends keyof ChartTypeRegistry = keyof ChartTypeRegistry
TElement extends default<AnyObject, AnyObject, TElement> = default<AnyObject, AnyObject>
TDatasetElement extends default<AnyObject, AnyObject, TDatasetElement> = default<AnyObject, AnyObject>
TParsedData ParsedDataType<TType>

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
datasetIndex number

# Defined in

types/index.d.ts:588 (opens new window)

# Properties

# _cachedMeta

• Readonly _cachedMeta: ChartMeta<TType, TElement, TDatasetElement>

# Defined in

types/index.d.ts:592 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:590 (opens new window)

# enableOptionSharing

• enableOptionSharing: boolean

# Defined in

types/index.d.ts:593 (opens new window)

# index

• Readonly index: number

# Defined in

types/index.d.ts:591 (opens new window)

# supportsDecimation

• supportsDecimation: boolean

# Defined in

types/index.d.ts:597 (opens new window)

# Methods

# addElements

▸ addElements(): void

# Returns

void

# Defined in

types/index.d.ts:613 (opens new window)

# applyStack

▸ Protected applyStack(scale, parsed): number

# Parameters

Name Type
scale Scale<CoreScaleOptions>
parsed unknown[]

# Returns

number

# Defined in

types/index.d.ts:649 (opens new window)

# buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

# Parameters

Name Type
resetNewElements? boolean

# Returns

void

# Defined in

types/index.d.ts:614 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Defined in

types/index.d.ts:611 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Defined in

types/index.d.ts:606 (opens new window)

# getAllParsedValues

▸ getAllParsedValues(scale): number[]

# Parameters

Name Type
scale Scale<CoreScaleOptions>

# Returns

number[]

# Defined in

types/index.d.ts:600 (opens new window)

# getDataset

▸ getDataset(): ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Returns

ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Defined in

types/index.d.ts:608 (opens new window)

# getLabelAndValue

▸ Protected getLabelAndValue(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
label string
value string

# Defined in

types/index.d.ts:601 (opens new window)

# getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

# Returns

number | boolean

# Defined in

types/index.d.ts:605 (opens new window)

# getMeta

▸ getMeta(): ChartMeta<TType, TElement, TDatasetElement>

# Returns

ChartMeta<TType, TElement, TDatasetElement>

# Defined in

types/index.d.ts:609 (opens new window)

# getMinMax

▸ Protected getMinMax(scale, canStack?): Object

# Parameters

Name Type
scale Scale<CoreScaleOptions>
canStack? boolean

# Returns

Object

Name Type
max number
min number

# Defined in

types/index.d.ts:656 (opens new window)

# getParsed

▸ Protected getParsed(index): TParsedData

# Parameters

Name Type
index number

# Returns

TParsedData

# Defined in

types/index.d.ts:648 (opens new window)

# getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

# Parameters

Name Type
scaleID string

# Returns

Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:610 (opens new window)

# getSharedOptions

▸ Protected getSharedOptions(options): AnyObject

Utility for checking if the options are shared and should be animated separately.

# Parameters

Name Type
options AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:623 (opens new window)

# getStyle

▸ getStyle(index, active): AnyObject

# Parameters

Name Type
index number
active boolean

# Returns

AnyObject

# Defined in

types/index.d.ts:616 (opens new window)

# includeOptions

▸ Protected includeOptions(mode, sharedOptions): boolean

Utility for determining if options should be included in the updated properties

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
sharedOptions AnyObject

# Returns

boolean

# Defined in

types/index.d.ts:628 (opens new window)

# initialize

▸ initialize(): void

# Returns

void

# Defined in

types/index.d.ts:612 (opens new window)

# linkScales

▸ linkScales(): void

# Returns

void

# Defined in

types/index.d.ts:599 (opens new window)

# parse

▸ parse(start, count): void

# Parameters

Name Type
start number
count number

# Returns

void

# Defined in

types/index.d.ts:644 (opens new window)

# parseArrayData

▸ Protected parseArrayData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<TType, TElement, TDatasetElement>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Defined in

types/index.d.ts:646 (opens new window)

# parseObjectData

▸ Protected parseObjectData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<TType, TElement, TDatasetElement>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Defined in

types/index.d.ts:647 (opens new window)

# parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<TType, TElement, TDatasetElement>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Defined in

types/index.d.ts:645 (opens new window)

# removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element TElement
datasetIndex number
index number

# Returns

void

# Defined in

types/index.d.ts:641 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Defined in

types/index.d.ts:607 (opens new window)

# resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): AnyObject

# Parameters

Name Type
index number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Defined in

types/index.d.ts:618 (opens new window)

# resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): AnyObject

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Defined in

types/index.d.ts:617 (opens new window)

# setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element TElement
datasetIndex number
index number

# Returns

void

# Defined in

types/index.d.ts:642 (opens new window)

# update

▸ update(mode): void

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:603 (opens new window)

# updateElement

▸ Protected updateElement(element, index, properties, mode): void

Utility for updating an element with new properties, using animations when appropriate.

# Parameters

Name Type
element TElement | TDatasetElement
index number
properties AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:634 (opens new window)

# updateElements

▸ updateElements(elements, start, count, mode): void

# Parameters

Name Type
elements TElement[]
start number
count number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Defined in

types/index.d.ts:602 (opens new window)

# updateIndex

▸ updateIndex(datasetIndex): void

# Parameters

Name Type
datasetIndex number

# Returns

void

# Defined in

types/index.d.ts:604 (opens new window)

# updateRangeFromParsed

▸ Protected updateRangeFromParsed(range, scale, parsed, stack): void

# Parameters

Name Type
range Object
range.max number
range.min number
scale Scale<CoreScaleOptions>
parsed unknown[]
stack string | boolean

# Returns

void

# Defined in

types/index.d.ts:650 (opens new window)

# updateSharedOptions

▸ Protected updateSharedOptions(sharedOptions, mode, newOptions): void

Utility to animate the shared options, that are potentially affecting multiple elements.

# Parameters

Name Type
sharedOptions AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
newOptions AnyObject

# Returns

void

# Defined in

types/index.d.ts:640 (opens new window)

← →

- + diff --git a/docs/master/api/classes/DomPlatform.html b/docs/master/api/classes/DomPlatform.html index 29bb7c510a..fc396e0d42 100644 --- a/docs/master/api/classes/DomPlatform.html +++ b/docs/master/api/classes/DomPlatform.html @@ -7,7 +7,7 @@ - + @@ -40,8 +40,8 @@ (opens new window) GitHub (opens new window)

# Class: DomPlatform

# Hierarchy

# Constructors

# constructor

• new DomPlatform()

# Inherited from

BasePlatform.constructor

# Methods

# acquireContext

▸ acquireContext(canvas, options?): CanvasRenderingContext2D

Called at chart construction time, returns a context2d instance implementing -the [W3C Canvas 2D Context API standard]https://www.w3.org/TR/2dcontext/ (opens new window).

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas from which to acquire context (platform specific)
options? CanvasRenderingContext2DSettings The chart options

# Returns

CanvasRenderingContext2D

# Inherited from

BasePlatform.acquireContext

# Defined in

types/index.d.ts:2147 (opens new window)

# addEventListener

▸ addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to listen for event
type string The (ChartEvent) type to listen for
listener (e: ChartEvent) => void Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs.

# Returns

void

# Inherited from

BasePlatform.addEventListener

# Defined in

types/index.d.ts:2165 (opens new window)

# getDevicePixelRatio

▸ getDevicePixelRatio(): number

# Returns

number

the current devicePixelRatio of the device this platform is connected to.

# Inherited from

BasePlatform.getDevicePixelRatio

# Defined in

types/index.d.ts:2176 (opens new window)

# getMaximumSize

▸ getMaximumSize(canvas, width?, height?, aspectRatio?): Object

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas for which to calculate the maximum size
width? number Parent element's content width
height? number Parent element's content height
aspectRatio? number The aspect ratio to maintain

# Returns

Object

the maximum size available.

Name Type
height number
width number

# Inherited from

BasePlatform.getMaximumSize

# Defined in

types/index.d.ts:2184 (opens new window)

# isAttached

▸ isAttached(canvas): boolean

# Parameters

Name Type
canvas HTMLCanvasElement

# Returns

boolean

true if the canvas is attached to the platform, false if not.

# Inherited from

BasePlatform.isAttached

# Defined in

types/index.d.ts:2189 (opens new window)

# releaseContext

▸ releaseContext(context): boolean

Called at chart destruction time, releases any resources associated to the context -previously returned by the acquireContext() method.

# Parameters

Name Type Description
context CanvasRenderingContext2D The context2d instance

# Returns

boolean

true if the method succeeded, else false

# Inherited from

BasePlatform.releaseContext

# Defined in

types/index.d.ts:2157 (opens new window)

# removeEventListener

▸ removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to remove the listener
type string The (ChartEvent) type to remove
listener (e: ChartEvent) => void The listener function to remove from the event target.

# Returns

void

# Inherited from

BasePlatform.removeEventListener

# Defined in

types/index.d.ts:2172 (opens new window)

# updateConfig

▸ updateConfig(config): void

Updates config with platform specific requirements

# Parameters

Name Type
config ChartConfiguration<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

BasePlatform.updateConfig

# Defined in

types/index.d.ts:2194 (opens new window)

+the [W3C Canvas 2D Context API standard]https://www.w3.org/TR/2dcontext/ (opens new window).

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas from which to acquire context (platform specific)
options? CanvasRenderingContext2DSettings The chart options

# Returns

CanvasRenderingContext2D

# Inherited from

BasePlatform.acquireContext

# Defined in

types/index.d.ts:2147 (opens new window)

# addEventListener

▸ addEventListener(chart, type, listener): void

Registers the specified listener on the given chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to listen for event
type string The (ChartEvent) type to listen for
listener (e: ChartEvent) => void Receives a notification (an object that implements the ChartEvent interface) when an event of the specified type occurs.

# Returns

void

# Inherited from

BasePlatform.addEventListener

# Defined in

types/index.d.ts:2165 (opens new window)

# getDevicePixelRatio

▸ getDevicePixelRatio(): number

# Returns

number

the current devicePixelRatio of the device this platform is connected to.

# Inherited from

BasePlatform.getDevicePixelRatio

# Defined in

types/index.d.ts:2176 (opens new window)

# getMaximumSize

▸ getMaximumSize(canvas, width?, height?, aspectRatio?): Object

# Parameters

Name Type Description
canvas HTMLCanvasElement The canvas for which to calculate the maximum size
width? number Parent element's content width
height? number Parent element's content height
aspectRatio? number The aspect ratio to maintain

# Returns

Object

the maximum size available.

Name Type
height number
width number

# Inherited from

BasePlatform.getMaximumSize

# Defined in

types/index.d.ts:2184 (opens new window)

# isAttached

▸ isAttached(canvas): boolean

# Parameters

Name Type
canvas HTMLCanvasElement

# Returns

boolean

true if the canvas is attached to the platform, false if not.

# Inherited from

BasePlatform.isAttached

# Defined in

types/index.d.ts:2189 (opens new window)

# releaseContext

▸ releaseContext(context): boolean

Called at chart destruction time, releases any resources associated to the context +previously returned by the acquireContext() method.

# Parameters

Name Type Description
context CanvasRenderingContext2D The context2d instance

# Returns

boolean

true if the method succeeded, else false

# Inherited from

BasePlatform.releaseContext

# Defined in

types/index.d.ts:2157 (opens new window)

# removeEventListener

▸ removeEventListener(chart, type, listener): void

Removes the specified listener previously registered with addEventListener.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> Chart from which to remove the listener
type string The (ChartEvent) type to remove
listener (e: ChartEvent) => void The listener function to remove from the event target.

# Returns

void

# Inherited from

BasePlatform.removeEventListener

# Defined in

types/index.d.ts:2172 (opens new window)

# updateConfig

▸ updateConfig(config): void

Updates config with platform specific requirements

# Parameters

Name Type
config ChartConfiguration<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> | ChartConfigurationCustomTypesPerDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

BasePlatform.updateConfig

# Defined in

types/index.d.ts:2194 (opens new window)

← →

- + diff --git a/docs/master/api/classes/PointElement.html b/docs/master/api/classes/PointElement.html index 65b8fbf5dc..5e9623dab7 100644 --- a/docs/master/api/classes/PointElement.html +++ b/docs/master/api/classes/PointElement.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: PointElement

# Hierarchy

# Constructors

# constructor

• new PointElement(cfg)

# Parameters

Name Type
cfg any

# Overrides

Element<PointProps, PointOptions & PointHoverOptions&gt;.constructor

# Defined in

elements/element.point.ts:49 (opens new window)

# Properties

# $animations

• $animations: Record<keyof Point, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# options

• options: PointOptions & PointHoverOptions

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# parsed

• parsed: CartesianParsedData

# Defined in

elements/element.point.ts:24 (opens new window)

# skip

• Optional skip: boolean

# Defined in

elements/element.point.ts:25 (opens new window)

# stop

• Optional stop: boolean

# Defined in

elements/element.point.ts:26 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# defaultRoutes

▪ Static defaultRoutes: Object

# Type declaration

Name Type
backgroundColor string
borderColor string

# Overrides

Element.defaultRoutes

# Defined in

elements/element.point.ts:44 (opens new window)

# defaults

▪ Static defaults: Object

# Type declaration

Name Type
borderWidth number
hitRadius number
hoverBorderWidth number
hoverRadius number
pointStyle string
radius number
rotation number

# Overrides

Element.defaults

# Defined in

elements/element.point.ts:31 (opens new window)

# id

▪ Static id: string = 'point'

# Defined in

elements/element.point.ts:22 (opens new window)

# Methods

# draw

▸ draw(ctx, area): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area ChartArea

# Returns

void

# Defined in

elements/element.point.ts:89 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Object

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Object

Name Type
x number
y number

# Defined in

elements/element.point.ts:76 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<Point, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof Point[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<Point, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# getRange

▸ getRange(): any

# Returns

any

# Defined in

elements/element.point.ts:102 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

elements/element.point.ts:62 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Defined in

elements/element.point.ts:68 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

elements/element.point.ts:72 (opens new window)

# size

▸ size(options?): number

# Parameters

Name Type
options? Partial<PointOptions & PointHoverOptions>

# Returns

number

# Defined in

elements/element.point.ts:81 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

+ (opens new window)

# Class: PointElement

# Hierarchy

# Constructors

# constructor

• new PointElement(cfg)

# Parameters

Name Type
cfg any

# Overrides

Element<PointProps, PointOptions & PointHoverOptions&gt;.constructor

# Defined in

elements/element.point.ts:49 (opens new window)

# Properties

# $animations

• $animations: Record<keyof Point, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# options

• options: PointOptions & PointHoverOptions

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# parsed

• parsed: CartesianParsedData

# Defined in

elements/element.point.ts:24 (opens new window)

# skip

• Optional skip: boolean

# Defined in

elements/element.point.ts:25 (opens new window)

# stop

• Optional stop: boolean

# Defined in

elements/element.point.ts:26 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# defaultRoutes

▪ Static defaultRoutes: Object

# Type declaration

Name Type
backgroundColor string
borderColor string

# Overrides

Element.defaultRoutes

# Defined in

elements/element.point.ts:44 (opens new window)

# defaults

▪ Static defaults: Object

# Type declaration

Name Type
borderWidth number
hitRadius number
hoverBorderWidth number
hoverRadius number
pointStyle string
radius number
rotation number

# Overrides

Element.defaults

# Defined in

elements/element.point.ts:31 (opens new window)

# id

▪ Static id: string = 'point'

# Defined in

elements/element.point.ts:22 (opens new window)

# Methods

# draw

▸ draw(ctx, area): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area ChartArea

# Returns

void

# Defined in

elements/element.point.ts:89 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Object

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Object

Name Type
x number
y number

# Defined in

elements/element.point.ts:76 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<Point, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof Point[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<Point, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# getRange

▸ getRange(): any

# Returns

any

# Defined in

elements/element.point.ts:102 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

elements/element.point.ts:62 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Defined in

elements/element.point.ts:68 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

elements/element.point.ts:72 (opens new window)

# size

▸ size(options?): number

# Parameters

Name Type
options? Partial<PointOptions & PointHoverOptions>

# Returns

number

# Defined in

elements/element.point.ts:81 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

← →

- + diff --git a/docs/master/api/classes/Scale.html b/docs/master/api/classes/Scale.html index 477a2e2827..0adb3dafd5 100644 --- a/docs/master/api/classes/Scale.html +++ b/docs/master/api/classes/Scale.html @@ -7,7 +7,7 @@ - + @@ -39,12 +39,12 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Class: Scale<O>

# Type parameters

Name Type
O extends CoreScaleOptions = CoreScaleOptions

# Hierarchy

# 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 (opens new window)

# Properties

# $animations

• $animations: Record<never, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# axis

• axis: string

# Defined in

types/index.d.ts:1276 (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

types/layout.d.ts:41 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:1266 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Defined in

types/index.d.ts:1265 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

LayoutItem.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

LayoutItem.height

# Defined in

types/layout.d.ts:25 (opens new window)

# id

• Readonly id: string

# Defined in

types/index.d.ts:1263 (opens new window)

# labelRotation

• labelRotation: number

# Defined in

types/index.d.ts:1277 (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

types/layout.d.ts:29 (opens new window)

# max

• max: number

# Defined in

types/index.d.ts:1279 (opens new window)

# maxHeight

• maxHeight: number

# Defined in

types/index.d.ts:1269 (opens new window)

# maxWidth

• maxWidth: number

# Defined in

types/index.d.ts:1268 (opens new window)

# min

• min: number

# Defined in

types/index.d.ts:1278 (opens new window)

# options

• options: O

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# paddingBottom

• paddingBottom: number

# Defined in

types/index.d.ts:1272 (opens new window)

# paddingLeft

• paddingLeft: number

# Defined in

types/index.d.ts:1273 (opens new window)

# paddingRight

• paddingRight: number

# Defined in

types/index.d.ts:1274 (opens new window)

# paddingTop

• paddingTop: number

# Defined in

types/index.d.ts:1271 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

LayoutItem.position

# Defined in

types/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

LayoutItem.right

# Defined in

types/layout.d.ts:37 (opens new window)

# ticks

• ticks: Tick[]

# Defined in

types/index.d.ts:1280 (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

types/layout.d.ts:33 (opens new window)

# type

• Readonly type: string

# Defined in

types/index.d.ts:1264 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

LayoutItem.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(): void

# Returns

void

# Defined in

types/index.d.ts:1361 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(): void

# Returns

void

# Defined in

types/index.d.ts:1367 (opens new window)

# afterDataLimits

▸ afterDataLimits(): void

# Returns

void

# Defined in

types/index.d.ts:1358 (opens new window)

# afterFit

▸ afterFit(): void

# Returns

void

# Defined in

types/index.d.ts:1370 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(): void

# Returns

void

# Defined in

types/index.d.ts:1355 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(): void

# Returns

void

# Defined in

types/index.d.ts:1364 (opens new window)

# afterUpdate

▸ afterUpdate(): void

# Returns

void

# Defined in

types/index.d.ts:1352 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(): void

# Returns

void

# Defined in

types/index.d.ts:1359 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(): void

# Returns

void

# Defined in

types/index.d.ts:1365 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(): void

# Returns

void

# Defined in

types/index.d.ts:1356 (opens new window)

# beforeFit

▸ beforeFit(): void

# Returns

void

# Defined in

types/index.d.ts:1368 (opens new window)

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

LayoutItem.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(): void

# Returns

void

# Defined in

types/index.d.ts:1353 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(): void

# Returns

void

# Defined in

types/index.d.ts:1362 (opens new window)

# beforeUpdate

▸ beforeUpdate(): void

# Returns

void

# Defined in

types/index.d.ts:1350 (opens new window)

# buildTicks

▸ buildTicks(): Tick[]

# Returns

Tick[]

# Defined in

types/index.d.ts:1360 (opens new window)

# calculateLabelRotation

▸ calculateLabelRotation(): void

# Returns

void

# Defined in

types/index.d.ts:1366 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Defined in

types/index.d.ts:1351 (opens new window)

# determineDataLimits

▸ determineDataLimits(): void

# Returns

void

# Defined in

types/index.d.ts:1357 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

LayoutItem.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# drawGrid

▸ drawGrid(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/index.d.ts:1285 (opens new window)

# drawLabels

▸ drawLabels(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/index.d.ts:1284 (opens new window)

# drawTitle

▸ drawTitle(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/index.d.ts:1283 (opens new window)

# fit

▸ fit(): void

# Returns

void

# Defined in

types/index.d.ts:1369 (opens new window)

# generateTickLabels

▸ generateTickLabels(ticks): void

# Parameters

Name Type
ticks Tick[]

# Returns

void

# Defined in

types/index.d.ts:1363 (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

types/index.d.ts:1341 (opens new window)

# getBaseValue

▸ getBaseValue(): number

# Returns

number

# Defined in

types/index.d.ts:1335 (opens new window)

# getDecimalForPixel

▸ getDecimalForPixel(pixel): number

# Parameters

Name Type
pixel number

# Returns

number

# Defined in

types/index.d.ts:1291 (opens new window)

# 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 (opens new window)

# getLabelItems

▸ getLabelItems(chartArea?): LabelItem[]

# Parameters

Name Type
chartArea? ChartArea

# Returns

LabelItem[]

# Defined in

types/index.d.ts:1349 (opens new window)

# getLabels

▸ getLabels(): string[]

# Returns

string[]

# Defined in

types/index.d.ts:1348 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

# getMinMax

▸ getMinMax(canStack): Object

# Parameters

Name Type
canStack boolean

# Returns

Object

Name Type
max number
min number

# Defined in

types/index.d.ts:1346 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

LayoutItem.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

▸ 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 (opens new window)

# getTicks

▸ getTicks(): Tick[]

# Returns

Tick[]

# Defined in

types/index.d.ts:1347 (opens new window)

# getUserBounds

▸ getUserBounds(): Object

# Returns

Object

Name Type
max number
maxDefined boolean
min number
minDefined boolean

# Defined in

types/index.d.ts:1345 (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

# Defined in

types/index.d.ts:1333 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# init

▸ init(options): void

# Parameters

Name Type
options O

# Returns

void

# Defined in

types/index.d.ts:1343 (opens new window)

# isFullSize

▸ isFullSize(): boolean

# Returns

boolean

# Defined in

types/index.d.ts:1372 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

LayoutItem.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# parse

▸ parse(raw, index?): unknown

# Parameters

Name Type
raw unknown
index? number

# Returns

unknown

# Defined in

types/index.d.ts:1344 (opens new window)

# setDimensions

▸ setDimensions(): void

# Returns

void

# Defined in

types/index.d.ts:1354 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

LayoutItem.update

# Defined in

types/layout.d.ts:64 (opens new window)

+ (opens new window)

# Class: Scale<O>

# Type parameters

Name Type
O extends CoreScaleOptions = CoreScaleOptions

# Hierarchy

# 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 (opens new window)

# Properties

# $animations

• $animations: Record<never, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# axis

• axis: string

# Defined in

types/index.d.ts:1276 (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

types/layout.d.ts:41 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:1266 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Defined in

types/index.d.ts:1265 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

LayoutItem.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

LayoutItem.height

# Defined in

types/layout.d.ts:25 (opens new window)

# id

• Readonly id: string

# Defined in

types/index.d.ts:1263 (opens new window)

# labelRotation

• labelRotation: number

# Defined in

types/index.d.ts:1277 (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

types/layout.d.ts:29 (opens new window)

# max

• max: number

# Defined in

types/index.d.ts:1279 (opens new window)

# maxHeight

• maxHeight: number

# Defined in

types/index.d.ts:1269 (opens new window)

# maxWidth

• maxWidth: number

# Defined in

types/index.d.ts:1268 (opens new window)

# min

• min: number

# Defined in

types/index.d.ts:1278 (opens new window)

# options

• options: O

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# paddingBottom

• paddingBottom: number

# Defined in

types/index.d.ts:1272 (opens new window)

# paddingLeft

• paddingLeft: number

# Defined in

types/index.d.ts:1273 (opens new window)

# paddingRight

• paddingRight: number

# Defined in

types/index.d.ts:1274 (opens new window)

# paddingTop

• paddingTop: number

# Defined in

types/index.d.ts:1271 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

LayoutItem.position

# Defined in

types/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

LayoutItem.right

# Defined in

types/layout.d.ts:37 (opens new window)

# ticks

• ticks: Tick[]

# Defined in

types/index.d.ts:1280 (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

types/layout.d.ts:33 (opens new window)

# type

• Readonly type: string

# Defined in

types/index.d.ts:1264 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

LayoutItem.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(): void

# Returns

void

# Defined in

types/index.d.ts:1361 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(): void

# Returns

void

# Defined in

types/index.d.ts:1367 (opens new window)

# afterDataLimits

▸ afterDataLimits(): void

# Returns

void

# Defined in

types/index.d.ts:1358 (opens new window)

# afterFit

▸ afterFit(): void

# Returns

void

# Defined in

types/index.d.ts:1370 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(): void

# Returns

void

# Defined in

types/index.d.ts:1355 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(): void

# Returns

void

# Defined in

types/index.d.ts:1364 (opens new window)

# afterUpdate

▸ afterUpdate(): void

# Returns

void

# Defined in

types/index.d.ts:1352 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(): void

# Returns

void

# Defined in

types/index.d.ts:1359 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(): void

# Returns

void

# Defined in

types/index.d.ts:1365 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(): void

# Returns

void

# Defined in

types/index.d.ts:1356 (opens new window)

# beforeFit

▸ beforeFit(): void

# Returns

void

# Defined in

types/index.d.ts:1368 (opens new window)

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

LayoutItem.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(): void

# Returns

void

# Defined in

types/index.d.ts:1353 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(): void

# Returns

void

# Defined in

types/index.d.ts:1362 (opens new window)

# beforeUpdate

▸ beforeUpdate(): void

# Returns

void

# Defined in

types/index.d.ts:1350 (opens new window)

# buildTicks

▸ buildTicks(): Tick[]

# Returns

Tick[]

# Defined in

types/index.d.ts:1360 (opens new window)

# calculateLabelRotation

▸ calculateLabelRotation(): void

# Returns

void

# Defined in

types/index.d.ts:1366 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Defined in

types/index.d.ts:1351 (opens new window)

# determineDataLimits

▸ determineDataLimits(): void

# Returns

void

# Defined in

types/index.d.ts:1357 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

LayoutItem.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# drawGrid

▸ drawGrid(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/index.d.ts:1285 (opens new window)

# drawLabels

▸ drawLabels(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/index.d.ts:1284 (opens new window)

# drawTitle

▸ drawTitle(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/index.d.ts:1283 (opens new window)

# fit

▸ fit(): void

# Returns

void

# Defined in

types/index.d.ts:1369 (opens new window)

# generateTickLabels

▸ generateTickLabels(ticks): void

# Parameters

Name Type
ticks Tick[]

# Returns

void

# Defined in

types/index.d.ts:1363 (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

types/index.d.ts:1341 (opens new window)

# getBaseValue

▸ getBaseValue(): number

# Returns

number

# Defined in

types/index.d.ts:1335 (opens new window)

# getDecimalForPixel

▸ getDecimalForPixel(pixel): number

# Parameters

Name Type
pixel number

# Returns

number

# Defined in

types/index.d.ts:1291 (opens new window)

# 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 (opens new window)

# getLabelItems

▸ getLabelItems(chartArea?): LabelItem[]

# Parameters

Name Type
chartArea? ChartArea

# Returns

LabelItem[]

# Defined in

types/index.d.ts:1349 (opens new window)

# getLabels

▸ getLabels(): string[]

# Returns

string[]

# Defined in

types/index.d.ts:1348 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

# getMinMax

▸ getMinMax(canStack): Object

# Parameters

Name Type
canStack boolean

# Returns

Object

Name Type
max number
min number

# Defined in

types/index.d.ts:1346 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

LayoutItem.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

# 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 (opens new window)

▸ 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 (opens new window)

# getTicks

▸ getTicks(): Tick[]

# Returns

Tick[]

# Defined in

types/index.d.ts:1347 (opens new window)

# getUserBounds

▸ getUserBounds(): Object

# Returns

Object

Name Type
max number
maxDefined boolean
min number
minDefined boolean

# Defined in

types/index.d.ts:1345 (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

# Defined in

types/index.d.ts:1333 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# init

▸ init(options): void

# Parameters

Name Type
options O

# Returns

void

# Defined in

types/index.d.ts:1343 (opens new window)

# isFullSize

▸ isFullSize(): boolean

# Returns

boolean

# Defined in

types/index.d.ts:1372 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

LayoutItem.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# parse

▸ parse(raw, index?): unknown

# Parameters

Name Type
raw unknown
index? number

# Returns

unknown

# Defined in

types/index.d.ts:1344 (opens new window)

# setDimensions

▸ setDimensions(): void

# Returns

void

# Defined in

types/index.d.ts:1354 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

LayoutItem.update

# Defined in

types/layout.d.ts:64 (opens new window)

← →

- + diff --git a/docs/master/api/enums/DecimationAlgorithm.html b/docs/master/api/enums/DecimationAlgorithm.html index d205a3308b..cf528038ea 100644 --- a/docs/master/api/enums/DecimationAlgorithm.html +++ b/docs/master/api/enums/DecimationAlgorithm.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Enumeration: DecimationAlgorithm

# Enumeration Members

# lttb

• lttb = "lttb"

# Defined in

types/index.d.ts:2203 (opens new window)

# minmax

• minmax = "min-max"

# Defined in

types/index.d.ts:2204 (opens new window)

+ (opens new window)

# Enumeration: DecimationAlgorithm

# Enumeration Members

# lttb

• lttb = "lttb"

# Defined in

types/index.d.ts:2203 (opens new window)

# minmax

• minmax = "min-max"

# Defined in

types/index.d.ts:2204 (opens new window)

← →

- + diff --git a/docs/master/api/enums/UpdateModeEnum.html b/docs/master/api/enums/UpdateModeEnum.html index a20c3c2814..aafe0388a8 100644 --- a/docs/master/api/enums/UpdateModeEnum.html +++ b/docs/master/api/enums/UpdateModeEnum.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Enumeration: UpdateModeEnum

# Enumeration Members

# active

• active = "active"

# Defined in

types/index.d.ts:577 (opens new window)

# default

• default = "default"

# Defined in

types/index.d.ts:576 (opens new window)

# hide

• hide = "hide"

# Defined in

types/index.d.ts:574 (opens new window)

# none

• none = "none"

# Defined in

types/index.d.ts:573 (opens new window)

# reset

• reset = "reset"

# Defined in

types/index.d.ts:572 (opens new window)

# resize

• resize = "resize"

# Defined in

types/index.d.ts:571 (opens new window)

# show

• show = "show"

# Defined in

types/index.d.ts:575 (opens new window)

+ (opens new window)

# Enumeration: UpdateModeEnum

# Enumeration Members

# active

• active = "active"

# Defined in

types/index.d.ts:577 (opens new window)

# default

• default = "default"

# Defined in

types/index.d.ts:576 (opens new window)

# hide

• hide = "hide"

# Defined in

types/index.d.ts:574 (opens new window)

# none

• none = "none"

# Defined in

types/index.d.ts:573 (opens new window)

# reset

• reset = "reset"

# Defined in

types/index.d.ts:572 (opens new window)

# resize

• resize = "resize"

# Defined in

types/index.d.ts:571 (opens new window)

# show

• show = "show"

# Defined in

types/index.d.ts:575 (opens new window)

← →

- + diff --git a/docs/master/api/index.html b/docs/master/api/index.html index d590e6f4e8..d59dd9876d 100644 --- a/docs/master/api/index.html +++ b/docs/master/api/index.html @@ -7,7 +7,7 @@ - + @@ -39,11 +39,11 @@ Stack Overflow (opens new window) GitHub - (opens new window)

  • API

    • Exports

    • Enumerations

    • Classes

    • Interfaces

# Chart.js - v4.4.1

# Enumerations

# Classes

# Interfaces

# Type Aliases

# Align

Ƭ Align: "start" | "center" | "end"

# Defined in

types/index.d.ts:1793 (opens new window)

# AnimationOptions

Ƭ AnimationOptions<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Type declaration

Name Type
animation false | AnimationSpec<TType> & { onComplete?: (this: Chart, event: AnimationEvent) => void ; onProgress?: (this: Chart, event: AnimationEvent) => void }
animations AnimationsSpec<TType>
transitions TransitionsSpec<TType>

# Defined in

types/index.d.ts:1746 (opens new window)

# AnimationSpec

Ƭ AnimationSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Type declaration

Name Type Description
delay? Scriptable<number, ScriptableContext<TType>> Delay before starting the animations. Default 0
duration? Scriptable<number, ScriptableContext<TType>> The number of milliseconds an animation takes. Default 1000
easing? Scriptable<EasingFunction, ScriptableContext<TType>> Easing function to use Default 'easeOutQuart'
loop? Scriptable<boolean, ScriptableContext<TType>> If set to true, the animations loop endlessly. Default false

# Defined in

types/index.d.ts:1690 (opens new window)

# AnimationsSpec

Ƭ AnimationsSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Index signature

▪ [name: string]: false | AnimationSpec<TType> & { fn: <T>(from: T, to: T, factor: number) => T ; from: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; properties: string[] ; to: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; type: "color" | "number" | "boolean" }

# Defined in

types/index.d.ts:1715 (opens new window)

# BarController

Ƭ BarController: DatasetController

# Defined in

types/index.d.ts:156 (opens new window)

types/index.d.ts:157 (opens new window)

# BubbleController

Ƭ BubbleController: DatasetController

# Defined in

types/index.d.ts:183 (opens new window)

types/index.d.ts:184 (opens new window)

# CartesianTickOptions

Ƭ CartesianTickOptions: TickOptions & { align: Align | "inner" ; autoSkip: boolean ; autoSkipPadding: number ; crossAlign: "near" | "center" | "far" ; includeBounds: boolean ; labelOffset: number ; maxRotation: number ; maxTicksLimit: number ; minRotation: number ; mirror: boolean ; padding: number ; sampleSize: number }

# Defined in

types/index.d.ts:3090 (opens new window)

# CategoryScale

Ƭ CategoryScale<O>: Scale<O>

# Type parameters

Name Type
O extends CategoryScaleOptions = CategoryScaleOptions

# Defined in

types/index.d.ts:3257 (opens new window)

types/index.d.ts:3258 (opens new window)

# CategoryScaleOptions

Ƭ CategoryScaleOptions: Omit<CartesianScaleOptions, "min" | "max"> & { labels: string[] | string[][] ; max: string | number ; min: string | number }

# Defined in

types/index.d.ts:3251 (opens new window)

# ChartComponentLike

Ƭ ChartComponentLike: ChartComponent | ChartComponent[] | { [key: string]: ChartComponent; } | Plugin | Plugin[]

# Defined in

types/index.d.ts:1125 (opens new window)

# ChartDataset

Ƭ ChartDataset<TType, TData>: DeepPartial<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }[TType]> & ChartDatasetProperties<TType, TData>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>

# Defined in

types/index.d.ts:3770 (opens new window)

# ChartDatasetCustomTypesPerDataset

Ƭ ChartDatasetCustomTypesPerDataset<TType, TData>: DeepPartial<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }[TType]> & ChartDatasetPropertiesCustomTypesPerDataset<TType, TData>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>

# Defined in

types/index.d.ts:3777 (opens new window)

# ChartItem

Ƭ ChartItem: string | CanvasRenderingContext2D | HTMLCanvasElement | { canvas: HTMLCanvasElement } | ArrayLike<CanvasRenderingContext2D | HTMLCanvasElement>

# Defined in

types/index.d.ts:563 (opens new window)

# ChartMeta

Ƭ ChartMeta<TType, TElement, TDatasetElement>: DeepPartial<{ [key in ChartType]: ChartTypeRegistry[key]["metaExtensions"] }[TType]> & ChartMetaCommon<TElement, TDatasetElement>

# Type parameters

Name Type
TType extends ChartType = ChartType
TElement extends Element = Element
TDatasetElement extends Element = Element

# Defined in

types/index.d.ts:467 (opens new window)

# ChartOptions

Ƭ ChartOptions<TType>: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Type parameters

Name Type
TType extends ChartType = ChartType

# Defined in

types/index.d.ts:3747 (opens new window)

# ChartType

Ƭ ChartType: keyof ChartTypeRegistry

# Defined in

types/index.d.ts:3726 (opens new window)

# Color

Ƭ Color: string | CanvasGradient | CanvasPattern

# Defined in

types/color.d.ts:1 (opens new window)

# DatasetChartOptions

Ƭ DatasetChartOptions<TType>: { [key in TType]: Object }

# Type parameters

Name Type
TType extends ChartType = ChartType

# Defined in

types/index.d.ts:3735 (opens new window)

# DecimationOptions

Ƭ DecimationOptions: LttbDecimationOptions | MinMaxDecimationOptions

# Defined in

types/index.d.ts:2220 (opens new window)

# DefaultDataPoint

Ƭ DefaultDataPoint<TType>: DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>

# Type parameters

Name Type
TType extends ChartType

# Defined in

types/index.d.ts:3756 (opens new window)

# DoughnutDataPoint

Ƭ DoughnutDataPoint: number

# Defined in

types/index.d.ts:338 (opens new window)

# EasingFunction

Ƭ EasingFunction: keyof typeof effects

# Defined in

helpers/helpers.easing.ts:122 (opens new window)

# ElementChartOptions

Ƭ ElementChartOptions<TType>: Object

# Type parameters

Name Type
TType extends ChartType = ChartType

# Type declaration

Name Type
elements ElementOptionsByType<TType>

# Defined in

types/index.d.ts:2136 (opens new window)

# FillTarget

Ƭ FillTarget: number | string | { value: number } | "start" | "end" | "origin" | "stack" | "shape" | boolean

# Defined in

types/index.d.ts:2228 (opens new window)

# InteractionAxis

Ƭ InteractionAxis: "x" | "y" | "xy" | "r"

# Defined in

types/index.d.ts:1562 (opens new window)

# InteractionMode

Ƭ InteractionMode: keyof InteractionModeMap

# Defined in

types/index.d.ts:761 (opens new window)

# InteractionModeFunction

Ƭ InteractionModeFunction: (chart: Chart, e: ChartEvent, options: InteractionOptions, useFinalPosition?: boolean) => InteractionItem[]

# Type declaration

▸ (chart, e, options, useFinalPosition?): InteractionItem[]

# Parameters
Name Type
chart Chart
e ChartEvent
options InteractionOptions
useFinalPosition? boolean
# Returns

InteractionItem[]

# Defined in

types/index.d.ts:723 (opens new window)

# LayoutPosition

Ƭ LayoutPosition: "left" | "top" | "right" | "bottom" | "center" | "chartArea" | { [scaleId: string]: number; }

# Defined in

types/layout.d.ts:3 (opens new window)

# LineController

Ƭ LineController: DatasetController

# Defined in

types/index.d.ts:229 (opens new window)

types/index.d.ts:230 (opens new window)

# LinearScale

Ƭ LinearScale<O>: Scale<O>

# Type parameters

Name Type
O extends LinearScaleOptions = LinearScaleOptions

# Defined in

types/index.d.ts:3306 (opens new window)

types/index.d.ts:3307 (opens new window)

# LinearScaleOptions

Ƭ LinearScaleOptions: CartesianScaleOptions & { beginAtZero: boolean ; grace?: string | number ; suggestedMax?: number ; suggestedMin?: number ; ticks: { count: number ; format: Intl.NumberFormatOptions ; precision: number ; stepSize: number } }

# Defined in

types/index.d.ts:3263 (opens new window)

# LogarithmicScale

Ƭ LogarithmicScale<O>: Scale<O>

# Type parameters

Name Type
O extends LogarithmicScaleOptions = LogarithmicScaleOptions

# Defined in

types/index.d.ts:3330 (opens new window)

types/index.d.ts:3331 (opens new window)

# LogarithmicScaleOptions

Ƭ LogarithmicScaleOptions: CartesianScaleOptions & { suggestedMax?: number ; suggestedMin?: number ; ticks: { format: Intl.NumberFormatOptions } }

# Defined in

types/index.d.ts:3312 (opens new window)

# Overrides

Ƭ Overrides: { [key in ChartType]: CoreChartOptions<key> & ElementChartOptions<key> & PluginChartOptions<key> & DatasetChartOptions<ChartType> & ScaleChartOptions<key> & ChartTypeRegistry[key]["chartOptions"] }

# Defined in

types/index.d.ts:700 (opens new window)

# ParsedDataType

Ƭ ParsedDataType<TType>: ChartTypeRegistry[TType]["parsedDataType"]

# Type parameters

Name Type
TType extends ChartType = ChartType

# Defined in

types/index.d.ts:3758 (opens new window)

# PieAnimationOptions

Ƭ PieAnimationOptions: DoughnutAnimationOptions

# Defined in

types/index.d.ts:361 (opens new window)

# PieController

Ƭ PieController: DoughnutController

# Defined in

types/index.d.ts:366 (opens new window)

types/index.d.ts:367 (opens new window)

# PieControllerChartOptions

Ƭ PieControllerChartOptions: DoughnutControllerChartOptions

# Defined in

types/index.d.ts:360 (opens new window)

# PieControllerDatasetOptions

Ƭ PieControllerDatasetOptions: DoughnutControllerDatasetOptions

# Defined in

types/index.d.ts:359 (opens new window)

# PieDataPoint

Ƭ PieDataPoint: DoughnutDataPoint

# Defined in

types/index.d.ts:363 (opens new window)

# PieMetaExtensions

Ƭ PieMetaExtensions: DoughnutMetaExtensions

# Defined in

types/index.d.ts:364 (opens new window)

# PointProps

Ƭ PointProps: Point

# Defined in

elements/element.point.ts:18 (opens new window)

# PointStyle

Ƭ PointStyle: "circle" | "cross" | "crossRot" | "dash" | "line" | "rect" | "rectRounded" | "rectRot" | "star" | "triangle" | false | HTMLImageElement | HTMLCanvasElement

# Defined in

types/index.d.ts:1968 (opens new window)

# PolarAreaAnimationOptions

Ƭ PolarAreaAnimationOptions: DoughnutAnimationOptions

# Defined in

types/index.d.ts:380 (opens new window)

# RadarController

Ƭ RadarController: DatasetController

# Defined in

types/index.d.ts:427 (opens new window)

types/index.d.ts:428 (opens new window)

# RadarControllerChartOptions

Ƭ RadarControllerChartOptions: LineControllerChartOptions

# Defined in

types/index.d.ts:425 (opens new window)

# RadialLinearScaleOptions

Ƭ RadialLinearScaleOptions: CoreScaleOptions & { angleLines: { borderDash: Scriptable<number[], ScriptableScaleContext> ; borderDashOffset: Scriptable<number, ScriptableScaleContext> ; color: Scriptable<Color, ScriptableScaleContext> ; display: boolean ; lineWidth: Scriptable<number, ScriptableScaleContext> } ; animate: boolean ; beginAtZero: boolean ; grid: Partial<GridLineOptions> ; max: number ; min: number ; pointLabels: { backdropColor: Scriptable<Color, ScriptableScalePointLabelContext> ; backdropPadding: Scriptable<number | ChartArea, ScriptableScalePointLabelContext> ; borderRadius: Scriptable<number | BorderRadius, ScriptableScalePointLabelContext> ; callback: (label: string, index: number) => string | string[] | number | number[] ; centerPointLabels: boolean ; color: Scriptable<Color, ScriptableScalePointLabelContext> ; display: boolean | "auto" ; font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScalePointLabelContext> ; padding: Scriptable<number, ScriptableScalePointLabelContext> } ; startAngle: number ; suggestedMax: number ; suggestedMin: number ; ticks: RadialTickOptions }

# Defined in

types/index.d.ts:3470 (opens new window)

# RadialTickOptions

Ƭ RadialTickOptions: TickOptions & { count: number ; format: Intl.NumberFormatOptions ; maxTicksLimit: number ; precision: number ; stepSize: number }

# Defined in

types/index.d.ts:3442 (opens new window)

# ScaleChartOptions

Ƭ ScaleChartOptions<TType>: Object

# Type parameters

Name Type
TType extends ChartType = ChartType

# Type declaration

Name Type
scales { [key: string]: ScaleOptionsByType<ChartTypeRegistry[TType]["scales"]>; }

# Defined in

types/index.d.ts:3741 (opens new window)

# ScaleOptions

Ƭ ScaleOptions<TScale>: DeepPartial<ScaleOptionsByType<TScale>>

# Type parameters

Name Type
TScale extends ScaleType = ScaleType

# Defined in

types/index.d.ts:3733 (opens new window)

# ScaleOptionsByType

Ƭ ScaleOptionsByType<TScale>: { [key in ScaleType]: Object & ScaleTypeRegistry[key]["options"] }[TScale]

# Type parameters

Name Type
TScale extends ScaleType = ScaleType

# Defined in

types/index.d.ts:3728 (opens new window)

# ScaleType

Ƭ ScaleType: keyof ScaleTypeRegistry

# Defined in

types/index.d.ts:3625 (opens new window)

# ScatterController

Ƭ ScatterController: LineController

# Defined in

types/index.d.ts:241 (opens new window)

types/index.d.ts:242 (opens new window)

# ScatterControllerChartOptions

Ƭ ScatterControllerChartOptions: LineControllerChartOptions

# Defined in

types/index.d.ts:239 (opens new window)

# ScatterControllerDatasetOptions

Ƭ ScatterControllerDatasetOptions: LineControllerDatasetOptions

# Defined in

types/index.d.ts:235 (opens new window)

# ScatterDataPoint

Ƭ ScatterDataPoint: Point

# Defined in

types/index.d.ts:237 (opens new window)

# Scriptable

Ƭ Scriptable<T, TContext>: T | (ctx: TContext, options: AnyObject) => T | undefined

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:44 (opens new window)

# ScriptableAndArray

Ƭ ScriptableAndArray<T, TContext>: readonly T[] | Scriptable<T, TContext>

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:47 (opens new window)

# ScriptableAndArrayOptions

Ƭ ScriptableAndArrayOptions<T, TContext>: { [P in keyof T]: ScriptableAndArray<T[P], TContext> }

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:48 (opens new window)

# ScriptableAndScriptableOptions

Ƭ ScriptableAndScriptableOptions<T, TContext>: Scriptable<T, TContext> | ScriptableOptions<T, TContext>

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:46 (opens new window)

# ScriptableOptions

Ƭ ScriptableOptions<T, TContext>: { [P in keyof T]: Scriptable<T[P], TContext> }

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:45 (opens new window)

# TextAlign

Ƭ TextAlign: "left" | "center" | "right"

# Defined in

types/index.d.ts:1792 (opens new window)

# TimeScaleOptions

Ƭ TimeScaleOptions: Omit<CartesianScaleOptions, "min" | "max"> & { adapters: { date: unknown } ; bounds: "ticks" | "data" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }

# Defined in

types/index.d.ts:3391 (opens new window)

# TimeScaleTickOptions

Ƭ TimeScaleTickOptions: Object

# Type declaration

Name Type Description
source "labels" | "auto" | "data" Ticks generation input values: - 'auto': generates "optimal" ticks based on scale size and time options. - 'data': generates ticks from data (including labels from data {t\|x\|y} objects). - 'labels': generates ticks from user given data.labels values ONLY. See https://github.com/chartjs/Chart.js/pull/4507 Since 2.7.0 Default 'auto'
stepSize number The number of units between grid lines. Default 1

# Defined in

types/index.d.ts:3373 (opens new window)

# TimeScaleTimeOptions

Ƭ TimeScaleTimeOptions: Object

# Type declaration

Name Type Description
displayFormats { [key: string]: string; } Sets how different time units are displayed.
isoWeekday boolean | number If boolean and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If number, the index of the first day of the week (0 - Sunday, 6 - Saturday). Default false
minUnit TimeUnit The minimum display format to be used for a time unit. Default 'millisecond'
parser string | (v: unknown) => number Custom parser for dates.
round false | TimeUnit If defined, dates will be rounded to the start of this unit. See Time Units below for the allowed units.
tooltipFormat string The format string to use for the tooltip.
unit false | TimeUnit If defined, will force the unit to be a certain type. See Time Units section below for details. Default false

# Defined in

types/index.d.ts:3336 (opens new window)

# TimeSeriesScale

Ƭ TimeSeriesScale<O>: TimeScale<O>

# Type parameters

Name Type
O extends TimeScaleOptions = TimeScaleOptions

# Defined in

types/index.d.ts:3436 (opens new window)

types/index.d.ts:3437 (opens new window)

# TooltipPositioner

Ƭ TooltipPositioner: keyof TooltipPositionerMap

# Defined in

types/index.d.ts:2650 (opens new window)

# TooltipPositionerFunction

Ƭ TooltipPositionerFunction<TType>: (this: TooltipModel<TType>, items: readonly ActiveElement[], eventPosition: Point) => TooltipPosition | false

# Type parameters

Name Type
TType extends ChartType

# Type declaration

▸ (this, items, eventPosition): TooltipPosition | false

# Parameters
Name Type
this TooltipModel<TType>
items readonly ActiveElement[]
eventPosition Point
# Returns

TooltipPosition | false

# Defined in

types/index.d.ts:2639 (opens new window)

# TooltipXAlignment

Ƭ TooltipXAlignment: "left" | "center" | "right"

# Defined in

types/index.d.ts:2550 (opens new window)

# TooltipYAlignment

Ƭ TooltipYAlignment: "top" | "center" | "bottom"

# Defined in

types/index.d.ts:2551 (opens new window)

# TransitionSpec

Ƭ TransitionSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Type declaration

Name Type
animation AnimationSpec<TType>
animations AnimationsSpec<TType>

# Defined in

types/index.d.ts:1737 (opens new window)

# TransitionsSpec

Ƭ TransitionsSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Index signature

▪ [mode: string]: TransitionSpec<TType>

# Defined in

types/index.d.ts:1742 (opens new window)

# UpdateMode

Ƭ UpdateMode: keyof typeof UpdateModeEnum

# Defined in

types/index.d.ts:580 (opens new window)

# Variables

# BarController

• BarController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => BarController

# Defined in

types/index.d.ts:156 (opens new window)

types/index.d.ts:157 (opens new window)

# BarElement

• BarElement: ChartComponent & (cfg: AnyObject) => BarElement<BarProps, BarOptions>

# Defined in

types/index.d.ts:2119 (opens new window)

types/index.d.ts:2124 (opens new window)

# BubbleController

• BubbleController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => BubbleController

# Defined in

types/index.d.ts:183 (opens new window)

types/index.d.ts:184 (opens new window)

# CategoryScale

• CategoryScale: ChartComponent & <O>(cfg: AnyObject) => CategoryScale<O>

# Defined in

types/index.d.ts:3257 (opens new window)

types/index.d.ts:3258 (opens new window)

# Decimation

• Const Decimation: Plugin

# Defined in

types/index.d.ts:2200 (opens new window)

# DoughnutController

• DoughnutController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => DoughnutController

# Defined in

types/index.d.ts:340 (opens new window)

types/index.d.ts:350 (opens new window)

# Filler

• Const Filler: Plugin

# Defined in

types/index.d.ts:2222 (opens new window)

# Interaction

• Const Interaction: Object

# Type declaration

Name Type
modes InteractionModeMap
evaluateInteractionItems (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, axis: InteractionAxis, position: Point, handler: (element: default<AnyObject, AnyObject> & VisualElement, datasetIndex: number, index: number) => void, intersect?: boolean) => InteractionItem[]

# Defined in

types/index.d.ts:763 (opens new window)

# Legend

• Const Legend: Plugin

# Defined in

types/index.d.ts:2252 (opens new window)

# LineController

• LineController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => LineController

# Defined in

types/index.d.ts:229 (opens new window)

types/index.d.ts:230 (opens new window)

# LineElement

• LineElement: ChartComponent & (cfg: AnyObject) => LineElement<LineProps, LineOptions>

# Defined in

types/index.d.ts:1950 (opens new window)

types/index.d.ts:1963 (opens new window)

# LinearScale

• LinearScale: ChartComponent & <O>(cfg: AnyObject) => LinearScale<O>

# Defined in

types/index.d.ts:3306 (opens new window)

types/index.d.ts:3307 (opens new window)

# LogarithmicScale

• LogarithmicScale: ChartComponent & <O>(cfg: AnyObject) => LogarithmicScale<O>

# Defined in

types/index.d.ts:3330 (opens new window)

types/index.d.ts:3331 (opens new window)

# PieController

• PieController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => DoughnutController

# Defined in

types/index.d.ts:366 (opens new window)

types/index.d.ts:367 (opens new window)

# PolarAreaController

• PolarAreaController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => PolarAreaController

# Defined in

types/index.d.ts:392 (opens new window)

types/index.d.ts:395 (opens new window)

# RadarController

• RadarController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => RadarController

# Defined in

types/index.d.ts:427 (opens new window)

types/index.d.ts:428 (opens new window)

# RadialLinearScale

• RadialLinearScale: ChartComponent & <O>(cfg: AnyObject) => RadialLinearScale<O>

# Defined in

types/index.d.ts:3583 (opens new window)

types/index.d.ts:3593 (opens new window)

# ScatterController

• ScatterController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => LineController

# Defined in

types/index.d.ts:241 (opens new window)

types/index.d.ts:242 (opens new window)

# SubTitle

• Const SubTitle: Plugin

# Defined in

types/index.d.ts:2508 (opens new window)

# Ticks

• Const Ticks: Object

# Type declaration

Name Type
formatters { logarithmic: (tickValue: number, index: number, ticks: { value: number }[]) => string ; numeric: (tickValue: number, index: number, ticks: { value: number }[]) => string ; values: (value: unknown) => string | string[] }
formatters.logarithmic [object Object]
formatters.numeric [object Object]
formatters.values [object Object]

# Defined in

types/index.d.ts:1496 (opens new window)

# TimeScale

• TimeScale: ChartComponent & <O>(cfg: AnyObject) => TimeScale<O>

# Defined in

types/index.d.ts:3424 (opens new window)

types/index.d.ts:3431 (opens new window)

# TimeSeriesScale

• TimeSeriesScale: ChartComponent & <O>(cfg: AnyObject) => TimeSeriesScale<O>

# Defined in

types/index.d.ts:3436 (opens new window)

types/index.d.ts:3437 (opens new window)

# Title

• Const Title: Plugin

# Defined in

types/index.d.ts:2509 (opens new window)

# Tooltip

• Tooltip: Tooltip

# Defined in

types/index.d.ts:2652 (opens new window)

types/index.d.ts:2656 (opens new window)

# defaults

• Const defaults: Defaults

# Defined in

types/index.d.ts:710 (opens new window)

# layouts

• Const layouts: Object

# Type declaration

Name Type
addBox (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, item: LayoutItem) => void
configure (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, item: LayoutItem, options: { fullSize?: number ; position?: LayoutPosition ; weight?: number }) => void
removeBox (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, layoutItem: LayoutItem) => void
update (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, width: number, height: number) => void

# Defined in

types/index.d.ts:778 (opens new window)

# registerables

• Const registerables: readonly ChartComponentLike[]

# Defined in

types/index.d.ts:561 (opens new window)

# registry

• Const registry: Registry

# Defined in

types/index.d.ts:1151 (opens new window)

+ (opens new window)

  • API

    • Exports

    • Enumerations

    • Classes

    • Interfaces

# Chart.js - v4.4.1

# Enumerations

# Classes

# Interfaces

# Type Aliases

# Align

Ƭ Align: "start" | "center" | "end"

# Defined in

types/index.d.ts:1793 (opens new window)

# AnimationOptions

Ƭ AnimationOptions<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Type declaration

Name Type
animation false | AnimationSpec<TType> & { onComplete?: (this: Chart, event: AnimationEvent) => void ; onProgress?: (this: Chart, event: AnimationEvent) => void }
animations AnimationsSpec<TType>
transitions TransitionsSpec<TType>

# Defined in

types/index.d.ts:1746 (opens new window)

# AnimationSpec

Ƭ AnimationSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Type declaration

Name Type Description
delay? Scriptable<number, ScriptableContext<TType>> Delay before starting the animations. Default 0
duration? Scriptable<number, ScriptableContext<TType>> The number of milliseconds an animation takes. Default 1000
easing? Scriptable<EasingFunction, ScriptableContext<TType>> Easing function to use Default 'easeOutQuart'
loop? Scriptable<boolean, ScriptableContext<TType>> If set to true, the animations loop endlessly. Default false

# Defined in

types/index.d.ts:1690 (opens new window)

# AnimationsSpec

Ƭ AnimationsSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Index signature

▪ [name: string]: false | AnimationSpec<TType> & { fn: <T>(from: T, to: T, factor: number) => T ; from: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; properties: string[] ; to: Scriptable<Color | number | boolean, ScriptableContext<TType>> ; type: "color" | "number" | "boolean" }

# Defined in

types/index.d.ts:1715 (opens new window)

# BarController

Ƭ BarController: DatasetController

# Defined in

types/index.d.ts:156 (opens new window)

types/index.d.ts:157 (opens new window)

# BubbleController

Ƭ BubbleController: DatasetController

# Defined in

types/index.d.ts:183 (opens new window)

types/index.d.ts:184 (opens new window)

# CartesianTickOptions

Ƭ CartesianTickOptions: TickOptions & { align: Align | "inner" ; autoSkip: boolean ; autoSkipPadding: number ; crossAlign: "near" | "center" | "far" ; includeBounds: boolean ; labelOffset: number ; maxRotation: number ; maxTicksLimit: number ; minRotation: number ; mirror: boolean ; padding: number ; sampleSize: number }

# Defined in

types/index.d.ts:3090 (opens new window)

# CategoryScale

Ƭ CategoryScale<O>: Scale<O>

# Type parameters

Name Type
O extends CategoryScaleOptions = CategoryScaleOptions

# Defined in

types/index.d.ts:3257 (opens new window)

types/index.d.ts:3258 (opens new window)

# CategoryScaleOptions

Ƭ CategoryScaleOptions: Omit<CartesianScaleOptions, "min" | "max"> & { labels: string[] | string[][] ; max: string | number ; min: string | number }

# Defined in

types/index.d.ts:3251 (opens new window)

# ChartComponentLike

Ƭ ChartComponentLike: ChartComponent | ChartComponent[] | { [key: string]: ChartComponent; } | Plugin | Plugin[]

# Defined in

types/index.d.ts:1125 (opens new window)

# ChartDataset

Ƭ ChartDataset<TType, TData>: DeepPartial<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }[TType]> & ChartDatasetProperties<TType, TData>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>

# Defined in

types/index.d.ts:3770 (opens new window)

# ChartDatasetCustomTypesPerDataset

Ƭ ChartDatasetCustomTypesPerDataset<TType, TData>: DeepPartial<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }[TType]> & ChartDatasetPropertiesCustomTypesPerDataset<TType, TData>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>

# Defined in

types/index.d.ts:3777 (opens new window)

# ChartItem

Ƭ ChartItem: string | CanvasRenderingContext2D | HTMLCanvasElement | { canvas: HTMLCanvasElement } | ArrayLike<CanvasRenderingContext2D | HTMLCanvasElement>

# Defined in

types/index.d.ts:563 (opens new window)

# ChartMeta

Ƭ ChartMeta<TType, TElement, TDatasetElement>: DeepPartial<{ [key in ChartType]: ChartTypeRegistry[key]["metaExtensions"] }[TType]> & ChartMetaCommon<TElement, TDatasetElement>

# Type parameters

Name Type
TType extends ChartType = ChartType
TElement extends Element = Element
TDatasetElement extends Element = Element

# Defined in

types/index.d.ts:467 (opens new window)

# ChartOptions

Ƭ ChartOptions<TType>: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Type parameters

Name Type
TType extends ChartType = ChartType

# Defined in

types/index.d.ts:3747 (opens new window)

# ChartType

Ƭ ChartType: keyof ChartTypeRegistry

# Defined in

types/index.d.ts:3726 (opens new window)

# Color

Ƭ Color: string | CanvasGradient | CanvasPattern

# Defined in

types/color.d.ts:1 (opens new window)

# DatasetChartOptions

Ƭ DatasetChartOptions<TType>: { [key in TType]: Object }

# Type parameters

Name Type
TType extends ChartType = ChartType

# Defined in

types/index.d.ts:3735 (opens new window)

# DecimationOptions

Ƭ DecimationOptions: LttbDecimationOptions | MinMaxDecimationOptions

# Defined in

types/index.d.ts:2220 (opens new window)

# DefaultDataPoint

Ƭ DefaultDataPoint<TType>: DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>

# Type parameters

Name Type
TType extends ChartType

# Defined in

types/index.d.ts:3756 (opens new window)

# DoughnutDataPoint

Ƭ DoughnutDataPoint: number

# Defined in

types/index.d.ts:338 (opens new window)

# EasingFunction

Ƭ EasingFunction: keyof typeof effects

# Defined in

helpers/helpers.easing.ts:122 (opens new window)

# ElementChartOptions

Ƭ ElementChartOptions<TType>: Object

# Type parameters

Name Type
TType extends ChartType = ChartType

# Type declaration

Name Type
elements ElementOptionsByType<TType>

# Defined in

types/index.d.ts:2136 (opens new window)

# FillTarget

Ƭ FillTarget: number | string | { value: number } | "start" | "end" | "origin" | "stack" | "shape" | boolean

# Defined in

types/index.d.ts:2228 (opens new window)

# InteractionAxis

Ƭ InteractionAxis: "x" | "y" | "xy" | "r"

# Defined in

types/index.d.ts:1562 (opens new window)

# InteractionMode

Ƭ InteractionMode: keyof InteractionModeMap

# Defined in

types/index.d.ts:761 (opens new window)

# InteractionModeFunction

Ƭ InteractionModeFunction: (chart: Chart, e: ChartEvent, options: InteractionOptions, useFinalPosition?: boolean) => InteractionItem[]

# Type declaration

▸ (chart, e, options, useFinalPosition?): InteractionItem[]

# Parameters
Name Type
chart Chart
e ChartEvent
options InteractionOptions
useFinalPosition? boolean
# Returns

InteractionItem[]

# Defined in

types/index.d.ts:723 (opens new window)

# LayoutPosition

Ƭ LayoutPosition: "left" | "top" | "right" | "bottom" | "center" | "chartArea" | { [scaleId: string]: number; }

# Defined in

types/layout.d.ts:3 (opens new window)

# LineController

Ƭ LineController: DatasetController

# Defined in

types/index.d.ts:229 (opens new window)

types/index.d.ts:230 (opens new window)

# LinearScale

Ƭ LinearScale<O>: Scale<O>

# Type parameters

Name Type
O extends LinearScaleOptions = LinearScaleOptions

# Defined in

types/index.d.ts:3306 (opens new window)

types/index.d.ts:3307 (opens new window)

# LinearScaleOptions

Ƭ LinearScaleOptions: CartesianScaleOptions & { beginAtZero: boolean ; grace?: string | number ; suggestedMax?: number ; suggestedMin?: number ; ticks: { count: number ; format: Intl.NumberFormatOptions ; precision: number ; stepSize: number } }

# Defined in

types/index.d.ts:3263 (opens new window)

# LogarithmicScale

Ƭ LogarithmicScale<O>: Scale<O>

# Type parameters

Name Type
O extends LogarithmicScaleOptions = LogarithmicScaleOptions

# Defined in

types/index.d.ts:3330 (opens new window)

types/index.d.ts:3331 (opens new window)

# LogarithmicScaleOptions

Ƭ LogarithmicScaleOptions: CartesianScaleOptions & { suggestedMax?: number ; suggestedMin?: number ; ticks: { format: Intl.NumberFormatOptions } }

# Defined in

types/index.d.ts:3312 (opens new window)

# Overrides

Ƭ Overrides: { [key in ChartType]: CoreChartOptions<key> & ElementChartOptions<key> & PluginChartOptions<key> & DatasetChartOptions<ChartType> & ScaleChartOptions<key> & ChartTypeRegistry[key]["chartOptions"] }

# Defined in

types/index.d.ts:700 (opens new window)

# ParsedDataType

Ƭ ParsedDataType<TType>: ChartTypeRegistry[TType]["parsedDataType"]

# Type parameters

Name Type
TType extends ChartType = ChartType

# Defined in

types/index.d.ts:3758 (opens new window)

# PieAnimationOptions

Ƭ PieAnimationOptions: DoughnutAnimationOptions

# Defined in

types/index.d.ts:361 (opens new window)

# PieController

Ƭ PieController: DoughnutController

# Defined in

types/index.d.ts:366 (opens new window)

types/index.d.ts:367 (opens new window)

# PieControllerChartOptions

Ƭ PieControllerChartOptions: DoughnutControllerChartOptions

# Defined in

types/index.d.ts:360 (opens new window)

# PieControllerDatasetOptions

Ƭ PieControllerDatasetOptions: DoughnutControllerDatasetOptions

# Defined in

types/index.d.ts:359 (opens new window)

# PieDataPoint

Ƭ PieDataPoint: DoughnutDataPoint

# Defined in

types/index.d.ts:363 (opens new window)

# PieMetaExtensions

Ƭ PieMetaExtensions: DoughnutMetaExtensions

# Defined in

types/index.d.ts:364 (opens new window)

# PointProps

Ƭ PointProps: Point

# Defined in

elements/element.point.ts:18 (opens new window)

# PointStyle

Ƭ PointStyle: "circle" | "cross" | "crossRot" | "dash" | "line" | "rect" | "rectRounded" | "rectRot" | "star" | "triangle" | false | HTMLImageElement | HTMLCanvasElement

# Defined in

types/index.d.ts:1968 (opens new window)

# PolarAreaAnimationOptions

Ƭ PolarAreaAnimationOptions: DoughnutAnimationOptions

# Defined in

types/index.d.ts:380 (opens new window)

# RadarController

Ƭ RadarController: DatasetController

# Defined in

types/index.d.ts:427 (opens new window)

types/index.d.ts:428 (opens new window)

# RadarControllerChartOptions

Ƭ RadarControllerChartOptions: LineControllerChartOptions

# Defined in

types/index.d.ts:425 (opens new window)

# RadialLinearScaleOptions

Ƭ RadialLinearScaleOptions: CoreScaleOptions & { angleLines: { borderDash: Scriptable<number[], ScriptableScaleContext> ; borderDashOffset: Scriptable<number, ScriptableScaleContext> ; color: Scriptable<Color, ScriptableScaleContext> ; display: boolean ; lineWidth: Scriptable<number, ScriptableScaleContext> } ; animate: boolean ; beginAtZero: boolean ; grid: Partial<GridLineOptions> ; max: number ; min: number ; pointLabels: { backdropColor: Scriptable<Color, ScriptableScalePointLabelContext> ; backdropPadding: Scriptable<number | ChartArea, ScriptableScalePointLabelContext> ; borderRadius: Scriptable<number | BorderRadius, ScriptableScalePointLabelContext> ; callback: (label: string, index: number) => string | string[] | number | number[] ; centerPointLabels: boolean ; color: Scriptable<Color, ScriptableScalePointLabelContext> ; display: boolean | "auto" ; font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScalePointLabelContext> ; padding: Scriptable<number, ScriptableScalePointLabelContext> } ; startAngle: number ; suggestedMax: number ; suggestedMin: number ; ticks: RadialTickOptions }

# Defined in

types/index.d.ts:3470 (opens new window)

# RadialTickOptions

Ƭ RadialTickOptions: TickOptions & { count: number ; format: Intl.NumberFormatOptions ; maxTicksLimit: number ; precision: number ; stepSize: number }

# Defined in

types/index.d.ts:3442 (opens new window)

# ScaleChartOptions

Ƭ ScaleChartOptions<TType>: Object

# Type parameters

Name Type
TType extends ChartType = ChartType

# Type declaration

Name Type
scales { [key: string]: ScaleOptionsByType<ChartTypeRegistry[TType]["scales"]>; }

# Defined in

types/index.d.ts:3741 (opens new window)

# ScaleOptions

Ƭ ScaleOptions<TScale>: DeepPartial<ScaleOptionsByType<TScale>>

# Type parameters

Name Type
TScale extends ScaleType = ScaleType

# Defined in

types/index.d.ts:3733 (opens new window)

# ScaleOptionsByType

Ƭ ScaleOptionsByType<TScale>: { [key in ScaleType]: Object & ScaleTypeRegistry[key]["options"] }[TScale]

# Type parameters

Name Type
TScale extends ScaleType = ScaleType

# Defined in

types/index.d.ts:3728 (opens new window)

# ScaleType

Ƭ ScaleType: keyof ScaleTypeRegistry

# Defined in

types/index.d.ts:3625 (opens new window)

# ScatterController

Ƭ ScatterController: LineController

# Defined in

types/index.d.ts:241 (opens new window)

types/index.d.ts:242 (opens new window)

# ScatterControllerChartOptions

Ƭ ScatterControllerChartOptions: LineControllerChartOptions

# Defined in

types/index.d.ts:239 (opens new window)

# ScatterControllerDatasetOptions

Ƭ ScatterControllerDatasetOptions: LineControllerDatasetOptions

# Defined in

types/index.d.ts:235 (opens new window)

# ScatterDataPoint

Ƭ ScatterDataPoint: Point

# Defined in

types/index.d.ts:237 (opens new window)

# Scriptable

Ƭ Scriptable<T, TContext>: T | (ctx: TContext, options: AnyObject) => T | undefined

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:44 (opens new window)

# ScriptableAndArray

Ƭ ScriptableAndArray<T, TContext>: readonly T[] | Scriptable<T, TContext>

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:47 (opens new window)

# ScriptableAndArrayOptions

Ƭ ScriptableAndArrayOptions<T, TContext>: { [P in keyof T]: ScriptableAndArray<T[P], TContext> }

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:48 (opens new window)

# ScriptableAndScriptableOptions

Ƭ ScriptableAndScriptableOptions<T, TContext>: Scriptable<T, TContext> | ScriptableOptions<T, TContext>

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:46 (opens new window)

# ScriptableOptions

Ƭ ScriptableOptions<T, TContext>: { [P in keyof T]: Scriptable<T[P], TContext> }

# Type parameters

Name
T
TContext

# Defined in

types/index.d.ts:45 (opens new window)

# TextAlign

Ƭ TextAlign: "left" | "center" | "right"

# Defined in

types/index.d.ts:1792 (opens new window)

# TimeScaleOptions

Ƭ TimeScaleOptions: Omit<CartesianScaleOptions, "min" | "max"> & { adapters: { date: unknown } ; bounds: "ticks" | "data" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }

# Defined in

types/index.d.ts:3391 (opens new window)

# TimeScaleTickOptions

Ƭ TimeScaleTickOptions: Object

# Type declaration

Name Type Description
source "labels" | "auto" | "data" Ticks generation input values: - 'auto': generates "optimal" ticks based on scale size and time options. - 'data': generates ticks from data (including labels from data {t\|x\|y} objects). - 'labels': generates ticks from user given data.labels values ONLY. See https://github.com/chartjs/Chart.js/pull/4507 Since 2.7.0 Default 'auto'
stepSize number The number of units between grid lines. Default 1

# Defined in

types/index.d.ts:3373 (opens new window)

# TimeScaleTimeOptions

Ƭ TimeScaleTimeOptions: Object

# Type declaration

Name Type Description
displayFormats { [key: string]: string; } Sets how different time units are displayed.
isoWeekday boolean | number If boolean and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If number, the index of the first day of the week (0 - Sunday, 6 - Saturday). Default false
minUnit TimeUnit The minimum display format to be used for a time unit. Default 'millisecond'
parser string | (v: unknown) => number Custom parser for dates.
round false | TimeUnit If defined, dates will be rounded to the start of this unit. See Time Units below for the allowed units.
tooltipFormat string The format string to use for the tooltip.
unit false | TimeUnit If defined, will force the unit to be a certain type. See Time Units section below for details. Default false

# Defined in

types/index.d.ts:3336 (opens new window)

# TimeSeriesScale

Ƭ TimeSeriesScale<O>: TimeScale<O>

# Type parameters

Name Type
O extends TimeScaleOptions = TimeScaleOptions

# Defined in

types/index.d.ts:3436 (opens new window)

types/index.d.ts:3437 (opens new window)

# TooltipPositioner

Ƭ TooltipPositioner: keyof TooltipPositionerMap

# Defined in

types/index.d.ts:2650 (opens new window)

# TooltipPositionerFunction

Ƭ TooltipPositionerFunction<TType>: (this: TooltipModel<TType>, items: readonly ActiveElement[], eventPosition: Point) => TooltipPosition | false

# Type parameters

Name Type
TType extends ChartType

# Type declaration

▸ (this, items, eventPosition): TooltipPosition | false

# Parameters
Name Type
this TooltipModel<TType>
items readonly ActiveElement[]
eventPosition Point
# Returns

TooltipPosition | false

# Defined in

types/index.d.ts:2639 (opens new window)

# TooltipXAlignment

Ƭ TooltipXAlignment: "left" | "center" | "right"

# Defined in

types/index.d.ts:2550 (opens new window)

# TooltipYAlignment

Ƭ TooltipYAlignment: "top" | "center" | "bottom"

# Defined in

types/index.d.ts:2551 (opens new window)

# TransitionSpec

Ƭ TransitionSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Type declaration

Name Type
animation AnimationSpec<TType>
animations AnimationsSpec<TType>

# Defined in

types/index.d.ts:1737 (opens new window)

# TransitionsSpec

Ƭ TransitionsSpec<TType>: Object

# Type parameters

Name Type
TType extends ChartType

# Index signature

▪ [mode: string]: TransitionSpec<TType>

# Defined in

types/index.d.ts:1742 (opens new window)

# UpdateMode

Ƭ UpdateMode: keyof typeof UpdateModeEnum

# Defined in

types/index.d.ts:580 (opens new window)

# Variables

# BarController

• BarController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => BarController

# Defined in

types/index.d.ts:156 (opens new window)

types/index.d.ts:157 (opens new window)

# BarElement

• BarElement: ChartComponent & (cfg: AnyObject) => BarElement<BarProps, BarOptions>

# Defined in

types/index.d.ts:2119 (opens new window)

types/index.d.ts:2124 (opens new window)

# BubbleController

• BubbleController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => BubbleController

# Defined in

types/index.d.ts:183 (opens new window)

types/index.d.ts:184 (opens new window)

# CategoryScale

• CategoryScale: ChartComponent & <O>(cfg: AnyObject) => CategoryScale<O>

# Defined in

types/index.d.ts:3257 (opens new window)

types/index.d.ts:3258 (opens new window)

# Decimation

• Const Decimation: Plugin

# Defined in

types/index.d.ts:2200 (opens new window)

# DoughnutController

• DoughnutController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => DoughnutController

# Defined in

types/index.d.ts:340 (opens new window)

types/index.d.ts:350 (opens new window)

# Filler

• Const Filler: Plugin

# Defined in

types/index.d.ts:2222 (opens new window)

# Interaction

• Const Interaction: Object

# Type declaration

Name Type
modes InteractionModeMap
evaluateInteractionItems (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, axis: InteractionAxis, position: Point, handler: (element: default<AnyObject, AnyObject> & VisualElement, datasetIndex: number, index: number) => void, intersect?: boolean) => InteractionItem[]

# Defined in

types/index.d.ts:763 (opens new window)

# Legend

• Const Legend: Plugin

# Defined in

types/index.d.ts:2252 (opens new window)

# LineController

• LineController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => LineController

# Defined in

types/index.d.ts:229 (opens new window)

types/index.d.ts:230 (opens new window)

# LineElement

• LineElement: ChartComponent & (cfg: AnyObject) => LineElement<LineProps, LineOptions>

# Defined in

types/index.d.ts:1950 (opens new window)

types/index.d.ts:1963 (opens new window)

# LinearScale

• LinearScale: ChartComponent & <O>(cfg: AnyObject) => LinearScale<O>

# Defined in

types/index.d.ts:3306 (opens new window)

types/index.d.ts:3307 (opens new window)

# LogarithmicScale

• LogarithmicScale: ChartComponent & <O>(cfg: AnyObject) => LogarithmicScale<O>

# Defined in

types/index.d.ts:3330 (opens new window)

types/index.d.ts:3331 (opens new window)

# PieController

• PieController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => DoughnutController

# Defined in

types/index.d.ts:366 (opens new window)

types/index.d.ts:367 (opens new window)

# PolarAreaController

• PolarAreaController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => PolarAreaController

# Defined in

types/index.d.ts:392 (opens new window)

types/index.d.ts:395 (opens new window)

# RadarController

• RadarController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => RadarController

# Defined in

types/index.d.ts:427 (opens new window)

types/index.d.ts:428 (opens new window)

# RadialLinearScale

• RadialLinearScale: ChartComponent & <O>(cfg: AnyObject) => RadialLinearScale<O>

# Defined in

types/index.d.ts:3583 (opens new window)

types/index.d.ts:3593 (opens new window)

# ScatterController

• ScatterController: ChartComponent & (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, datasetIndex: number) => LineController

# Defined in

types/index.d.ts:241 (opens new window)

types/index.d.ts:242 (opens new window)

# SubTitle

• Const SubTitle: Plugin

# Defined in

types/index.d.ts:2508 (opens new window)

# Ticks

• Const Ticks: Object

# Type declaration

Name Type
formatters { logarithmic: (tickValue: number, index: number, ticks: { value: number }[]) => string ; numeric: (tickValue: number, index: number, ticks: { value: number }[]) => string ; values: (value: unknown) => string | string[] }
formatters.logarithmic [object Object]
formatters.numeric [object Object]
formatters.values [object Object]

# Defined in

types/index.d.ts:1496 (opens new window)

# TimeScale

• TimeScale: ChartComponent & <O>(cfg: AnyObject) => TimeScale<O>

# Defined in

types/index.d.ts:3424 (opens new window)

types/index.d.ts:3431 (opens new window)

# TimeSeriesScale

• TimeSeriesScale: ChartComponent & <O>(cfg: AnyObject) => TimeSeriesScale<O>

# Defined in

types/index.d.ts:3436 (opens new window)

types/index.d.ts:3437 (opens new window)

# Title

• Const Title: Plugin

# Defined in

types/index.d.ts:2509 (opens new window)

# Tooltip

• Tooltip: Tooltip

# Defined in

types/index.d.ts:2652 (opens new window)

types/index.d.ts:2656 (opens new window)

# defaults

• Const defaults: Defaults

# Defined in

types/index.d.ts:710 (opens new window)

# layouts

• Const layouts: Object

# Type declaration

Name Type
addBox (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, item: LayoutItem) => void
configure (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, item: LayoutItem, options: { fullSize?: number ; position?: LayoutPosition ; weight?: number }) => void
removeBox (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, layoutItem: LayoutItem) => void
update (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, width: number, height: number) => void

# Defined in

types/index.d.ts:778 (opens new window)

# registerables

• Const registerables: readonly ChartComponentLike[]

# Defined in

types/index.d.ts:561 (opens new window)

# registry

• Const registry: Registry

# Defined in

types/index.d.ts:1151 (opens new window)

DecimationAlgorithm →

- + diff --git a/docs/master/api/interfaces/ActiveDataPoint.html b/docs/master/api/interfaces/ActiveDataPoint.html index 8939bf2d94..901e771ef0 100644 --- a/docs/master/api/interfaces/ActiveDataPoint.html +++ b/docs/master/api/interfaces/ActiveDataPoint.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ActiveDataPoint

# Hierarchy

# Properties

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:476 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:477 (opens new window)

+ (opens new window)

# Interface: ActiveDataPoint

# Hierarchy

# Properties

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:476 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:477 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ActiveElement.html b/docs/master/api/interfaces/ActiveElement.html index d0de5c0766..fa3f3f444d 100644 --- a/docs/master/api/interfaces/ActiveElement.html +++ b/docs/master/api/interfaces/ActiveElement.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ActiveElement

# Hierarchy

# Properties

# datasetIndex

• datasetIndex: number

# Inherited from

ActiveDataPoint.datasetIndex

# Defined in

types/index.d.ts:476 (opens new window)

# element

• element: default<AnyObject, AnyObject>

# Defined in

types/index.d.ts:481 (opens new window)

# index

• index: number

# Inherited from

ActiveDataPoint.index

# Defined in

types/index.d.ts:477 (opens new window)

+ (opens new window)

# Interface: ActiveElement

# Hierarchy

# Properties

# datasetIndex

• datasetIndex: number

# Inherited from

ActiveDataPoint.datasetIndex

# Defined in

types/index.d.ts:476 (opens new window)

# element

• element: default<AnyObject, AnyObject>

# Defined in

types/index.d.ts:481 (opens new window)

# index

• index: number

# Inherited from

ActiveDataPoint.index

# Defined in

types/index.d.ts:477 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/AnimationEvent.html b/docs/master/api/interfaces/AnimationEvent.html index 6e3a3e8df0..f0395660db 100644 --- a/docs/master/api/interfaces/AnimationEvent.html +++ b/docs/master/api/interfaces/AnimationEvent.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: AnimationEvent

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/animation.d.ts:14 (opens new window)

# currentStep

• currentStep: number

# Defined in

types/animation.d.ts:17 (opens new window)

# initial

• initial: boolean

# Defined in

types/animation.d.ts:16 (opens new window)

# numSteps

• numSteps: number

# Defined in

types/animation.d.ts:15 (opens new window)

+ (opens new window)

# Interface: AnimationEvent

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/animation.d.ts:14 (opens new window)

# currentStep

• currentStep: number

# Defined in

types/animation.d.ts:17 (opens new window)

# initial

• initial: boolean

# Defined in

types/animation.d.ts:16 (opens new window)

# numSteps

• numSteps: number

# Defined in

types/animation.d.ts:15 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ArcBorderRadius.html b/docs/master/api/interfaces/ArcBorderRadius.html index 6d0602c382..cd08aa636c 100644 --- a/docs/master/api/interfaces/ArcBorderRadius.html +++ b/docs/master/api/interfaces/ArcBorderRadius.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ArcBorderRadius

# Properties

# innerEnd

• innerEnd: number

# Defined in

types/index.d.ts:1826 (opens new window)

# innerStart

• innerStart: number

# Defined in

types/index.d.ts:1825 (opens new window)

# outerEnd

• outerEnd: number

# Defined in

types/index.d.ts:1824 (opens new window)

# outerStart

• outerStart: number

# Defined in

types/index.d.ts:1823 (opens new window)

+ (opens new window)

# Interface: ArcBorderRadius

# Properties

# innerEnd

• innerEnd: number

# Defined in

types/index.d.ts:1826 (opens new window)

# innerStart

• innerStart: number

# Defined in

types/index.d.ts:1825 (opens new window)

# outerEnd

• outerEnd: number

# Defined in

types/index.d.ts:1824 (opens new window)

# outerStart

• outerStart: number

# Defined in

types/index.d.ts:1823 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ArcHoverOptions.html b/docs/master/api/interfaces/ArcHoverOptions.html index 2fe6b60a9f..62afeff5ff 100644 --- a/docs/master/api/interfaces/ArcHoverOptions.html +++ b/docs/master/api/interfaces/ArcHoverOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ArcHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: number[]

# Defined in

types/index.d.ts:1873 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: number

# Defined in

types/index.d.ts:1874 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverOffset

• hoverOffset: number

# Defined in

types/index.d.ts:1875 (opens new window)

+ (opens new window)

# Interface: ArcHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: number[]

# Defined in

types/index.d.ts:1873 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: number

# Defined in

types/index.d.ts:1874 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverOffset

• hoverOffset: number

# Defined in

types/index.d.ts:1875 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ArcOptions.html b/docs/master/api/interfaces/ArcOptions.html index 6f35710393..5a493653a0 100644 --- a/docs/master/api/interfaces/ArcOptions.html +++ b/docs/master/api/interfaces/ArcOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ArcOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

CommonElementOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderAlign

• borderAlign: "center" | "inner"

Arc stroke alignment.

# Defined in

types/index.d.ts:1833 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

CommonElementOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: number[]

Line dash. See MDN.

Default

[]

# Defined in

types/index.d.ts:1838 (opens new window)

# borderDashOffset

• borderDashOffset: number

Line dash offset. See MDN.

Default

0.0

# Defined in

types/index.d.ts:1843 (opens new window)

# borderJoinStyle

• borderJoinStyle: CanvasLineJoin

Line join style. See MDN. Default is 'round' when borderAlign is 'inner', else 'bevel'.

# Defined in

types/index.d.ts:1847 (opens new window)

# borderRadius

• borderRadius: number | ArcBorderRadius

Sets the border radius for arcs

Default

0

# Defined in

types/index.d.ts:1853 (opens new window)

# borderWidth

• borderWidth: number

# Inherited from

CommonElementOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# circular

• circular: boolean

If false, Arc will be flat.

Default

true

# Defined in

types/index.d.ts:1864 (opens new window)

# offset

• offset: number

Arc offset (in pixels).

# Defined in

types/index.d.ts:1858 (opens new window)

# spacing

• spacing: number

Spacing between arcs

# Defined in

types/index.d.ts:1869 (opens new window)

+ (opens new window)

# Interface: ArcOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

CommonElementOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderAlign

• borderAlign: "center" | "inner"

Arc stroke alignment.

# Defined in

types/index.d.ts:1833 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

CommonElementOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: number[]

Line dash. See MDN.

Default

[]

# Defined in

types/index.d.ts:1838 (opens new window)

# borderDashOffset

• borderDashOffset: number

Line dash offset. See MDN.

Default

0.0

# Defined in

types/index.d.ts:1843 (opens new window)

# borderJoinStyle

• borderJoinStyle: CanvasLineJoin

Line join style. See MDN. Default is 'round' when borderAlign is 'inner', else 'bevel'.

# Defined in

types/index.d.ts:1847 (opens new window)

# borderRadius

• borderRadius: number | ArcBorderRadius

Sets the border radius for arcs

Default

0

# Defined in

types/index.d.ts:1853 (opens new window)

# borderWidth

• borderWidth: number

# Inherited from

CommonElementOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# circular

• circular: boolean

If false, Arc will be flat.

Default

true

# Defined in

types/index.d.ts:1864 (opens new window)

# offset

• offset: number

Arc offset (in pixels).

# Defined in

types/index.d.ts:1858 (opens new window)

# spacing

• spacing: number

Spacing between arcs

# Defined in

types/index.d.ts:1869 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ArcProps.html b/docs/master/api/interfaces/ArcProps.html index 2e6d6e2ae6..3e5eaca700 100644 --- a/docs/master/api/interfaces/ArcProps.html +++ b/docs/master/api/interfaces/ArcProps.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ArcProps

# Hierarchy

# Properties

# circumference

• circumference: number

# Defined in

elements/element.arc.ts:260 (opens new window)

# endAngle

• endAngle: number

# Defined in

elements/element.arc.ts:257 (opens new window)

# innerRadius

• innerRadius: number

# Defined in

elements/element.arc.ts:258 (opens new window)

# outerRadius

• outerRadius: number

# Defined in

elements/element.arc.ts:259 (opens new window)

# startAngle

• startAngle: number

# Defined in

elements/element.arc.ts:256 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

+ (opens new window)

# Interface: ArcProps

# Hierarchy

# Properties

# circumference

• circumference: number

# Defined in

elements/element.arc.ts:260 (opens new window)

# endAngle

• endAngle: number

# Defined in

elements/element.arc.ts:257 (opens new window)

# innerRadius

• innerRadius: number

# Defined in

elements/element.arc.ts:258 (opens new window)

# outerRadius

• outerRadius: number

# Defined in

elements/element.arc.ts:259 (opens new window)

# startAngle

• startAngle: number

# Defined in

elements/element.arc.ts:256 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BackdropOptions.html b/docs/master/api/interfaces/BackdropOptions.html index a056b0f393..b76584c5a4 100644 --- a/docs/master/api/interfaces/BackdropOptions.html +++ b/docs/master/api/interfaces/BackdropOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BackdropOptions

# Properties

# color

• color: Scriptable<Color, ScriptableScaleContext>

Color of label backdrops.

# Defined in

types/index.d.ts:1486 (opens new window)

# height

• height: number

Height of backdrop in pixels

# Defined in

types/index.d.ts:1481 (opens new window)

# left

• left: number

Left position of backdrop as pixel

# Defined in

types/index.d.ts:1466 (opens new window)

# top

• top: number

Top position of backdrop as pixel

# Defined in

types/index.d.ts:1471 (opens new window)

# width

• width: number

Width of backdrop in pixels

# Defined in

types/index.d.ts:1476 (opens new window)

+ (opens new window)

# Interface: BackdropOptions

# Properties

# color

• color: Scriptable<Color, ScriptableScaleContext>

Color of label backdrops.

# Defined in

types/index.d.ts:1486 (opens new window)

# height

• height: number

Height of backdrop in pixels

# Defined in

types/index.d.ts:1481 (opens new window)

# left

• left: number

Left position of backdrop as pixel

# Defined in

types/index.d.ts:1466 (opens new window)

# top

• top: number

Top position of backdrop as pixel

# Defined in

types/index.d.ts:1471 (opens new window)

# width

• width: number

Width of backdrop in pixels

# Defined in

types/index.d.ts:1476 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BarControllerChartOptions.html b/docs/master/api/interfaces/BarControllerChartOptions.html index d15c3cdde9..8e13065067 100644 --- a/docs/master/api/interfaces/BarControllerChartOptions.html +++ b/docs/master/api/interfaces/BarControllerChartOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BarControllerChartOptions

# Properties

# skipNull

• Optional skipNull: boolean

Should null or undefined values be omitted from drawing

# Defined in

types/index.d.ts:153 (opens new window)

+ (opens new window)

# Interface: BarControllerChartOptions

# Properties

# skipNull

• Optional skipNull: boolean

Should null or undefined values be omitted from drawing

# Defined in

types/index.d.ts:153 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BarControllerDatasetOptions.html b/docs/master/api/interfaces/BarControllerDatasetOptions.html index 271bd2e48d..4dc7fa55de 100644 --- a/docs/master/api/interfaces/BarControllerDatasetOptions.html +++ b/docs/master/api/interfaces/BarControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,8 +39,8 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BarControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"bar"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"bar">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# barPercentage

• barPercentage: number

Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.

Default

0.9

# Defined in

types/index.d.ts:114 (opens new window)

# barThickness

• barThickness: number | "flex"

Manually set width of each bar in pixels. If set to 'flex', it computes "optimal" sample widths that globally arrange bars side by side. If not set (default), bars are equally sized based on the smallest interval.

# Defined in

types/index.d.ts:124 (opens new window)

# base

• base: ScriptableAndArray<number, ScriptableContext<"bar">>

The base value for the bar in data units along the value axis.

# Inherited from

ScriptableAndArrayOptions.base

# Defined in

types/index.d.ts:2080 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderRadius

• borderRadius: ScriptableAndArray<number | BorderRadius, ScriptableContext<"bar">>

Border radius

Default

0

# Inherited from

ScriptableAndArrayOptions.borderRadius

# Defined in

types/index.d.ts:2092 (opens new window)

# borderSkipped

• borderSkipped: ScriptableAndArray<boolean | "end" | "start" | "left" | "top" | "bottom" | "right" | "middle", ScriptableContext<"bar">>

Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).

Default

'start'

# Inherited from

ScriptableAndArrayOptions.borderSkipped

# Defined in

types/index.d.ts:2086 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number | { bottom?: number ; left?: number ; right?: number ; top?: number }, ScriptableContext<"bar">>

Width of the border, number for all sides, object to specify width for each side specifically

Default

0

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:2105 (opens new window)

# categoryPercentage

• categoryPercentage: number

Percent (0-1) of the available width each category should be within the sample width.

Default

0.8

# Defined in

types/index.d.ts:119 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# grouped

• grouped: boolean

Should the bars be grouped on index axis

Default

true

# Defined in

types/index.d.ts:146 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# inflateAmount

• inflateAmount: ScriptableAndArray<number | "auto", ScriptableContext<"bar">>

Amount to inflate the rectangle(s). This can be used to hide artifacts between bars. -Unit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.

Default

'auto'

# Inherited from

ScriptableAndArrayOptions.inflateAmount

# Defined in

types/index.d.ts:2099 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# maxBarThickness

• maxBarThickness: number

Set this to ensure that bars are not sized thicker than this.

# Defined in

types/index.d.ts:129 (opens new window)

# minBarLength

• minBarLength: number

Set this to ensure that bars have a minimum length in pixels.

# Defined in

types/index.d.ts:134 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointStyle

• pointStyle: PointStyle

Point style for the legend

Default

'circle;

# Defined in

types/index.d.ts:140 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# transitions

• transitions: TransitionsSpec<"bar">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:104 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:108 (opens new window)

+ (opens new window)

# Interface: BarControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"bar"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"bar">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# barPercentage

• barPercentage: number

Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.

Default

0.9

# Defined in

types/index.d.ts:114 (opens new window)

# barThickness

• barThickness: number | "flex"

Manually set width of each bar in pixels. If set to 'flex', it computes "optimal" sample widths that globally arrange bars side by side. If not set (default), bars are equally sized based on the smallest interval.

# Defined in

types/index.d.ts:124 (opens new window)

# base

• base: ScriptableAndArray<number, ScriptableContext<"bar">>

The base value for the bar in data units along the value axis.

# Inherited from

ScriptableAndArrayOptions.base

# Defined in

types/index.d.ts:2080 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderRadius

• borderRadius: ScriptableAndArray<number | BorderRadius, ScriptableContext<"bar">>

Border radius

Default

0

# Inherited from

ScriptableAndArrayOptions.borderRadius

# Defined in

types/index.d.ts:2092 (opens new window)

# borderSkipped

• borderSkipped: ScriptableAndArray<boolean | "end" | "start" | "left" | "top" | "bottom" | "right" | "middle", ScriptableContext<"bar">>

Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).

Default

'start'

# Inherited from

ScriptableAndArrayOptions.borderSkipped

# Defined in

types/index.d.ts:2086 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number | { bottom?: number ; left?: number ; right?: number ; top?: number }, ScriptableContext<"bar">>

Width of the border, number for all sides, object to specify width for each side specifically

Default

0

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:2105 (opens new window)

# categoryPercentage

• categoryPercentage: number

Percent (0-1) of the available width each category should be within the sample width.

Default

0.8

# Defined in

types/index.d.ts:119 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# grouped

• grouped: boolean

Should the bars be grouped on index axis

Default

true

# Defined in

types/index.d.ts:146 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"bar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# inflateAmount

• inflateAmount: ScriptableAndArray<number | "auto", ScriptableContext<"bar">>

Amount to inflate the rectangle(s). This can be used to hide artifacts between bars. +Unit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.

Default

'auto'

# Inherited from

ScriptableAndArrayOptions.inflateAmount

# Defined in

types/index.d.ts:2099 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# maxBarThickness

• maxBarThickness: number

Set this to ensure that bars are not sized thicker than this.

# Defined in

types/index.d.ts:129 (opens new window)

# minBarLength

• minBarLength: number

Set this to ensure that bars have a minimum length in pixels.

# Defined in

types/index.d.ts:134 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointStyle

• pointStyle: PointStyle

Point style for the legend

Default

'circle;

# Defined in

types/index.d.ts:140 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# transitions

• transitions: TransitionsSpec<"bar">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:104 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:108 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BarElement.html b/docs/master/api/interfaces/BarElement.html index b92355424e..29b84f3840 100644 --- a/docs/master/api/interfaces/BarElement.html +++ b/docs/master/api/interfaces/BarElement.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BarElement<T, O>

# Type parameters

Name Type
T extends BarProps = BarProps
O extends BarOptions = BarOptions

# Hierarchy

# Properties

# $animations

• $animations: Record<keyof T, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# options

• options: O

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# draw

▸ draw(ctx, area?): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area? ChartArea

# Returns

void

# Inherited from

VisualElement.draw

# Defined in

types/index.d.ts:1796 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Point

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Point

# Inherited from

VisualElement.getCenterPoint

# Defined in

types/index.d.ts:1800 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<T, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof T[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<T, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# getRange

▸ Optional getRange(axis): number

# Parameters

Name Type
axis "x" | "y"

# Returns

number

# Inherited from

VisualElement.getRange

# Defined in

types/index.d.ts:1801 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inRange

# Defined in

types/index.d.ts:1797 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inXRange

# Defined in

types/index.d.ts:1798 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inYRange

# Defined in

types/index.d.ts:1799 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

+ (opens new window)

# Interface: BarElement<T, O>

# Type parameters

Name Type
T extends BarProps = BarProps
O extends BarOptions = BarOptions

# Hierarchy

# Properties

# $animations

• $animations: Record<keyof T, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# options

• options: O

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# draw

▸ draw(ctx, area?): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area? ChartArea

# Returns

void

# Inherited from

VisualElement.draw

# Defined in

types/index.d.ts:1796 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Point

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Point

# Inherited from

VisualElement.getCenterPoint

# Defined in

types/index.d.ts:1800 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<T, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof T[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<T, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# getRange

▸ Optional getRange(axis): number

# Parameters

Name Type
axis "x" | "y"

# Returns

number

# Inherited from

VisualElement.getRange

# Defined in

types/index.d.ts:1801 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inRange

# Defined in

types/index.d.ts:1797 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inXRange

# Defined in

types/index.d.ts:1798 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inYRange

# Defined in

types/index.d.ts:1799 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BarHoverOptions.html b/docs/master/api/interfaces/BarHoverOptions.html index 20431c790e..3fa437ac8a 100644 --- a/docs/master/api/interfaces/BarHoverOptions.html +++ b/docs/master/api/interfaces/BarHoverOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BarHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderRadius

• hoverBorderRadius: number | BorderRadius

# Defined in

types/index.d.ts:2116 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

+ (opens new window)

# Interface: BarHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderRadius

• hoverBorderRadius: number | BorderRadius

# Defined in

types/index.d.ts:2116 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BarOptions.html b/docs/master/api/interfaces/BarOptions.html index a9a03b29e0..dee84203c1 100644 --- a/docs/master/api/interfaces/BarOptions.html +++ b/docs/master/api/interfaces/BarOptions.html @@ -7,7 +7,7 @@ - + @@ -39,8 +39,8 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BarOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

Omit.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# base

• base: number

The base value for the bar in data units along the value axis.

# Defined in

types/index.d.ts:2080 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

Omit.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderRadius

• borderRadius: number | BorderRadius

Border radius

Default

0

# Defined in

types/index.d.ts:2092 (opens new window)

# borderSkipped

• borderSkipped: boolean | "end" | "start" | "left" | "top" | "bottom" | "right" | "middle"

Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).

Default

'start'

# Defined in

types/index.d.ts:2086 (opens new window)

# borderWidth

• borderWidth: number | { bottom?: number ; left?: number ; right?: number ; top?: number }

Width of the border, number for all sides, object to specify width for each side specifically

Default

0

# Defined in

types/index.d.ts:2105 (opens new window)

# inflateAmount

• inflateAmount: number | "auto"

Amount to inflate the rectangle(s). This can be used to hide artifacts between bars. -Unit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.

Default

'auto'

# Defined in

types/index.d.ts:2099 (opens new window)

+ (opens new window)

# Interface: BarOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

Omit.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# base

• base: number

The base value for the bar in data units along the value axis.

# Defined in

types/index.d.ts:2080 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

Omit.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderRadius

• borderRadius: number | BorderRadius

Border radius

Default

0

# Defined in

types/index.d.ts:2092 (opens new window)

# borderSkipped

• borderSkipped: boolean | "end" | "start" | "left" | "top" | "bottom" | "right" | "middle"

Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).

Default

'start'

# Defined in

types/index.d.ts:2086 (opens new window)

# borderWidth

• borderWidth: number | { bottom?: number ; left?: number ; right?: number ; top?: number }

Width of the border, number for all sides, object to specify width for each side specifically

Default

0

# Defined in

types/index.d.ts:2105 (opens new window)

# inflateAmount

• inflateAmount: number | "auto"

Amount to inflate the rectangle(s). This can be used to hide artifacts between bars. +Unit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.

Default

'auto'

# Defined in

types/index.d.ts:2099 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BarProps.html b/docs/master/api/interfaces/BarProps.html index 3332d436db..51b22d45cd 100644 --- a/docs/master/api/interfaces/BarProps.html +++ b/docs/master/api/interfaces/BarProps.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BarProps

# Hierarchy

# Properties

# base

• base: number

# Defined in

types/index.d.ts:2070 (opens new window)

# height

• height: number

# Defined in

types/index.d.ts:2073 (opens new window)

# horizontal

• horizontal: boolean

# Defined in

types/index.d.ts:2071 (opens new window)

# width

• width: number

# Defined in

types/index.d.ts:2072 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

+ (opens new window)

# Interface: BarProps

# Hierarchy

# Properties

# base

• base: number

# Defined in

types/index.d.ts:2070 (opens new window)

# height

• height: number

# Defined in

types/index.d.ts:2073 (opens new window)

# horizontal

• horizontal: boolean

# Defined in

types/index.d.ts:2071 (opens new window)

# width

• width: number

# Defined in

types/index.d.ts:2072 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BorderOptions.html b/docs/master/api/interfaces/BorderOptions.html index 6b26436428..06fe141487 100644 --- a/docs/master/api/interfaces/BorderOptions.html +++ b/docs/master/api/interfaces/BorderOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BorderOptions

# Properties

# color

• color: Color

# Defined in

types/index.d.ts:2966 (opens new window)

# dash

• dash: Scriptable<number[], ScriptableScaleContext>

Default

[]

# Defined in

types/index.d.ts:2961 (opens new window)

# dashOffset

• dashOffset: Scriptable<number, ScriptableScaleContext>

Default

0

# Defined in

types/index.d.ts:2965 (opens new window)

# display

• display: boolean

Default

true

# Defined in

types/index.d.ts:2957 (opens new window)

# width

• width: number

# Defined in

types/index.d.ts:2967 (opens new window)

# z

• z: number

# Defined in

types/index.d.ts:2968 (opens new window)

+ (opens new window)

# Interface: BorderOptions

# Properties

# color

• color: Color

# Defined in

types/index.d.ts:2966 (opens new window)

# dash

• dash: Scriptable<number[], ScriptableScaleContext>

Default

[]

# Defined in

types/index.d.ts:2961 (opens new window)

# dashOffset

• dashOffset: Scriptable<number, ScriptableScaleContext>

Default

0

# Defined in

types/index.d.ts:2965 (opens new window)

# display

• display: boolean

Default

true

# Defined in

types/index.d.ts:2957 (opens new window)

# width

• width: number

# Defined in

types/index.d.ts:2967 (opens new window)

# z

• z: number

# Defined in

types/index.d.ts:2968 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BorderRadius.html b/docs/master/api/interfaces/BorderRadius.html index fb6b296bc3..0e134e642c 100644 --- a/docs/master/api/interfaces/BorderRadius.html +++ b/docs/master/api/interfaces/BorderRadius.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BorderRadius

# Properties

# bottomLeft

• bottomLeft: number

# Defined in

types/index.d.ts:2111 (opens new window)

# bottomRight

• bottomRight: number

# Defined in

types/index.d.ts:2112 (opens new window)

# topLeft

• topLeft: number

# Defined in

types/index.d.ts:2109 (opens new window)

# topRight

• topRight: number

# Defined in

types/index.d.ts:2110 (opens new window)

+ (opens new window)

# Interface: BorderRadius

# Properties

# bottomLeft

• bottomLeft: number

# Defined in

types/index.d.ts:2111 (opens new window)

# bottomRight

• bottomRight: number

# Defined in

types/index.d.ts:2112 (opens new window)

# topLeft

• topLeft: number

# Defined in

types/index.d.ts:2109 (opens new window)

# topRight

• topRight: number

# Defined in

types/index.d.ts:2110 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BubbleControllerDatasetOptions.html b/docs/master/api/interfaces/BubbleControllerDatasetOptions.html index ef82125bf8..e1cb647451 100644 --- a/docs/master/api/interfaces/BubbleControllerDatasetOptions.html +++ b/docs/master/api/interfaces/BubbleControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BubbleControllerDatasetOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# drawActiveElementsOnTop

• drawActiveElementsOnTop: ScriptableAndArray<boolean, ScriptableContext<"bubble">>

Draw the active elements over the other elements of the dataset,

Default

true

# Inherited from

ScriptableAndArrayOptions.drawActiveElementsOnTop

# Defined in

types/index.d.ts:2008 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hitRadius

• hitRadius: ScriptableAndArray<number, ScriptableContext<"bubble">>

Extra radius added to point radius for hit detection.

Default

1

# Inherited from

ScriptableAndArrayOptions.hitRadius

# Defined in

types/index.d.ts:1993 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverRadius

• hoverRadius: ScriptableAndArray<number, ScriptableContext<"bubble">>

Point radius when hovered.

Default

4

# Inherited from

ScriptableAndArrayOptions.hoverRadius

# Defined in

types/index.d.ts:2016 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointStyle

• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<"bubble">>

Point style

Default

'circle;

# Inherited from

ScriptableAndArrayOptions.pointStyle

# Defined in

types/index.d.ts:1998 (opens new window)

# radius

• radius: ScriptableAndArray<number, ScriptableContext<"bubble">>

Point radius

Default

3

# Inherited from

ScriptableAndArrayOptions.radius

# Defined in

types/index.d.ts:1988 (opens new window)

# rotation

• rotation: ScriptableAndArray<number, ScriptableContext<"bubble">>

Point rotation (in degrees).

Default

0

# Inherited from

ScriptableAndArrayOptions.rotation

# Defined in

types/index.d.ts:2003 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:169 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:173 (opens new window)

+ (opens new window)

# Interface: BubbleControllerDatasetOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# drawActiveElementsOnTop

• drawActiveElementsOnTop: ScriptableAndArray<boolean, ScriptableContext<"bubble">>

Draw the active elements over the other elements of the dataset,

Default

true

# Inherited from

ScriptableAndArrayOptions.drawActiveElementsOnTop

# Defined in

types/index.d.ts:2008 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hitRadius

• hitRadius: ScriptableAndArray<number, ScriptableContext<"bubble">>

Extra radius added to point radius for hit detection.

Default

1

# Inherited from

ScriptableAndArrayOptions.hitRadius

# Defined in

types/index.d.ts:1993 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"bubble">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverRadius

• hoverRadius: ScriptableAndArray<number, ScriptableContext<"bubble">>

Point radius when hovered.

Default

4

# Inherited from

ScriptableAndArrayOptions.hoverRadius

# Defined in

types/index.d.ts:2016 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointStyle

• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<"bubble">>

Point style

Default

'circle;

# Inherited from

ScriptableAndArrayOptions.pointStyle

# Defined in

types/index.d.ts:1998 (opens new window)

# radius

• radius: ScriptableAndArray<number, ScriptableContext<"bubble">>

Point radius

Default

3

# Inherited from

ScriptableAndArrayOptions.radius

# Defined in

types/index.d.ts:1988 (opens new window)

# rotation

• rotation: ScriptableAndArray<number, ScriptableContext<"bubble">>

Point rotation (in degrees).

Default

0

# Inherited from

ScriptableAndArrayOptions.rotation

# Defined in

types/index.d.ts:2003 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:169 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:173 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/BubbleDataPoint.html b/docs/master/api/interfaces/BubbleDataPoint.html index 89b39c1ec7..f211dc22f5 100644 --- a/docs/master/api/interfaces/BubbleDataPoint.html +++ b/docs/master/api/interfaces/BubbleDataPoint.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: BubbleDataPoint

# Hierarchy

  • Point

    ↳ BubbleDataPoint

# Properties

# r

• r: number

Bubble radius in pixels (not scaled).

# Defined in

types/index.d.ts:180 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

+ (opens new window)

# Interface: BubbleDataPoint

# Hierarchy

  • Point

    ↳ BubbleDataPoint

# Properties

# r

• r: number

Bubble radius in pixels (not scaled).

# Defined in

types/index.d.ts:180 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CanvasFontSpec.html b/docs/master/api/interfaces/CanvasFontSpec.html index fd83395968..66e0bccf4e 100644 --- a/docs/master/api/interfaces/CanvasFontSpec.html +++ b/docs/master/api/interfaces/CanvasFontSpec.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CanvasFontSpec

# Hierarchy

# Properties

# family

• family: string

Default font family for all text, follows CSS font-family options.

Default

"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

# Inherited from

FontSpec.family

# Defined in

types/index.d.ts:1766 (opens new window)

# lineHeight

• lineHeight: string | number

Height of an individual line of text (see MDN).

Default

1.2

# Inherited from

FontSpec.lineHeight

# Defined in

types/index.d.ts:1785 (opens new window)

# size

• size: number

Default font size (in px) for text. Does not apply to radialLinear scale point labels.

Default

12

# Inherited from

FontSpec.size

# Defined in

types/index.d.ts:1771 (opens new window)

# string

• string: string

# Defined in

types/index.d.ts:1789 (opens new window)

# style

• style: "normal" | "inherit" | "italic" | "oblique" | "initial"

Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit)

Default

'normal'

# Inherited from

FontSpec.style

# Defined in

types/index.d.ts:1776 (opens new window)

# weight

• weight: number | "bold" | "normal" | "lighter" | "bolder"

Default font weight (boldness). (see MDN).

# Inherited from

FontSpec.weight

# Defined in

types/index.d.ts:1780 (opens new window)

+ (opens new window)

# Interface: CanvasFontSpec

# Hierarchy

# Properties

# family

• family: string

Default font family for all text, follows CSS font-family options.

Default

"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

# Inherited from

FontSpec.family

# Defined in

types/index.d.ts:1766 (opens new window)

# lineHeight

• lineHeight: string | number

Height of an individual line of text (see MDN).

Default

1.2

# Inherited from

FontSpec.lineHeight

# Defined in

types/index.d.ts:1785 (opens new window)

# size

• size: number

Default font size (in px) for text. Does not apply to radialLinear scale point labels.

Default

12

# Inherited from

FontSpec.size

# Defined in

types/index.d.ts:1771 (opens new window)

# string

• string: string

# Defined in

types/index.d.ts:1789 (opens new window)

# style

• style: "normal" | "inherit" | "italic" | "oblique" | "initial"

Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit)

Default

'normal'

# Inherited from

FontSpec.style

# Defined in

types/index.d.ts:1776 (opens new window)

# weight

• weight: number | "bold" | "normal" | "lighter" | "bolder"

Default font weight (boldness). (see MDN).

# Inherited from

FontSpec.weight

# Defined in

types/index.d.ts:1780 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CartesianParsedData.html b/docs/master/api/interfaces/CartesianParsedData.html index 23d70c51c9..0c6a6f0d21 100644 --- a/docs/master/api/interfaces/CartesianParsedData.html +++ b/docs/master/api/interfaces/CartesianParsedData.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CartesianParsedData

# Hierarchy

  • Point

    ↳ CartesianParsedData

# Properties

# _stacks

• Optional _stacks: Object

# Index signature

▪ [key: string]: { [key: number]: number; }

# Defined in

types/index.d.ts:3629 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

+ (opens new window)

# Interface: CartesianParsedData

# Hierarchy

  • Point

    ↳ CartesianParsedData

# Properties

# _stacks

• Optional _stacks: Object

# Index signature

▪ [key: string]: { [key: number]: number; }

# Defined in

types/index.d.ts:3629 (opens new window)

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CartesianScaleOptions.html b/docs/master/api/interfaces/CartesianScaleOptions.html index ec155c15df..eaffb7a227 100644 --- a/docs/master/api/interfaces/CartesianScaleOptions.html +++ b/docs/master/api/interfaces/CartesianScaleOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CartesianScaleOptions

# Hierarchy

# Properties

# alignToPixels

• alignToPixels: boolean

Align pixel values to device pixels

# Inherited from

CoreScaleOptions.alignToPixels

# Defined in

types/index.d.ts:1168 (opens new window)

# axis

• axis: "x" | "y" | "r"

Which type of axis this is. Possible values are: 'x', 'y', 'r'. If not set, this is inferred from the first character of the ID which should be 'x', 'y' or 'r'.

# Defined in

types/index.d.ts:3197 (opens new window)

# backgroundColor

• backgroundColor: Color

Background color of the scale area.

# Inherited from

CoreScaleOptions.backgroundColor

# Defined in

types/index.d.ts:1172 (opens new window)

# border

• border: BorderOptions

# Defined in

types/index.d.ts:3217 (opens new window)

# bounds

• bounds: "data" | "ticks"

Scale boundary strategy (bypassed by min/max time options)

  • data: make sure data are fully visible, ticks outside are removed
  • ticks: make sure ticks are fully visible, data outside are truncated

Since

2.7.0

Default

'ticks'

# Defined in

types/index.d.ts:3176 (opens new window)

# clip

• clip: boolean

Clip the dataset drawing against the size of the scale instead of chart area.

Default

true

# Inherited from

CoreScaleOptions.clip

# Defined in

types/index.d.ts:1182 (opens new window)

# display

• display: boolean | "auto"

Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.

Default

true

# Inherited from

CoreScaleOptions.display

# Defined in

types/index.d.ts:1164 (opens new window)

# grid

• grid: Partial<GridLineOptions>

# Defined in

types/index.d.ts:3215 (opens new window)

# max

• max: number

User defined maximum value for the scale, overrides maximum value from data.

# Overrides

CoreScaleOptions.max

# Defined in

types/index.d.ts:3207 (opens new window)

# min

• min: number

User defined minimum value for the scale, overrides minimum value from data.

# Overrides

CoreScaleOptions.min

# Defined in

types/index.d.ts:3202 (opens new window)

# offset

• offset: boolean

If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.

Default

false

# Defined in

types/index.d.ts:3213 (opens new window)

# position

• position: "center" | "left" | "top" | "bottom" | "right" | { [scale: string]: number; }

Position of the axis.

# Defined in

types/index.d.ts:3181 (opens new window)

# reverse

• reverse: boolean

Reverse the scale.

Default

false

# Inherited from

CoreScaleOptions.reverse

# Defined in

types/index.d.ts:1177 (opens new window)

# stack

• Optional stack: string

Stack group. Axes at the same position with same stack are stacked.

# Defined in

types/index.d.ts:3186 (opens new window)

# stackWeight

• Optional stackWeight: number

Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.

Default

1

# Defined in

types/index.d.ts:3192 (opens new window)

# stacked

• Optional stacked: boolean | "single"

If true, data will be comprised between datasets of data

Default

false

# Defined in

types/index.d.ts:3246 (opens new window)

# suggestedMax

• suggestedMax: unknown

Adjustment used when calculating the minimum data value.

# Inherited from

CoreScaleOptions.suggestedMax

# Defined in

types/index.d.ts:1203 (opens new window)

# suggestedMin

• suggestedMin: unknown

Adjustment used when calculating the maximum data value.

# Inherited from

CoreScaleOptions.suggestedMin

# Defined in

types/index.d.ts:1199 (opens new window)

# ticks

• ticks: CartesianTickOptions

# Defined in

types/index.d.ts:3248 (opens new window)

# title

• title: Object

Options for the scale title.

# Type declaration

Name Type Description
align Align Alignment of the axis title.
color Color Color of the axis label.
display boolean If true, displays the axis title.
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableCartesianScaleContext> Information about the axis title font.
padding number | { bottom: number ; top: number ; y: number } Padding to apply around scale labels.
text string | string[] The text for the title, e.g. "# of People" or "Response Choices".

# Defined in

types/index.d.ts:3220 (opens new window)

# weight

• weight: number

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

Default

true

# Inherited from

CoreScaleOptions.weight

# Defined in

types/index.d.ts:1187 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(axis): void

Callback that runs after ticks are created. Useful for filtering ticks.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterBuildTicks

# Defined in

types/index.d.ts:1231 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(axis): void

Callback that runs after tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterCalculateLabelRotation

# Defined in

types/index.d.ts:1247 (opens new window)

# afterDataLimits

▸ afterDataLimits(axis): void

Callback that runs after data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterDataLimits

# Defined in

types/index.d.ts:1223 (opens new window)

# afterFit

▸ afterFit(axis): void

Callback that runs after the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterFit

# Defined in

types/index.d.ts:1255 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(axis): void

Callback that runs after dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterSetDimensions

# Defined in

types/index.d.ts:1215 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(axis): void

Callback that runs after ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterTickToLabelConversion

# Defined in

types/index.d.ts:1239 (opens new window)

# afterUpdate

▸ afterUpdate(axis): void

Callback that runs at the end of the update process.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterUpdate

# Defined in

types/index.d.ts:1259 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(axis): void

Callback that runs before ticks are created.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeBuildTicks

# Defined in

types/index.d.ts:1227 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(axis): void

Callback that runs before tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeCalculateLabelRotation

# Defined in

types/index.d.ts:1243 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(axis): void

Callback that runs before data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeDataLimits

# Defined in

types/index.d.ts:1219 (opens new window)

# beforeFit

▸ beforeFit(axis): void

Callback that runs before the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeFit

# Defined in

types/index.d.ts:1251 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(axis): void

Callback that runs before dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeSetDimensions

# Defined in

types/index.d.ts:1211 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(axis): void

Callback that runs before ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeTickToLabelConversion

# Defined in

types/index.d.ts:1235 (opens new window)

# beforeUpdate

▸ beforeUpdate(axis): void

Callback called before the update process starts.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeUpdate

# Defined in

types/index.d.ts:1207 (opens new window)

+ (opens new window)

# Interface: CartesianScaleOptions

# Hierarchy

# Properties

# alignToPixels

• alignToPixels: boolean

Align pixel values to device pixels

# Inherited from

CoreScaleOptions.alignToPixels

# Defined in

types/index.d.ts:1168 (opens new window)

# axis

• axis: "x" | "y" | "r"

Which type of axis this is. Possible values are: 'x', 'y', 'r'. If not set, this is inferred from the first character of the ID which should be 'x', 'y' or 'r'.

# Defined in

types/index.d.ts:3197 (opens new window)

# backgroundColor

• backgroundColor: Color

Background color of the scale area.

# Inherited from

CoreScaleOptions.backgroundColor

# Defined in

types/index.d.ts:1172 (opens new window)

# border

• border: BorderOptions

# Defined in

types/index.d.ts:3217 (opens new window)

# bounds

• bounds: "data" | "ticks"

Scale boundary strategy (bypassed by min/max time options)

  • data: make sure data are fully visible, ticks outside are removed
  • ticks: make sure ticks are fully visible, data outside are truncated

Since

2.7.0

Default

'ticks'

# Defined in

types/index.d.ts:3176 (opens new window)

# clip

• clip: boolean

Clip the dataset drawing against the size of the scale instead of chart area.

Default

true

# Inherited from

CoreScaleOptions.clip

# Defined in

types/index.d.ts:1182 (opens new window)

# display

• display: boolean | "auto"

Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.

Default

true

# Inherited from

CoreScaleOptions.display

# Defined in

types/index.d.ts:1164 (opens new window)

# grid

• grid: Partial<GridLineOptions>

# Defined in

types/index.d.ts:3215 (opens new window)

# max

• max: number

User defined maximum value for the scale, overrides maximum value from data.

# Overrides

CoreScaleOptions.max

# Defined in

types/index.d.ts:3207 (opens new window)

# min

• min: number

User defined minimum value for the scale, overrides minimum value from data.

# Overrides

CoreScaleOptions.min

# Defined in

types/index.d.ts:3202 (opens new window)

# offset

• offset: boolean

If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.

Default

false

# Defined in

types/index.d.ts:3213 (opens new window)

# position

• position: "center" | "left" | "top" | "bottom" | "right" | { [scale: string]: number; }

Position of the axis.

# Defined in

types/index.d.ts:3181 (opens new window)

# reverse

• reverse: boolean

Reverse the scale.

Default

false

# Inherited from

CoreScaleOptions.reverse

# Defined in

types/index.d.ts:1177 (opens new window)

# stack

• Optional stack: string

Stack group. Axes at the same position with same stack are stacked.

# Defined in

types/index.d.ts:3186 (opens new window)

# stackWeight

• Optional stackWeight: number

Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.

Default

1

# Defined in

types/index.d.ts:3192 (opens new window)

# stacked

• Optional stacked: boolean | "single"

If true, data will be comprised between datasets of data

Default

false

# Defined in

types/index.d.ts:3246 (opens new window)

# suggestedMax

• suggestedMax: unknown

Adjustment used when calculating the minimum data value.

# Inherited from

CoreScaleOptions.suggestedMax

# Defined in

types/index.d.ts:1203 (opens new window)

# suggestedMin

• suggestedMin: unknown

Adjustment used when calculating the maximum data value.

# Inherited from

CoreScaleOptions.suggestedMin

# Defined in

types/index.d.ts:1199 (opens new window)

# ticks

• ticks: CartesianTickOptions

# Defined in

types/index.d.ts:3248 (opens new window)

# title

• title: Object

Options for the scale title.

# Type declaration

Name Type Description
align Align Alignment of the axis title.
color Color Color of the axis label.
display boolean If true, displays the axis title.
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableCartesianScaleContext> Information about the axis title font.
padding number | { bottom: number ; top: number ; y: number } Padding to apply around scale labels.
text string | string[] The text for the title, e.g. "# of People" or "Response Choices".

# Defined in

types/index.d.ts:3220 (opens new window)

# weight

• weight: number

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

Default

true

# Inherited from

CoreScaleOptions.weight

# Defined in

types/index.d.ts:1187 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(axis): void

Callback that runs after ticks are created. Useful for filtering ticks.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterBuildTicks

# Defined in

types/index.d.ts:1231 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(axis): void

Callback that runs after tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterCalculateLabelRotation

# Defined in

types/index.d.ts:1247 (opens new window)

# afterDataLimits

▸ afterDataLimits(axis): void

Callback that runs after data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterDataLimits

# Defined in

types/index.d.ts:1223 (opens new window)

# afterFit

▸ afterFit(axis): void

Callback that runs after the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterFit

# Defined in

types/index.d.ts:1255 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(axis): void

Callback that runs after dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterSetDimensions

# Defined in

types/index.d.ts:1215 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(axis): void

Callback that runs after ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterTickToLabelConversion

# Defined in

types/index.d.ts:1239 (opens new window)

# afterUpdate

▸ afterUpdate(axis): void

Callback that runs at the end of the update process.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.afterUpdate

# Defined in

types/index.d.ts:1259 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(axis): void

Callback that runs before ticks are created.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeBuildTicks

# Defined in

types/index.d.ts:1227 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(axis): void

Callback that runs before tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeCalculateLabelRotation

# Defined in

types/index.d.ts:1243 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(axis): void

Callback that runs before data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeDataLimits

# Defined in

types/index.d.ts:1219 (opens new window)

# beforeFit

▸ beforeFit(axis): void

Callback that runs before the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeFit

# Defined in

types/index.d.ts:1251 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(axis): void

Callback that runs before dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeSetDimensions

# Defined in

types/index.d.ts:1211 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(axis): void

Callback that runs before ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeTickToLabelConversion

# Defined in

types/index.d.ts:1235 (opens new window)

# beforeUpdate

▸ beforeUpdate(axis): void

Callback called before the update process starts.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Inherited from

CoreScaleOptions.beforeUpdate

# Defined in

types/index.d.ts:1207 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CartesianScaleTypeRegistry.html b/docs/master/api/interfaces/CartesianScaleTypeRegistry.html index a73ca6f581..ef33cfadd2 100644 --- a/docs/master/api/interfaces/CartesianScaleTypeRegistry.html +++ b/docs/master/api/interfaces/CartesianScaleTypeRegistry.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CartesianScaleTypeRegistry

# Hierarchy

# Properties

# category

• category: Object

# Type declaration

Name Type
options CategoryScaleOptions

# Defined in

types/index.d.ts:3605 (opens new window)

# linear

• linear: Object

# Type declaration

Name Type
options LinearScaleOptions

# Defined in

types/index.d.ts:3599 (opens new window)

# logarithmic

• logarithmic: Object

# Type declaration

Name Type
options LogarithmicScaleOptions

# Defined in

types/index.d.ts:3602 (opens new window)

# time

• time: Object

# Type declaration

Name Type
options TimeScaleOptions

# Defined in

types/index.d.ts:3608 (opens new window)

# timeseries

• timeseries: Object

# Type declaration

Name Type
options TimeScaleOptions

# Defined in

types/index.d.ts:3611 (opens new window)

+ (opens new window)

# Interface: CartesianScaleTypeRegistry

# Hierarchy

# Properties

# category

• category: Object

# Type declaration

Name Type
options CategoryScaleOptions

# Defined in

types/index.d.ts:3605 (opens new window)

# linear

• linear: Object

# Type declaration

Name Type
options LinearScaleOptions

# Defined in

types/index.d.ts:3599 (opens new window)

# logarithmic

• logarithmic: Object

# Type declaration

Name Type
options LogarithmicScaleOptions

# Defined in

types/index.d.ts:3602 (opens new window)

# time

• time: Object

# Type declaration

Name Type
options TimeScaleOptions

# Defined in

types/index.d.ts:3608 (opens new window)

# timeseries

• timeseries: Object

# Type declaration

Name Type
options TimeScaleOptions

# Defined in

types/index.d.ts:3611 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartArea.html b/docs/master/api/interfaces/ChartArea.html index 5b3b7c667f..062ae76ca3 100644 --- a/docs/master/api/interfaces/ChartArea.html +++ b/docs/master/api/interfaces/ChartArea.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartArea

# Properties

# bottom

• bottom: number

# Defined in

types/geometric.d.ts:5 (opens new window)

# height

• height: number

# Defined in

types/geometric.d.ts:7 (opens new window)

# left

• left: number

# Defined in

types/geometric.d.ts:3 (opens new window)

• right: number

# Defined in

types/geometric.d.ts:4 (opens new window)

# top

• top: number

# Defined in

types/geometric.d.ts:2 (opens new window)

# width

• width: number

# Defined in

types/geometric.d.ts:6 (opens new window)

+ (opens new window)

# Interface: ChartArea

# Properties

# bottom

• bottom: number

# Defined in

types/geometric.d.ts:5 (opens new window)

# height

• height: number

# Defined in

types/geometric.d.ts:7 (opens new window)

# left

• left: number

# Defined in

types/geometric.d.ts:3 (opens new window)

• right: number

# Defined in

types/geometric.d.ts:4 (opens new window)

# top

• top: number

# Defined in

types/geometric.d.ts:2 (opens new window)

# width

• width: number

# Defined in

types/geometric.d.ts:6 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartComponent.html b/docs/master/api/interfaces/ChartComponent.html index 193f9764ef..c7ba16443f 100644 --- a/docs/master/api/interfaces/ChartComponent.html +++ b/docs/master/api/interfaces/ChartComponent.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartComponent

# Hierarchy

# Properties

# defaultRoutes

• Optional defaultRoutes: Object

# Index signature

▪ [property: string]: string

# Defined in

types/index.d.ts:1554 (opens new window)

# defaults

• Optional defaults: AnyObject

# Defined in

types/index.d.ts:1553 (opens new window)

# id

• id: string

# Defined in

types/index.d.ts:1552 (opens new window)

# Methods

# afterRegister

▸ Optional afterRegister(): void

# Returns

void

# Defined in

types/index.d.ts:1557 (opens new window)

# afterUnregister

▸ Optional afterUnregister(): void

# Returns

void

# Defined in

types/index.d.ts:1559 (opens new window)

# beforeRegister

▸ Optional beforeRegister(): void

# Returns

void

# Defined in

types/index.d.ts:1556 (opens new window)

# beforeUnregister

▸ Optional beforeUnregister(): void

# Returns

void

# Defined in

types/index.d.ts:1558 (opens new window)

+ (opens new window)

# Interface: ChartComponent

# Hierarchy

# Properties

# defaultRoutes

• Optional defaultRoutes: Object

# Index signature

▪ [property: string]: string

# Defined in

types/index.d.ts:1554 (opens new window)

# defaults

• Optional defaults: AnyObject

# Defined in

types/index.d.ts:1553 (opens new window)

# id

• id: string

# Defined in

types/index.d.ts:1552 (opens new window)

# Methods

# afterRegister

▸ Optional afterRegister(): void

# Returns

void

# Defined in

types/index.d.ts:1557 (opens new window)

# afterUnregister

▸ Optional afterUnregister(): void

# Returns

void

# Defined in

types/index.d.ts:1559 (opens new window)

# beforeRegister

▸ Optional beforeRegister(): void

# Returns

void

# Defined in

types/index.d.ts:1556 (opens new window)

# beforeUnregister

▸ Optional beforeUnregister(): void

# Returns

void

# Defined in

types/index.d.ts:1558 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartConfiguration.html b/docs/master/api/interfaces/ChartConfiguration.html index 58b5702f2f..5d27f70a46 100644 --- a/docs/master/api/interfaces/ChartConfiguration.html +++ b/docs/master/api/interfaces/ChartConfiguration.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartConfiguration<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# data

• data: ChartData<TType, TData, TLabel>

# Defined in

types/index.d.ts:3817 (opens new window)

# options

• Optional options: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Defined in

types/index.d.ts:3818 (opens new window)

# platform

• Optional platform: typeof BasePlatform

# Defined in

types/index.d.ts:3820 (opens new window)

# plugins

• Optional plugins: Plugin<TType, AnyObject>[]

# Defined in

types/index.d.ts:3819 (opens new window)

# type

• type: TType

# Defined in

types/index.d.ts:3816 (opens new window)

+ (opens new window)

# Interface: ChartConfiguration<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# data

• data: ChartData<TType, TData, TLabel>

# Defined in

types/index.d.ts:3817 (opens new window)

# options

• Optional options: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Defined in

types/index.d.ts:3818 (opens new window)

# platform

• Optional platform: typeof BasePlatform

# Defined in

types/index.d.ts:3820 (opens new window)

# plugins

• Optional plugins: Plugin<TType, AnyObject>[]

# Defined in

types/index.d.ts:3819 (opens new window)

# type

• type: TType

# Defined in

types/index.d.ts:3816 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartConfigurationCustomTypesPerDataset.html b/docs/master/api/interfaces/ChartConfigurationCustomTypesPerDataset.html index b9df0b58fd..ae7e7a8e77 100644 --- a/docs/master/api/interfaces/ChartConfigurationCustomTypesPerDataset.html +++ b/docs/master/api/interfaces/ChartConfigurationCustomTypesPerDataset.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# data

• data: ChartDataCustomTypesPerDataset<TType, TData, TLabel>

# Defined in

types/index.d.ts:3828 (opens new window)

# options

• Optional options: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Defined in

types/index.d.ts:3829 (opens new window)

# plugins

• Optional plugins: Plugin<TType, AnyObject>[]

# Defined in

types/index.d.ts:3830 (opens new window)

+ (opens new window)

# Interface: ChartConfigurationCustomTypesPerDataset<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# data

• data: ChartDataCustomTypesPerDataset<TType, TData, TLabel>

# Defined in

types/index.d.ts:3828 (opens new window)

# options

• Optional options: DeepPartial<CoreChartOptions<TType> & ElementChartOptions<TType> & PluginChartOptions<TType> & DatasetChartOptions<TType> & ScaleChartOptions<TType> & ChartTypeRegistry[TType]["chartOptions"]>

# Defined in

types/index.d.ts:3829 (opens new window)

# plugins

• Optional plugins: Plugin<TType, AnyObject>[]

# Defined in

types/index.d.ts:3830 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartData.html b/docs/master/api/interfaces/ChartData.html index bbb3189400..2e57111f20 100644 --- a/docs/master/api/interfaces/ChartData.html +++ b/docs/master/api/interfaces/ChartData.html @@ -7,7 +7,7 @@ - + @@ -41,7 +41,7 @@ GitHub (opens new window)

# Interface: ChartData<TType, TData, TLabel>

TData represents the data point type. If unspecified, a default is provided based on the chart type. -TLabel represents the label type

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# datasets

• datasets: ChartDataset<TType, TData>[]

# Defined in

types/index.d.ts:3797 (opens new window)

# labels

• Optional labels: TLabel[]

# Defined in

types/index.d.ts:3794 (opens new window)

# xLabels

• Optional xLabels: TLabel[]

# Defined in

types/index.d.ts:3795 (opens new window)

# yLabels

• Optional yLabels: TLabel[]

# Defined in

types/index.d.ts:3796 (opens new window)

+TLabel represents the label type

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# datasets

• datasets: ChartDataset<TType, TData>[]

# Defined in

types/index.d.ts:3797 (opens new window)

# labels

• Optional labels: TLabel[]

# Defined in

types/index.d.ts:3794 (opens new window)

# xLabels

• Optional xLabels: TLabel[]

# Defined in

types/index.d.ts:3795 (opens new window)

# yLabels

• Optional yLabels: TLabel[]

# Defined in

types/index.d.ts:3796 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartDataCustomTypesPerDataset.html b/docs/master/api/interfaces/ChartDataCustomTypesPerDataset.html index 6fff89e578..f945c7b985 100644 --- a/docs/master/api/interfaces/ChartDataCustomTypesPerDataset.html +++ b/docs/master/api/interfaces/ChartDataCustomTypesPerDataset.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartDataCustomTypesPerDataset<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# datasets

• datasets: ChartDatasetCustomTypesPerDataset<TType, TData>[]

# Defined in

types/index.d.ts:3808 (opens new window)

# labels

• Optional labels: TLabel[]

# Defined in

types/index.d.ts:3805 (opens new window)

# xLabels

• Optional xLabels: TLabel[]

# Defined in

types/index.d.ts:3806 (opens new window)

# yLabels

• Optional yLabels: TLabel[]

# Defined in

types/index.d.ts:3807 (opens new window)

+ (opens new window)

# Interface: ChartDataCustomTypesPerDataset<TType, TData, TLabel>

# Type parameters

Name Type
TType extends ChartType = ChartType
TData DefaultDataPoint<TType>
TLabel unknown

# Properties

# datasets

• datasets: ChartDatasetCustomTypesPerDataset<TType, TData>[]

# Defined in

types/index.d.ts:3808 (opens new window)

# labels

• Optional labels: TLabel[]

# Defined in

types/index.d.ts:3805 (opens new window)

# xLabels

• Optional xLabels: TLabel[]

# Defined in

types/index.d.ts:3806 (opens new window)

# yLabels

• Optional yLabels: TLabel[]

# Defined in

types/index.d.ts:3807 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartDatasetProperties.html b/docs/master/api/interfaces/ChartDatasetProperties.html index 18c903db75..21faccf8f7 100644 --- a/docs/master/api/interfaces/ChartDatasetProperties.html +++ b/docs/master/api/interfaces/ChartDatasetProperties.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartDatasetProperties<TType, TData>

# Type parameters

Name Type
TType extends ChartType
TData TData

# Properties

# data

• data: TData

# Defined in

types/index.d.ts:3762 (opens new window)

# type

• Optional type: TType

# Defined in

types/index.d.ts:3761 (opens new window)

+ (opens new window)

# Interface: ChartDatasetProperties<TType, TData>

# Type parameters

Name Type
TType extends ChartType
TData TData

# Properties

# data

• data: TData

# Defined in

types/index.d.ts:3762 (opens new window)

# type

• Optional type: TType

# Defined in

types/index.d.ts:3761 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html b/docs/master/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html index c302afe62d..cee864b46e 100644 --- a/docs/master/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html +++ b/docs/master/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartDatasetPropertiesCustomTypesPerDataset<TType, TData>

# Type parameters

Name Type
TType extends ChartType
TData TData

# Properties

# data

• data: TData

# Defined in

types/index.d.ts:3767 (opens new window)

# type

• type: TType

# Defined in

types/index.d.ts:3766 (opens new window)

+ (opens new window)

# Interface: ChartDatasetPropertiesCustomTypesPerDataset<TType, TData>

# Type parameters

Name Type
TType extends ChartType
TData TData

# Properties

# data

• data: TData

# Defined in

types/index.d.ts:3767 (opens new window)

# type

• type: TType

# Defined in

types/index.d.ts:3766 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartEvent.html b/docs/master/api/interfaces/ChartEvent.html index d2b97bcc1c..ad36c5c59a 100644 --- a/docs/master/api/interfaces/ChartEvent.html +++ b/docs/master/api/interfaces/ChartEvent.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartEvent

# Properties

# native

• native: Event

# Defined in

types/index.d.ts:1547 (opens new window)

# type

• type: "resize" | "click" | "contextmenu" | "dblclick" | "keydown" | "keypress" | "keyup" | "mousedown" | "mouseenter" | "mousemove" | "mouseout" | "mouseup"

# Defined in

types/index.d.ts:1534 (opens new window)

# x

• x: number

# Defined in

types/index.d.ts:1548 (opens new window)

# y

• y: number

# Defined in

types/index.d.ts:1549 (opens new window)

+ (opens new window)

# Interface: ChartEvent

# Properties

# native

• native: Event

# Defined in

types/index.d.ts:1547 (opens new window)

# type

• type: "resize" | "click" | "contextmenu" | "dblclick" | "keydown" | "keypress" | "keyup" | "mousedown" | "mouseenter" | "mousemove" | "mouseout" | "mouseup"

# Defined in

types/index.d.ts:1534 (opens new window)

# x

• x: number

# Defined in

types/index.d.ts:1548 (opens new window)

# y

• y: number

# Defined in

types/index.d.ts:1549 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ChartTypeRegistry.html b/docs/master/api/interfaces/ChartTypeRegistry.html index 3f99c7d601..257b18e096 100644 --- a/docs/master/api/interfaces/ChartTypeRegistry.html +++ b/docs/master/api/interfaces/ChartTypeRegistry.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ChartTypeRegistry

# Properties

# bar

• bar: Object

# Type declaration

Name Type
chartOptions BarControllerChartOptions
datasetOptions BarControllerDatasetOptions
defaultDataPoint number | [number, number]
metaExtensions {}
parsedDataType BarParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3660 (opens new window)

# bubble

• bubble: Object

# Type declaration

Name Type
chartOptions unknown
datasetOptions BubbleControllerDatasetOptions
defaultDataPoint BubbleDataPoint
metaExtensions {}
parsedDataType BubbleParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3684 (opens new window)

# doughnut

• doughnut: Object

# Type declaration

Name Type
chartOptions DoughnutControllerChartOptions
datasetOptions DoughnutControllerDatasetOptions
defaultDataPoint number
metaExtensions DoughnutMetaExtensions
parsedDataType number
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3700 (opens new window)

# line

• line: Object

# Type declaration

Name Type
chartOptions LineControllerChartOptions
datasetOptions LineControllerDatasetOptions & FillerControllerDatasetOptions
defaultDataPoint number | Point
metaExtensions {}
parsedDataType CartesianParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3668 (opens new window)

# pie

• pie: Object

# Type declaration

Name Type
chartOptions DoughnutControllerChartOptions
datasetOptions DoughnutControllerDatasetOptions
defaultDataPoint number
metaExtensions DoughnutMetaExtensions
parsedDataType number
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3692 (opens new window)

# polarArea

• polarArea: Object

# Type declaration

Name Type
chartOptions PolarAreaControllerChartOptions
datasetOptions PolarAreaControllerDatasetOptions
defaultDataPoint number
metaExtensions {}
parsedDataType RadialParsedData
scales "radialLinear"

# Defined in

types/index.d.ts:3708 (opens new window)

# radar

• radar: Object

# Type declaration

Name Type
chartOptions LineControllerChartOptions
datasetOptions RadarControllerDatasetOptions & FillerControllerDatasetOptions
defaultDataPoint number
metaExtensions {}
parsedDataType RadialParsedData
scales "radialLinear"

# Defined in

types/index.d.ts:3716 (opens new window)

# scatter

• scatter: Object

# Type declaration

Name Type
chartOptions LineControllerChartOptions
datasetOptions LineControllerDatasetOptions
defaultDataPoint number | Point
metaExtensions {}
parsedDataType CartesianParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3676 (opens new window)

+ (opens new window)

# Interface: ChartTypeRegistry

# Properties

# bar

• bar: Object

# Type declaration

Name Type
chartOptions BarControllerChartOptions
datasetOptions BarControllerDatasetOptions
defaultDataPoint number | [number, number]
metaExtensions {}
parsedDataType BarParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3660 (opens new window)

# bubble

• bubble: Object

# Type declaration

Name Type
chartOptions unknown
datasetOptions BubbleControllerDatasetOptions
defaultDataPoint BubbleDataPoint
metaExtensions {}
parsedDataType BubbleParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3684 (opens new window)

# doughnut

• doughnut: Object

# Type declaration

Name Type
chartOptions DoughnutControllerChartOptions
datasetOptions DoughnutControllerDatasetOptions
defaultDataPoint number
metaExtensions DoughnutMetaExtensions
parsedDataType number
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3700 (opens new window)

# line

• line: Object

# Type declaration

Name Type
chartOptions LineControllerChartOptions
datasetOptions LineControllerDatasetOptions & FillerControllerDatasetOptions
defaultDataPoint number | Point
metaExtensions {}
parsedDataType CartesianParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3668 (opens new window)

# pie

• pie: Object

# Type declaration

Name Type
chartOptions DoughnutControllerChartOptions
datasetOptions DoughnutControllerDatasetOptions
defaultDataPoint number
metaExtensions DoughnutMetaExtensions
parsedDataType number
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3692 (opens new window)

# polarArea

• polarArea: Object

# Type declaration

Name Type
chartOptions PolarAreaControllerChartOptions
datasetOptions PolarAreaControllerDatasetOptions
defaultDataPoint number
metaExtensions {}
parsedDataType RadialParsedData
scales "radialLinear"

# Defined in

types/index.d.ts:3708 (opens new window)

# radar

• radar: Object

# Type declaration

Name Type
chartOptions LineControllerChartOptions
datasetOptions RadarControllerDatasetOptions & FillerControllerDatasetOptions
defaultDataPoint number
metaExtensions {}
parsedDataType RadialParsedData
scales "radialLinear"

# Defined in

types/index.d.ts:3716 (opens new window)

# scatter

• scatter: Object

# Type declaration

Name Type
chartOptions LineControllerChartOptions
datasetOptions LineControllerDatasetOptions
defaultDataPoint number | Point
metaExtensions {}
parsedDataType CartesianParsedData
scales keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3676 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CommonElementOptions.html b/docs/master/api/interfaces/CommonElementOptions.html index 7e51973013..65f987d927 100644 --- a/docs/master/api/interfaces/CommonElementOptions.html +++ b/docs/master/api/interfaces/CommonElementOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CommonElementOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Defined in

types/index.d.ts:1807 (opens new window)

# borderColor

• borderColor: Color

# Defined in

types/index.d.ts:1806 (opens new window)

# borderWidth

• borderWidth: number

# Defined in

types/index.d.ts:1805 (opens new window)

+ (opens new window)

# Interface: CommonElementOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Defined in

types/index.d.ts:1807 (opens new window)

# borderColor

• borderColor: Color

# Defined in

types/index.d.ts:1806 (opens new window)

# borderWidth

• borderWidth: number

# Defined in

types/index.d.ts:1805 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CommonHoverOptions.html b/docs/master/api/interfaces/CommonHoverOptions.html index 57eef556cf..ebf2ad5370 100644 --- a/docs/master/api/interfaces/CommonHoverOptions.html +++ b/docs/master/api/interfaces/CommonHoverOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CommonHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Defined in

types/index.d.ts:1811 (opens new window)

+ (opens new window)

# Interface: CommonHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Defined in

types/index.d.ts:1811 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ComplexFillTarget.html b/docs/master/api/interfaces/ComplexFillTarget.html index 4b906666fd..f3eb2e5896 100644 --- a/docs/master/api/interfaces/ComplexFillTarget.html +++ b/docs/master/api/interfaces/ComplexFillTarget.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ComplexFillTarget

# Properties

# above

• above: Color

If no color is set, the default color will be the background color of the chart.

# Defined in

types/index.d.ts:2238 (opens new window)

# below

• below: Color

Same as the above.

# Defined in

types/index.d.ts:2242 (opens new window)

# target

• target: FillTarget

The accepted values are the same as the filling mode values, so you may use absolute and relative dataset indexes and/or boundaries.

# Defined in

types/index.d.ts:2234 (opens new window)

+ (opens new window)

# Interface: ComplexFillTarget

# Properties

# above

• above: Color

If no color is set, the default color will be the background color of the chart.

# Defined in

types/index.d.ts:2238 (opens new window)

# below

• below: Color

Same as the above.

# Defined in

types/index.d.ts:2242 (opens new window)

# target

• target: FillTarget

The accepted values are the same as the filling mode values, so you may use absolute and relative dataset indexes and/or boundaries.

# Defined in

types/index.d.ts:2234 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ControllerDatasetOptions.html b/docs/master/api/interfaces/ControllerDatasetOptions.html index b9ed8b1691..ca766177b5 100644 --- a/docs/master/api/interfaces/ControllerDatasetOptions.html +++ b/docs/master/api/interfaces/ControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ControllerDatasetOptions

# Hierarchy

# Properties

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Defined in

types/index.d.ts:75 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Defined in

types/index.d.ts:93 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ParsingOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ParsingOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Defined in

types/index.d.ts:88 (opens new window)

+ (opens new window)

# Interface: ControllerDatasetOptions

# Hierarchy

# Properties

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Defined in

types/index.d.ts:75 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Defined in

types/index.d.ts:93 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ParsingOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ParsingOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Defined in

types/index.d.ts:88 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CoreChartOptions.html b/docs/master/api/interfaces/CoreChartOptions.html index 2dabd324f9..8df0ac1902 100644 --- a/docs/master/api/interfaces/CoreChartOptions.html +++ b/docs/master/api/interfaces/CoreChartOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CoreChartOptions<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<TType> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<TType>

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# aspectRatio

• aspectRatio: number

Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style.

Default

2

# Defined in

types/index.d.ts:1645 (opens new window)

# backgroundColor

• backgroundColor: Scriptable<Color, ScriptableContext<TType>>

base background color

See

Defaults.backgroundColor

# Defined in

types/index.d.ts:1614 (opens new window)

# borderColor

• borderColor: Scriptable<Color, ScriptableContext<TType>>

base border color

See

Defaults.borderColor

# Defined in

types/index.d.ts:1619 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Defined in

types/index.d.ts:1603 (opens new window)

# color

• color: Scriptable<Color, ScriptableContext<TType>>

base color

See

Defaults.color

# Defined in

types/index.d.ts:1609 (opens new window)

# datasets

• datasets: Object

# Type declaration

Name Type
bar BarControllerDatasetOptions
bubble BubbleControllerDatasetOptions
doughnut DoughnutControllerDatasetOptions
line LineControllerDatasetOptions & FillerControllerDatasetOptions
pie DoughnutControllerDatasetOptions
polarArea PolarAreaControllerDatasetOptions
radar RadarControllerDatasetOptions & FillerControllerDatasetOptions
scatter LineControllerDatasetOptions

# Defined in

types/index.d.ts:1590 (opens new window)

# devicePixelRatio

• devicePixelRatio: number

Override the window's default devicePixelRatio.

Default

window.devicePixelRatio

# Defined in

types/index.d.ts:1662 (opens new window)

# events

• events: keyof HTMLElementEventMap[]

The events option defines the browser events that the chart should listen to for tooltips and hovering.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Defined in

types/index.d.ts:1672 (opens new window)

# font

• font: Partial<FontSpec>

base font

See

Defaults.font

# Defined in

types/index.d.ts:1624 (opens new window)

# hover

• hover: CoreInteractionOptions

# Defined in

types/index.d.ts:1666 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Defined in

types/index.d.ts:1598 (opens new window)

# interaction

• interaction: CoreInteractionOptions

# Defined in

types/index.d.ts:1664 (opens new window)

# layout

• layout: Partial<{ autoPadding: boolean ; padding: Scriptable<Padding, ScriptableContext<TType>> }>

# Defined in

types/index.d.ts:1684 (opens new window)

# locale

• locale: string

Locale used for number formatting (using Intl.NumberFormat).

Default

user's browser setting

# Defined in

types/index.d.ts:1651 (opens new window)

# maintainAspectRatio

• maintainAspectRatio: boolean

Maintain the original canvas aspect ratio (width / height) when resizing. For this option to work properly the chart must be in its own dedicated container.

Default

true

# Defined in

types/index.d.ts:1634 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ParsingOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ParsingOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# resizeDelay

• resizeDelay: number

Delay the resize update by give amount of milliseconds. This can ease the resize process by debouncing update of the elements.

Default

0

# Defined in

types/index.d.ts:1639 (opens new window)

# responsive

• responsive: boolean

Resizes the chart canvas when its container does (important note...).

Default

true

# Defined in

types/index.d.ts:1629 (opens new window)

# transitions

• transitions: TransitionsSpec<TType>

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# Methods

# onClick

▸ onClick(event, elements, chart): void

Called if the event is of type 'mouseup' or 'click'. Passed the event, an array of active elements, and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/index.d.ts:1682 (opens new window)

# onHover

▸ onHover(event, elements, chart): void

Called when any of the events fire. Passed the event, an array of active elements (bars, points, etc), and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/index.d.ts:1677 (opens new window)

# onResize

▸ onResize(chart, size): void

Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
size Object
size.height number
size.width number

# Returns

void

# Defined in

types/index.d.ts:1656 (opens new window)

+ (opens new window)

# Interface: CoreChartOptions<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<TType> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<TType>

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# aspectRatio

• aspectRatio: number

Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style.

Default

2

# Defined in

types/index.d.ts:1645 (opens new window)

# backgroundColor

• backgroundColor: Scriptable<Color, ScriptableContext<TType>>

base background color

See

Defaults.backgroundColor

# Defined in

types/index.d.ts:1614 (opens new window)

# borderColor

• borderColor: Scriptable<Color, ScriptableContext<TType>>

base border color

See

Defaults.borderColor

# Defined in

types/index.d.ts:1619 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Defined in

types/index.d.ts:1603 (opens new window)

# color

• color: Scriptable<Color, ScriptableContext<TType>>

base color

See

Defaults.color

# Defined in

types/index.d.ts:1609 (opens new window)

# datasets

• datasets: Object

# Type declaration

Name Type
bar BarControllerDatasetOptions
bubble BubbleControllerDatasetOptions
doughnut DoughnutControllerDatasetOptions
line LineControllerDatasetOptions & FillerControllerDatasetOptions
pie DoughnutControllerDatasetOptions
polarArea PolarAreaControllerDatasetOptions
radar RadarControllerDatasetOptions & FillerControllerDatasetOptions
scatter LineControllerDatasetOptions

# Defined in

types/index.d.ts:1590 (opens new window)

# devicePixelRatio

• devicePixelRatio: number

Override the window's default devicePixelRatio.

Default

window.devicePixelRatio

# Defined in

types/index.d.ts:1662 (opens new window)

# events

• events: keyof HTMLElementEventMap[]

The events option defines the browser events that the chart should listen to for tooltips and hovering.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Defined in

types/index.d.ts:1672 (opens new window)

# font

• font: Partial<FontSpec>

base font

See

Defaults.font

# Defined in

types/index.d.ts:1624 (opens new window)

# hover

• hover: CoreInteractionOptions

# Defined in

types/index.d.ts:1666 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Defined in

types/index.d.ts:1598 (opens new window)

# interaction

• interaction: CoreInteractionOptions

# Defined in

types/index.d.ts:1664 (opens new window)

# layout

• layout: Partial<{ autoPadding: boolean ; padding: Scriptable<Padding, ScriptableContext<TType>> }>

# Defined in

types/index.d.ts:1684 (opens new window)

# locale

• locale: string

Locale used for number formatting (using Intl.NumberFormat).

Default

user's browser setting

# Defined in

types/index.d.ts:1651 (opens new window)

# maintainAspectRatio

• maintainAspectRatio: boolean

Maintain the original canvas aspect ratio (width / height) when resizing. For this option to work properly the chart must be in its own dedicated container.

Default

true

# Defined in

types/index.d.ts:1634 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ParsingOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ParsingOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# resizeDelay

• resizeDelay: number

Delay the resize update by give amount of milliseconds. This can ease the resize process by debouncing update of the elements.

Default

0

# Defined in

types/index.d.ts:1639 (opens new window)

# responsive

• responsive: boolean

Resizes the chart canvas when its container does (important note...).

Default

true

# Defined in

types/index.d.ts:1629 (opens new window)

# transitions

• transitions: TransitionsSpec<TType>

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# Methods

# onClick

▸ onClick(event, elements, chart): void

Called if the event is of type 'mouseup' or 'click'. Passed the event, an array of active elements, and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/index.d.ts:1682 (opens new window)

# onHover

▸ onHover(event, elements, chart): void

Called when any of the events fire. Passed the event, an array of active elements (bars, points, etc), and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Defined in

types/index.d.ts:1677 (opens new window)

# onResize

▸ onResize(chart, size): void

Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
size Object
size.height number
size.width number

# Returns

void

# Defined in

types/index.d.ts:1656 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CoreInteractionOptions.html b/docs/master/api/interfaces/CoreInteractionOptions.html index 642f38a632..8ff750a8eb 100644 --- a/docs/master/api/interfaces/CoreInteractionOptions.html +++ b/docs/master/api/interfaces/CoreInteractionOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CoreInteractionOptions

# Hierarchy

# Properties

# axis

• axis: InteractionAxis

Defines which directions are used in calculating distances. Defaults to 'x' for 'index' mode and 'xy' in dataset and 'nearest' modes.

# Defined in

types/index.d.ts:1579 (opens new window)

# includeInvisible

• includeInvisible: boolean

if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.

Default

false

# Defined in

types/index.d.ts:1585 (opens new window)

# intersect

• intersect: boolean

if true, the hover mode only applies when the mouse position intersects an item on the chart.

Default

true

# Defined in

types/index.d.ts:1574 (opens new window)

# mode

• mode: keyof InteractionModeMap

Sets which elements appear in the tooltip. See Interaction Modes for details.

Default

'nearest'

# Defined in

types/index.d.ts:1569 (opens new window)

+ (opens new window)

# Interface: CoreInteractionOptions

# Hierarchy

# Properties

# axis

• axis: InteractionAxis

Defines which directions are used in calculating distances. Defaults to 'x' for 'index' mode and 'xy' in dataset and 'nearest' modes.

# Defined in

types/index.d.ts:1579 (opens new window)

# includeInvisible

• includeInvisible: boolean

if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.

Default

false

# Defined in

types/index.d.ts:1585 (opens new window)

# intersect

• intersect: boolean

if true, the hover mode only applies when the mouse position intersects an item on the chart.

Default

true

# Defined in

types/index.d.ts:1574 (opens new window)

# mode

• mode: keyof InteractionModeMap

Sets which elements appear in the tooltip. See Interaction Modes for details.

Default

'nearest'

# Defined in

types/index.d.ts:1569 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/CoreScaleOptions.html b/docs/master/api/interfaces/CoreScaleOptions.html index 67e16af547..371e4fb50e 100644 --- a/docs/master/api/interfaces/CoreScaleOptions.html +++ b/docs/master/api/interfaces/CoreScaleOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: CoreScaleOptions

# Hierarchy

# Properties

# alignToPixels

• alignToPixels: boolean

Align pixel values to device pixels

# Defined in

types/index.d.ts:1168 (opens new window)

# backgroundColor

• backgroundColor: Color

Background color of the scale area.

# Defined in

types/index.d.ts:1172 (opens new window)

# clip

• clip: boolean

Clip the dataset drawing against the size of the scale instead of chart area.

Default

true

# Defined in

types/index.d.ts:1182 (opens new window)

# display

• display: boolean | "auto"

Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.

Default

true

# Defined in

types/index.d.ts:1164 (opens new window)

# max

• max: unknown

User defined maximum value for the scale, overrides maximum value from data.

# Defined in

types/index.d.ts:1195 (opens new window)

# min

• min: unknown

User defined minimum value for the scale, overrides minimum value from data.

# Defined in

types/index.d.ts:1191 (opens new window)

# reverse

• reverse: boolean

Reverse the scale.

Default

false

# Defined in

types/index.d.ts:1177 (opens new window)

# suggestedMax

• suggestedMax: unknown

Adjustment used when calculating the minimum data value.

# Defined in

types/index.d.ts:1203 (opens new window)

# suggestedMin

• suggestedMin: unknown

Adjustment used when calculating the maximum data value.

# Defined in

types/index.d.ts:1199 (opens new window)

# weight

• weight: number

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

Default

true

# Defined in

types/index.d.ts:1187 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(axis): void

Callback that runs after ticks are created. Useful for filtering ticks.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1231 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(axis): void

Callback that runs after tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1247 (opens new window)

# afterDataLimits

▸ afterDataLimits(axis): void

Callback that runs after data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1223 (opens new window)

# afterFit

▸ afterFit(axis): void

Callback that runs after the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1255 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(axis): void

Callback that runs after dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1215 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(axis): void

Callback that runs after ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1239 (opens new window)

# afterUpdate

▸ afterUpdate(axis): void

Callback that runs at the end of the update process.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1259 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(axis): void

Callback that runs before ticks are created.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1227 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(axis): void

Callback that runs before tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1243 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(axis): void

Callback that runs before data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1219 (opens new window)

# beforeFit

▸ beforeFit(axis): void

Callback that runs before the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1251 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(axis): void

Callback that runs before dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1211 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(axis): void

Callback that runs before ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1235 (opens new window)

# beforeUpdate

▸ beforeUpdate(axis): void

Callback called before the update process starts.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1207 (opens new window)

+ (opens new window)

# Interface: CoreScaleOptions

# Hierarchy

# Properties

# alignToPixels

• alignToPixels: boolean

Align pixel values to device pixels

# Defined in

types/index.d.ts:1168 (opens new window)

# backgroundColor

• backgroundColor: Color

Background color of the scale area.

# Defined in

types/index.d.ts:1172 (opens new window)

# clip

• clip: boolean

Clip the dataset drawing against the size of the scale instead of chart area.

Default

true

# Defined in

types/index.d.ts:1182 (opens new window)

# display

• display: boolean | "auto"

Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.

Default

true

# Defined in

types/index.d.ts:1164 (opens new window)

# max

• max: unknown

User defined maximum value for the scale, overrides maximum value from data.

# Defined in

types/index.d.ts:1195 (opens new window)

# min

• min: unknown

User defined minimum value for the scale, overrides minimum value from data.

# Defined in

types/index.d.ts:1191 (opens new window)

# reverse

• reverse: boolean

Reverse the scale.

Default

false

# Defined in

types/index.d.ts:1177 (opens new window)

# suggestedMax

• suggestedMax: unknown

Adjustment used when calculating the minimum data value.

# Defined in

types/index.d.ts:1203 (opens new window)

# suggestedMin

• suggestedMin: unknown

Adjustment used when calculating the maximum data value.

# Defined in

types/index.d.ts:1199 (opens new window)

# weight

• weight: number

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

Default

true

# Defined in

types/index.d.ts:1187 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(axis): void

Callback that runs after ticks are created. Useful for filtering ticks.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1231 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(axis): void

Callback that runs after tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1247 (opens new window)

# afterDataLimits

▸ afterDataLimits(axis): void

Callback that runs after data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1223 (opens new window)

# afterFit

▸ afterFit(axis): void

Callback that runs after the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1255 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(axis): void

Callback that runs after dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1215 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(axis): void

Callback that runs after ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1239 (opens new window)

# afterUpdate

▸ afterUpdate(axis): void

Callback that runs at the end of the update process.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1259 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(axis): void

Callback that runs before ticks are created.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1227 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(axis): void

Callback that runs before tick rotation is determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1243 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(axis): void

Callback that runs before data limits are determined.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1219 (opens new window)

# beforeFit

▸ beforeFit(axis): void

Callback that runs before the scale fits to the canvas.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1251 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(axis): void

Callback that runs before dimensions are set.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1211 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(axis): void

Callback that runs before ticks are converted into strings.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1235 (opens new window)

# beforeUpdate

▸ beforeUpdate(axis): void

Callback called before the update process starts.

# Parameters

Name Type
axis Scale<CoreScaleOptions>

# Returns

void

# Defined in

types/index.d.ts:1207 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/DatasetControllerChartComponent.html b/docs/master/api/interfaces/DatasetControllerChartComponent.html index bbab3dd18b..110399eedb 100644 --- a/docs/master/api/interfaces/DatasetControllerChartComponent.html +++ b/docs/master/api/interfaces/DatasetControllerChartComponent.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: DatasetControllerChartComponent

# Hierarchy

# Properties

# defaultRoutes

• Optional defaultRoutes: Object

# Index signature

▪ [property: string]: string

# Inherited from

ChartComponent.defaultRoutes

# Defined in

types/index.d.ts:1554 (opens new window)

# defaults

• defaults: Object

# Type declaration

Name Type
dataElementType? string | false
datasetElementType? string | false

# Overrides

ChartComponent.defaults

# Defined in

types/index.d.ts:660 (opens new window)

# id

• id: string

# Inherited from

ChartComponent.id

# Defined in

types/index.d.ts:1552 (opens new window)

# Methods

# afterRegister

▸ Optional afterRegister(): void

# Returns

void

# Inherited from

ChartComponent.afterRegister

# Defined in

types/index.d.ts:1557 (opens new window)

# afterUnregister

▸ Optional afterUnregister(): void

# Returns

void

# Inherited from

ChartComponent.afterUnregister

# Defined in

types/index.d.ts:1559 (opens new window)

# beforeRegister

▸ Optional beforeRegister(): void

# Returns

void

# Inherited from

ChartComponent.beforeRegister

# Defined in

types/index.d.ts:1556 (opens new window)

# beforeUnregister

▸ Optional beforeUnregister(): void

# Returns

void

# Inherited from

ChartComponent.beforeUnregister

# Defined in

types/index.d.ts:1558 (opens new window)

+ (opens new window)

# Interface: DatasetControllerChartComponent

# Hierarchy

# Properties

# defaultRoutes

• Optional defaultRoutes: Object

# Index signature

▪ [property: string]: string

# Inherited from

ChartComponent.defaultRoutes

# Defined in

types/index.d.ts:1554 (opens new window)

# defaults

• defaults: Object

# Type declaration

Name Type
dataElementType? string | false
datasetElementType? string | false

# Overrides

ChartComponent.defaults

# Defined in

types/index.d.ts:660 (opens new window)

# id

• id: string

# Inherited from

ChartComponent.id

# Defined in

types/index.d.ts:1552 (opens new window)

# Methods

# afterRegister

▸ Optional afterRegister(): void

# Returns

void

# Inherited from

ChartComponent.afterRegister

# Defined in

types/index.d.ts:1557 (opens new window)

# afterUnregister

▸ Optional afterUnregister(): void

# Returns

void

# Inherited from

ChartComponent.afterUnregister

# Defined in

types/index.d.ts:1559 (opens new window)

# beforeRegister

▸ Optional beforeRegister(): void

# Returns

void

# Inherited from

ChartComponent.beforeRegister

# Defined in

types/index.d.ts:1556 (opens new window)

# beforeUnregister

▸ Optional beforeUnregister(): void

# Returns

void

# Inherited from

ChartComponent.beforeUnregister

# Defined in

types/index.d.ts:1558 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/Defaults.html b/docs/master/api/interfaces/Defaults.html index 82a2a7ac95..9199e45c8e 100644 --- a/docs/master/api/interfaces/Defaults.html +++ b/docs/master/api/interfaces/Defaults.html @@ -7,7 +7,7 @@ - + @@ -39,10 +39,10 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: Defaults

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<keyof ChartTypeRegistry> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

CoreChartOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<keyof ChartTypeRegistry>

# Inherited from

CoreChartOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# aspectRatio

• aspectRatio: number

Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style.

Default

2

# Inherited from

CoreChartOptions.aspectRatio

# Defined in

types/index.d.ts:1645 (opens new window)

# backgroundColor

• backgroundColor: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

base background color

See

Defaults.backgroundColor

# Inherited from

CoreChartOptions.backgroundColor

# Defined in

types/index.d.ts:1614 (opens new window)

# borderColor

• borderColor: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

base border color

See

Defaults.borderColor

# Inherited from

CoreChartOptions.borderColor

# Defined in

types/index.d.ts:1619 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

CoreChartOptions.clip

# Defined in

types/index.d.ts:1603 (opens new window)

# color

• color: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

base color

See

Defaults.color

# Inherited from

CoreChartOptions.color

# Defined in

types/index.d.ts:1609 (opens new window)

# datasets

• datasets: Object

# Type declaration

Name Type
bar BarControllerDatasetOptions
bubble BubbleControllerDatasetOptions
doughnut DoughnutControllerDatasetOptions
line LineControllerDatasetOptions & FillerControllerDatasetOptions
pie DoughnutControllerDatasetOptions
polarArea PolarAreaControllerDatasetOptions
radar RadarControllerDatasetOptions & FillerControllerDatasetOptions
scatter LineControllerDatasetOptions

# Inherited from

CoreChartOptions.datasets

# Defined in

types/index.d.ts:1590 (opens new window)

# devicePixelRatio

• devicePixelRatio: number

Override the window's default devicePixelRatio.

Default

window.devicePixelRatio

# Inherited from

CoreChartOptions.devicePixelRatio

# Defined in

types/index.d.ts:1662 (opens new window)

# elements

• elements: ElementOptionsByType<keyof ChartTypeRegistry>

# Inherited from

ElementChartOptions.elements

# Defined in

types/index.d.ts:2137 (opens new window)

# events

• events: keyof HTMLElementEventMap[]

The events option defines the browser events that the chart should listen to for tooltips and hovering.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Inherited from

CoreChartOptions.events

# Defined in

types/index.d.ts:1672 (opens new window)

# font

• font: Partial<FontSpec>

base font

See

Defaults.font

# Inherited from

CoreChartOptions.font

# Defined in

types/index.d.ts:1624 (opens new window)

# hover

• hover: CoreInteractionOptions

# Inherited from

CoreChartOptions.hover

# Defined in

types/index.d.ts:1666 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

CoreChartOptions.indexAxis

# Defined in

types/index.d.ts:1598 (opens new window)

# interaction

• interaction: CoreInteractionOptions

# Inherited from

CoreChartOptions.interaction

# Defined in

types/index.d.ts:1664 (opens new window)

# layout

• layout: Partial<{ autoPadding: boolean ; padding: Scriptable<Padding, ScriptableContext<keyof ChartTypeRegistry>> }>

# Inherited from

CoreChartOptions.layout

# Defined in

types/index.d.ts:1684 (opens new window)

# locale

• locale: string

Locale used for number formatting (using Intl.NumberFormat).

Default

user's browser setting

# Inherited from

CoreChartOptions.locale

# Defined in

types/index.d.ts:1651 (opens new window)

# maintainAspectRatio

• maintainAspectRatio: boolean

Maintain the original canvas aspect ratio (width / height) when resizing. For this option to work properly the chart must be in its own dedicated container.

Default

true

# Inherited from

CoreChartOptions.maintainAspectRatio

# Defined in

types/index.d.ts:1634 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

CoreChartOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

CoreChartOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# plugins

• plugins: PluginOptionsByType<keyof ChartTypeRegistry>

# Inherited from

PluginChartOptions.plugins

# Defined in

types/index.d.ts:2950 (opens new window)

# resizeDelay

• resizeDelay: number

Delay the resize update by give amount of milliseconds. This can ease the resize process by debouncing update of the elements.

Default

0

# Inherited from

CoreChartOptions.resizeDelay

# Defined in

types/index.d.ts:1639 (opens new window)

# responsive

• responsive: boolean

Resizes the chart canvas when its container does (important note...).

Default

true

# Inherited from

CoreChartOptions.responsive

# Defined in

types/index.d.ts:1629 (opens new window)

# scale

• scale: ScaleOptionsByType<keyof ScaleTypeRegistry>

# Defined in

types/index.d.ts:668 (opens new window)

# scales

• scales: Object

# Type declaration

Name Type
category { type: "category" } & Omit<CartesianScaleOptions, "max" | "min"> & { labels: string[] | string[][] ; max: string | number ; min: string | number }
linear { type: "linear" } & CartesianScaleOptions & { beginAtZero: boolean ; grace?: string | number ; suggestedMax?: number ; suggestedMin?: number ; ticks: { count: number ; format: NumberFormatOptions ; precision: number ; stepSize: number } }
logarithmic { type: "logarithmic" } & CartesianScaleOptions & { suggestedMax?: number ; suggestedMin?: number ; ticks: { format: NumberFormatOptions } }
radialLinear { type: "radialLinear" } & CoreScaleOptions & { angleLines: { borderDash: Scriptable<number[], ScriptableScaleContext> ; borderDashOffset: Scriptable<number, ScriptableScaleContext> ; color: Scriptable<Color, ScriptableScaleContext> ; display: boolean ; lineWidth: Scriptable<number, ScriptableScaleContext> } ; animate: boolean ; beginAtZero: boolean ; grid: Partial<GridLineOptions> ; max: number ; min: number ; pointLabels: { backdropColor: Scriptable<Color, ScriptableScalePointLabelContext> ; backdropPadding: Scriptable<number | ChartArea, ScriptableScalePointLabelContext> ; borderRadius: Scriptable<number | BorderRadius, ScriptableScalePointLabelContext> ; callback: (label: string, index: number) => string | number | string[] | number[] ; centerPointLabels: boolean ; color: Scriptable<Color, ScriptableScalePointLabelContext> ; display: boolean | "auto" ; font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScalePointLabelContext> ; padding: Scriptable<number, ScriptableScalePointLabelContext> } ; startAngle: number ; suggestedMax: number ; suggestedMin: number ; ticks: RadialTickOptions }
time { type: "time" } & Omit<CartesianScaleOptions, "max" | "min"> & { adapters: { date: unknown } ; bounds: "data" | "ticks" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }
timeseries { type: "timeseries" } & Omit<CartesianScaleOptions, "max" | "min"> & { adapters: { date: unknown } ; bounds: "data" | "ticks" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }

# Defined in

types/index.d.ts:669 (opens new window)

# transitions

• transitions: TransitionsSpec<keyof ChartTypeRegistry>

# Inherited from

CoreChartOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# Methods

# describe

▸ describe(scope, values): AnyObject

# Parameters

Name Type
scope string
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:677 (opens new window)

# get

▸ get(scope): AnyObject

# Parameters

Name Type
scope string

# Returns

AnyObject

# Defined in

types/index.d.ts:675 (opens new window)

# onClick

▸ onClick(event, elements, chart): void

Called if the event is of type 'mouseup' or 'click'. Passed the event, an array of active elements, and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

CoreChartOptions.onClick

# Defined in

types/index.d.ts:1682 (opens new window)

# onHover

▸ onHover(event, elements, chart): void

Called when any of the events fire. Passed the event, an array of active elements (bars, points, etc), and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

CoreChartOptions.onHover

# Defined in

types/index.d.ts:1677 (opens new window)

# onResize

▸ onResize(chart, size): void

Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
size Object
size.height number
size.width number

# Returns

void

# Inherited from

CoreChartOptions.onResize

# Defined in

types/index.d.ts:1656 (opens new window)

# override

▸ override(scope, values): AnyObject

# Parameters

Name Type
scope string
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:678 (opens new window)

# route

▸ route(scope, name, targetScope, targetName): void

Routes the named defaults to fallback to another scope/name. + (opens new window)

# Interface: Defaults

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<keyof ChartTypeRegistry> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

CoreChartOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<keyof ChartTypeRegistry>

# Inherited from

CoreChartOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# aspectRatio

• aspectRatio: number

Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style.

Default

2

# Inherited from

CoreChartOptions.aspectRatio

# Defined in

types/index.d.ts:1645 (opens new window)

# backgroundColor

• backgroundColor: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

base background color

See

Defaults.backgroundColor

# Inherited from

CoreChartOptions.backgroundColor

# Defined in

types/index.d.ts:1614 (opens new window)

# borderColor

• borderColor: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

base border color

See

Defaults.borderColor

# Inherited from

CoreChartOptions.borderColor

# Defined in

types/index.d.ts:1619 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

CoreChartOptions.clip

# Defined in

types/index.d.ts:1603 (opens new window)

# color

• color: Scriptable<Color, ScriptableContext<keyof ChartTypeRegistry>>

base color

See

Defaults.color

# Inherited from

CoreChartOptions.color

# Defined in

types/index.d.ts:1609 (opens new window)

# datasets

• datasets: Object

# Type declaration

Name Type
bar BarControllerDatasetOptions
bubble BubbleControllerDatasetOptions
doughnut DoughnutControllerDatasetOptions
line LineControllerDatasetOptions & FillerControllerDatasetOptions
pie DoughnutControllerDatasetOptions
polarArea PolarAreaControllerDatasetOptions
radar RadarControllerDatasetOptions & FillerControllerDatasetOptions
scatter LineControllerDatasetOptions

# Inherited from

CoreChartOptions.datasets

# Defined in

types/index.d.ts:1590 (opens new window)

# devicePixelRatio

• devicePixelRatio: number

Override the window's default devicePixelRatio.

Default

window.devicePixelRatio

# Inherited from

CoreChartOptions.devicePixelRatio

# Defined in

types/index.d.ts:1662 (opens new window)

# elements

• elements: ElementOptionsByType<keyof ChartTypeRegistry>

# Inherited from

ElementChartOptions.elements

# Defined in

types/index.d.ts:2137 (opens new window)

# events

• events: keyof HTMLElementEventMap[]

The events option defines the browser events that the chart should listen to for tooltips and hovering.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Inherited from

CoreChartOptions.events

# Defined in

types/index.d.ts:1672 (opens new window)

# font

• font: Partial<FontSpec>

base font

See

Defaults.font

# Inherited from

CoreChartOptions.font

# Defined in

types/index.d.ts:1624 (opens new window)

# hover

• hover: CoreInteractionOptions

# Inherited from

CoreChartOptions.hover

# Defined in

types/index.d.ts:1666 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

CoreChartOptions.indexAxis

# Defined in

types/index.d.ts:1598 (opens new window)

# interaction

• interaction: CoreInteractionOptions

# Inherited from

CoreChartOptions.interaction

# Defined in

types/index.d.ts:1664 (opens new window)

# layout

• layout: Partial<{ autoPadding: boolean ; padding: Scriptable<Padding, ScriptableContext<keyof ChartTypeRegistry>> }>

# Inherited from

CoreChartOptions.layout

# Defined in

types/index.d.ts:1684 (opens new window)

# locale

• locale: string

Locale used for number formatting (using Intl.NumberFormat).

Default

user's browser setting

# Inherited from

CoreChartOptions.locale

# Defined in

types/index.d.ts:1651 (opens new window)

# maintainAspectRatio

• maintainAspectRatio: boolean

Maintain the original canvas aspect ratio (width / height) when resizing. For this option to work properly the chart must be in its own dedicated container.

Default

true

# Inherited from

CoreChartOptions.maintainAspectRatio

# Defined in

types/index.d.ts:1634 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

CoreChartOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

CoreChartOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# plugins

• plugins: PluginOptionsByType<keyof ChartTypeRegistry>

# Inherited from

PluginChartOptions.plugins

# Defined in

types/index.d.ts:2950 (opens new window)

# resizeDelay

• resizeDelay: number

Delay the resize update by give amount of milliseconds. This can ease the resize process by debouncing update of the elements.

Default

0

# Inherited from

CoreChartOptions.resizeDelay

# Defined in

types/index.d.ts:1639 (opens new window)

# responsive

• responsive: boolean

Resizes the chart canvas when its container does (important note...).

Default

true

# Inherited from

CoreChartOptions.responsive

# Defined in

types/index.d.ts:1629 (opens new window)

# scale

• scale: ScaleOptionsByType<keyof ScaleTypeRegistry>

# Defined in

types/index.d.ts:668 (opens new window)

# scales

• scales: Object

# Type declaration

Name Type
category { type: "category" } & Omit<CartesianScaleOptions, "max" | "min"> & { labels: string[] | string[][] ; max: string | number ; min: string | number }
linear { type: "linear" } & CartesianScaleOptions & { beginAtZero: boolean ; grace?: string | number ; suggestedMax?: number ; suggestedMin?: number ; ticks: { count: number ; format: NumberFormatOptions ; precision: number ; stepSize: number } }
logarithmic { type: "logarithmic" } & CartesianScaleOptions & { suggestedMax?: number ; suggestedMin?: number ; ticks: { format: NumberFormatOptions } }
radialLinear { type: "radialLinear" } & CoreScaleOptions & { angleLines: { borderDash: Scriptable<number[], ScriptableScaleContext> ; borderDashOffset: Scriptable<number, ScriptableScaleContext> ; color: Scriptable<Color, ScriptableScaleContext> ; display: boolean ; lineWidth: Scriptable<number, ScriptableScaleContext> } ; animate: boolean ; beginAtZero: boolean ; grid: Partial<GridLineOptions> ; max: number ; min: number ; pointLabels: { backdropColor: Scriptable<Color, ScriptableScalePointLabelContext> ; backdropPadding: Scriptable<number | ChartArea, ScriptableScalePointLabelContext> ; borderRadius: Scriptable<number | BorderRadius, ScriptableScalePointLabelContext> ; callback: (label: string, index: number) => string | number | string[] | number[] ; centerPointLabels: boolean ; color: Scriptable<Color, ScriptableScalePointLabelContext> ; display: boolean | "auto" ; font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScalePointLabelContext> ; padding: Scriptable<number, ScriptableScalePointLabelContext> } ; startAngle: number ; suggestedMax: number ; suggestedMin: number ; ticks: RadialTickOptions }
time { type: "time" } & Omit<CartesianScaleOptions, "max" | "min"> & { adapters: { date: unknown } ; bounds: "data" | "ticks" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }
timeseries { type: "timeseries" } & Omit<CartesianScaleOptions, "max" | "min"> & { adapters: { date: unknown } ; bounds: "data" | "ticks" ; max: string | number ; min: string | number ; offsetAfterAutoskip: boolean ; suggestedMax: string | number ; suggestedMin: string | number ; ticks: TimeScaleTickOptions ; time: TimeScaleTimeOptions }

# Defined in

types/index.d.ts:669 (opens new window)

# transitions

• transitions: TransitionsSpec<keyof ChartTypeRegistry>

# Inherited from

CoreChartOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# Methods

# describe

▸ describe(scope, values): AnyObject

# Parameters

Name Type
scope string
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:677 (opens new window)

# get

▸ get(scope): AnyObject

# Parameters

Name Type
scope string

# Returns

AnyObject

# Defined in

types/index.d.ts:675 (opens new window)

# onClick

▸ onClick(event, elements, chart): void

Called if the event is of type 'mouseup' or 'click'. Passed the event, an array of active elements, and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

CoreChartOptions.onClick

# Defined in

types/index.d.ts:1682 (opens new window)

# onHover

▸ onHover(event, elements, chart): void

Called when any of the events fire. Passed the event, an array of active elements (bars, points, etc), and the chart.

# Parameters

Name Type
event ChartEvent
elements ActiveElement[]
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Returns

void

# Inherited from

CoreChartOptions.onHover

# Defined in

types/index.d.ts:1677 (opens new window)

# onResize

▸ onResize(chart, size): void

Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.

# Parameters

Name Type
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
size Object
size.height number
size.width number

# Returns

void

# Inherited from

CoreChartOptions.onResize

# Defined in

types/index.d.ts:1656 (opens new window)

# override

▸ override(scope, values): AnyObject

# Parameters

Name Type
scope string
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:678 (opens new window)

# route

▸ route(scope, name, targetScope, targetName): void

Routes the named defaults to fallback to another scope/name. This routing is useful when those target values, like defaults.color, are changed runtime. If the values would be copied, the runtime change would not take effect. By routing, the -fallback is evaluated at each access, so its always up to date.

Example:

defaults.route('elements.arc', 'backgroundColor', '', 'color')

  • reads the backgroundColor from defaults.color when undefined locally

# Parameters

Name Type Description
scope string Scope this route applies to.
name string Property name that should be routed to different namespace when not defined here.
targetScope string The namespace where those properties should be routed to. Empty string ('') is the root of defaults.
targetName string The target name in the target scope the property should be routed to.

# Returns

void

# Defined in

types/index.d.ts:697 (opens new window)

# set

▸ set(values): AnyObject

# Parameters

Name Type
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:673 (opens new window)

▸ set(scope, values): AnyObject

# Parameters

Name Type
scope string
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:674 (opens new window)

+fallback is evaluated at each access, so its always up to date.

Example:

defaults.route('elements.arc', 'backgroundColor', '', 'color')

  • reads the backgroundColor from defaults.color when undefined locally

# Parameters

Name Type Description
scope string Scope this route applies to.
name string Property name that should be routed to different namespace when not defined here.
targetScope string The namespace where those properties should be routed to. Empty string ('') is the root of defaults.
targetName string The target name in the target scope the property should be routed to.

# Returns

void

# Defined in

types/index.d.ts:697 (opens new window)

# set

▸ set(values): AnyObject

# Parameters

Name Type
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:673 (opens new window)

▸ set(scope, values): AnyObject

# Parameters

Name Type
scope string
values AnyObject

# Returns

AnyObject

# Defined in

types/index.d.ts:674 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/DoughnutAnimationOptions.html b/docs/master/api/interfaces/DoughnutAnimationOptions.html index f82c966771..c286e4cc8e 100644 --- a/docs/master/api/interfaces/DoughnutAnimationOptions.html +++ b/docs/master/api/interfaces/DoughnutAnimationOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: DoughnutAnimationOptions

# Properties

# animateRotate

• animateRotate: boolean

If true, the chart will animate in with a rotation animation. This property is in the options.animation object.

Default

true

# Defined in

types/index.d.ts:289 (opens new window)

# animateScale

• animateScale: boolean

If true, will animate scaling the chart from the center outwards.

Default

false

# Defined in

types/index.d.ts:295 (opens new window)

+ (opens new window)

# Interface: DoughnutAnimationOptions

# Properties

# animateRotate

• animateRotate: boolean

If true, the chart will animate in with a rotation animation. This property is in the options.animation object.

Default

true

# Defined in

types/index.d.ts:289 (opens new window)

# animateScale

• animateScale: boolean

If true, will animate scaling the chart from the center outwards.

Default

false

# Defined in

types/index.d.ts:295 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/DoughnutController.html b/docs/master/api/interfaces/DoughnutController.html index e137879ce2..542d5aa263 100644 --- a/docs/master/api/interfaces/DoughnutController.html +++ b/docs/master/api/interfaces/DoughnutController.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: DoughnutController

# Hierarchy

# Properties

# _cachedMeta

• Readonly _cachedMeta: ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DatasetController._cachedMeta

# Defined in

types/index.d.ts:592 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

DatasetController.chart

# Defined in

types/index.d.ts:590 (opens new window)

# enableOptionSharing

• enableOptionSharing: boolean

# Inherited from

DatasetController.enableOptionSharing

# Defined in

types/index.d.ts:593 (opens new window)

# index

• Readonly index: number

# Inherited from

DatasetController.index

# Defined in

types/index.d.ts:591 (opens new window)

# innerRadius

• Readonly innerRadius: number

# Defined in

types/index.d.ts:341 (opens new window)

# offsetX

• Readonly offsetX: number

# Defined in

types/index.d.ts:343 (opens new window)

# offsetY

• Readonly offsetY: number

# Defined in

types/index.d.ts:344 (opens new window)

# outerRadius

• Readonly outerRadius: number

# Defined in

types/index.d.ts:342 (opens new window)

# supportsDecimation

• supportsDecimation: boolean

# Inherited from

DatasetController.supportsDecimation

# Defined in

types/index.d.ts:597 (opens new window)

# Methods

# addElements

▸ addElements(): void

# Returns

void

# Inherited from

DatasetController.addElements

# Defined in

types/index.d.ts:613 (opens new window)

# applyStack

▸ Protected applyStack(scale, parsed): number

# Parameters

Name Type
scale Scale<CoreScaleOptions>
parsed unknown[]

# Returns

number

# Inherited from

DatasetController.applyStack

# Defined in

types/index.d.ts:649 (opens new window)

# buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

# Parameters

Name Type
resetNewElements? boolean

# Returns

void

# Inherited from

DatasetController.buildOrUpdateElements

# Defined in

types/index.d.ts:614 (opens new window)

# calculateCircumference

▸ calculateCircumference(value): number

# Parameters

Name Type
value number

# Returns

number

# Defined in

types/index.d.ts:347 (opens new window)

# calculateTotal

▸ calculateTotal(): number

# Returns

number

# Defined in

types/index.d.ts:346 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

DatasetController.configure

# Defined in

types/index.d.ts:611 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Inherited from

DatasetController.draw

# Defined in

types/index.d.ts:606 (opens new window)

# getAllParsedValues

▸ getAllParsedValues(scale): number[]

# Parameters

Name Type
scale Scale<CoreScaleOptions>

# Returns

number[]

# Inherited from

DatasetController.getAllParsedValues

# Defined in

types/index.d.ts:600 (opens new window)

# getDataset

▸ getDataset(): ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Returns

ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Inherited from

DatasetController.getDataset

# Defined in

types/index.d.ts:608 (opens new window)

# getLabelAndValue

▸ Protected getLabelAndValue(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
label string
value string

# Inherited from

DatasetController.getLabelAndValue

# Defined in

types/index.d.ts:601 (opens new window)

# getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

# Returns

number | boolean

# Inherited from

DatasetController.getMaxOverflow

# Defined in

types/index.d.ts:605 (opens new window)

# getMeta

▸ getMeta(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DatasetController.getMeta

# Defined in

types/index.d.ts:609 (opens new window)

# getMinMax

▸ Protected getMinMax(scale, canStack?): Object

# Parameters

Name Type
scale Scale<CoreScaleOptions>
canStack? boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

DatasetController.getMinMax

# Defined in

types/index.d.ts:656 (opens new window)

# getParsed

▸ Protected getParsed(index): number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Parameters

Name Type
index number

# Returns

number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Inherited from

DatasetController.getParsed

# Defined in

types/index.d.ts:648 (opens new window)

# getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

# Parameters

Name Type
scaleID string

# Returns

Scale<CoreScaleOptions>

# Inherited from

DatasetController.getScaleForId

# Defined in

types/index.d.ts:610 (opens new window)

# getSharedOptions

▸ Protected getSharedOptions(options): AnyObject

Utility for checking if the options are shared and should be animated separately.

# Parameters

Name Type
options AnyObject

# Returns

AnyObject

# Inherited from

DatasetController.getSharedOptions

# Defined in

types/index.d.ts:623 (opens new window)

# getStyle

▸ getStyle(index, active): AnyObject

# Parameters

Name Type
index number
active boolean

# Returns

AnyObject

# Inherited from

DatasetController.getStyle

# Defined in

types/index.d.ts:616 (opens new window)

# includeOptions

▸ Protected includeOptions(mode, sharedOptions): boolean

Utility for determining if options should be included in the updated properties

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
sharedOptions AnyObject

# Returns

boolean

# Inherited from

DatasetController.includeOptions

# Defined in

types/index.d.ts:628 (opens new window)

# initialize

▸ initialize(): void

# Returns

void

# Inherited from

DatasetController.initialize

# Defined in

types/index.d.ts:612 (opens new window)

# linkScales

▸ linkScales(): void

# Returns

void

# Inherited from

DatasetController.linkScales

# Defined in

types/index.d.ts:599 (opens new window)

# parse

▸ parse(start, count): void

# Parameters

Name Type
start number
count number

# Returns

void

# Inherited from

DatasetController.parse

# Defined in

types/index.d.ts:644 (opens new window)

# parseArrayData

▸ Protected parseArrayData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parseArrayData

# Defined in

types/index.d.ts:646 (opens new window)

# parseObjectData

▸ Protected parseObjectData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parseObjectData

# Defined in

types/index.d.ts:647 (opens new window)

# parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parsePrimitiveData

# Defined in

types/index.d.ts:645 (opens new window)

# removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DatasetController.removeHoverStyle

# Defined in

types/index.d.ts:641 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Inherited from

DatasetController.reset

# Defined in

types/index.d.ts:607 (opens new window)

# resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): AnyObject

# Parameters

Name Type
index number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DatasetController.resolveDataElementOptions

# Defined in

types/index.d.ts:618 (opens new window)

# resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): AnyObject

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DatasetController.resolveDatasetElementOptions

# Defined in

types/index.d.ts:617 (opens new window)

# setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DatasetController.setHoverStyle

# Defined in

types/index.d.ts:642 (opens new window)

# update

▸ update(mode): void

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.update

# Defined in

types/index.d.ts:603 (opens new window)

# updateElement

▸ Protected updateElement(element, index, properties, mode): void

Utility for updating an element with new properties, using animations when appropriate.

# Parameters

Name Type
element default<AnyObject, AnyObject>
index number
properties AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.updateElement

# Defined in

types/index.d.ts:634 (opens new window)

# updateElements

▸ updateElements(elements, start, count, mode): void

# Parameters

Name Type
elements default<AnyObject, AnyObject>[]
start number
count number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.updateElements

# Defined in

types/index.d.ts:602 (opens new window)

# updateIndex

▸ updateIndex(datasetIndex): void

# Parameters

Name Type
datasetIndex number

# Returns

void

# Inherited from

DatasetController.updateIndex

# Defined in

types/index.d.ts:604 (opens new window)

# updateRangeFromParsed

▸ Protected updateRangeFromParsed(range, scale, parsed, stack): void

# Parameters

Name Type
range Object
range.max number
range.min number
scale Scale<CoreScaleOptions>
parsed unknown[]
stack string | boolean

# Returns

void

# Inherited from

DatasetController.updateRangeFromParsed

# Defined in

types/index.d.ts:650 (opens new window)

# updateSharedOptions

▸ Protected updateSharedOptions(sharedOptions, mode, newOptions): void

Utility to animate the shared options, that are potentially affecting multiple elements.

# Parameters

Name Type
sharedOptions AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
newOptions AnyObject

# Returns

void

# Inherited from

DatasetController.updateSharedOptions

# Defined in

types/index.d.ts:640 (opens new window)

+ (opens new window)

# Interface: DoughnutController

# Hierarchy

# Properties

# _cachedMeta

• Readonly _cachedMeta: ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DatasetController._cachedMeta

# Defined in

types/index.d.ts:592 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

DatasetController.chart

# Defined in

types/index.d.ts:590 (opens new window)

# enableOptionSharing

• enableOptionSharing: boolean

# Inherited from

DatasetController.enableOptionSharing

# Defined in

types/index.d.ts:593 (opens new window)

# index

• Readonly index: number

# Inherited from

DatasetController.index

# Defined in

types/index.d.ts:591 (opens new window)

# innerRadius

• Readonly innerRadius: number

# Defined in

types/index.d.ts:341 (opens new window)

# offsetX

• Readonly offsetX: number

# Defined in

types/index.d.ts:343 (opens new window)

# offsetY

• Readonly offsetY: number

# Defined in

types/index.d.ts:344 (opens new window)

# outerRadius

• Readonly outerRadius: number

# Defined in

types/index.d.ts:342 (opens new window)

# supportsDecimation

• supportsDecimation: boolean

# Inherited from

DatasetController.supportsDecimation

# Defined in

types/index.d.ts:597 (opens new window)

# Methods

# addElements

▸ addElements(): void

# Returns

void

# Inherited from

DatasetController.addElements

# Defined in

types/index.d.ts:613 (opens new window)

# applyStack

▸ Protected applyStack(scale, parsed): number

# Parameters

Name Type
scale Scale<CoreScaleOptions>
parsed unknown[]

# Returns

number

# Inherited from

DatasetController.applyStack

# Defined in

types/index.d.ts:649 (opens new window)

# buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

# Parameters

Name Type
resetNewElements? boolean

# Returns

void

# Inherited from

DatasetController.buildOrUpdateElements

# Defined in

types/index.d.ts:614 (opens new window)

# calculateCircumference

▸ calculateCircumference(value): number

# Parameters

Name Type
value number

# Returns

number

# Defined in

types/index.d.ts:347 (opens new window)

# calculateTotal

▸ calculateTotal(): number

# Returns

number

# Defined in

types/index.d.ts:346 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

DatasetController.configure

# Defined in

types/index.d.ts:611 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Inherited from

DatasetController.draw

# Defined in

types/index.d.ts:606 (opens new window)

# getAllParsedValues

▸ getAllParsedValues(scale): number[]

# Parameters

Name Type
scale Scale<CoreScaleOptions>

# Returns

number[]

# Inherited from

DatasetController.getAllParsedValues

# Defined in

types/index.d.ts:600 (opens new window)

# getDataset

▸ getDataset(): ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Returns

ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Inherited from

DatasetController.getDataset

# Defined in

types/index.d.ts:608 (opens new window)

# getLabelAndValue

▸ Protected getLabelAndValue(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
label string
value string

# Inherited from

DatasetController.getLabelAndValue

# Defined in

types/index.d.ts:601 (opens new window)

# getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

# Returns

number | boolean

# Inherited from

DatasetController.getMaxOverflow

# Defined in

types/index.d.ts:605 (opens new window)

# getMeta

▸ getMeta(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DatasetController.getMeta

# Defined in

types/index.d.ts:609 (opens new window)

# getMinMax

▸ Protected getMinMax(scale, canStack?): Object

# Parameters

Name Type
scale Scale<CoreScaleOptions>
canStack? boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

DatasetController.getMinMax

# Defined in

types/index.d.ts:656 (opens new window)

# getParsed

▸ Protected getParsed(index): number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Parameters

Name Type
index number

# Returns

number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Inherited from

DatasetController.getParsed

# Defined in

types/index.d.ts:648 (opens new window)

# getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

# Parameters

Name Type
scaleID string

# Returns

Scale<CoreScaleOptions>

# Inherited from

DatasetController.getScaleForId

# Defined in

types/index.d.ts:610 (opens new window)

# getSharedOptions

▸ Protected getSharedOptions(options): AnyObject

Utility for checking if the options are shared and should be animated separately.

# Parameters

Name Type
options AnyObject

# Returns

AnyObject

# Inherited from

DatasetController.getSharedOptions

# Defined in

types/index.d.ts:623 (opens new window)

# getStyle

▸ getStyle(index, active): AnyObject

# Parameters

Name Type
index number
active boolean

# Returns

AnyObject

# Inherited from

DatasetController.getStyle

# Defined in

types/index.d.ts:616 (opens new window)

# includeOptions

▸ Protected includeOptions(mode, sharedOptions): boolean

Utility for determining if options should be included in the updated properties

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
sharedOptions AnyObject

# Returns

boolean

# Inherited from

DatasetController.includeOptions

# Defined in

types/index.d.ts:628 (opens new window)

# initialize

▸ initialize(): void

# Returns

void

# Inherited from

DatasetController.initialize

# Defined in

types/index.d.ts:612 (opens new window)

# linkScales

▸ linkScales(): void

# Returns

void

# Inherited from

DatasetController.linkScales

# Defined in

types/index.d.ts:599 (opens new window)

# parse

▸ parse(start, count): void

# Parameters

Name Type
start number
count number

# Returns

void

# Inherited from

DatasetController.parse

# Defined in

types/index.d.ts:644 (opens new window)

# parseArrayData

▸ Protected parseArrayData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parseArrayData

# Defined in

types/index.d.ts:646 (opens new window)

# parseObjectData

▸ Protected parseObjectData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parseObjectData

# Defined in

types/index.d.ts:647 (opens new window)

# parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DatasetController.parsePrimitiveData

# Defined in

types/index.d.ts:645 (opens new window)

# removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DatasetController.removeHoverStyle

# Defined in

types/index.d.ts:641 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Inherited from

DatasetController.reset

# Defined in

types/index.d.ts:607 (opens new window)

# resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): AnyObject

# Parameters

Name Type
index number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DatasetController.resolveDataElementOptions

# Defined in

types/index.d.ts:618 (opens new window)

# resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): AnyObject

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DatasetController.resolveDatasetElementOptions

# Defined in

types/index.d.ts:617 (opens new window)

# setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DatasetController.setHoverStyle

# Defined in

types/index.d.ts:642 (opens new window)

# update

▸ update(mode): void

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.update

# Defined in

types/index.d.ts:603 (opens new window)

# updateElement

▸ Protected updateElement(element, index, properties, mode): void

Utility for updating an element with new properties, using animations when appropriate.

# Parameters

Name Type
element default<AnyObject, AnyObject>
index number
properties AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.updateElement

# Defined in

types/index.d.ts:634 (opens new window)

# updateElements

▸ updateElements(elements, start, count, mode): void

# Parameters

Name Type
elements default<AnyObject, AnyObject>[]
start number
count number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DatasetController.updateElements

# Defined in

types/index.d.ts:602 (opens new window)

# updateIndex

▸ updateIndex(datasetIndex): void

# Parameters

Name Type
datasetIndex number

# Returns

void

# Inherited from

DatasetController.updateIndex

# Defined in

types/index.d.ts:604 (opens new window)

# updateRangeFromParsed

▸ Protected updateRangeFromParsed(range, scale, parsed, stack): void

# Parameters

Name Type
range Object
range.max number
range.min number
scale Scale<CoreScaleOptions>
parsed unknown[]
stack string | boolean

# Returns

void

# Inherited from

DatasetController.updateRangeFromParsed

# Defined in

types/index.d.ts:650 (opens new window)

# updateSharedOptions

▸ Protected updateSharedOptions(sharedOptions, mode, newOptions): void

Utility to animate the shared options, that are potentially affecting multiple elements.

# Parameters

Name Type
sharedOptions AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
newOptions AnyObject

# Returns

void

# Inherited from

DatasetController.updateSharedOptions

# Defined in

types/index.d.ts:640 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/DoughnutControllerChartOptions.html b/docs/master/api/interfaces/DoughnutControllerChartOptions.html index c73770daee..cf1227bc1c 100644 --- a/docs/master/api/interfaces/DoughnutControllerChartOptions.html +++ b/docs/master/api/interfaces/DoughnutControllerChartOptions.html @@ -7,7 +7,7 @@ - + @@ -39,8 +39,8 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: DoughnutControllerChartOptions

# Properties

# animation

• animation: false | DoughnutAnimationOptions

# Defined in

types/index.d.ts:335 (opens new window)

# circumference

• circumference: number

Sweep to allow arcs to cover.

Default

360

# Defined in

types/index.d.ts:303 (opens new window)

# cutout

• cutout: Scriptable<string | number, ScriptableContext<"doughnut">>

The portion of the chart that is cut out of the middle. ('50%' - for doughnut, 0 - for pie) -String ending with '%' means percentage, number means pixels.

Default

50

# Defined in

types/index.d.ts:310 (opens new window)

# offset

• offset: number | number[]

Arc offset (in pixels).

# Defined in

types/index.d.ts:315 (opens new window)

# radius

• radius: Scriptable<string | number, ScriptableContext<"doughnut">>

The outer radius of the chart. String ending with '%' means percentage of maximum radius, number means pixels.

Default

'100%'

# Defined in

types/index.d.ts:321 (opens new window)

# rotation

• rotation: number

Starting angle to draw arcs from.

Default

0

# Defined in

types/index.d.ts:327 (opens new window)

# spacing

• spacing: number

Spacing between the arcs

Default

0

# Defined in

types/index.d.ts:333 (opens new window)

+ (opens new window)

# Interface: DoughnutControllerChartOptions

# Properties

# animation

• animation: false | DoughnutAnimationOptions

# Defined in

types/index.d.ts:335 (opens new window)

# circumference

• circumference: number

Sweep to allow arcs to cover.

Default

360

# Defined in

types/index.d.ts:303 (opens new window)

# cutout

• cutout: Scriptable<string | number, ScriptableContext<"doughnut">>

The portion of the chart that is cut out of the middle. ('50%' - for doughnut, 0 - for pie) +String ending with '%' means percentage, number means pixels.

Default

50

# Defined in

types/index.d.ts:310 (opens new window)

# offset

• offset: number | number[]

Arc offset (in pixels).

# Defined in

types/index.d.ts:315 (opens new window)

# radius

• radius: Scriptable<string | number, ScriptableContext<"doughnut">>

The outer radius of the chart. String ending with '%' means percentage of maximum radius, number means pixels.

Default

'100%'

# Defined in

types/index.d.ts:321 (opens new window)

# rotation

• rotation: number

Starting angle to draw arcs from.

Default

0

# Defined in

types/index.d.ts:327 (opens new window)

# spacing

• spacing: number

Spacing between the arcs

Default

0

# Defined in

types/index.d.ts:333 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/DoughnutControllerDatasetOptions.html b/docs/master/api/interfaces/DoughnutControllerDatasetOptions.html index 13c51aecad..771ca25879 100644 --- a/docs/master/api/interfaces/DoughnutControllerDatasetOptions.html +++ b/docs/master/api/interfaces/DoughnutControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,8 +39,8 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: DoughnutControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"doughnut"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"doughnut">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderAlign

• borderAlign: ScriptableAndArray<"center" | "inner", ScriptableContext<"doughnut">>

Arc stroke alignment.

# Inherited from

ScriptableAndArrayOptions.borderAlign

# Defined in

types/index.d.ts:1833 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

Line dash. See MDN.

Default

[]

# Inherited from

ScriptableAndArrayOptions.borderDash

# Defined in

types/index.d.ts:1838 (opens new window)

# borderDashOffset

• borderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

ScriptableAndArrayOptions.borderDashOffset

# Defined in

types/index.d.ts:1843 (opens new window)

# borderJoinStyle

• borderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"doughnut">>

Line join style. See MDN. Default is 'round' when borderAlign is 'inner', else 'bevel'.

# Inherited from

ScriptableAndArrayOptions.borderJoinStyle

# Defined in

types/index.d.ts:1847 (opens new window)

# borderRadius

• borderRadius: ScriptableAndArray<number | ArcBorderRadius, ScriptableContext<"doughnut">>

Sets the border radius for arcs

Default

0

# Inherited from

ScriptableAndArrayOptions.borderRadius

# Defined in

types/index.d.ts:1853 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# circular

• circular: ScriptableAndArray<boolean, ScriptableContext<"doughnut">>

If false, Arc will be flat.

Default

true

# Inherited from

ScriptableAndArrayOptions.circular

# Defined in

types/index.d.ts:1864 (opens new window)

# circumference

• circumference: number

Sweep to allow arcs to cover.

Default

360

# Defined in

types/index.d.ts:257 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDash

# Defined in

types/index.d.ts:1873 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1874 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverOffset

• hoverOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverOffset

# Defined in

types/index.d.ts:1875 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# offset

• offset: number | number[]

Arc offset (in pixels).

# Overrides

ScriptableAndArrayOptions.offset

# Defined in

types/index.d.ts:262 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# rotation

• rotation: number

Starting angle to draw this dataset from.

Default

0

# Defined in

types/index.d.ts:268 (opens new window)

# spacing

• spacing: number

Similar to the offset option, but applies to all arcs. This can be used to to add spaces -between arcs

Default

0

# Overrides

ScriptableAndArrayOptions.spacing

# Defined in

types/index.d.ts:281 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# transitions

• transitions: TransitionsSpec<"doughnut">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# weight

• weight: number

The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.

Default

1

# Defined in

types/index.d.ts:274 (opens new window)

+ (opens new window)

# Interface: DoughnutControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"doughnut"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"doughnut">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderAlign

• borderAlign: ScriptableAndArray<"center" | "inner", ScriptableContext<"doughnut">>

Arc stroke alignment.

# Inherited from

ScriptableAndArrayOptions.borderAlign

# Defined in

types/index.d.ts:1833 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

Line dash. See MDN.

Default

[]

# Inherited from

ScriptableAndArrayOptions.borderDash

# Defined in

types/index.d.ts:1838 (opens new window)

# borderDashOffset

• borderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

ScriptableAndArrayOptions.borderDashOffset

# Defined in

types/index.d.ts:1843 (opens new window)

# borderJoinStyle

• borderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"doughnut">>

Line join style. See MDN. Default is 'round' when borderAlign is 'inner', else 'bevel'.

# Inherited from

ScriptableAndArrayOptions.borderJoinStyle

# Defined in

types/index.d.ts:1847 (opens new window)

# borderRadius

• borderRadius: ScriptableAndArray<number | ArcBorderRadius, ScriptableContext<"doughnut">>

Sets the border radius for arcs

Default

0

# Inherited from

ScriptableAndArrayOptions.borderRadius

# Defined in

types/index.d.ts:1853 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# circular

• circular: ScriptableAndArray<boolean, ScriptableContext<"doughnut">>

If false, Arc will be flat.

Default

true

# Inherited from

ScriptableAndArrayOptions.circular

# Defined in

types/index.d.ts:1864 (opens new window)

# circumference

• circumference: number

Sweep to allow arcs to cover.

Default

360

# Defined in

types/index.d.ts:257 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDash

# Defined in

types/index.d.ts:1873 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1874 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverOffset

• hoverOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

ScriptableAndArrayOptions.hoverOffset

# Defined in

types/index.d.ts:1875 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# offset

• offset: number | number[]

Arc offset (in pixels).

# Overrides

ScriptableAndArrayOptions.offset

# Defined in

types/index.d.ts:262 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# rotation

• rotation: number

Starting angle to draw this dataset from.

Default

0

# Defined in

types/index.d.ts:268 (opens new window)

# spacing

• spacing: number

Similar to the offset option, but applies to all arcs. This can be used to to add spaces +between arcs

Default

0

# Overrides

ScriptableAndArrayOptions.spacing

# Defined in

types/index.d.ts:281 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# transitions

• transitions: TransitionsSpec<"doughnut">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# weight

• weight: number

The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.

Default

1

# Defined in

types/index.d.ts:274 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/DoughnutMetaExtensions.html b/docs/master/api/interfaces/DoughnutMetaExtensions.html index 25026cc0b1..9565daecdd 100644 --- a/docs/master/api/interfaces/DoughnutMetaExtensions.html +++ b/docs/master/api/interfaces/DoughnutMetaExtensions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: DoughnutMetaExtensions

# Properties

# total

• total: number

# Defined in

types/index.d.ts:356 (opens new window)

+ (opens new window)

# Interface: DoughnutMetaExtensions

# Properties

# total

• total: number

# Defined in

types/index.d.ts:356 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ElementOptionsByType.html b/docs/master/api/interfaces/ElementOptionsByType.html index 4076f91b19..dbb7df46dd 100644 --- a/docs/master/api/interfaces/ElementOptionsByType.html +++ b/docs/master/api/interfaces/ElementOptionsByType.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ElementOptionsByType<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# arc

• arc: ScriptableAndArrayOptions<ArcOptions & ArcHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2130 (opens new window)

# bar

• bar: ScriptableAndArrayOptions<BarOptions & BarHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2131 (opens new window)

# line

• line: ScriptableAndArrayOptions<LineOptions & LineHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2132 (opens new window)

# point

• point: ScriptableAndArrayOptions<PointOptions & PointHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2133 (opens new window)

+ (opens new window)

# Interface: ElementOptionsByType<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# arc

• arc: ScriptableAndArrayOptions<ArcOptions & ArcHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2130 (opens new window)

# bar

• bar: ScriptableAndArrayOptions<BarOptions & BarHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2131 (opens new window)

# line

• line: ScriptableAndArrayOptions<LineOptions & LineHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2132 (opens new window)

# point

• point: ScriptableAndArrayOptions<PointOptions & PointHoverOptions, ScriptableContext<TType>>

# Defined in

types/index.d.ts:2133 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ExtendedPlugin.html b/docs/master/api/interfaces/ExtendedPlugin.html index c52bb8aab0..d9fb8d794b 100644 --- a/docs/master/api/interfaces/ExtendedPlugin.html +++ b/docs/master/api/interfaces/ExtendedPlugin.html @@ -7,7 +7,7 @@ - + @@ -40,8 +40,8 @@ (opens new window) GitHub (opens new window)

# Interface: ExtendedPlugin<TType, O, Model>

# Type parameters

Name Type
TType extends ChartType
O AnyObject
Model TooltipModel<TType>

# Hierarchy

# Methods

# afterTooltipDraw

▸ Optional afterTooltipDraw(chart, args, options): void

Desc

Called after drawing the tooltip. Note that this hook will not -be called if the tooltip drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.tooltip Model The tooltip.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:2705 (opens new window)

# beforeTooltipDraw

▸ Optional beforeTooltipDraw(chart, args, options): boolean | void

Desc

Called before drawing the tooltip. If any plugin returns false, -the tooltip drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.tooltip Model The tooltip.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart tooltip drawing.

# Defined in

types/index.d.ts:2696 (opens new window)

+be called if the tooltip drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.tooltip Model The tooltip.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:2705 (opens new window)

# beforeTooltipDraw

▸ Optional beforeTooltipDraw(chart, args, options): boolean | void

Desc

Called before drawing the tooltip. If any plugin returns false, +the tooltip drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.tooltip Model The tooltip.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart tooltip drawing.

# Defined in

types/index.d.ts:2696 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/FillerControllerDatasetOptions.html b/docs/master/api/interfaces/FillerControllerDatasetOptions.html index 3004d04345..7afca6f5c9 100644 --- a/docs/master/api/interfaces/FillerControllerDatasetOptions.html +++ b/docs/master/api/interfaces/FillerControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: FillerControllerDatasetOptions

# Properties

# fill

• fill: FillTarget | ComplexFillTarget

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Defined in

types/index.d.ts:2249 (opens new window)

+ (opens new window)

# Interface: FillerControllerDatasetOptions

# Properties

# fill

• fill: FillTarget | ComplexFillTarget

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Defined in

types/index.d.ts:2249 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/FillerOptions.html b/docs/master/api/interfaces/FillerOptions.html index 9dd0d957d1..c3091d330b 100644 --- a/docs/master/api/interfaces/FillerOptions.html +++ b/docs/master/api/interfaces/FillerOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: FillerOptions

# Properties

# drawTime

• drawTime: "beforeDraw" | "beforeDatasetsDraw" | "beforeDatasetDraw"

# Defined in

types/index.d.ts:2224 (opens new window)

# propagate

• propagate: boolean

# Defined in

types/index.d.ts:2225 (opens new window)

+ (opens new window)

# Interface: FillerOptions

# Properties

# drawTime

• drawTime: "beforeDraw" | "beforeDatasetsDraw" | "beforeDatasetDraw"

# Defined in

types/index.d.ts:2224 (opens new window)

# propagate

• propagate: boolean

# Defined in

types/index.d.ts:2225 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/FontSpec.html b/docs/master/api/interfaces/FontSpec.html index cabe4d0765..bcfe09bb41 100644 --- a/docs/master/api/interfaces/FontSpec.html +++ b/docs/master/api/interfaces/FontSpec.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: FontSpec

# Hierarchy

# Properties

# family

• family: string

Default font family for all text, follows CSS font-family options.

Default

"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

# Defined in

types/index.d.ts:1766 (opens new window)

# lineHeight

• lineHeight: string | number

Height of an individual line of text (see MDN).

Default

1.2

# Defined in

types/index.d.ts:1785 (opens new window)

# size

• size: number

Default font size (in px) for text. Does not apply to radialLinear scale point labels.

Default

12

# Defined in

types/index.d.ts:1771 (opens new window)

# style

• style: "normal" | "inherit" | "italic" | "oblique" | "initial"

Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit)

Default

'normal'

# Defined in

types/index.d.ts:1776 (opens new window)

# weight

• weight: number | "bold" | "normal" | "lighter" | "bolder"

Default font weight (boldness). (see MDN).

# Defined in

types/index.d.ts:1780 (opens new window)

+ (opens new window)

# Interface: FontSpec

# Hierarchy

# Properties

# family

• family: string

Default font family for all text, follows CSS font-family options.

Default

"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif"

# Defined in

types/index.d.ts:1766 (opens new window)

# lineHeight

• lineHeight: string | number

Height of an individual line of text (see MDN).

Default

1.2

# Defined in

types/index.d.ts:1785 (opens new window)

# size

• size: number

Default font size (in px) for text. Does not apply to radialLinear scale point labels.

Default

12

# Defined in

types/index.d.ts:1771 (opens new window)

# style

• style: "normal" | "inherit" | "italic" | "oblique" | "initial"

Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit)

Default

'normal'

# Defined in

types/index.d.ts:1776 (opens new window)

# weight

• weight: number | "bold" | "normal" | "lighter" | "bolder"

Default font weight (boldness). (see MDN).

# Defined in

types/index.d.ts:1780 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/GridLineOptions.html b/docs/master/api/interfaces/GridLineOptions.html index b8eec122cf..0eadcad50e 100644 --- a/docs/master/api/interfaces/GridLineOptions.html +++ b/docs/master/api/interfaces/GridLineOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: GridLineOptions

# Properties

# circular

• circular: boolean

Default

false

# Defined in

types/index.d.ts:2979 (opens new window)

# color

• color: ScriptableAndArray<Color, ScriptableScaleContext>

Default

'rgba(0, 0, 0, 0.1)'

# Defined in

types/index.d.ts:2983 (opens new window)

# display

• display: boolean

Default

true

# Defined in

types/index.d.ts:2975 (opens new window)

# drawOnChartArea

• drawOnChartArea: boolean

Default

true

# Defined in

types/index.d.ts:2991 (opens new window)

# drawTicks

• drawTicks: boolean

Default

true

# Defined in

types/index.d.ts:2995 (opens new window)

# lineWidth

• lineWidth: ScriptableAndArray<number, ScriptableScaleContext>

Default

1

# Defined in

types/index.d.ts:2987 (opens new window)

# offset

• offset: boolean

Default

false

# Defined in

types/index.d.ts:3019 (opens new window)

# tickBorderDash

• tickBorderDash: Scriptable<number[], ScriptableScaleContext>

Default

[]

# Defined in

types/index.d.ts:2999 (opens new window)

# tickBorderDashOffset

• tickBorderDashOffset: Scriptable<number, ScriptableScaleContext>

Default

0

# Defined in

types/index.d.ts:3003 (opens new window)

# tickColor

• tickColor: ScriptableAndArray<Color, ScriptableScaleContext>

Default

'rgba(0, 0, 0, 0.1)'

# Defined in

types/index.d.ts:3007 (opens new window)

# tickLength

• tickLength: number

Default

10

# Defined in

types/index.d.ts:3011 (opens new window)

# tickWidth

• tickWidth: number

Default

1

# Defined in

types/index.d.ts:3015 (opens new window)

# z

• z: number

Default

0

# Defined in

types/index.d.ts:3023 (opens new window)

+ (opens new window)

# Interface: GridLineOptions

# Properties

# circular

• circular: boolean

Default

false

# Defined in

types/index.d.ts:2979 (opens new window)

# color

• color: ScriptableAndArray<Color, ScriptableScaleContext>

Default

'rgba(0, 0, 0, 0.1)'

# Defined in

types/index.d.ts:2983 (opens new window)

# display

• display: boolean

Default

true

# Defined in

types/index.d.ts:2975 (opens new window)

# drawOnChartArea

• drawOnChartArea: boolean

Default

true

# Defined in

types/index.d.ts:2991 (opens new window)

# drawTicks

• drawTicks: boolean

Default

true

# Defined in

types/index.d.ts:2995 (opens new window)

# lineWidth

• lineWidth: ScriptableAndArray<number, ScriptableScaleContext>

Default

1

# Defined in

types/index.d.ts:2987 (opens new window)

# offset

• offset: boolean

Default

false

# Defined in

types/index.d.ts:3019 (opens new window)

# tickBorderDash

• tickBorderDash: Scriptable<number[], ScriptableScaleContext>

Default

[]

# Defined in

types/index.d.ts:2999 (opens new window)

# tickBorderDashOffset

• tickBorderDashOffset: Scriptable<number, ScriptableScaleContext>

Default

0

# Defined in

types/index.d.ts:3003 (opens new window)

# tickColor

• tickColor: ScriptableAndArray<Color, ScriptableScaleContext>

Default

'rgba(0, 0, 0, 0.1)'

# Defined in

types/index.d.ts:3007 (opens new window)

# tickLength

• tickLength: number

Default

10

# Defined in

types/index.d.ts:3011 (opens new window)

# tickWidth

• tickWidth: number

Default

1

# Defined in

types/index.d.ts:3015 (opens new window)

# z

• z: number

Default

0

# Defined in

types/index.d.ts:3023 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/InteractionItem.html b/docs/master/api/interfaces/InteractionItem.html index ee64482afd..29572a11a4 100644 --- a/docs/master/api/interfaces/InteractionItem.html +++ b/docs/master/api/interfaces/InteractionItem.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: InteractionItem

# Properties

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:719 (opens new window)

# element

• element: default<AnyObject, AnyObject>

# Defined in

types/index.d.ts:718 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:720 (opens new window)

+ (opens new window)

# Interface: InteractionItem

# Properties

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:719 (opens new window)

# element

• element: default<AnyObject, AnyObject>

# Defined in

types/index.d.ts:718 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:720 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/InteractionModeMap.html b/docs/master/api/interfaces/InteractionModeMap.html index 81cfaa3ad4..bc9293af57 100644 --- a/docs/master/api/interfaces/InteractionModeMap.html +++ b/docs/master/api/interfaces/InteractionModeMap.html @@ -7,7 +7,7 @@ - + @@ -40,9 +40,9 @@ (opens new window) GitHub (opens new window)

# Interface: InteractionModeMap

# Properties

# dataset

• dataset: InteractionModeFunction

Returns items in the same dataset. If the options.intersect parameter is true, we only return items if we intersect something -If the options.intersect is false, we find the nearest item and return the items in that dataset

# Defined in

types/index.d.ts:741 (opens new window)

# index

• index: InteractionModeFunction

Returns items at the same index. If the options.intersect parameter is true, we only return items if we intersect something -If the options.intersect mode is false, we find the nearest item and return the items at the same index as that item

# Defined in

types/index.d.ts:735 (opens new window)

# nearest

• nearest: InteractionModeFunction

nearest mode returns the element closest to the point

# Defined in

types/index.d.ts:750 (opens new window)

# point

• point: InteractionModeFunction

Point mode returns all elements that hit test based on the event position -of the event

# Defined in

types/index.d.ts:746 (opens new window)

# x

• x: InteractionModeFunction

x mode returns the elements that hit-test at the current x coordinate

# Defined in

types/index.d.ts:754 (opens new window)

# y

• y: InteractionModeFunction

y mode returns the elements that hit-test at the current y coordinate

# Defined in

types/index.d.ts:758 (opens new window)

+If the options.intersect is false, we find the nearest item and return the items in that dataset

# Defined in

types/index.d.ts:741 (opens new window)

# index

• index: InteractionModeFunction

Returns items at the same index. If the options.intersect parameter is true, we only return items if we intersect something +If the options.intersect mode is false, we find the nearest item and return the items at the same index as that item

# Defined in

types/index.d.ts:735 (opens new window)

# nearest

• nearest: InteractionModeFunction

nearest mode returns the element closest to the point

# Defined in

types/index.d.ts:750 (opens new window)

# point

• point: InteractionModeFunction

Point mode returns all elements that hit test based on the event position +of the event

# Defined in

types/index.d.ts:746 (opens new window)

# x

• x: InteractionModeFunction

x mode returns the elements that hit-test at the current x coordinate

# Defined in

types/index.d.ts:754 (opens new window)

# y

• y: InteractionModeFunction

y mode returns the elements that hit-test at the current y coordinate

# Defined in

types/index.d.ts:758 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/InteractionOptions.html b/docs/master/api/interfaces/InteractionOptions.html index 0ebc6bba8c..8bf1554297 100644 --- a/docs/master/api/interfaces/InteractionOptions.html +++ b/docs/master/api/interfaces/InteractionOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: InteractionOptions

# Properties

# axis

• Optional axis: string

# Defined in

types/index.d.ts:712 (opens new window)

# includeInvisible

• Optional includeInvisible: boolean

# Defined in

types/index.d.ts:714 (opens new window)

# intersect

• Optional intersect: boolean

# Defined in

types/index.d.ts:713 (opens new window)

+ (opens new window)

# Interface: InteractionOptions

# Properties

# axis

• Optional axis: string

# Defined in

types/index.d.ts:712 (opens new window)

# includeInvisible

• Optional includeInvisible: boolean

# Defined in

types/index.d.ts:714 (opens new window)

# intersect

• Optional intersect: boolean

# Defined in

types/index.d.ts:713 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LabelItem.html b/docs/master/api/interfaces/LabelItem.html index da1d935588..6a7712b0f5 100644 --- a/docs/master/api/interfaces/LabelItem.html +++ b/docs/master/api/interfaces/LabelItem.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LabelItem

# Properties

# font

• font: CanvasFontSpec

# Defined in

types/index.d.ts:1491 (opens new window)

# label

• label: string | string[]

# Defined in

types/index.d.ts:1490 (opens new window)

# options

• options: RenderTextOpts

# Defined in

types/index.d.ts:1493 (opens new window)

# textOffset

• textOffset: number

# Defined in

types/index.d.ts:1492 (opens new window)

+ (opens new window)

# Interface: LabelItem

# Properties

# font

• font: CanvasFontSpec

# Defined in

types/index.d.ts:1491 (opens new window)

# label

• label: string | string[]

# Defined in

types/index.d.ts:1490 (opens new window)

# options

• options: RenderTextOpts

# Defined in

types/index.d.ts:1493 (opens new window)

# textOffset

• textOffset: number

# Defined in

types/index.d.ts:1492 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LayoutItem.html b/docs/master/api/interfaces/LayoutItem.html index c60e0de494..5272512a91 100644 --- a/docs/master/api/interfaces/LayoutItem.html +++ b/docs/master/api/interfaces/LayoutItem.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LayoutItem

# Hierarchy

# Properties

# bottom

• bottom: number

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

# Defined in

types/layout.d.ts:41 (opens new window)

# fullSize

• fullSize: boolean

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

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Defined in

types/layout.d.ts:25 (opens new window)

# left

• left: number

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

# Defined in

types/layout.d.ts:29 (opens new window)

# position

• position: LayoutPosition

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

# Defined in

types/layout.d.ts:9 (opens new window)

• right: number

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

# Defined in

types/layout.d.ts:37 (opens new window)

# top

• top: number

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

# Defined in

types/layout.d.ts:33 (opens new window)

# weight

• weight: number

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

# Defined in

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Defined in

types/layout.d.ts:21 (opens new window)

# Methods

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Defined in

types/layout.d.ts:46 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/layout.d.ts:50 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Defined in

types/layout.d.ts:54 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Defined in

types/layout.d.ts:58 (opens new window)

# update

▸ update(width, height, margins?): void

Takes two parameters: width and height.

# Parameters

Name Type
width number
height number
margins? ChartArea

# Returns

void

# Defined in

types/layout.d.ts:64 (opens new window)

+ (opens new window)

# Interface: LayoutItem

# Hierarchy

# Properties

# bottom

• bottom: number

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

# Defined in

types/layout.d.ts:41 (opens new window)

# fullSize

• fullSize: boolean

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

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Defined in

types/layout.d.ts:25 (opens new window)

# left

• left: number

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

# Defined in

types/layout.d.ts:29 (opens new window)

# position

• position: LayoutPosition

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

# Defined in

types/layout.d.ts:9 (opens new window)

• right: number

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

# Defined in

types/layout.d.ts:37 (opens new window)

# top

• top: number

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

# Defined in

types/layout.d.ts:33 (opens new window)

# weight

• weight: number

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

# Defined in

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Defined in

types/layout.d.ts:21 (opens new window)

# Methods

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Defined in

types/layout.d.ts:46 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Defined in

types/layout.d.ts:50 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Defined in

types/layout.d.ts:54 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Defined in

types/layout.d.ts:58 (opens new window)

# update

▸ update(width, height, margins?): void

Takes two parameters: width and height.

# Parameters

Name Type
width number
height number
margins? ChartArea

# Returns

void

# Defined in

types/layout.d.ts:64 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LegendElement.html b/docs/master/api/interfaces/LegendElement.html index 4346c3e2db..ec5dda8a81 100644 --- a/docs/master/api/interfaces/LegendElement.html +++ b/docs/master/api/interfaces/LegendElement.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LegendElement<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# $animations

• $animations: Record<string, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (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

types/layout.d.ts:41 (opens new window)

# chart

• chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>

# Defined in

types/index.d.ts:2343 (opens new window)

# ctx

• ctx: CanvasRenderingContext2D

# Defined in

types/index.d.ts:2344 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

LayoutItem.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

LayoutItem.height

# Defined in

types/layout.d.ts:25 (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

types/layout.d.ts:29 (opens new window)

# legendItems

• Optional legendItems: LegendItem[]

# Defined in

types/index.d.ts:2345 (opens new window)

# options

• options: LegendOptions<TType>

# Overrides

Element.options

# Defined in

types/index.d.ts:2346 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

LayoutItem.position

# Defined in

types/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

LayoutItem.right

# Defined in

types/layout.d.ts:37 (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

types/layout.d.ts:33 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

LayoutItem.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

LayoutItem.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

LayoutItem.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

LayoutItem.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<AnyObject, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends string[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<AnyObject, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

LayoutItem.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

LayoutItem.update

# Defined in

types/layout.d.ts:64 (opens new window)

+ (opens new window)

# Interface: LegendElement<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# $animations

• $animations: Record<string, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (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

types/layout.d.ts:41 (opens new window)

# chart

• chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>

# Defined in

types/index.d.ts:2343 (opens new window)

# ctx

• ctx: CanvasRenderingContext2D

# Defined in

types/index.d.ts:2344 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

LayoutItem.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

LayoutItem.height

# Defined in

types/layout.d.ts:25 (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

types/layout.d.ts:29 (opens new window)

# legendItems

• Optional legendItems: LegendItem[]

# Defined in

types/index.d.ts:2345 (opens new window)

# options

• options: LegendOptions<TType>

# Overrides

Element.options

# Defined in

types/index.d.ts:2346 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

LayoutItem.position

# Defined in

types/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

LayoutItem.right

# Defined in

types/layout.d.ts:37 (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

types/layout.d.ts:33 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

LayoutItem.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

LayoutItem.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

LayoutItem.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

LayoutItem.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<AnyObject, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends string[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<AnyObject, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

LayoutItem.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

LayoutItem.update

# Defined in

types/layout.d.ts:64 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LegendItem.html b/docs/master/api/interfaces/LegendItem.html index b2333767be..fe0a186a5b 100644 --- a/docs/master/api/interfaces/LegendItem.html +++ b/docs/master/api/interfaces/LegendItem.html @@ -7,7 +7,7 @@ - + @@ -39,8 +39,8 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LegendItem

# Properties

# borderRadius

• Optional borderRadius: number | BorderRadius

Border radius of the legend box

Since

3.1.0

# Defined in

types/index.d.ts:2264 (opens new window)

# datasetIndex

• Optional datasetIndex: number

Index of the associated dataset

# Defined in

types/index.d.ts:2269 (opens new window)

# fillStyle

• Optional fillStyle: Color

Fill style of the legend box

# Defined in

types/index.d.ts:2279 (opens new window)

# fontColor

• Optional fontColor: Color

Font color for the text -Defaults to LegendOptions.labels.color

# Defined in

types/index.d.ts:2285 (opens new window)

# hidden

• Optional hidden: boolean

If true, this item represents a hidden dataset. Label will be rendered with a strike-through effect

# Defined in

types/index.d.ts:2290 (opens new window)

# index

• Optional index: number

Index the associated label in the labels array

# Defined in

types/index.d.ts:2274 (opens new window)

# lineCap

• Optional lineCap: CanvasLineCap

For box border.

See

https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap

# Defined in

types/index.d.ts:2296 (opens new window)

# lineDash

• Optional lineDash: number[]

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash

# Defined in

types/index.d.ts:2302 (opens new window)

# lineDashOffset

• Optional lineDashOffset: number

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset

# Defined in

types/index.d.ts:2308 (opens new window)

# lineJoin

• Optional lineJoin: CanvasLineJoin

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin

# Defined in

types/index.d.ts:2314 (opens new window)

# lineWidth

• Optional lineWidth: number

Width of box border

# Defined in

types/index.d.ts:2319 (opens new window)

# pointStyle

• Optional pointStyle: PointStyle

Point style of the legend box (only used if usePointStyle is true)

# Defined in

types/index.d.ts:2329 (opens new window)

# rotation

• Optional rotation: number

Rotation of the point in degrees (only used if usePointStyle is true)

# Defined in

types/index.d.ts:2334 (opens new window)

# strokeStyle

• Optional strokeStyle: Color

Stroke style of the legend box

# Defined in

types/index.d.ts:2324 (opens new window)

# text

• text: string

Label that will be displayed

# Defined in

types/index.d.ts:2258 (opens new window)

# textAlign

• Optional textAlign: TextAlign

Text alignment

# Defined in

types/index.d.ts:2339 (opens new window)

+ (opens new window)

# Interface: LegendItem

# Properties

# borderRadius

• Optional borderRadius: number | BorderRadius

Border radius of the legend box

Since

3.1.0

# Defined in

types/index.d.ts:2264 (opens new window)

# datasetIndex

• Optional datasetIndex: number

Index of the associated dataset

# Defined in

types/index.d.ts:2269 (opens new window)

# fillStyle

• Optional fillStyle: Color

Fill style of the legend box

# Defined in

types/index.d.ts:2279 (opens new window)

# fontColor

• Optional fontColor: Color

Font color for the text +Defaults to LegendOptions.labels.color

# Defined in

types/index.d.ts:2285 (opens new window)

# hidden

• Optional hidden: boolean

If true, this item represents a hidden dataset. Label will be rendered with a strike-through effect

# Defined in

types/index.d.ts:2290 (opens new window)

# index

• Optional index: number

Index the associated label in the labels array

# Defined in

types/index.d.ts:2274 (opens new window)

# lineCap

• Optional lineCap: CanvasLineCap

For box border.

See

https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap

# Defined in

types/index.d.ts:2296 (opens new window)

# lineDash

• Optional lineDash: number[]

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash

# Defined in

types/index.d.ts:2302 (opens new window)

# lineDashOffset

• Optional lineDashOffset: number

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset

# Defined in

types/index.d.ts:2308 (opens new window)

# lineJoin

• Optional lineJoin: CanvasLineJoin

For box border.

See

https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin

# Defined in

types/index.d.ts:2314 (opens new window)

# lineWidth

• Optional lineWidth: number

Width of box border

# Defined in

types/index.d.ts:2319 (opens new window)

# pointStyle

• Optional pointStyle: PointStyle

Point style of the legend box (only used if usePointStyle is true)

# Defined in

types/index.d.ts:2329 (opens new window)

# rotation

• Optional rotation: number

Rotation of the point in degrees (only used if usePointStyle is true)

# Defined in

types/index.d.ts:2334 (opens new window)

# strokeStyle

• Optional strokeStyle: Color

Stroke style of the legend box

# Defined in

types/index.d.ts:2324 (opens new window)

# text

• text: string

Label that will be displayed

# Defined in

types/index.d.ts:2258 (opens new window)

# textAlign

• Optional textAlign: TextAlign

Text alignment

# Defined in

types/index.d.ts:2339 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LegendOptions.html b/docs/master/api/interfaces/LegendOptions.html index 11741f6ffc..3ef8764971 100644 --- a/docs/master/api/interfaces/LegendOptions.html +++ b/docs/master/api/interfaces/LegendOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LegendOptions<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# align

• align: Align

Alignment of the legend.

Default

'center'

# Defined in

types/index.d.ts:2364 (opens new window)

# display

• display: boolean

Is the legend shown?

Default

true

# Defined in

types/index.d.ts:2354 (opens new window)

# fullSize

• fullSize: boolean

Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.

Default

true

# Defined in

types/index.d.ts:2377 (opens new window)

# labels

• labels: Object

# Type declaration

Name Type Description
borderRadius number Override the borderRadius to use. Default undefined
boxHeight number Height of the coloured box. Default fontSize
boxPadding number Padding between the color box and the text Default 1
boxWidth number Width of colored box. Default 40
color Color Color of label See Defaults.color
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext> Font of label See Defaults.font
padding number Padding between rows of colored boxes. Default 10
pointStyle PointStyle Override point style for the legend. Only applies if usePointStyle is true
pointStyleWidth number If usePointStyle is true, the width of the point style used for the legend.
textAlign? TextAlign Text alignment
useBorderRadius boolean Label borderRadius will match corresponding borderRadius. Default false
usePointStyle boolean Label style will match corresponding point style (size is based on the minimum value between boxWidth and font.size). Default false
filter (item: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => boolean Filters legend items out of the legend. Receives 2 parameters, a Legend Item and the chart data
generateLabels (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => LegendItem[] Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See Legend Item for details.
sort (a: LegendItem, b: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => number Sorts the legend items

# Defined in

types/index.d.ts:2396 (opens new window)

# maxHeight

• maxHeight: number

Maximum height of the legend, in pixels

# Defined in

types/index.d.ts:2368 (opens new window)

# maxWidth

• maxWidth: number

Maximum width of the legend, in pixels

# Defined in

types/index.d.ts:2372 (opens new window)

# position

• position: LayoutPosition

Position of the legend.

Default

'top'

# Defined in

types/index.d.ts:2359 (opens new window)

# reverse

• reverse: boolean

Legend will show datasets in reverse order.

Default

false

# Defined in

types/index.d.ts:2382 (opens new window)

# rtl

• rtl: boolean

true for rendering the legends from right to left.

# Defined in

types/index.d.ts:2477 (opens new window)

# textDirection

• textDirection: string

This will force the text direction 'rtl' or 'ltr' on the canvas for rendering the legend, regardless of the css specified on the canvas

Default

canvas's default

# Defined in

types/index.d.ts:2482 (opens new window)

# title

• title: Object

# Type declaration

Name Type Description
color Color Color of title See Defaults.color
display boolean Is the legend title displayed. Default false
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext> see Fonts
padding? number | ChartArea -
position "center" | "end" | "start" -
text string The string title.

# Defined in

types/index.d.ts:2484 (opens new window)

# Methods

# onClick

▸ onClick(this, e, legendItem, legend): void

A callback that is called when a click event is registered on a label item.

# Parameters

Name Type
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# Returns

void

# Defined in

types/index.d.ts:2386 (opens new window)

# onHover

▸ onHover(this, e, legendItem, legend): void

A callback that is called when a 'mousemove' event is registered on top of a label item

# Parameters

Name Type
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# Returns

void

# Defined in

types/index.d.ts:2390 (opens new window)

# onLeave

▸ onLeave(this, e, legendItem, legend): void

A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item.

# Parameters

Name Type
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# Returns

void

# Defined in

types/index.d.ts:2394 (opens new window)

+ (opens new window)

# Interface: LegendOptions<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# align

• align: Align

Alignment of the legend.

Default

'center'

# Defined in

types/index.d.ts:2364 (opens new window)

# display

• display: boolean

Is the legend shown?

Default

true

# Defined in

types/index.d.ts:2354 (opens new window)

# fullSize

• fullSize: boolean

Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.

Default

true

# Defined in

types/index.d.ts:2377 (opens new window)

# labels

• labels: Object

# Type declaration

Name Type Description
borderRadius number Override the borderRadius to use. Default undefined
boxHeight number Height of the coloured box. Default fontSize
boxPadding number Padding between the color box and the text Default 1
boxWidth number Width of colored box. Default 40
color Color Color of label See Defaults.color
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext> Font of label See Defaults.font
padding number Padding between rows of colored boxes. Default 10
pointStyle PointStyle Override point style for the legend. Only applies if usePointStyle is true
pointStyleWidth number If usePointStyle is true, the width of the point style used for the legend.
textAlign? TextAlign Text alignment
useBorderRadius boolean Label borderRadius will match corresponding borderRadius. Default false
usePointStyle boolean Label style will match corresponding point style (size is based on the minimum value between boxWidth and font.size). Default false
filter (item: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => boolean Filters legend items out of the legend. Receives 2 parameters, a Legend Item and the chart data
generateLabels (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => LegendItem[] Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See Legend Item for details.
sort (a: LegendItem, b: LegendItem, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => number Sorts the legend items

# Defined in

types/index.d.ts:2396 (opens new window)

# maxHeight

• maxHeight: number

Maximum height of the legend, in pixels

# Defined in

types/index.d.ts:2368 (opens new window)

# maxWidth

• maxWidth: number

Maximum width of the legend, in pixels

# Defined in

types/index.d.ts:2372 (opens new window)

# position

• position: LayoutPosition

Position of the legend.

Default

'top'

# Defined in

types/index.d.ts:2359 (opens new window)

# reverse

• reverse: boolean

Legend will show datasets in reverse order.

Default

false

# Defined in

types/index.d.ts:2382 (opens new window)

# rtl

• rtl: boolean

true for rendering the legends from right to left.

# Defined in

types/index.d.ts:2477 (opens new window)

# textDirection

• textDirection: string

This will force the text direction 'rtl' or 'ltr' on the canvas for rendering the legend, regardless of the css specified on the canvas

Default

canvas's default

# Defined in

types/index.d.ts:2482 (opens new window)

# title

• title: Object

# Type declaration

Name Type Description
color Color Color of title See Defaults.color
display boolean Is the legend title displayed. Default false
font ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext> see Fonts
padding? number | ChartArea -
position "center" | "end" | "start" -
text string The string title.

# Defined in

types/index.d.ts:2484 (opens new window)

# Methods

# onClick

▸ onClick(this, e, legendItem, legend): void

A callback that is called when a click event is registered on a label item.

# Parameters

Name Type
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# Returns

void

# Defined in

types/index.d.ts:2386 (opens new window)

# onHover

▸ onHover(this, e, legendItem, legend): void

A callback that is called when a 'mousemove' event is registered on top of a label item

# Parameters

Name Type
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# Returns

void

# Defined in

types/index.d.ts:2390 (opens new window)

# onLeave

▸ onLeave(this, e, legendItem, legend): void

A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item.

# Parameters

Name Type
this LegendElement<TType>
e ChartEvent
legendItem LegendItem
legend LegendElement<TType>

# Returns

void

# Defined in

types/index.d.ts:2394 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LineControllerChartOptions.html b/docs/master/api/interfaces/LineControllerChartOptions.html index b656641d6b..01cdad5fc4 100644 --- a/docs/master/api/interfaces/LineControllerChartOptions.html +++ b/docs/master/api/interfaces/LineControllerChartOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LineControllerChartOptions

# Properties

# showLine

• showLine: boolean

If false, the lines between points are not drawn.

Default

true

# Defined in

types/index.d.ts:226 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

Default

false

# Defined in

types/index.d.ts:221 (opens new window)

+ (opens new window)

# Interface: LineControllerChartOptions

# Properties

# showLine

• showLine: boolean

If false, the lines between points are not drawn.

Default

true

# Defined in

types/index.d.ts:226 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

Default

false

# Defined in

types/index.d.ts:221 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LineControllerDatasetOptions.html b/docs/master/api/interfaces/LineControllerDatasetOptions.html index 97267acd32..2829aec983 100644 --- a/docs/master/api/interfaces/LineControllerDatasetOptions.html +++ b/docs/master/api/interfaces/LineControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LineControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"line"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"line">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderCapStyle

• borderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<"line">>

Line cap style. See MDN.

Default

'butt'

# Inherited from

ScriptableOptions.borderCapStyle

# Defined in

types/index.d.ts:1887 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: Scriptable<number[], ScriptableContext<"line">>

Line dash. See MDN.

Default

[]

# Inherited from

ScriptableOptions.borderDash

# Defined in

types/index.d.ts:1892 (opens new window)

# borderDashOffset

• borderDashOffset: Scriptable<number, ScriptableContext<"line">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

ScriptableOptions.borderDashOffset

# Defined in

types/index.d.ts:1897 (opens new window)

# borderJoinStyle

• borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<"line">>

Line join style. See MDN.

Default

'miter'

# Inherited from

ScriptableOptions.borderJoinStyle

# Defined in

types/index.d.ts:1902 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# capBezierPoints

• capBezierPoints: Scriptable<boolean, ScriptableContext<"line">>

true to keep Bézier control inside the chart, false for no restriction.

Default

true

# Inherited from

ScriptableOptions.capBezierPoints

# Defined in

types/index.d.ts:1907 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# cubicInterpolationMode

• cubicInterpolationMode: Scriptable<"default" | "monotone", ScriptableContext<"line">>

Interpolation mode to apply.

Default

'default'

# Inherited from

ScriptableOptions.cubicInterpolationMode

# Defined in

types/index.d.ts:1912 (opens new window)

# fill

• fill: Scriptable<FillTarget | ComplexFillTarget, ScriptableContext<"line">>

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Inherited from

ScriptableOptions.fill

# Defined in

types/index.d.ts:1926 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderCapStyle

• hoverBorderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderCapStyle

# Defined in

types/index.d.ts:1944 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: Scriptable<number[], ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderDash

# Defined in

types/index.d.ts:1945 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: Scriptable<number, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1946 (opens new window)

# hoverBorderJoinStyle

• hoverBorderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderJoinStyle

# Defined in

types/index.d.ts:1947 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointBackgroundColor

• pointBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

The fill color for points.

# Inherited from

ScriptableAndArrayOptions.pointBackgroundColor

# Defined in

types/index.d.ts:2023 (opens new window)

# pointBorderColor

• pointBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

The border color for points.

# Inherited from

ScriptableAndArrayOptions.pointBorderColor

# Defined in

types/index.d.ts:2027 (opens new window)

# pointBorderWidth

• pointBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

The width of the point border in pixels.

# Inherited from

ScriptableAndArrayOptions.pointBorderWidth

# Defined in

types/index.d.ts:2031 (opens new window)

# pointHitRadius

• pointHitRadius: ScriptableAndArray<number, ScriptableContext<"line">>

The pixel size of the non-displayed point that reacts to mouse events.

# Inherited from

ScriptableAndArrayOptions.pointHitRadius

# Defined in

types/index.d.ts:2035 (opens new window)

# pointHoverBackgroundColor

• pointHoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

Point background color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBackgroundColor

# Defined in

types/index.d.ts:2054 (opens new window)

# pointHoverBorderColor

• pointHoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

Point border color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderColor

# Defined in

types/index.d.ts:2058 (opens new window)

# pointHoverBorderWidth

• pointHoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

Border width of point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderWidth

# Defined in

types/index.d.ts:2062 (opens new window)

# pointHoverRadius

• pointHoverRadius: ScriptableAndArray<number, ScriptableContext<"line">>

The radius of the point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverRadius

# Defined in

types/index.d.ts:2066 (opens new window)

# pointRadius

• pointRadius: ScriptableAndArray<number, ScriptableContext<"line">>

The radius of the point shape. If set to 0, the point is not rendered.

# Inherited from

ScriptableAndArrayOptions.pointRadius

# Defined in

types/index.d.ts:2039 (opens new window)

# pointRotation

• pointRotation: ScriptableAndArray<number, ScriptableContext<"line">>

The rotation of the point in degrees.

# Inherited from

ScriptableAndArrayOptions.pointRotation

# Defined in

types/index.d.ts:2043 (opens new window)

# pointStyle

• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<"line">>

Style of the point.

# Inherited from

ScriptableAndArrayOptions.pointStyle

# Defined in

types/index.d.ts:2047 (opens new window)

# segment

• segment: Scriptable<{ backgroundColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderCapStyle: Scriptable<CanvasLineCap, ScriptableLineSegmentContext> ; borderColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderDash: Scriptable<number[], ScriptableLineSegmentContext> ; borderDashOffset: Scriptable<number, ScriptableLineSegmentContext> ; borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableLineSegmentContext> ; borderWidth: Scriptable<number, ScriptableLineSegmentContext> }, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.segment

# Defined in

types/index.d.ts:1932 (opens new window)

# showLine

• showLine: boolean

# Defined in

types/index.d.ts:213 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

Default

false

# Overrides

ScriptableOptions.spanGaps

# Defined in

types/index.d.ts:211 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# stepped

• stepped: Scriptable<boolean | "middle" | "after" | "before", ScriptableContext<"line">>

true to show the line as a stepped line (tension will be ignored).

Default

false

# Inherited from

ScriptableOptions.stepped

# Defined in

types/index.d.ts:1922 (opens new window)

# tension

• tension: Scriptable<number, ScriptableContext<"line">>

Bézier curve tension (0 for no Bézier curves).

Default

0

# Inherited from

ScriptableOptions.tension

# Defined in

types/index.d.ts:1917 (opens new window)

# transitions

• transitions: TransitionsSpec<"line">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:201 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:205 (opens new window)

+ (opens new window)

# Interface: LineControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"line"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"line">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderCapStyle

• borderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<"line">>

Line cap style. See MDN.

Default

'butt'

# Inherited from

ScriptableOptions.borderCapStyle

# Defined in

types/index.d.ts:1887 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: Scriptable<number[], ScriptableContext<"line">>

Line dash. See MDN.

Default

[]

# Inherited from

ScriptableOptions.borderDash

# Defined in

types/index.d.ts:1892 (opens new window)

# borderDashOffset

• borderDashOffset: Scriptable<number, ScriptableContext<"line">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

ScriptableOptions.borderDashOffset

# Defined in

types/index.d.ts:1897 (opens new window)

# borderJoinStyle

• borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<"line">>

Line join style. See MDN.

Default

'miter'

# Inherited from

ScriptableOptions.borderJoinStyle

# Defined in

types/index.d.ts:1902 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# capBezierPoints

• capBezierPoints: Scriptable<boolean, ScriptableContext<"line">>

true to keep Bézier control inside the chart, false for no restriction.

Default

true

# Inherited from

ScriptableOptions.capBezierPoints

# Defined in

types/index.d.ts:1907 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# cubicInterpolationMode

• cubicInterpolationMode: Scriptable<"default" | "monotone", ScriptableContext<"line">>

Interpolation mode to apply.

Default

'default'

# Inherited from

ScriptableOptions.cubicInterpolationMode

# Defined in

types/index.d.ts:1912 (opens new window)

# fill

• fill: Scriptable<FillTarget | ComplexFillTarget, ScriptableContext<"line">>

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Inherited from

ScriptableOptions.fill

# Defined in

types/index.d.ts:1926 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderCapStyle

• hoverBorderCapStyle: Scriptable<CanvasLineCap, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderCapStyle

# Defined in

types/index.d.ts:1944 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: Scriptable<number[], ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderDash

# Defined in

types/index.d.ts:1945 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: Scriptable<number, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1946 (opens new window)

# hoverBorderJoinStyle

• hoverBorderJoinStyle: Scriptable<CanvasLineJoin, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.hoverBorderJoinStyle

# Defined in

types/index.d.ts:1947 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointBackgroundColor

• pointBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

The fill color for points.

# Inherited from

ScriptableAndArrayOptions.pointBackgroundColor

# Defined in

types/index.d.ts:2023 (opens new window)

# pointBorderColor

• pointBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

The border color for points.

# Inherited from

ScriptableAndArrayOptions.pointBorderColor

# Defined in

types/index.d.ts:2027 (opens new window)

# pointBorderWidth

• pointBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

The width of the point border in pixels.

# Inherited from

ScriptableAndArrayOptions.pointBorderWidth

# Defined in

types/index.d.ts:2031 (opens new window)

# pointHitRadius

• pointHitRadius: ScriptableAndArray<number, ScriptableContext<"line">>

The pixel size of the non-displayed point that reacts to mouse events.

# Inherited from

ScriptableAndArrayOptions.pointHitRadius

# Defined in

types/index.d.ts:2035 (opens new window)

# pointHoverBackgroundColor

• pointHoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"line">>

Point background color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBackgroundColor

# Defined in

types/index.d.ts:2054 (opens new window)

# pointHoverBorderColor

• pointHoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"line">>

Point border color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderColor

# Defined in

types/index.d.ts:2058 (opens new window)

# pointHoverBorderWidth

• pointHoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"line">>

Border width of point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderWidth

# Defined in

types/index.d.ts:2062 (opens new window)

# pointHoverRadius

• pointHoverRadius: ScriptableAndArray<number, ScriptableContext<"line">>

The radius of the point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverRadius

# Defined in

types/index.d.ts:2066 (opens new window)

# pointRadius

• pointRadius: ScriptableAndArray<number, ScriptableContext<"line">>

The radius of the point shape. If set to 0, the point is not rendered.

# Inherited from

ScriptableAndArrayOptions.pointRadius

# Defined in

types/index.d.ts:2039 (opens new window)

# pointRotation

• pointRotation: ScriptableAndArray<number, ScriptableContext<"line">>

The rotation of the point in degrees.

# Inherited from

ScriptableAndArrayOptions.pointRotation

# Defined in

types/index.d.ts:2043 (opens new window)

# pointStyle

• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<"line">>

Style of the point.

# Inherited from

ScriptableAndArrayOptions.pointStyle

# Defined in

types/index.d.ts:2047 (opens new window)

# segment

• segment: Scriptable<{ backgroundColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderCapStyle: Scriptable<CanvasLineCap, ScriptableLineSegmentContext> ; borderColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderDash: Scriptable<number[], ScriptableLineSegmentContext> ; borderDashOffset: Scriptable<number, ScriptableLineSegmentContext> ; borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableLineSegmentContext> ; borderWidth: Scriptable<number, ScriptableLineSegmentContext> }, ScriptableContext<"line">>

# Inherited from

ScriptableOptions.segment

# Defined in

types/index.d.ts:1932 (opens new window)

# showLine

• showLine: boolean

# Defined in

types/index.d.ts:213 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

Default

false

# Overrides

ScriptableOptions.spanGaps

# Defined in

types/index.d.ts:211 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# stepped

• stepped: Scriptable<boolean | "middle" | "after" | "before", ScriptableContext<"line">>

true to show the line as a stepped line (tension will be ignored).

Default

false

# Inherited from

ScriptableOptions.stepped

# Defined in

types/index.d.ts:1922 (opens new window)

# tension

• tension: Scriptable<number, ScriptableContext<"line">>

Bézier curve tension (0 for no Bézier curves).

Default

0

# Inherited from

ScriptableOptions.tension

# Defined in

types/index.d.ts:1917 (opens new window)

# transitions

• transitions: TransitionsSpec<"line">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:201 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:205 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LineElement.html b/docs/master/api/interfaces/LineElement.html index 98bd1b6665..8b7fd69597 100644 --- a/docs/master/api/interfaces/LineElement.html +++ b/docs/master/api/interfaces/LineElement.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LineElement<T, O>

# Type parameters

Name Type
T extends LineProps = LineProps
O extends LineOptions = LineOptions

# Hierarchy

# Properties

# $animations

• $animations: Record<keyof T, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# options

• options: O

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# points

• points: Point[]

# Defined in

types/index.d.ts:1954 (opens new window)

# segments

• Readonly segments: Segment[]

# Defined in

types/index.d.ts:1955 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# draw

▸ draw(ctx, area?): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area? ChartArea

# Returns

void

# Inherited from

VisualElement.draw

# Defined in

types/index.d.ts:1796 (opens new window)

# first

▸ first(): false | Point

# Returns

false | Point

# Defined in

types/index.d.ts:1956 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Point

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Point

# Inherited from

VisualElement.getCenterPoint

# Defined in

types/index.d.ts:1800 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<T, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof T[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<T, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# getRange

▸ Optional getRange(axis): number

# Parameters

Name Type
axis "x" | "y"

# Returns

number

# Inherited from

VisualElement.getRange

# Defined in

types/index.d.ts:1801 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inRange

# Defined in

types/index.d.ts:1797 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inXRange

# Defined in

types/index.d.ts:1798 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inYRange

# Defined in

types/index.d.ts:1799 (opens new window)

# interpolate

▸ interpolate(point, property): Point | Point[]

# Parameters

Name Type
point Point
property "x" | "y"

# Returns

Point | Point[]

# Defined in

types/index.d.ts:1958 (opens new window)

# last

▸ last(): false | Point

# Returns

false | Point

# Defined in

types/index.d.ts:1957 (opens new window)

# path

▸ path(ctx): boolean

# Parameters

Name Type
ctx CanvasRenderingContext2D

# Returns

boolean

# Defined in

types/index.d.ts:1960 (opens new window)

# pathSegment

▸ pathSegment(ctx, segment, params): boolean

# Parameters

Name Type
ctx CanvasRenderingContext2D
segment Segment
params AnyObject

# Returns

boolean

# Defined in

types/index.d.ts:1959 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# updateControlPoints

▸ updateControlPoints(chartArea, indexAxis?): void

# Parameters

Name Type
chartArea ChartArea
indexAxis? "x" | "y"

# Returns

void

# Defined in

types/index.d.ts:1953 (opens new window)

+ (opens new window)

# Interface: LineElement<T, O>

# Type parameters

Name Type
T extends LineProps = LineProps
O extends LineOptions = LineOptions

# Hierarchy

# Properties

# $animations

• $animations: Record<keyof T, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# options

• options: O

# Inherited from

Element.options

# Defined in

core/core.element.ts:14 (opens new window)

# points

• points: Point[]

# Defined in

types/index.d.ts:1954 (opens new window)

# segments

• Readonly segments: Segment[]

# Defined in

types/index.d.ts:1955 (opens new window)

# x

• x: number

# Inherited from

Element.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Element.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# draw

▸ draw(ctx, area?): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area? ChartArea

# Returns

void

# Inherited from

VisualElement.draw

# Defined in

types/index.d.ts:1796 (opens new window)

# first

▸ first(): false | Point

# Returns

false | Point

# Defined in

types/index.d.ts:1956 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Point

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Point

# Inherited from

VisualElement.getCenterPoint

# Defined in

types/index.d.ts:1800 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<T, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends keyof T[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<T, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# getRange

▸ Optional getRange(axis): number

# Parameters

Name Type
axis "x" | "y"

# Returns

number

# Inherited from

VisualElement.getRange

# Defined in

types/index.d.ts:1801 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inRange

# Defined in

types/index.d.ts:1797 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inXRange

# Defined in

types/index.d.ts:1798 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Inherited from

VisualElement.inYRange

# Defined in

types/index.d.ts:1799 (opens new window)

# interpolate

▸ interpolate(point, property): Point | Point[]

# Parameters

Name Type
point Point
property "x" | "y"

# Returns

Point | Point[]

# Defined in

types/index.d.ts:1958 (opens new window)

# last

▸ last(): false | Point

# Returns

false | Point

# Defined in

types/index.d.ts:1957 (opens new window)

# path

▸ path(ctx): boolean

# Parameters

Name Type
ctx CanvasRenderingContext2D

# Returns

boolean

# Defined in

types/index.d.ts:1960 (opens new window)

# pathSegment

▸ pathSegment(ctx, segment, params): boolean

# Parameters

Name Type
ctx CanvasRenderingContext2D
segment Segment
params AnyObject

# Returns

boolean

# Defined in

types/index.d.ts:1959 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# updateControlPoints

▸ updateControlPoints(chartArea, indexAxis?): void

# Parameters

Name Type
chartArea ChartArea
indexAxis? "x" | "y"

# Returns

void

# Defined in

types/index.d.ts:1953 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LineHoverOptions.html b/docs/master/api/interfaces/LineHoverOptions.html index 35c9e80e11..f309db4b3e 100644 --- a/docs/master/api/interfaces/LineHoverOptions.html +++ b/docs/master/api/interfaces/LineHoverOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LineHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderCapStyle

• hoverBorderCapStyle: CanvasLineCap

# Defined in

types/index.d.ts:1944 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: number[]

# Defined in

types/index.d.ts:1945 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: number

# Defined in

types/index.d.ts:1946 (opens new window)

# hoverBorderJoinStyle

• hoverBorderJoinStyle: CanvasLineJoin

# Defined in

types/index.d.ts:1947 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

+ (opens new window)

# Interface: LineHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderCapStyle

• hoverBorderCapStyle: CanvasLineCap

# Defined in

types/index.d.ts:1944 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: number[]

# Defined in

types/index.d.ts:1945 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: number

# Defined in

types/index.d.ts:1946 (opens new window)

# hoverBorderJoinStyle

• hoverBorderJoinStyle: CanvasLineJoin

# Defined in

types/index.d.ts:1947 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LineOptions.html b/docs/master/api/interfaces/LineOptions.html index 8ba52e7c74..592179ddf7 100644 --- a/docs/master/api/interfaces/LineOptions.html +++ b/docs/master/api/interfaces/LineOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LineOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

CommonElementOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderCapStyle

• borderCapStyle: CanvasLineCap

Line cap style. See MDN.

Default

'butt'

# Defined in

types/index.d.ts:1887 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

CommonElementOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: number[]

Line dash. See MDN.

Default

[]

# Defined in

types/index.d.ts:1892 (opens new window)

# borderDashOffset

• borderDashOffset: number

Line dash offset. See MDN.

Default

0.0

# Defined in

types/index.d.ts:1897 (opens new window)

# borderJoinStyle

• borderJoinStyle: CanvasLineJoin

Line join style. See MDN.

Default

'miter'

# Defined in

types/index.d.ts:1902 (opens new window)

# borderWidth

• borderWidth: number

# Inherited from

CommonElementOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# capBezierPoints

• capBezierPoints: boolean

true to keep Bézier control inside the chart, false for no restriction.

Default

true

# Defined in

types/index.d.ts:1907 (opens new window)

# cubicInterpolationMode

• cubicInterpolationMode: "default" | "monotone"

Interpolation mode to apply.

Default

'default'

# Defined in

types/index.d.ts:1912 (opens new window)

# fill

• fill: FillTarget | ComplexFillTarget

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Defined in

types/index.d.ts:1926 (opens new window)

# segment

• segment: Object

# Type declaration

Name Type
backgroundColor Scriptable<Color, ScriptableLineSegmentContext>
borderCapStyle Scriptable<CanvasLineCap, ScriptableLineSegmentContext>
borderColor Scriptable<Color, ScriptableLineSegmentContext>
borderDash Scriptable<number[], ScriptableLineSegmentContext>
borderDashOffset Scriptable<number, ScriptableLineSegmentContext>
borderJoinStyle Scriptable<CanvasLineJoin, ScriptableLineSegmentContext>
borderWidth Scriptable<number, ScriptableLineSegmentContext>

# Defined in

types/index.d.ts:1932 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

# Defined in

types/index.d.ts:1930 (opens new window)

# stepped

• stepped: boolean | "middle" | "after" | "before"

true to show the line as a stepped line (tension will be ignored).

Default

false

# Defined in

types/index.d.ts:1922 (opens new window)

# tension

• tension: number

Bézier curve tension (0 for no Bézier curves).

Default

0

# Defined in

types/index.d.ts:1917 (opens new window)

+ (opens new window)

# Interface: LineOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

CommonElementOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderCapStyle

• borderCapStyle: CanvasLineCap

Line cap style. See MDN.

Default

'butt'

# Defined in

types/index.d.ts:1887 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

CommonElementOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: number[]

Line dash. See MDN.

Default

[]

# Defined in

types/index.d.ts:1892 (opens new window)

# borderDashOffset

• borderDashOffset: number

Line dash offset. See MDN.

Default

0.0

# Defined in

types/index.d.ts:1897 (opens new window)

# borderJoinStyle

• borderJoinStyle: CanvasLineJoin

Line join style. See MDN.

Default

'miter'

# Defined in

types/index.d.ts:1902 (opens new window)

# borderWidth

• borderWidth: number

# Inherited from

CommonElementOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# capBezierPoints

• capBezierPoints: boolean

true to keep Bézier control inside the chart, false for no restriction.

Default

true

# Defined in

types/index.d.ts:1907 (opens new window)

# cubicInterpolationMode

• cubicInterpolationMode: "default" | "monotone"

Interpolation mode to apply.

Default

'default'

# Defined in

types/index.d.ts:1912 (opens new window)

# fill

• fill: FillTarget | ComplexFillTarget

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Defined in

types/index.d.ts:1926 (opens new window)

# segment

• segment: Object

# Type declaration

Name Type
backgroundColor Scriptable<Color, ScriptableLineSegmentContext>
borderCapStyle Scriptable<CanvasLineCap, ScriptableLineSegmentContext>
borderColor Scriptable<Color, ScriptableLineSegmentContext>
borderDash Scriptable<number[], ScriptableLineSegmentContext>
borderDashOffset Scriptable<number, ScriptableLineSegmentContext>
borderJoinStyle Scriptable<CanvasLineJoin, ScriptableLineSegmentContext>
borderWidth Scriptable<number, ScriptableLineSegmentContext>

# Defined in

types/index.d.ts:1932 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

# Defined in

types/index.d.ts:1930 (opens new window)

# stepped

• stepped: boolean | "middle" | "after" | "before"

true to show the line as a stepped line (tension will be ignored).

Default

false

# Defined in

types/index.d.ts:1922 (opens new window)

# tension

• tension: number

Bézier curve tension (0 for no Bézier curves).

Default

0

# Defined in

types/index.d.ts:1917 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/LineProps.html b/docs/master/api/interfaces/LineProps.html index 3bc336c4ed..d071979db7 100644 --- a/docs/master/api/interfaces/LineProps.html +++ b/docs/master/api/interfaces/LineProps.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: LineProps

# Properties

# points

• points: Point[]

# Defined in

types/index.d.ts:1879 (opens new window)

+ (opens new window)

# Interface: LineProps

# Properties

# points

• points: Point[]

# Defined in

types/index.d.ts:1879 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ParsingOptions.html b/docs/master/api/interfaces/ParsingOptions.html index 2814d1a1b6..6e49d79f76 100644 --- a/docs/master/api/interfaces/ParsingOptions.html +++ b/docs/master/api/interfaces/ParsingOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ParsingOptions

# Hierarchy

# Properties

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Defined in

types/index.d.ts:63 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Defined in

types/index.d.ts:54 (opens new window)

+ (opens new window)

# Interface: ParsingOptions

# Hierarchy

# Properties

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Defined in

types/index.d.ts:63 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Defined in

types/index.d.ts:54 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/Plugin.html b/docs/master/api/interfaces/Plugin.html index 1914c85e43..91989b389b 100644 --- a/docs/master/api/interfaces/Plugin.html +++ b/docs/master/api/interfaces/Plugin.html @@ -7,7 +7,7 @@ - + @@ -39,30 +39,30 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: Plugin<TType, O>

# Type parameters

Name Type
TType extends ChartType = ChartType
O AnyObject

# Hierarchy

# Properties

# defaults

• Optional defaults: Partial<O>

Default options used in the plugin

# Defined in

types/index.d.ts:1122 (opens new window)

# events

• Optional events: keyof HTMLElementEventMap[]

The events option defines the browser events that the plugin should listen.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Defined in

types/index.d.ts:823 (opens new window)

# id

• id: string

# Defined in

types/index.d.ts:817 (opens new window)

# Methods

# afterBuildTicks

▸ Optional afterBuildTicks(chart, args, options): void

Desc

Called after scale has build its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:982 (opens new window)

# afterDataLimits

▸ Optional afterDataLimits(chart, args, options): void

Desc

Called after scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:966 (opens new window)

# afterDatasetDraw

▸ Optional afterDatasetDraw(chart, args, options): void

Desc

Called after the chart datasets at the given args.index have been drawn + (opens new window)

# Interface: Plugin<TType, O>

# Type parameters

Name Type
TType extends ChartType = ChartType
O AnyObject

# Hierarchy

# Properties

# defaults

• Optional defaults: Partial<O>

Default options used in the plugin

# Defined in

types/index.d.ts:1122 (opens new window)

# events

• Optional events: keyof HTMLElementEventMap[]

The events option defines the browser events that the plugin should listen.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Defined in

types/index.d.ts:823 (opens new window)

# id

• id: string

# Defined in

types/index.d.ts:817 (opens new window)

# Methods

# afterBuildTicks

▸ Optional afterBuildTicks(chart, args, options): void

Desc

Called after scale has build its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:982 (opens new window)

# afterDataLimits

▸ Optional afterDataLimits(chart, args, options): void

Desc

Called after scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:966 (opens new window)

# afterDatasetDraw

▸ Optional afterDatasetDraw(chart, args, options): void

Desc

Called after the chart datasets at the given args.index have been drawn (datasets are drawn in the reverse order). Note that this hook will not be called -if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1064 (opens new window)

# afterDatasetUpdate

▸ Optional afterDatasetUpdate(chart, args, options): void

Desc

Called after the chart datasets at the given args.index has been updated. Note -that this hook will not be called if the datasets update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:941 (opens new window)

# afterDatasetsDraw

▸ Optional afterDatasetsDraw(chart, args, options, cancelable): void

Desc

Called after the chart datasets have been drawn. Note that this hook -will not be called if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.
cancelable false -

# Returns

void

# Defined in

types/index.d.ts:1041 (opens new window)

# afterDatasetsUpdate

▸ Optional afterDatasetsUpdate(chart, args, options): void

Desc

Called after the chart datasets have been updated. Note that this hook -will not be called if the datasets update has been previously cancelled.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:918 (opens new window)

# afterDestroy

▸ Optional afterDestroy(chart, args, options): void

Called after the chart has been destroyed.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1109 (opens new window)

# afterDraw

▸ Optional afterDraw(chart, args, options): void

Desc

Called after the chart has been drawn. Note that this hook will not be called -if the drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1024 (opens new window)

# afterEvent

▸ Optional afterEvent(chart, args, options): void

Desc

Called after the event has been consumed. Note that this hook -will not be called if the event has been previously discarded.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.changed? boolean Set to true if the plugin needs a render. Should only be changed to true, because this args object is passed through all plugins.
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1087 (opens new window)

# afterInit

▸ Optional afterInit(chart, args, options): void

Desc

Called after chart has been initialized and before the first update.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:862 (opens new window)

# afterLayout

▸ Optional afterLayout(chart, args, options): void

Desc

Called after the chart has been laid out. Note that this hook will not -be called if the layout update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:990 (opens new window)

# afterRender

▸ Optional afterRender(chart, args, options): void

Desc

Called after the chart has been fully rendered (and animation completed). Note -that this hook will not be called if the rendering has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1007 (opens new window)

# afterTooltipDraw

▸ Optional afterTooltipDraw(chart, args, options): void

Desc

Called after drawing the tooltip. Note that this hook will not -be called if the tooltip drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.tooltip TooltipModel<TType> The tooltip.
options O The plugin options.

# Returns

void

# Inherited from

ExtendedPlugin.afterTooltipDraw

# Defined in

types/index.d.ts:2705 (opens new window)

# afterUpdate

▸ Optional afterUpdate(chart, args, options): void

Desc

Called after chart has been updated and before rendering. Note that this -hook will not be called if the chart update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:881 (opens new window)

# beforeBuildTicks

▸ Optional beforeBuildTicks(chart, args, options): void

Desc

Called before scale builds its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:974 (opens new window)

# beforeDataLimits

▸ Optional beforeDataLimits(chart, args, options): void

Desc

Called before scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:958 (opens new window)

# beforeDatasetDraw

▸ Optional beforeDatasetDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart dataset at the given args.index (datasets +if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1064 (opens new window)

# afterDatasetUpdate

▸ Optional afterDatasetUpdate(chart, args, options): void

Desc

Called after the chart datasets at the given args.index has been updated. Note +that this hook will not be called if the datasets update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:941 (opens new window)

# afterDatasetsDraw

▸ Optional afterDatasetsDraw(chart, args, options, cancelable): void

Desc

Called after the chart datasets have been drawn. Note that this hook +will not be called if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.
cancelable false -

# Returns

void

# Defined in

types/index.d.ts:1041 (opens new window)

# afterDatasetsUpdate

▸ Optional afterDatasetsUpdate(chart, args, options): void

Desc

Called after the chart datasets have been updated. Note that this hook +will not be called if the datasets update has been previously cancelled.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:918 (opens new window)

# afterDestroy

▸ Optional afterDestroy(chart, args, options): void

Called after the chart has been destroyed.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1109 (opens new window)

# afterDraw

▸ Optional afterDraw(chart, args, options): void

Desc

Called after the chart has been drawn. Note that this hook will not be called +if the drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1024 (opens new window)

# afterEvent

▸ Optional afterEvent(chart, args, options): void

Desc

Called after the event has been consumed. Note that this hook +will not be called if the event has been previously discarded.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.changed? boolean Set to true if the plugin needs a render. Should only be changed to true, because this args object is passed through all plugins.
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1087 (opens new window)

# afterInit

▸ Optional afterInit(chart, args, options): void

Desc

Called after chart has been initialized and before the first update.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:862 (opens new window)

# afterLayout

▸ Optional afterLayout(chart, args, options): void

Desc

Called after the chart has been laid out. Note that this hook will not +be called if the layout update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:990 (opens new window)

# afterRender

▸ Optional afterRender(chart, args, options): void

Desc

Called after the chart has been fully rendered (and animation completed). Note +that this hook will not be called if the rendering has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1007 (opens new window)

# afterTooltipDraw

▸ Optional afterTooltipDraw(chart, args, options): void

Desc

Called after drawing the tooltip. Note that this hook will not +be called if the tooltip drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.tooltip TooltipModel<TType> The tooltip.
options O The plugin options.

# Returns

void

# Inherited from

ExtendedPlugin.afterTooltipDraw

# Defined in

types/index.d.ts:2705 (opens new window)

# afterUpdate

▸ Optional afterUpdate(chart, args, options): void

Desc

Called after chart has been updated and before rendering. Note that this +hook will not be called if the chart update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:881 (opens new window)

# beforeBuildTicks

▸ Optional beforeBuildTicks(chart, args, options): void

Desc

Called before scale builds its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:974 (opens new window)

# beforeDataLimits

▸ Optional beforeDataLimits(chart, args, options): void

Desc

Called before scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:958 (opens new window)

# beforeDatasetDraw

▸ Optional beforeDatasetDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart dataset at the given args.index (datasets are drawn in the reverse order). If any plugin returns false, the datasets drawing -is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Defined in

types/index.d.ts:1053 (opens new window)

# beforeDatasetUpdate

▸ Optional beforeDatasetUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart dataset at the given args.index. If any plugin -returns false, the datasets update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Defined in

types/index.d.ts:930 (opens new window)

# beforeDatasetsDraw

▸ Optional beforeDatasetsDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart datasets. If any plugin returns false, -the datasets drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Defined in

types/index.d.ts:1033 (opens new window)

# beforeDatasetsUpdate

▸ Optional beforeDatasetsUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart datasets. If any plugin returns false, -the datasets update is cancelled until another update is triggered.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

boolean | void

false to cancel the datasets update.

# Defined in

types/index.d.ts:908 (opens new window)

# beforeDestroy

▸ Optional beforeDestroy(chart, args, options): void

Called before the chart is being destroyed.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1102 (opens new window)

# beforeDraw

▸ Optional beforeDraw(chart, args, options): boolean | void

Desc

Called before drawing chart at every animation frame. If any plugin returns false, -the frame drawing is cancelled untilanother render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart drawing.

# Defined in

types/index.d.ts:1016 (opens new window)

# beforeElementsUpdate

▸ Optional beforeElementsUpdate(chart, args, options): void

Desc

Called during the update process, before any chart elements have been created. -This can be used for data decimation by changing the data array inside a dataset.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:889 (opens new window)

# beforeEvent

▸ Optional beforeEvent(chart, args, options): boolean | void

Desc

Called before processing the specified event. If any plugin returns false, -the event will be discarded.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options O The plugin options.

# Returns

boolean | void

# Defined in

types/index.d.ts:1075 (opens new window)

# beforeInit

▸ Optional beforeInit(chart, args, options): void

Desc

Called before initializing chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:855 (opens new window)

# beforeLayout

▸ Optional beforeLayout(chart, args, options): boolean | void

Desc

Called before laying out chart. If any plugin returns false, -the layout update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart layout.

# Defined in

types/index.d.ts:950 (opens new window)

# beforeRender

▸ Optional beforeRender(chart, args, options): boolean | void

Desc

Called before rendering chart. If any plugin returns false, -the rendering is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart rendering.

# Defined in

types/index.d.ts:999 (opens new window)

# beforeTooltipDraw

▸ Optional beforeTooltipDraw(chart, args, options): boolean | void

Desc

Called before drawing the tooltip. If any plugin returns false, -the tooltip drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.tooltip TooltipModel<TType> The tooltip.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart tooltip drawing.

# Inherited from

ExtendedPlugin.beforeTooltipDraw

# Defined in

types/index.d.ts:2696 (opens new window)

# beforeUpdate

▸ Optional beforeUpdate(chart, args, options): boolean | void

Desc

Called before updating chart. If any plugin returns false, the update -is cancelled (and thus subsequent render(s)) until another update is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options O The plugin options.

# Returns

boolean | void

false to cancel the chart update.

# Defined in

types/index.d.ts:872 (opens new window)

# install

▸ Optional install(chart, args, options): void

Desc

Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:832 (opens new window)

# reset

▸ Optional reset(chart, args, options): void

Desc

Called during chart reset

Since

version 3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:897 (opens new window)

# resize

▸ Optional resize(chart, args, options): void

Desc

Called after the chart as been resized.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.size Object The new canvas display size (eq. canvas.style width & height).
args.size.height number -
args.size.width number -
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1095 (opens new window)

# start

▸ Optional start(chart, args, options): void

Desc

Called when a plugin is starting. This happens when chart is created or plugin is enabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:840 (opens new window)

# stop

▸ Optional stop(chart, args, options): void

Desc

Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:848 (opens new window)

# uninstall

▸ Optional uninstall(chart, args, options): void

Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1117 (opens new window)

+is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Defined in

types/index.d.ts:1053 (opens new window)

# beforeDatasetUpdate

▸ Optional beforeDatasetUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart dataset at the given args.index. If any plugin +returns false, the datasets update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Defined in

types/index.d.ts:930 (opens new window)

# beforeDatasetsDraw

▸ Optional beforeDatasetsDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart datasets. If any plugin returns false, +the datasets drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Defined in

types/index.d.ts:1033 (opens new window)

# beforeDatasetsUpdate

▸ Optional beforeDatasetsUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart datasets. If any plugin returns false, +the datasets update is cancelled until another update is triggered.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options O The plugin options.

# Returns

boolean | void

false to cancel the datasets update.

# Defined in

types/index.d.ts:908 (opens new window)

# beforeDestroy

▸ Optional beforeDestroy(chart, args, options): void

Called before the chart is being destroyed.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1102 (opens new window)

# beforeDraw

▸ Optional beforeDraw(chart, args, options): boolean | void

Desc

Called before drawing chart at every animation frame. If any plugin returns false, +the frame drawing is cancelled untilanother render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart drawing.

# Defined in

types/index.d.ts:1016 (opens new window)

# beforeElementsUpdate

▸ Optional beforeElementsUpdate(chart, args, options): void

Desc

Called during the update process, before any chart elements have been created. +This can be used for data decimation by changing the data array inside a dataset.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:889 (opens new window)

# beforeEvent

▸ Optional beforeEvent(chart, args, options): boolean | void

Desc

Called before processing the specified event. If any plugin returns false, +the event will be discarded.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options O The plugin options.

# Returns

boolean | void

# Defined in

types/index.d.ts:1075 (opens new window)

# beforeInit

▸ Optional beforeInit(chart, args, options): void

Desc

Called before initializing chart.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:855 (opens new window)

# beforeLayout

▸ Optional beforeLayout(chart, args, options): boolean | void

Desc

Called before laying out chart. If any plugin returns false, +the layout update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart layout.

# Defined in

types/index.d.ts:950 (opens new window)

# beforeRender

▸ Optional beforeRender(chart, args, options): boolean | void

Desc

Called before rendering chart. If any plugin returns false, +the rendering is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options O The plugin options.

# Returns

boolean | void

false to cancel the chart rendering.

# Defined in

types/index.d.ts:999 (opens new window)

# beforeTooltipDraw

▸ Optional beforeTooltipDraw(chart, args, options): boolean | void

Desc

Called before drawing the tooltip. If any plugin returns false, +the tooltip drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.tooltip TooltipModel<TType> The tooltip.
options O The plugin options.

# Returns

boolean | void

false to cancel the chart tooltip drawing.

# Inherited from

ExtendedPlugin.beforeTooltipDraw

# Defined in

types/index.d.ts:2696 (opens new window)

# beforeUpdate

▸ Optional beforeUpdate(chart, args, options): boolean | void

Desc

Called before updating chart. If any plugin returns false, the update +is cancelled (and thus subsequent render(s)) until another update is triggered.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options O The plugin options.

# Returns

boolean | void

false to cancel the chart update.

# Defined in

types/index.d.ts:872 (opens new window)

# install

▸ Optional install(chart, args, options): void

Desc

Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:832 (opens new window)

# reset

▸ Optional reset(chart, args, options): void

Desc

Called during chart reset

Since

version 3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:897 (opens new window)

# resize

▸ Optional resize(chart, args, options): void

Desc

Called after the chart as been resized.

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args Object The call arguments.
args.size Object The new canvas display size (eq. canvas.style width & height).
args.size.height number -
args.size.width number -
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1095 (opens new window)

# start

▸ Optional start(chart, args, options): void

Desc

Called when a plugin is starting. This happens when chart is created or plugin is enabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:840 (opens new window)

# stop

▸ Optional stop(chart, args, options): void

Desc

Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:848 (opens new window)

# uninstall

▸ Optional uninstall(chart, args, options): void

Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown> The chart instance.
args EmptyObject The call arguments.
options O The plugin options.

# Returns

void

# Defined in

types/index.d.ts:1117 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PluginChartOptions.html b/docs/master/api/interfaces/PluginChartOptions.html index 473a7c9f9f..8b42f2fcb8 100644 --- a/docs/master/api/interfaces/PluginChartOptions.html +++ b/docs/master/api/interfaces/PluginChartOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PluginChartOptions<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# plugins

• plugins: PluginOptionsByType<TType>

# Defined in

types/index.d.ts:2950 (opens new window)

+ (opens new window)

# Interface: PluginChartOptions<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# plugins

• plugins: PluginOptionsByType<TType>

# Defined in

types/index.d.ts:2950 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PluginOptionsByType.html b/docs/master/api/interfaces/PluginOptionsByType.html index 8fb97cfd53..10ec5d45f3 100644 --- a/docs/master/api/interfaces/PluginOptionsByType.html +++ b/docs/master/api/interfaces/PluginOptionsByType.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PluginOptionsByType<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# colors

• colors: ColorsPluginOptions

# Defined in

types/index.d.ts:2941 (opens new window)

# decimation

• decimation: DecimationOptions

# Defined in

types/index.d.ts:2942 (opens new window)

# filler

• filler: FillerOptions

# Defined in

types/index.d.ts:2943 (opens new window)

# legend

• legend: LegendOptions<TType>

# Defined in

types/index.d.ts:2944 (opens new window)

# subtitle

• subtitle: TitleOptions

# Defined in

types/index.d.ts:2945 (opens new window)

# title

• title: TitleOptions

# Defined in

types/index.d.ts:2946 (opens new window)

# tooltip

• tooltip: TooltipOptions<TType>

# Defined in

types/index.d.ts:2947 (opens new window)

+ (opens new window)

# Interface: PluginOptionsByType<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# colors

• colors: ColorsPluginOptions

# Defined in

types/index.d.ts:2941 (opens new window)

# decimation

• decimation: DecimationOptions

# Defined in

types/index.d.ts:2942 (opens new window)

# filler

• filler: FillerOptions

# Defined in

types/index.d.ts:2943 (opens new window)

# legend

• legend: LegendOptions<TType>

# Defined in

types/index.d.ts:2944 (opens new window)

# subtitle

• subtitle: TitleOptions

# Defined in

types/index.d.ts:2945 (opens new window)

# title

• title: TitleOptions

# Defined in

types/index.d.ts:2946 (opens new window)

# tooltip

• tooltip: TooltipOptions<TType>

# Defined in

types/index.d.ts:2947 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/Point.html b/docs/master/api/interfaces/Point.html index ac0eee85a0..1ad0b0ac30 100644 --- a/docs/master/api/interfaces/Point.html +++ b/docs/master/api/interfaces/Point.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: Point

# Hierarchy

# Properties

# x

• x: number

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Defined in

types/geometric.d.ts:12 (opens new window)

+ (opens new window)

# Interface: Point

# Hierarchy

# Properties

# x

• x: number

# Defined in

types/geometric.d.ts:11 (opens new window)

# y

• y: number

# Defined in

types/geometric.d.ts:12 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PointHoverOptions.html b/docs/master/api/interfaces/PointHoverOptions.html index 5e25bde1d4..7a3bd7958e 100644 --- a/docs/master/api/interfaces/PointHoverOptions.html +++ b/docs/master/api/interfaces/PointHoverOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PointHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverRadius

• hoverRadius: number

Point radius when hovered.

Default

4

# Defined in

types/index.d.ts:2016 (opens new window)

+ (opens new window)

# Interface: PointHoverOptions

# Hierarchy

# Properties

# hoverBackgroundColor

• hoverBackgroundColor: Color

# Inherited from

CommonHoverOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: Color

# Inherited from

CommonHoverOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: number

# Inherited from

CommonHoverOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverRadius

• hoverRadius: number

Point radius when hovered.

Default

4

# Defined in

types/index.d.ts:2016 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PointOptions.html b/docs/master/api/interfaces/PointOptions.html index e14e669e68..2def4468fb 100644 --- a/docs/master/api/interfaces/PointOptions.html +++ b/docs/master/api/interfaces/PointOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PointOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

CommonElementOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

CommonElementOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderWidth

• borderWidth: number

# Inherited from

CommonElementOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# drawActiveElementsOnTop

• drawActiveElementsOnTop: boolean

Draw the active elements over the other elements of the dataset,

Default

true

# Defined in

types/index.d.ts:2008 (opens new window)

# hitRadius

• hitRadius: number

Extra radius added to point radius for hit detection.

Default

1

# Defined in

types/index.d.ts:1993 (opens new window)

# pointStyle

• pointStyle: PointStyle

Point style

Default

'circle;

# Defined in

types/index.d.ts:1998 (opens new window)

# radius

• radius: number

Point radius

Default

3

# Defined in

types/index.d.ts:1988 (opens new window)

# rotation

• rotation: number

Point rotation (in degrees).

Default

0

# Defined in

types/index.d.ts:2003 (opens new window)

+ (opens new window)

# Interface: PointOptions

# Hierarchy

# Properties

# backgroundColor

• backgroundColor: Color

# Inherited from

CommonElementOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderColor

• borderColor: Color

# Inherited from

CommonElementOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderWidth

• borderWidth: number

# Inherited from

CommonElementOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# drawActiveElementsOnTop

• drawActiveElementsOnTop: boolean

Draw the active elements over the other elements of the dataset,

Default

true

# Defined in

types/index.d.ts:2008 (opens new window)

# hitRadius

• hitRadius: number

Extra radius added to point radius for hit detection.

Default

1

# Defined in

types/index.d.ts:1993 (opens new window)

# pointStyle

• pointStyle: PointStyle

Point style

Default

'circle;

# Defined in

types/index.d.ts:1998 (opens new window)

# radius

• radius: number

Point radius

Default

3

# Defined in

types/index.d.ts:1988 (opens new window)

# rotation

• rotation: number

Point rotation (in degrees).

Default

0

# Defined in

types/index.d.ts:2003 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PointPrefixedHoverOptions.html b/docs/master/api/interfaces/PointPrefixedHoverOptions.html index 0d8384899f..4af33f2d8e 100644 --- a/docs/master/api/interfaces/PointPrefixedHoverOptions.html +++ b/docs/master/api/interfaces/PointPrefixedHoverOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PointPrefixedHoverOptions

# Properties

# pointHoverBackgroundColor

• pointHoverBackgroundColor: Color

Point background color when hovered.

# Defined in

types/index.d.ts:2054 (opens new window)

# pointHoverBorderColor

• pointHoverBorderColor: Color

Point border color when hovered.

# Defined in

types/index.d.ts:2058 (opens new window)

# pointHoverBorderWidth

• pointHoverBorderWidth: number

Border width of point when hovered.

# Defined in

types/index.d.ts:2062 (opens new window)

# pointHoverRadius

• pointHoverRadius: number

The radius of the point when hovered.

# Defined in

types/index.d.ts:2066 (opens new window)

+ (opens new window)

# Interface: PointPrefixedHoverOptions

# Properties

# pointHoverBackgroundColor

• pointHoverBackgroundColor: Color

Point background color when hovered.

# Defined in

types/index.d.ts:2054 (opens new window)

# pointHoverBorderColor

• pointHoverBorderColor: Color

Point border color when hovered.

# Defined in

types/index.d.ts:2058 (opens new window)

# pointHoverBorderWidth

• pointHoverBorderWidth: number

Border width of point when hovered.

# Defined in

types/index.d.ts:2062 (opens new window)

# pointHoverRadius

• pointHoverRadius: number

The radius of the point when hovered.

# Defined in

types/index.d.ts:2066 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PointPrefixedOptions.html b/docs/master/api/interfaces/PointPrefixedOptions.html index 5acab825d6..9a599b1a07 100644 --- a/docs/master/api/interfaces/PointPrefixedOptions.html +++ b/docs/master/api/interfaces/PointPrefixedOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PointPrefixedOptions

# Properties

# pointBackgroundColor

• pointBackgroundColor: Color

The fill color for points.

# Defined in

types/index.d.ts:2023 (opens new window)

# pointBorderColor

• pointBorderColor: Color

The border color for points.

# Defined in

types/index.d.ts:2027 (opens new window)

# pointBorderWidth

• pointBorderWidth: number

The width of the point border in pixels.

# Defined in

types/index.d.ts:2031 (opens new window)

# pointHitRadius

• pointHitRadius: number

The pixel size of the non-displayed point that reacts to mouse events.

# Defined in

types/index.d.ts:2035 (opens new window)

# pointRadius

• pointRadius: number

The radius of the point shape. If set to 0, the point is not rendered.

# Defined in

types/index.d.ts:2039 (opens new window)

# pointRotation

• pointRotation: number

The rotation of the point in degrees.

# Defined in

types/index.d.ts:2043 (opens new window)

# pointStyle

• pointStyle: PointStyle

Style of the point.

# Defined in

types/index.d.ts:2047 (opens new window)

+ (opens new window)

# Interface: PointPrefixedOptions

# Properties

# pointBackgroundColor

• pointBackgroundColor: Color

The fill color for points.

# Defined in

types/index.d.ts:2023 (opens new window)

# pointBorderColor

• pointBorderColor: Color

The border color for points.

# Defined in

types/index.d.ts:2027 (opens new window)

# pointBorderWidth

• pointBorderWidth: number

The width of the point border in pixels.

# Defined in

types/index.d.ts:2031 (opens new window)

# pointHitRadius

• pointHitRadius: number

The pixel size of the non-displayed point that reacts to mouse events.

# Defined in

types/index.d.ts:2035 (opens new window)

# pointRadius

• pointRadius: number

The radius of the point shape. If set to 0, the point is not rendered.

# Defined in

types/index.d.ts:2039 (opens new window)

# pointRotation

• pointRotation: number

The rotation of the point in degrees.

# Defined in

types/index.d.ts:2043 (opens new window)

# pointStyle

• pointStyle: PointStyle

Style of the point.

# Defined in

types/index.d.ts:2047 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PolarAreaController.html b/docs/master/api/interfaces/PolarAreaController.html index 37280d1835..df449356d1 100644 --- a/docs/master/api/interfaces/PolarAreaController.html +++ b/docs/master/api/interfaces/PolarAreaController.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PolarAreaController

# Hierarchy

# Properties

# _cachedMeta

• Readonly _cachedMeta: ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DoughnutController._cachedMeta

# Defined in

types/index.d.ts:592 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

DoughnutController.chart

# Defined in

types/index.d.ts:590 (opens new window)

# enableOptionSharing

• enableOptionSharing: boolean

# Inherited from

DoughnutController.enableOptionSharing

# Defined in

types/index.d.ts:593 (opens new window)

# index

• Readonly index: number

# Inherited from

DoughnutController.index

# Defined in

types/index.d.ts:591 (opens new window)

# innerRadius

• Readonly innerRadius: number

# Inherited from

DoughnutController.innerRadius

# Defined in

types/index.d.ts:341 (opens new window)

# offsetX

• Readonly offsetX: number

# Inherited from

DoughnutController.offsetX

# Defined in

types/index.d.ts:343 (opens new window)

# offsetY

• Readonly offsetY: number

# Inherited from

DoughnutController.offsetY

# Defined in

types/index.d.ts:344 (opens new window)

# outerRadius

• Readonly outerRadius: number

# Inherited from

DoughnutController.outerRadius

# Defined in

types/index.d.ts:342 (opens new window)

# supportsDecimation

• supportsDecimation: boolean

# Inherited from

DoughnutController.supportsDecimation

# Defined in

types/index.d.ts:597 (opens new window)

# Methods

# addElements

▸ addElements(): void

# Returns

void

# Inherited from

DoughnutController.addElements

# Defined in

types/index.d.ts:613 (opens new window)

# applyStack

▸ Protected applyStack(scale, parsed): number

# Parameters

Name Type
scale Scale<CoreScaleOptions>
parsed unknown[]

# Returns

number

# Inherited from

DoughnutController.applyStack

# Defined in

types/index.d.ts:649 (opens new window)

# buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

# Parameters

Name Type
resetNewElements? boolean

# Returns

void

# Inherited from

DoughnutController.buildOrUpdateElements

# Defined in

types/index.d.ts:614 (opens new window)

# calculateCircumference

▸ calculateCircumference(value): number

# Parameters

Name Type
value number

# Returns

number

# Inherited from

DoughnutController.calculateCircumference

# Defined in

types/index.d.ts:347 (opens new window)

# calculateTotal

▸ calculateTotal(): number

# Returns

number

# Inherited from

DoughnutController.calculateTotal

# Defined in

types/index.d.ts:346 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

DoughnutController.configure

# Defined in

types/index.d.ts:611 (opens new window)

# countVisibleElements

▸ countVisibleElements(): number

# Returns

number

# Defined in

types/index.d.ts:393 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Inherited from

DoughnutController.draw

# Defined in

types/index.d.ts:606 (opens new window)

# getAllParsedValues

▸ getAllParsedValues(scale): number[]

# Parameters

Name Type
scale Scale<CoreScaleOptions>

# Returns

number[]

# Inherited from

DoughnutController.getAllParsedValues

# Defined in

types/index.d.ts:600 (opens new window)

# getDataset

▸ getDataset(): ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Returns

ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Inherited from

DoughnutController.getDataset

# Defined in

types/index.d.ts:608 (opens new window)

# getLabelAndValue

▸ Protected getLabelAndValue(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
label string
value string

# Inherited from

DoughnutController.getLabelAndValue

# Defined in

types/index.d.ts:601 (opens new window)

# getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

# Returns

number | boolean

# Inherited from

DoughnutController.getMaxOverflow

# Defined in

types/index.d.ts:605 (opens new window)

# getMeta

▸ getMeta(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DoughnutController.getMeta

# Defined in

types/index.d.ts:609 (opens new window)

# getMinMax

▸ Protected getMinMax(scale, canStack?): Object

# Parameters

Name Type
scale Scale<CoreScaleOptions>
canStack? boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

DoughnutController.getMinMax

# Defined in

types/index.d.ts:656 (opens new window)

# getParsed

▸ Protected getParsed(index): number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Parameters

Name Type
index number

# Returns

number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Inherited from

DoughnutController.getParsed

# Defined in

types/index.d.ts:648 (opens new window)

# getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

# Parameters

Name Type
scaleID string

# Returns

Scale<CoreScaleOptions>

# Inherited from

DoughnutController.getScaleForId

# Defined in

types/index.d.ts:610 (opens new window)

# getSharedOptions

▸ Protected getSharedOptions(options): AnyObject

Utility for checking if the options are shared and should be animated separately.

# Parameters

Name Type
options AnyObject

# Returns

AnyObject

# Inherited from

DoughnutController.getSharedOptions

# Defined in

types/index.d.ts:623 (opens new window)

# getStyle

▸ getStyle(index, active): AnyObject

# Parameters

Name Type
index number
active boolean

# Returns

AnyObject

# Inherited from

DoughnutController.getStyle

# Defined in

types/index.d.ts:616 (opens new window)

# includeOptions

▸ Protected includeOptions(mode, sharedOptions): boolean

Utility for determining if options should be included in the updated properties

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
sharedOptions AnyObject

# Returns

boolean

# Inherited from

DoughnutController.includeOptions

# Defined in

types/index.d.ts:628 (opens new window)

# initialize

▸ initialize(): void

# Returns

void

# Inherited from

DoughnutController.initialize

# Defined in

types/index.d.ts:612 (opens new window)

# linkScales

▸ linkScales(): void

# Returns

void

# Inherited from

DoughnutController.linkScales

# Defined in

types/index.d.ts:599 (opens new window)

# parse

▸ parse(start, count): void

# Parameters

Name Type
start number
count number

# Returns

void

# Inherited from

DoughnutController.parse

# Defined in

types/index.d.ts:644 (opens new window)

# parseArrayData

▸ Protected parseArrayData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DoughnutController.parseArrayData

# Defined in

types/index.d.ts:646 (opens new window)

# parseObjectData

▸ Protected parseObjectData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DoughnutController.parseObjectData

# Defined in

types/index.d.ts:647 (opens new window)

# parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DoughnutController.parsePrimitiveData

# Defined in

types/index.d.ts:645 (opens new window)

# removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DoughnutController.removeHoverStyle

# Defined in

types/index.d.ts:641 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Inherited from

DoughnutController.reset

# Defined in

types/index.d.ts:607 (opens new window)

# resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): AnyObject

# Parameters

Name Type
index number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DoughnutController.resolveDataElementOptions

# Defined in

types/index.d.ts:618 (opens new window)

# resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): AnyObject

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DoughnutController.resolveDatasetElementOptions

# Defined in

types/index.d.ts:617 (opens new window)

# setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DoughnutController.setHoverStyle

# Defined in

types/index.d.ts:642 (opens new window)

# update

▸ update(mode): void

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DoughnutController.update

# Defined in

types/index.d.ts:603 (opens new window)

# updateElement

▸ Protected updateElement(element, index, properties, mode): void

Utility for updating an element with new properties, using animations when appropriate.

# Parameters

Name Type
element default<AnyObject, AnyObject>
index number
properties AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DoughnutController.updateElement

# Defined in

types/index.d.ts:634 (opens new window)

# updateElements

▸ updateElements(elements, start, count, mode): void

# Parameters

Name Type
elements default<AnyObject, AnyObject>[]
start number
count number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DoughnutController.updateElements

# Defined in

types/index.d.ts:602 (opens new window)

# updateIndex

▸ updateIndex(datasetIndex): void

# Parameters

Name Type
datasetIndex number

# Returns

void

# Inherited from

DoughnutController.updateIndex

# Defined in

types/index.d.ts:604 (opens new window)

# updateRangeFromParsed

▸ Protected updateRangeFromParsed(range, scale, parsed, stack): void

# Parameters

Name Type
range Object
range.max number
range.min number
scale Scale<CoreScaleOptions>
parsed unknown[]
stack string | boolean

# Returns

void

# Inherited from

DoughnutController.updateRangeFromParsed

# Defined in

types/index.d.ts:650 (opens new window)

# updateSharedOptions

▸ Protected updateSharedOptions(sharedOptions, mode, newOptions): void

Utility to animate the shared options, that are potentially affecting multiple elements.

# Parameters

Name Type
sharedOptions AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
newOptions AnyObject

# Returns

void

# Inherited from

DoughnutController.updateSharedOptions

# Defined in

types/index.d.ts:640 (opens new window)

+ (opens new window)

# Interface: PolarAreaController

# Hierarchy

# Properties

# _cachedMeta

• Readonly _cachedMeta: ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DoughnutController._cachedMeta

# Defined in

types/index.d.ts:592 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

DoughnutController.chart

# Defined in

types/index.d.ts:590 (opens new window)

# enableOptionSharing

• enableOptionSharing: boolean

# Inherited from

DoughnutController.enableOptionSharing

# Defined in

types/index.d.ts:593 (opens new window)

# index

• Readonly index: number

# Inherited from

DoughnutController.index

# Defined in

types/index.d.ts:591 (opens new window)

# innerRadius

• Readonly innerRadius: number

# Inherited from

DoughnutController.innerRadius

# Defined in

types/index.d.ts:341 (opens new window)

# offsetX

• Readonly offsetX: number

# Inherited from

DoughnutController.offsetX

# Defined in

types/index.d.ts:343 (opens new window)

# offsetY

• Readonly offsetY: number

# Inherited from

DoughnutController.offsetY

# Defined in

types/index.d.ts:344 (opens new window)

# outerRadius

• Readonly outerRadius: number

# Inherited from

DoughnutController.outerRadius

# Defined in

types/index.d.ts:342 (opens new window)

# supportsDecimation

• supportsDecimation: boolean

# Inherited from

DoughnutController.supportsDecimation

# Defined in

types/index.d.ts:597 (opens new window)

# Methods

# addElements

▸ addElements(): void

# Returns

void

# Inherited from

DoughnutController.addElements

# Defined in

types/index.d.ts:613 (opens new window)

# applyStack

▸ Protected applyStack(scale, parsed): number

# Parameters

Name Type
scale Scale<CoreScaleOptions>
parsed unknown[]

# Returns

number

# Inherited from

DoughnutController.applyStack

# Defined in

types/index.d.ts:649 (opens new window)

# buildOrUpdateElements

▸ buildOrUpdateElements(resetNewElements?): void

# Parameters

Name Type
resetNewElements? boolean

# Returns

void

# Inherited from

DoughnutController.buildOrUpdateElements

# Defined in

types/index.d.ts:614 (opens new window)

# calculateCircumference

▸ calculateCircumference(value): number

# Parameters

Name Type
value number

# Returns

number

# Inherited from

DoughnutController.calculateCircumference

# Defined in

types/index.d.ts:347 (opens new window)

# calculateTotal

▸ calculateTotal(): number

# Returns

number

# Inherited from

DoughnutController.calculateTotal

# Defined in

types/index.d.ts:346 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

DoughnutController.configure

# Defined in

types/index.d.ts:611 (opens new window)

# countVisibleElements

▸ countVisibleElements(): number

# Returns

number

# Defined in

types/index.d.ts:393 (opens new window)

# draw

▸ draw(): void

# Returns

void

# Inherited from

DoughnutController.draw

# Defined in

types/index.d.ts:606 (opens new window)

# getAllParsedValues

▸ getAllParsedValues(scale): number[]

# Parameters

Name Type
scale Scale<CoreScaleOptions>

# Returns

number[]

# Inherited from

DoughnutController.getAllParsedValues

# Defined in

types/index.d.ts:600 (opens new window)

# getDataset

▸ getDataset(): ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Returns

ChartDataset<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[]>

# Inherited from

DoughnutController.getDataset

# Defined in

types/index.d.ts:608 (opens new window)

# getLabelAndValue

▸ Protected getLabelAndValue(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
label string
value string

# Inherited from

DoughnutController.getLabelAndValue

# Defined in

types/index.d.ts:601 (opens new window)

# getMaxOverflow

▸ Protected getMaxOverflow(): number | boolean

# Returns

number | boolean

# Inherited from

DoughnutController.getMaxOverflow

# Defined in

types/index.d.ts:605 (opens new window)

# getMeta

▸ getMeta(): ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Returns

ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>

# Inherited from

DoughnutController.getMeta

# Defined in

types/index.d.ts:609 (opens new window)

# getMinMax

▸ Protected getMinMax(scale, canStack?): Object

# Parameters

Name Type
scale Scale<CoreScaleOptions>
canStack? boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

DoughnutController.getMinMax

# Defined in

types/index.d.ts:656 (opens new window)

# getParsed

▸ Protected getParsed(index): number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Parameters

Name Type
index number

# Returns

number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData

# Inherited from

DoughnutController.getParsed

# Defined in

types/index.d.ts:648 (opens new window)

# getScaleForId

▸ getScaleForId(scaleID): Scale<CoreScaleOptions>

# Parameters

Name Type
scaleID string

# Returns

Scale<CoreScaleOptions>

# Inherited from

DoughnutController.getScaleForId

# Defined in

types/index.d.ts:610 (opens new window)

# getSharedOptions

▸ Protected getSharedOptions(options): AnyObject

Utility for checking if the options are shared and should be animated separately.

# Parameters

Name Type
options AnyObject

# Returns

AnyObject

# Inherited from

DoughnutController.getSharedOptions

# Defined in

types/index.d.ts:623 (opens new window)

# getStyle

▸ getStyle(index, active): AnyObject

# Parameters

Name Type
index number
active boolean

# Returns

AnyObject

# Inherited from

DoughnutController.getStyle

# Defined in

types/index.d.ts:616 (opens new window)

# includeOptions

▸ Protected includeOptions(mode, sharedOptions): boolean

Utility for determining if options should be included in the updated properties

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
sharedOptions AnyObject

# Returns

boolean

# Inherited from

DoughnutController.includeOptions

# Defined in

types/index.d.ts:628 (opens new window)

# initialize

▸ initialize(): void

# Returns

void

# Inherited from

DoughnutController.initialize

# Defined in

types/index.d.ts:612 (opens new window)

# linkScales

▸ linkScales(): void

# Returns

void

# Inherited from

DoughnutController.linkScales

# Defined in

types/index.d.ts:599 (opens new window)

# parse

▸ parse(start, count): void

# Parameters

Name Type
start number
count number

# Returns

void

# Inherited from

DoughnutController.parse

# Defined in

types/index.d.ts:644 (opens new window)

# parseArrayData

▸ Protected parseArrayData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DoughnutController.parseArrayData

# Defined in

types/index.d.ts:646 (opens new window)

# parseObjectData

▸ Protected parseObjectData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DoughnutController.parseObjectData

# Defined in

types/index.d.ts:647 (opens new window)

# parsePrimitiveData

▸ Protected parsePrimitiveData(meta, data, start, count): AnyObject[]

# Parameters

Name Type
meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>>
data AnyObject[]
start number
count number

# Returns

AnyObject[]

# Inherited from

DoughnutController.parsePrimitiveData

# Defined in

types/index.d.ts:645 (opens new window)

# removeHoverStyle

▸ removeHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DoughnutController.removeHoverStyle

# Defined in

types/index.d.ts:641 (opens new window)

# reset

▸ reset(): void

# Returns

void

# Inherited from

DoughnutController.reset

# Defined in

types/index.d.ts:607 (opens new window)

# resolveDataElementOptions

▸ Protected resolveDataElementOptions(index, mode): AnyObject

# Parameters

Name Type
index number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DoughnutController.resolveDataElementOptions

# Defined in

types/index.d.ts:618 (opens new window)

# resolveDatasetElementOptions

▸ Protected resolveDatasetElementOptions(mode): AnyObject

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

AnyObject

# Inherited from

DoughnutController.resolveDatasetElementOptions

# Defined in

types/index.d.ts:617 (opens new window)

# setHoverStyle

▸ setHoverStyle(element, datasetIndex, index): void

# Parameters

Name Type
element default<AnyObject, AnyObject>
datasetIndex number
index number

# Returns

void

# Inherited from

DoughnutController.setHoverStyle

# Defined in

types/index.d.ts:642 (opens new window)

# update

▸ update(mode): void

# Parameters

Name Type
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DoughnutController.update

# Defined in

types/index.d.ts:603 (opens new window)

# updateElement

▸ Protected updateElement(element, index, properties, mode): void

Utility for updating an element with new properties, using animations when appropriate.

# Parameters

Name Type
element default<AnyObject, AnyObject>
index number
properties AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DoughnutController.updateElement

# Defined in

types/index.d.ts:634 (opens new window)

# updateElements

▸ updateElements(elements, start, count, mode): void

# Parameters

Name Type
elements default<AnyObject, AnyObject>[]
start number
count number
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"

# Returns

void

# Inherited from

DoughnutController.updateElements

# Defined in

types/index.d.ts:602 (opens new window)

# updateIndex

▸ updateIndex(datasetIndex): void

# Parameters

Name Type
datasetIndex number

# Returns

void

# Inherited from

DoughnutController.updateIndex

# Defined in

types/index.d.ts:604 (opens new window)

# updateRangeFromParsed

▸ Protected updateRangeFromParsed(range, scale, parsed, stack): void

# Parameters

Name Type
range Object
range.max number
range.min number
scale Scale<CoreScaleOptions>
parsed unknown[]
stack string | boolean

# Returns

void

# Inherited from

DoughnutController.updateRangeFromParsed

# Defined in

types/index.d.ts:650 (opens new window)

# updateSharedOptions

▸ Protected updateSharedOptions(sharedOptions, mode, newOptions): void

Utility to animate the shared options, that are potentially affecting multiple elements.

# Parameters

Name Type
sharedOptions AnyObject
mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset"
newOptions AnyObject

# Returns

void

# Inherited from

DoughnutController.updateSharedOptions

# Defined in

types/index.d.ts:640 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PolarAreaControllerChartOptions.html b/docs/master/api/interfaces/PolarAreaControllerChartOptions.html index e81a3b8081..27df117266 100644 --- a/docs/master/api/interfaces/PolarAreaControllerChartOptions.html +++ b/docs/master/api/interfaces/PolarAreaControllerChartOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PolarAreaControllerChartOptions

# Properties

# animation

• animation: false | DoughnutAnimationOptions

# Defined in

types/index.d.ts:389 (opens new window)

# startAngle

• startAngle: number

Starting angle to draw arcs for the first item in a dataset. In degrees, 0 is at top.

Default

0

# Defined in

types/index.d.ts:387 (opens new window)

+ (opens new window)

# Interface: PolarAreaControllerChartOptions

# Properties

# animation

• animation: false | DoughnutAnimationOptions

# Defined in

types/index.d.ts:389 (opens new window)

# startAngle

• startAngle: number

Starting angle to draw arcs for the first item in a dataset. In degrees, 0 is at top.

Default

0

# Defined in

types/index.d.ts:387 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/PolarAreaControllerDatasetOptions.html b/docs/master/api/interfaces/PolarAreaControllerDatasetOptions.html index efd9324b89..ecd571157b 100644 --- a/docs/master/api/interfaces/PolarAreaControllerDatasetOptions.html +++ b/docs/master/api/interfaces/PolarAreaControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,8 +39,8 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: PolarAreaControllerDatasetOptions

# Hierarchy

# Properties

# angle

• angle: number

Arc angle to cover. - for polar only

Default

circumference / (arc count)

# Defined in

types/index.d.ts:377 (opens new window)

# animation

• animation: false | AnimationSpec<"doughnut"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

DoughnutControllerDatasetOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"doughnut">

# Inherited from

DoughnutControllerDatasetOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderAlign

• borderAlign: ScriptableAndArray<"center" | "inner", ScriptableContext<"doughnut">>

Arc stroke alignment.

# Inherited from

DoughnutControllerDatasetOptions.borderAlign

# Defined in

types/index.d.ts:1833 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

Line dash. See MDN.

Default

[]

# Inherited from

DoughnutControllerDatasetOptions.borderDash

# Defined in

types/index.d.ts:1838 (opens new window)

# borderDashOffset

• borderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

DoughnutControllerDatasetOptions.borderDashOffset

# Defined in

types/index.d.ts:1843 (opens new window)

# borderJoinStyle

• borderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"doughnut">>

Line join style. See MDN. Default is 'round' when borderAlign is 'inner', else 'bevel'.

# Inherited from

DoughnutControllerDatasetOptions.borderJoinStyle

# Defined in

types/index.d.ts:1847 (opens new window)

# borderRadius

• borderRadius: ScriptableAndArray<number | ArcBorderRadius, ScriptableContext<"doughnut">>

Sets the border radius for arcs

Default

0

# Inherited from

DoughnutControllerDatasetOptions.borderRadius

# Defined in

types/index.d.ts:1853 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# circular

• circular: ScriptableAndArray<boolean, ScriptableContext<"doughnut">>

If false, Arc will be flat.

Default

true

# Inherited from

DoughnutControllerDatasetOptions.circular

# Defined in

types/index.d.ts:1864 (opens new window)

# circumference

• circumference: number

Sweep to allow arcs to cover.

Default

360

# Inherited from

DoughnutControllerDatasetOptions.circumference

# Defined in

types/index.d.ts:257 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

DoughnutControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

DoughnutControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderDash

# Defined in

types/index.d.ts:1873 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1874 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverOffset

• hoverOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverOffset

# Defined in

types/index.d.ts:1875 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

DoughnutControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

DoughnutControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

DoughnutControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# offset

• offset: number | number[]

Arc offset (in pixels).

# Inherited from

DoughnutControllerDatasetOptions.offset

# Defined in

types/index.d.ts:262 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

DoughnutControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

DoughnutControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# rotation

• rotation: number

Starting angle to draw this dataset from.

Default

0

# Inherited from

DoughnutControllerDatasetOptions.rotation

# Defined in

types/index.d.ts:268 (opens new window)

# spacing

• spacing: number

Similar to the offset option, but applies to all arcs. This can be used to to add spaces -between arcs

Default

0

# Inherited from

DoughnutControllerDatasetOptions.spacing

# Defined in

types/index.d.ts:281 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

DoughnutControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# transitions

• transitions: TransitionsSpec<"doughnut">

# Inherited from

DoughnutControllerDatasetOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# weight

• weight: number

The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.

Default

1

# Inherited from

DoughnutControllerDatasetOptions.weight

# Defined in

types/index.d.ts:274 (opens new window)

+ (opens new window)

# Interface: PolarAreaControllerDatasetOptions

# Hierarchy

# Properties

# angle

• angle: number

Arc angle to cover. - for polar only

Default

circumference / (arc count)

# Defined in

types/index.d.ts:377 (opens new window)

# animation

• animation: false | AnimationSpec<"doughnut"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

DoughnutControllerDatasetOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"doughnut">

# Inherited from

DoughnutControllerDatasetOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderAlign

• borderAlign: ScriptableAndArray<"center" | "inner", ScriptableContext<"doughnut">>

Arc stroke alignment.

# Inherited from

DoughnutControllerDatasetOptions.borderAlign

# Defined in

types/index.d.ts:1833 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

Line dash. See MDN.

Default

[]

# Inherited from

DoughnutControllerDatasetOptions.borderDash

# Defined in

types/index.d.ts:1838 (opens new window)

# borderDashOffset

• borderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

DoughnutControllerDatasetOptions.borderDashOffset

# Defined in

types/index.d.ts:1843 (opens new window)

# borderJoinStyle

• borderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"doughnut">>

Line join style. See MDN. Default is 'round' when borderAlign is 'inner', else 'bevel'.

# Inherited from

DoughnutControllerDatasetOptions.borderJoinStyle

# Defined in

types/index.d.ts:1847 (opens new window)

# borderRadius

• borderRadius: ScriptableAndArray<number | ArcBorderRadius, ScriptableContext<"doughnut">>

Sets the border radius for arcs

Default

0

# Inherited from

DoughnutControllerDatasetOptions.borderRadius

# Defined in

types/index.d.ts:1853 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# circular

• circular: ScriptableAndArray<boolean, ScriptableContext<"doughnut">>

If false, Arc will be flat.

Default

true

# Inherited from

DoughnutControllerDatasetOptions.circular

# Defined in

types/index.d.ts:1864 (opens new window)

# circumference

• circumference: number

Sweep to allow arcs to cover.

Default

360

# Inherited from

DoughnutControllerDatasetOptions.circumference

# Defined in

types/index.d.ts:257 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

DoughnutControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

DoughnutControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: ScriptableAndArray<number[], ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderDash

# Defined in

types/index.d.ts:1873 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1874 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverOffset

• hoverOffset: ScriptableAndArray<number, ScriptableContext<"doughnut">>

# Inherited from

DoughnutControllerDatasetOptions.hoverOffset

# Defined in

types/index.d.ts:1875 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

DoughnutControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

DoughnutControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

DoughnutControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# offset

• offset: number | number[]

Arc offset (in pixels).

# Inherited from

DoughnutControllerDatasetOptions.offset

# Defined in

types/index.d.ts:262 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

DoughnutControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

DoughnutControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# rotation

• rotation: number

Starting angle to draw this dataset from.

Default

0

# Inherited from

DoughnutControllerDatasetOptions.rotation

# Defined in

types/index.d.ts:268 (opens new window)

# spacing

• spacing: number

Similar to the offset option, but applies to all arcs. This can be used to to add spaces +between arcs

Default

0

# Inherited from

DoughnutControllerDatasetOptions.spacing

# Defined in

types/index.d.ts:281 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

DoughnutControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# transitions

• transitions: TransitionsSpec<"doughnut">

# Inherited from

DoughnutControllerDatasetOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# weight

• weight: number

The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.

Default

1

# Inherited from

DoughnutControllerDatasetOptions.weight

# Defined in

types/index.d.ts:274 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/RadarControllerDatasetOptions.html b/docs/master/api/interfaces/RadarControllerDatasetOptions.html index 9f087fe4d6..b2faf8766a 100644 --- a/docs/master/api/interfaces/RadarControllerDatasetOptions.html +++ b/docs/master/api/interfaces/RadarControllerDatasetOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: RadarControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"radar"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"radar">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderCapStyle

• borderCapStyle: ScriptableAndArray<CanvasLineCap, ScriptableContext<"radar">>

Line cap style. See MDN.

Default

'butt'

# Inherited from

ScriptableAndArrayOptions.borderCapStyle

# Defined in

types/index.d.ts:1887 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: ScriptableAndArray<number[], ScriptableContext<"radar">>

Line dash. See MDN.

Default

[]

# Inherited from

ScriptableAndArrayOptions.borderDash

# Defined in

types/index.d.ts:1892 (opens new window)

# borderDashOffset

• borderDashOffset: ScriptableAndArray<number, ScriptableContext<"radar">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

ScriptableAndArrayOptions.borderDashOffset

# Defined in

types/index.d.ts:1897 (opens new window)

# borderJoinStyle

• borderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"radar">>

Line join style. See MDN.

Default

'miter'

# Inherited from

ScriptableAndArrayOptions.borderJoinStyle

# Defined in

types/index.d.ts:1902 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# capBezierPoints

• capBezierPoints: ScriptableAndArray<boolean, ScriptableContext<"radar">>

true to keep Bézier control inside the chart, false for no restriction.

Default

true

# Inherited from

ScriptableAndArrayOptions.capBezierPoints

# Defined in

types/index.d.ts:1907 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# cubicInterpolationMode

• cubicInterpolationMode: ScriptableAndArray<"default" | "monotone", ScriptableContext<"radar">>

Interpolation mode to apply.

Default

'default'

# Inherited from

ScriptableAndArrayOptions.cubicInterpolationMode

# Defined in

types/index.d.ts:1912 (opens new window)

# drawActiveElementsOnTop

• drawActiveElementsOnTop: ScriptableAndArray<boolean, ScriptableContext<"radar">>

Draw the active elements over the other elements of the dataset,

Default

true

# Inherited from

ScriptableAndArrayOptions.drawActiveElementsOnTop

# Defined in

types/index.d.ts:2008 (opens new window)

# fill

• fill: ScriptableAndArray<FillTarget | ComplexFillTarget, ScriptableContext<"radar">>

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Inherited from

ScriptableAndArrayOptions.fill

# Defined in

types/index.d.ts:1926 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hitRadius

• hitRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

Extra radius added to point radius for hit detection.

Default

1

# Inherited from

ScriptableAndArrayOptions.hitRadius

# Defined in

types/index.d.ts:1993 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderCapStyle

• hoverBorderCapStyle: ScriptableAndArray<CanvasLineCap, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderCapStyle

# Defined in

types/index.d.ts:1944 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: ScriptableAndArray<number[], ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDash

# Defined in

types/index.d.ts:1945 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: ScriptableAndArray<number, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1946 (opens new window)

# hoverBorderJoinStyle

• hoverBorderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderJoinStyle

# Defined in

types/index.d.ts:1947 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverRadius

• hoverRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

Point radius when hovered.

Default

4

# Inherited from

ScriptableAndArrayOptions.hoverRadius

# Defined in

types/index.d.ts:2016 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointBackgroundColor

• pointBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

The fill color for points.

# Inherited from

ScriptableAndArrayOptions.pointBackgroundColor

# Defined in

types/index.d.ts:2023 (opens new window)

# pointBorderColor

• pointBorderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

The border color for points.

# Inherited from

ScriptableAndArrayOptions.pointBorderColor

# Defined in

types/index.d.ts:2027 (opens new window)

# pointBorderWidth

• pointBorderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

The width of the point border in pixels.

# Inherited from

ScriptableAndArrayOptions.pointBorderWidth

# Defined in

types/index.d.ts:2031 (opens new window)

# pointHitRadius

• pointHitRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

The pixel size of the non-displayed point that reacts to mouse events.

# Inherited from

ScriptableAndArrayOptions.pointHitRadius

# Defined in

types/index.d.ts:2035 (opens new window)

# pointHoverBackgroundColor

• pointHoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

Point background color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBackgroundColor

# Defined in

types/index.d.ts:2054 (opens new window)

# pointHoverBorderColor

• pointHoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

Point border color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderColor

# Defined in

types/index.d.ts:2058 (opens new window)

# pointHoverBorderWidth

• pointHoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

Border width of point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderWidth

# Defined in

types/index.d.ts:2062 (opens new window)

# pointHoverRadius

• pointHoverRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

The radius of the point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverRadius

# Defined in

types/index.d.ts:2066 (opens new window)

# pointRadius

• pointRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

The radius of the point shape. If set to 0, the point is not rendered.

# Inherited from

ScriptableAndArrayOptions.pointRadius

# Defined in

types/index.d.ts:2039 (opens new window)

# pointRotation

• pointRotation: ScriptableAndArray<number, ScriptableContext<"radar">>

The rotation of the point in degrees.

# Inherited from

ScriptableAndArrayOptions.pointRotation

# Defined in

types/index.d.ts:2043 (opens new window)

# pointStyle

• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<"radar">>

Point style

Default

'circle;

# Inherited from

ScriptableAndArrayOptions.pointStyle

# Defined in

types/index.d.ts:1998 (opens new window)

types/index.d.ts:2047 (opens new window)

# radius

• radius: ScriptableAndArray<number, ScriptableContext<"radar">>

Point radius

Default

3

# Inherited from

ScriptableAndArrayOptions.radius

# Defined in

types/index.d.ts:1988 (opens new window)

# rotation

• rotation: ScriptableAndArray<number, ScriptableContext<"radar">>

Point rotation (in degrees).

Default

0

# Inherited from

ScriptableAndArrayOptions.rotation

# Defined in

types/index.d.ts:2003 (opens new window)

# segment

• segment: ScriptableAndArray<{ backgroundColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderCapStyle: Scriptable<CanvasLineCap, ScriptableLineSegmentContext> ; borderColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderDash: Scriptable<number[], ScriptableLineSegmentContext> ; borderDashOffset: Scriptable<number, ScriptableLineSegmentContext> ; borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableLineSegmentContext> ; borderWidth: Scriptable<number, ScriptableLineSegmentContext> }, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.segment

# Defined in

types/index.d.ts:1932 (opens new window)

# showLine

• showLine: boolean

If false, the line is not drawn for this dataset.

# Defined in

types/index.d.ts:422 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

# Overrides

ScriptableAndArrayOptions.spanGaps

# Defined in

types/index.d.ts:417 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# stepped

• stepped: ScriptableAndArray<boolean | "middle" | "after" | "before", ScriptableContext<"radar">>

true to show the line as a stepped line (tension will be ignored).

Default

false

# Inherited from

ScriptableAndArrayOptions.stepped

# Defined in

types/index.d.ts:1922 (opens new window)

# tension

• tension: ScriptableAndArray<number, ScriptableContext<"radar">>

Bézier curve tension (0 for no Bézier curves).

Default

0

# Inherited from

ScriptableAndArrayOptions.tension

# Defined in

types/index.d.ts:1917 (opens new window)

# transitions

• transitions: TransitionsSpec<"radar">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:408 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:412 (opens new window)

+ (opens new window)

# Interface: RadarControllerDatasetOptions

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<"radar"> & { onComplete?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void ; onProgress?: (this: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, event: AnimationEvent) => void }

# Inherited from

AnimationOptions.animation

# Defined in

types/index.d.ts:1747 (opens new window)

# animations

• animations: AnimationsSpec<"radar">

# Inherited from

AnimationOptions.animations

# Defined in

types/index.d.ts:1757 (opens new window)

# backgroundColor

• backgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.backgroundColor

# Defined in

types/index.d.ts:1807 (opens new window)

# borderCapStyle

• borderCapStyle: ScriptableAndArray<CanvasLineCap, ScriptableContext<"radar">>

Line cap style. See MDN.

Default

'butt'

# Inherited from

ScriptableAndArrayOptions.borderCapStyle

# Defined in

types/index.d.ts:1887 (opens new window)

# borderColor

• borderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.borderColor

# Defined in

types/index.d.ts:1806 (opens new window)

# borderDash

• borderDash: ScriptableAndArray<number[], ScriptableContext<"radar">>

Line dash. See MDN.

Default

[]

# Inherited from

ScriptableAndArrayOptions.borderDash

# Defined in

types/index.d.ts:1892 (opens new window)

# borderDashOffset

• borderDashOffset: ScriptableAndArray<number, ScriptableContext<"radar">>

Line dash offset. See MDN.

Default

0.0

# Inherited from

ScriptableAndArrayOptions.borderDashOffset

# Defined in

types/index.d.ts:1897 (opens new window)

# borderJoinStyle

• borderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"radar">>

Line join style. See MDN.

Default

'miter'

# Inherited from

ScriptableAndArrayOptions.borderJoinStyle

# Defined in

types/index.d.ts:1902 (opens new window)

# borderWidth

• borderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.borderWidth

# Defined in

types/index.d.ts:1805 (opens new window)

# capBezierPoints

• capBezierPoints: ScriptableAndArray<boolean, ScriptableContext<"radar">>

true to keep Bézier control inside the chart, false for no restriction.

Default

true

# Inherited from

ScriptableAndArrayOptions.capBezierPoints

# Defined in

types/index.d.ts:1907 (opens new window)

# clip

• clip: number | false | ChartArea

How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}

# Inherited from

ControllerDatasetOptions.clip

# Defined in

types/index.d.ts:75 (opens new window)

# cubicInterpolationMode

• cubicInterpolationMode: ScriptableAndArray<"default" | "monotone", ScriptableContext<"radar">>

Interpolation mode to apply.

Default

'default'

# Inherited from

ScriptableAndArrayOptions.cubicInterpolationMode

# Defined in

types/index.d.ts:1912 (opens new window)

# drawActiveElementsOnTop

• drawActiveElementsOnTop: ScriptableAndArray<boolean, ScriptableContext<"radar">>

Draw the active elements over the other elements of the dataset,

Default

true

# Inherited from

ScriptableAndArrayOptions.drawActiveElementsOnTop

# Defined in

types/index.d.ts:2008 (opens new window)

# fill

• fill: ScriptableAndArray<FillTarget | ComplexFillTarget, ScriptableContext<"radar">>

Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end

# Inherited from

ScriptableAndArrayOptions.fill

# Defined in

types/index.d.ts:1926 (opens new window)

# hidden

• hidden: boolean

Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.

Default

false

# Inherited from

ControllerDatasetOptions.hidden

# Defined in

types/index.d.ts:93 (opens new window)

# hitRadius

• hitRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

Extra radius added to point radius for hit detection.

Default

1

# Inherited from

ScriptableAndArrayOptions.hitRadius

# Defined in

types/index.d.ts:1993 (opens new window)

# hoverBackgroundColor

• hoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBackgroundColor

# Defined in

types/index.d.ts:1813 (opens new window)

# hoverBorderCapStyle

• hoverBorderCapStyle: ScriptableAndArray<CanvasLineCap, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderCapStyle

# Defined in

types/index.d.ts:1944 (opens new window)

# hoverBorderColor

• hoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderColor

# Defined in

types/index.d.ts:1812 (opens new window)

# hoverBorderDash

• hoverBorderDash: ScriptableAndArray<number[], ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDash

# Defined in

types/index.d.ts:1945 (opens new window)

# hoverBorderDashOffset

• hoverBorderDashOffset: ScriptableAndArray<number, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderDashOffset

# Defined in

types/index.d.ts:1946 (opens new window)

# hoverBorderJoinStyle

• hoverBorderJoinStyle: ScriptableAndArray<CanvasLineJoin, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderJoinStyle

# Defined in

types/index.d.ts:1947 (opens new window)

# hoverBorderWidth

• hoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.hoverBorderWidth

# Defined in

types/index.d.ts:1811 (opens new window)

# hoverRadius

• hoverRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

Point radius when hovered.

Default

4

# Inherited from

ScriptableAndArrayOptions.hoverRadius

# Defined in

types/index.d.ts:2016 (opens new window)

# indexAxis

• indexAxis: "x" | "y"

The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.

Default

'x'

# Inherited from

ControllerDatasetOptions.indexAxis

# Defined in

types/index.d.ts:71 (opens new window)

# label

• label: string

The label for the dataset which appears in the legend and tooltips.

# Inherited from

ControllerDatasetOptions.label

# Defined in

types/index.d.ts:79 (opens new window)

# normalized

• normalized: boolean

Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.

# Inherited from

ControllerDatasetOptions.normalized

# Defined in

types/index.d.ts:63 (opens new window)

# order

• order: number

The drawing order of dataset. Also affects order for stacking, tooltip and legend.

# Inherited from

ControllerDatasetOptions.order

# Defined in

types/index.d.ts:83 (opens new window)

# parsing

• parsing: false | { [key: string]: string; }

How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.

# Inherited from

ControllerDatasetOptions.parsing

# Defined in

types/index.d.ts:54 (opens new window)

# pointBackgroundColor

• pointBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

The fill color for points.

# Inherited from

ScriptableAndArrayOptions.pointBackgroundColor

# Defined in

types/index.d.ts:2023 (opens new window)

# pointBorderColor

• pointBorderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

The border color for points.

# Inherited from

ScriptableAndArrayOptions.pointBorderColor

# Defined in

types/index.d.ts:2027 (opens new window)

# pointBorderWidth

• pointBorderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

The width of the point border in pixels.

# Inherited from

ScriptableAndArrayOptions.pointBorderWidth

# Defined in

types/index.d.ts:2031 (opens new window)

# pointHitRadius

• pointHitRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

The pixel size of the non-displayed point that reacts to mouse events.

# Inherited from

ScriptableAndArrayOptions.pointHitRadius

# Defined in

types/index.d.ts:2035 (opens new window)

# pointHoverBackgroundColor

• pointHoverBackgroundColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

Point background color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBackgroundColor

# Defined in

types/index.d.ts:2054 (opens new window)

# pointHoverBorderColor

• pointHoverBorderColor: ScriptableAndArray<Color, ScriptableContext<"radar">>

Point border color when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderColor

# Defined in

types/index.d.ts:2058 (opens new window)

# pointHoverBorderWidth

• pointHoverBorderWidth: ScriptableAndArray<number, ScriptableContext<"radar">>

Border width of point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverBorderWidth

# Defined in

types/index.d.ts:2062 (opens new window)

# pointHoverRadius

• pointHoverRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

The radius of the point when hovered.

# Inherited from

ScriptableAndArrayOptions.pointHoverRadius

# Defined in

types/index.d.ts:2066 (opens new window)

# pointRadius

• pointRadius: ScriptableAndArray<number, ScriptableContext<"radar">>

The radius of the point shape. If set to 0, the point is not rendered.

# Inherited from

ScriptableAndArrayOptions.pointRadius

# Defined in

types/index.d.ts:2039 (opens new window)

# pointRotation

• pointRotation: ScriptableAndArray<number, ScriptableContext<"radar">>

The rotation of the point in degrees.

# Inherited from

ScriptableAndArrayOptions.pointRotation

# Defined in

types/index.d.ts:2043 (opens new window)

# pointStyle

• pointStyle: ScriptableAndArray<PointStyle, ScriptableContext<"radar">>

Point style

Default

'circle;

# Inherited from

ScriptableAndArrayOptions.pointStyle

# Defined in

types/index.d.ts:1998 (opens new window)

types/index.d.ts:2047 (opens new window)

# radius

• radius: ScriptableAndArray<number, ScriptableContext<"radar">>

Point radius

Default

3

# Inherited from

ScriptableAndArrayOptions.radius

# Defined in

types/index.d.ts:1988 (opens new window)

# rotation

• rotation: ScriptableAndArray<number, ScriptableContext<"radar">>

Point rotation (in degrees).

Default

0

# Inherited from

ScriptableAndArrayOptions.rotation

# Defined in

types/index.d.ts:2003 (opens new window)

# segment

• segment: ScriptableAndArray<{ backgroundColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderCapStyle: Scriptable<CanvasLineCap, ScriptableLineSegmentContext> ; borderColor: Scriptable<Color, ScriptableLineSegmentContext> ; borderDash: Scriptable<number[], ScriptableLineSegmentContext> ; borderDashOffset: Scriptable<number, ScriptableLineSegmentContext> ; borderJoinStyle: Scriptable<CanvasLineJoin, ScriptableLineSegmentContext> ; borderWidth: Scriptable<number, ScriptableLineSegmentContext> }, ScriptableContext<"radar">>

# Inherited from

ScriptableAndArrayOptions.segment

# Defined in

types/index.d.ts:1932 (opens new window)

# showLine

• showLine: boolean

If false, the line is not drawn for this dataset.

# Defined in

types/index.d.ts:422 (opens new window)

# spanGaps

• spanGaps: number | boolean

If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.

# Overrides

ScriptableAndArrayOptions.spanGaps

# Defined in

types/index.d.ts:417 (opens new window)

# stack

• stack: string

The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).

# Inherited from

ControllerDatasetOptions.stack

# Defined in

types/index.d.ts:88 (opens new window)

# stepped

• stepped: ScriptableAndArray<boolean | "middle" | "after" | "before", ScriptableContext<"radar">>

true to show the line as a stepped line (tension will be ignored).

Default

false

# Inherited from

ScriptableAndArrayOptions.stepped

# Defined in

types/index.d.ts:1922 (opens new window)

# tension

• tension: ScriptableAndArray<number, ScriptableContext<"radar">>

Bézier curve tension (0 for no Bézier curves).

Default

0

# Inherited from

ScriptableAndArrayOptions.tension

# Defined in

types/index.d.ts:1917 (opens new window)

# transitions

• transitions: TransitionsSpec<"radar">

# Inherited from

AnimationOptions.transitions

# Defined in

types/index.d.ts:1758 (opens new window)

# xAxisID

• xAxisID: string

The ID of the x axis to plot this dataset on.

# Defined in

types/index.d.ts:408 (opens new window)

# yAxisID

• yAxisID: string

The ID of the y axis to plot this dataset on.

# Defined in

types/index.d.ts:412 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/RadialLinearScale.html b/docs/master/api/interfaces/RadialLinearScale.html index e1e0813a83..51c90363df 100644 --- a/docs/master/api/interfaces/RadialLinearScale.html +++ b/docs/master/api/interfaces/RadialLinearScale.html @@ -7,7 +7,7 @@ - + @@ -39,12 +39,12 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: RadialLinearScale<O>

# Type parameters

Name Type
O extends RadialLinearScaleOptions = RadialLinearScaleOptions

# Hierarchy

  • Scale<O>

    ↳ RadialLinearScale

# Properties

# $animations

• $animations: Record<never, Animation>

# Inherited from

Scale.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Scale.active

# Defined in

core/core.element.ts:13 (opens new window)

# axis

• axis: string

# Inherited from

Scale.axis

# Defined in

types/index.d.ts:1276 (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

types/layout.d.ts:41 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

Scale.chart

# Defined in

types/index.d.ts:1266 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Inherited from

Scale.ctx

# Defined in

types/index.d.ts:1265 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

Scale.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

Scale.height

# Defined in

types/layout.d.ts:25 (opens new window)

# id

• Readonly id: string

# Inherited from

Scale.id

# Defined in

types/index.d.ts:1263 (opens new window)

# labelRotation

• labelRotation: number

# Inherited from

Scale.labelRotation

# Defined in

types/index.d.ts:1277 (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

types/layout.d.ts:29 (opens new window)

# max

• max: number

# Inherited from

Scale.max

# Defined in

types/index.d.ts:1279 (opens new window)

# maxHeight

• maxHeight: number

# Inherited from

Scale.maxHeight

# Defined in

types/index.d.ts:1269 (opens new window)

# maxWidth

• maxWidth: number

# Inherited from

Scale.maxWidth

# Defined in

types/index.d.ts:1268 (opens new window)

# min

• min: number

# Inherited from

Scale.min

# Defined in

types/index.d.ts:1278 (opens new window)

# options

• options: O

# Inherited from

Scale.options

# Defined in

core/core.element.ts:14 (opens new window)

# paddingBottom

• paddingBottom: number

# Inherited from

Scale.paddingBottom

# Defined in

types/index.d.ts:1272 (opens new window)

# paddingLeft

• paddingLeft: number

# Inherited from

Scale.paddingLeft

# Defined in

types/index.d.ts:1273 (opens new window)

# paddingRight

• paddingRight: number

# Inherited from

Scale.paddingRight

# Defined in

types/index.d.ts:1274 (opens new window)

# paddingTop

• paddingTop: number

# Inherited from

Scale.paddingTop

# Defined in

types/index.d.ts:1271 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

Scale.position

# Defined in

types/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

types/layout.d.ts:37 (opens new window)

# ticks

• ticks: Tick[]

# Inherited from

Scale.ticks

# Defined in

types/index.d.ts:1280 (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

types/layout.d.ts:33 (opens new window)

# type

• Readonly type: string

# Inherited from

Scale.type

# Defined in

types/index.d.ts:1264 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

Scale.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Scale.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Scale.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(): void

# Returns

void

# Inherited from

Scale.afterBuildTicks

# Defined in

types/index.d.ts:1361 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.afterCalculateLabelRotation

# Defined in

types/index.d.ts:1367 (opens new window)

# afterDataLimits

▸ afterDataLimits(): void

# Returns

void

# Inherited from

Scale.afterDataLimits

# Defined in

types/index.d.ts:1358 (opens new window)

# afterFit

▸ afterFit(): void

# Returns

void

# Inherited from

Scale.afterFit

# Defined in

types/index.d.ts:1370 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(): void

# Returns

void

# Inherited from

Scale.afterSetDimensions

# Defined in

types/index.d.ts:1355 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.afterTickToLabelConversion

# Defined in

types/index.d.ts:1364 (opens new window)

# afterUpdate

▸ afterUpdate(): void

# Returns

void

# Inherited from

Scale.afterUpdate

# Defined in

types/index.d.ts:1352 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(): void

# Returns

void

# Inherited from

Scale.beforeBuildTicks

# Defined in

types/index.d.ts:1359 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.beforeCalculateLabelRotation

# Defined in

types/index.d.ts:1365 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(): void

# Returns

void

# Inherited from

Scale.beforeDataLimits

# Defined in

types/index.d.ts:1356 (opens new window)

# beforeFit

▸ beforeFit(): void

# Returns

void

# Inherited from

Scale.beforeFit

# Defined in

types/index.d.ts:1368 (opens new window)

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

Scale.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(): void

# Returns

void

# Inherited from

Scale.beforeSetDimensions

# Defined in

types/index.d.ts:1353 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.beforeTickToLabelConversion

# Defined in

types/index.d.ts:1362 (opens new window)

# beforeUpdate

▸ beforeUpdate(): void

# Returns

void

# Inherited from

Scale.beforeUpdate

# Defined in

types/index.d.ts:1350 (opens new window)

# buildTicks

▸ buildTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.buildTicks

# Defined in

types/index.d.ts:1360 (opens new window)

# calculateLabelRotation

▸ calculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.calculateLabelRotation

# Defined in

types/index.d.ts:1366 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

Scale.configure

# Defined in

types/index.d.ts:1351 (opens new window)

# determineDataLimits

▸ determineDataLimits(): void

# Returns

void

# Inherited from

Scale.determineDataLimits

# Defined in

types/index.d.ts:1357 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# drawGrid

▸ drawGrid(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawGrid

# Defined in

types/index.d.ts:1285 (opens new window)

# drawLabels

▸ drawLabels(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawLabels

# Defined in

types/index.d.ts:1284 (opens new window)

# drawTitle

▸ drawTitle(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawTitle

# Defined in

types/index.d.ts:1283 (opens new window)

# fit

▸ fit(): void

# Returns

void

# Inherited from

Scale.fit

# Defined in

types/index.d.ts:1369 (opens new window)

# generateTickLabels

▸ generateTickLabels(ticks): void

# Parameters

Name Type
ticks Tick[]

# Returns

void

# Inherited from

Scale.generateTickLabels

# Defined in

types/index.d.ts:1363 (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.getBasePixel

# Defined in

types/index.d.ts:1341 (opens new window)

# getBasePosition

▸ getBasePosition(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
angle number
x number
y number

# Defined in

types/index.d.ts:3591 (opens new window)

# getBaseValue

▸ getBaseValue(): number

# Returns

number

# Inherited from

Scale.getBaseValue

# Defined in

types/index.d.ts:1335 (opens new window)

# getDecimalForPixel

▸ getDecimalForPixel(pixel): number

# Parameters

Name Type
pixel number

# Returns

number

# Inherited from

Scale.getDecimalForPixel

# Defined in

types/index.d.ts:1291 (opens new window)

# getDistanceFromCenterForValue

▸ getDistanceFromCenterForValue(value): number

# Parameters

Name Type
value number

# Returns

number

# Defined in

types/index.d.ts:3586 (opens new window)

# getIndexAngle

▸ getIndexAngle(index): number

# Parameters

Name Type
index number

# Returns

number

# Defined in

types/index.d.ts:3585 (opens new window)

# 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

# Inherited from

Scale.getLabelForValue

# Defined in

types/index.d.ts:1311 (opens new window)

# getLabelItems

▸ getLabelItems(chartArea?): LabelItem[]

# Parameters

Name Type
chartArea? ChartArea

# Returns

LabelItem[]

# Inherited from

Scale.getLabelItems

# Defined in

types/index.d.ts:1349 (opens new window)

# getLabels

▸ getLabels(): string[]

# Returns

string[]

# Inherited from

Scale.getLabels

# Defined in

types/index.d.ts:1348 (opens new window)

# getLineWidthForValue

▸ getLineWidthForValue(value): number

Returns the grid line width at given value

# Parameters

Name Type
value number

# Returns

number

# Inherited from

Scale.getLineWidthForValue

# Defined in

types/index.d.ts:1316 (opens new window)

# 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>>[]

# Inherited from

Scale.getMatchingVisibleMetas

# Defined in

types/index.d.ts:1281 (opens new window)

# getMinMax

▸ getMinMax(canStack): Object

# Parameters

Name Type
canStack boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

Scale.getMinMax

# Defined in

types/index.d.ts:1346 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

Scale.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# 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

Scale.getPixelForDecimal

# Defined in

types/index.d.ts:1298 (opens new window)

# 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

Scale.getPixelForTick

# Defined in

types/index.d.ts:1305 (opens new window)

# 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

Scale.getPixelForValue

# Defined in

types/index.d.ts:1325 (opens new window)

# getPointLabelPosition

▸ getPointLabelPosition(index): ChartArea

# Parameters

Name Type
index number

# Returns

ChartArea

# Defined in

types/index.d.ts:3590 (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

types/index.d.ts:3588 (opens new window)

# getPointPositionForValue

▸ getPointPositionForValue(index, value): Object

# Parameters

Name Type
index number
value number

# Returns

Object

Name Type
angle number
x number
y number

# Defined in

types/index.d.ts:3589 (opens new window)

# 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

Scale.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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

Scale.getProps

# Defined in

core/core.element.ts:32 (opens new window)

# getTicks

▸ getTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.getTicks

# Defined in

types/index.d.ts:1347 (opens new window)

# getUserBounds

▸ getUserBounds(): Object

# Returns

Object

Name Type
max number
maxDefined boolean
min number
minDefined boolean

# Inherited from

Scale.getUserBounds

# Defined in

types/index.d.ts:1345 (opens new window)

# getValueForDistanceFromCenter

▸ getValueForDistanceFromCenter(distance): number

# Parameters

Name Type
distance number

# Returns

number

# Defined in

types/index.d.ts:3587 (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

Scale.getValueForPixel

# Defined in

types/index.d.ts:1333 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Scale.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# init

▸ init(options): void

# Parameters

Name Type
options O

# Returns

void

# Inherited from

Scale.init

# Defined in

types/index.d.ts:1343 (opens new window)

# isFullSize

▸ isFullSize(): boolean

# Returns

boolean

# Inherited from

Scale.isFullSize

# Defined in

types/index.d.ts:1372 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

Scale.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# parse

▸ parse(raw, index?): unknown

# Parameters

Name Type
raw unknown
index? number

# Returns

unknown

# Inherited from

Scale.parse

# Defined in

types/index.d.ts:1344 (opens new window)

# setCenterPoint

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

# Parameters

Name Type
leftMovement number
rightMovement number
topMovement number
bottomMovement number

# Returns

void

# Defined in

types/index.d.ts:3584 (opens new window)

# setDimensions

▸ setDimensions(): void

# Returns

void

# Inherited from

Scale.setDimensions

# Defined in

types/index.d.ts:1354 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Scale.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

Scale.update

# Defined in

types/layout.d.ts:64 (opens new window)

+ (opens new window)

# Interface: RadialLinearScale<O>

# Type parameters

Name Type
O extends RadialLinearScaleOptions = RadialLinearScaleOptions

# Hierarchy

  • Scale<O>

    ↳ RadialLinearScale

# Properties

# $animations

• $animations: Record<never, Animation>

# Inherited from

Scale.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Scale.active

# Defined in

core/core.element.ts:13 (opens new window)

# axis

• axis: string

# Inherited from

Scale.axis

# Defined in

types/index.d.ts:1276 (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

types/layout.d.ts:41 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

Scale.chart

# Defined in

types/index.d.ts:1266 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Inherited from

Scale.ctx

# Defined in

types/index.d.ts:1265 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

Scale.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

Scale.height

# Defined in

types/layout.d.ts:25 (opens new window)

# id

• Readonly id: string

# Inherited from

Scale.id

# Defined in

types/index.d.ts:1263 (opens new window)

# labelRotation

• labelRotation: number

# Inherited from

Scale.labelRotation

# Defined in

types/index.d.ts:1277 (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

types/layout.d.ts:29 (opens new window)

# max

• max: number

# Inherited from

Scale.max

# Defined in

types/index.d.ts:1279 (opens new window)

# maxHeight

• maxHeight: number

# Inherited from

Scale.maxHeight

# Defined in

types/index.d.ts:1269 (opens new window)

# maxWidth

• maxWidth: number

# Inherited from

Scale.maxWidth

# Defined in

types/index.d.ts:1268 (opens new window)

# min

• min: number

# Inherited from

Scale.min

# Defined in

types/index.d.ts:1278 (opens new window)

# options

• options: O

# Inherited from

Scale.options

# Defined in

core/core.element.ts:14 (opens new window)

# paddingBottom

• paddingBottom: number

# Inherited from

Scale.paddingBottom

# Defined in

types/index.d.ts:1272 (opens new window)

# paddingLeft

• paddingLeft: number

# Inherited from

Scale.paddingLeft

# Defined in

types/index.d.ts:1273 (opens new window)

# paddingRight

• paddingRight: number

# Inherited from

Scale.paddingRight

# Defined in

types/index.d.ts:1274 (opens new window)

# paddingTop

• paddingTop: number

# Inherited from

Scale.paddingTop

# Defined in

types/index.d.ts:1271 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

Scale.position

# Defined in

types/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

types/layout.d.ts:37 (opens new window)

# ticks

• ticks: Tick[]

# Inherited from

Scale.ticks

# Defined in

types/index.d.ts:1280 (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

types/layout.d.ts:33 (opens new window)

# type

• Readonly type: string

# Inherited from

Scale.type

# Defined in

types/index.d.ts:1264 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

Scale.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Scale.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Scale.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(): void

# Returns

void

# Inherited from

Scale.afterBuildTicks

# Defined in

types/index.d.ts:1361 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.afterCalculateLabelRotation

# Defined in

types/index.d.ts:1367 (opens new window)

# afterDataLimits

▸ afterDataLimits(): void

# Returns

void

# Inherited from

Scale.afterDataLimits

# Defined in

types/index.d.ts:1358 (opens new window)

# afterFit

▸ afterFit(): void

# Returns

void

# Inherited from

Scale.afterFit

# Defined in

types/index.d.ts:1370 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(): void

# Returns

void

# Inherited from

Scale.afterSetDimensions

# Defined in

types/index.d.ts:1355 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.afterTickToLabelConversion

# Defined in

types/index.d.ts:1364 (opens new window)

# afterUpdate

▸ afterUpdate(): void

# Returns

void

# Inherited from

Scale.afterUpdate

# Defined in

types/index.d.ts:1352 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(): void

# Returns

void

# Inherited from

Scale.beforeBuildTicks

# Defined in

types/index.d.ts:1359 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.beforeCalculateLabelRotation

# Defined in

types/index.d.ts:1365 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(): void

# Returns

void

# Inherited from

Scale.beforeDataLimits

# Defined in

types/index.d.ts:1356 (opens new window)

# beforeFit

▸ beforeFit(): void

# Returns

void

# Inherited from

Scale.beforeFit

# Defined in

types/index.d.ts:1368 (opens new window)

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

Scale.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(): void

# Returns

void

# Inherited from

Scale.beforeSetDimensions

# Defined in

types/index.d.ts:1353 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.beforeTickToLabelConversion

# Defined in

types/index.d.ts:1362 (opens new window)

# beforeUpdate

▸ beforeUpdate(): void

# Returns

void

# Inherited from

Scale.beforeUpdate

# Defined in

types/index.d.ts:1350 (opens new window)

# buildTicks

▸ buildTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.buildTicks

# Defined in

types/index.d.ts:1360 (opens new window)

# calculateLabelRotation

▸ calculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.calculateLabelRotation

# Defined in

types/index.d.ts:1366 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

Scale.configure

# Defined in

types/index.d.ts:1351 (opens new window)

# determineDataLimits

▸ determineDataLimits(): void

# Returns

void

# Inherited from

Scale.determineDataLimits

# Defined in

types/index.d.ts:1357 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# drawGrid

▸ drawGrid(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawGrid

# Defined in

types/index.d.ts:1285 (opens new window)

# drawLabels

▸ drawLabels(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawLabels

# Defined in

types/index.d.ts:1284 (opens new window)

# drawTitle

▸ drawTitle(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawTitle

# Defined in

types/index.d.ts:1283 (opens new window)

# fit

▸ fit(): void

# Returns

void

# Inherited from

Scale.fit

# Defined in

types/index.d.ts:1369 (opens new window)

# generateTickLabels

▸ generateTickLabels(ticks): void

# Parameters

Name Type
ticks Tick[]

# Returns

void

# Inherited from

Scale.generateTickLabels

# Defined in

types/index.d.ts:1363 (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.getBasePixel

# Defined in

types/index.d.ts:1341 (opens new window)

# getBasePosition

▸ getBasePosition(index): Object

# Parameters

Name Type
index number

# Returns

Object

Name Type
angle number
x number
y number

# Defined in

types/index.d.ts:3591 (opens new window)

# getBaseValue

▸ getBaseValue(): number

# Returns

number

# Inherited from

Scale.getBaseValue

# Defined in

types/index.d.ts:1335 (opens new window)

# getDecimalForPixel

▸ getDecimalForPixel(pixel): number

# Parameters

Name Type
pixel number

# Returns

number

# Inherited from

Scale.getDecimalForPixel

# Defined in

types/index.d.ts:1291 (opens new window)

# getDistanceFromCenterForValue

▸ getDistanceFromCenterForValue(value): number

# Parameters

Name Type
value number

# Returns

number

# Defined in

types/index.d.ts:3586 (opens new window)

# getIndexAngle

▸ getIndexAngle(index): number

# Parameters

Name Type
index number

# Returns

number

# Defined in

types/index.d.ts:3585 (opens new window)

# 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

# Inherited from

Scale.getLabelForValue

# Defined in

types/index.d.ts:1311 (opens new window)

# getLabelItems

▸ getLabelItems(chartArea?): LabelItem[]

# Parameters

Name Type
chartArea? ChartArea

# Returns

LabelItem[]

# Inherited from

Scale.getLabelItems

# Defined in

types/index.d.ts:1349 (opens new window)

# getLabels

▸ getLabels(): string[]

# Returns

string[]

# Inherited from

Scale.getLabels

# Defined in

types/index.d.ts:1348 (opens new window)

# getLineWidthForValue

▸ getLineWidthForValue(value): number

Returns the grid line width at given value

# Parameters

Name Type
value number

# Returns

number

# Inherited from

Scale.getLineWidthForValue

# Defined in

types/index.d.ts:1316 (opens new window)

# 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>>[]

# Inherited from

Scale.getMatchingVisibleMetas

# Defined in

types/index.d.ts:1281 (opens new window)

# getMinMax

▸ getMinMax(canStack): Object

# Parameters

Name Type
canStack boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

Scale.getMinMax

# Defined in

types/index.d.ts:1346 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

Scale.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# 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

Scale.getPixelForDecimal

# Defined in

types/index.d.ts:1298 (opens new window)

# 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

Scale.getPixelForTick

# Defined in

types/index.d.ts:1305 (opens new window)

# 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

Scale.getPixelForValue

# Defined in

types/index.d.ts:1325 (opens new window)

# getPointLabelPosition

▸ getPointLabelPosition(index): ChartArea

# Parameters

Name Type
index number

# Returns

ChartArea

# Defined in

types/index.d.ts:3590 (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

types/index.d.ts:3588 (opens new window)

# getPointPositionForValue

▸ getPointPositionForValue(index, value): Object

# Parameters

Name Type
index number
value number

# Returns

Object

Name Type
angle number
x number
y number

# Defined in

types/index.d.ts:3589 (opens new window)

# 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

Scale.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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

Scale.getProps

# Defined in

core/core.element.ts:32 (opens new window)

# getTicks

▸ getTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.getTicks

# Defined in

types/index.d.ts:1347 (opens new window)

# getUserBounds

▸ getUserBounds(): Object

# Returns

Object

Name Type
max number
maxDefined boolean
min number
minDefined boolean

# Inherited from

Scale.getUserBounds

# Defined in

types/index.d.ts:1345 (opens new window)

# getValueForDistanceFromCenter

▸ getValueForDistanceFromCenter(distance): number

# Parameters

Name Type
distance number

# Returns

number

# Defined in

types/index.d.ts:3587 (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

Scale.getValueForPixel

# Defined in

types/index.d.ts:1333 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Scale.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# init

▸ init(options): void

# Parameters

Name Type
options O

# Returns

void

# Inherited from

Scale.init

# Defined in

types/index.d.ts:1343 (opens new window)

# isFullSize

▸ isFullSize(): boolean

# Returns

boolean

# Inherited from

Scale.isFullSize

# Defined in

types/index.d.ts:1372 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

Scale.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# parse

▸ parse(raw, index?): unknown

# Parameters

Name Type
raw unknown
index? number

# Returns

unknown

# Inherited from

Scale.parse

# Defined in

types/index.d.ts:1344 (opens new window)

# setCenterPoint

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

# Parameters

Name Type
leftMovement number
rightMovement number
topMovement number
bottomMovement number

# Returns

void

# Defined in

types/index.d.ts:3584 (opens new window)

# setDimensions

▸ setDimensions(): void

# Returns

void

# Inherited from

Scale.setDimensions

# Defined in

types/index.d.ts:1354 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Scale.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

Scale.update

# Defined in

types/layout.d.ts:64 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/RadialScaleTypeRegistry.html b/docs/master/api/interfaces/RadialScaleTypeRegistry.html index 72823b020d..3d6578cbf3 100644 --- a/docs/master/api/interfaces/RadialScaleTypeRegistry.html +++ b/docs/master/api/interfaces/RadialScaleTypeRegistry.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: RadialScaleTypeRegistry

# Hierarchy

# Properties

# radialLinear

• radialLinear: Object

# Type declaration

Name Type
options RadialLinearScaleOptions

# Defined in

types/index.d.ts:3617 (opens new window)

+ (opens new window)

# Interface: RadialScaleTypeRegistry

# Hierarchy

# Properties

# radialLinear

• radialLinear: Object

# Type declaration

Name Type
options RadialLinearScaleOptions

# Defined in

types/index.d.ts:3617 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/Registry.html b/docs/master/api/interfaces/Registry.html index 4929261ead..356c38a121 100644 --- a/docs/master/api/interfaces/Registry.html +++ b/docs/master/api/interfaces/Registry.html @@ -7,7 +7,7 @@ - + @@ -40,7 +40,7 @@ (opens new window) GitHub (opens new window)

# Interface: Registry

Please use the module's default export which provides a singleton instance -Note: class is exported for typedoc

# Properties

# controllers

• Readonly controllers: TypedRegistry<DatasetController<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>, number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData>>

# Defined in

types/index.d.ts:1132 (opens new window)

# elements

• Readonly elements: TypedRegistry<default<AnyObject, AnyObject>>

# Defined in

types/index.d.ts:1133 (opens new window)

# plugins

• Readonly plugins: TypedRegistry<Plugin<keyof ChartTypeRegistry, AnyObject>>

# Defined in

types/index.d.ts:1134 (opens new window)

# scales

• Readonly scales: TypedRegistry<Scale<CoreScaleOptions>>

# Defined in

types/index.d.ts:1135 (opens new window)

# Methods

# add

▸ add(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1137 (opens new window)

# addControllers

▸ addControllers(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1140 (opens new window)

# addElements

▸ addElements(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1141 (opens new window)

# addPlugins

▸ addPlugins(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1142 (opens new window)

# addScales

▸ addScales(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1143 (opens new window)

# getController

▸ getController(id): DatasetController<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>, number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData>

# Parameters

Name Type
id string

# Returns

DatasetController<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>, number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData>

# Defined in

types/index.d.ts:1145 (opens new window)

# getElement

▸ getElement(id): default<AnyObject, AnyObject>

# Parameters

Name Type
id string

# Returns

default<AnyObject, AnyObject>

# Defined in

types/index.d.ts:1146 (opens new window)

# getPlugin

▸ getPlugin(id): Plugin<keyof ChartTypeRegistry, AnyObject>

# Parameters

Name Type
id string

# Returns

Plugin<keyof ChartTypeRegistry, AnyObject>

# Defined in

types/index.d.ts:1147 (opens new window)

# getScale

▸ getScale(id): Scale<CoreScaleOptions>

# Parameters

Name Type
id string

# Returns

Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:1148 (opens new window)

# remove

▸ remove(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1138 (opens new window)

+Note: class is exported for typedoc

# Properties

# controllers

• Readonly controllers: TypedRegistry<DatasetController<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>, number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData>>

# Defined in

types/index.d.ts:1132 (opens new window)

# elements

• Readonly elements: TypedRegistry<default<AnyObject, AnyObject>>

# Defined in

types/index.d.ts:1133 (opens new window)

# plugins

• Readonly plugins: TypedRegistry<Plugin<keyof ChartTypeRegistry, AnyObject>>

# Defined in

types/index.d.ts:1134 (opens new window)

# scales

• Readonly scales: TypedRegistry<Scale<CoreScaleOptions>>

# Defined in

types/index.d.ts:1135 (opens new window)

# Methods

# add

▸ add(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1137 (opens new window)

# addControllers

▸ addControllers(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1140 (opens new window)

# addElements

▸ addElements(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1141 (opens new window)

# addPlugins

▸ addPlugins(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1142 (opens new window)

# addScales

▸ addScales(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1143 (opens new window)

# getController

▸ getController(id): DatasetController<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>, number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData>

# Parameters

Name Type
id string

# Returns

DatasetController<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>, number | CartesianParsedData | BarParsedData | BubbleParsedData | RadialParsedData>

# Defined in

types/index.d.ts:1145 (opens new window)

# getElement

▸ getElement(id): default<AnyObject, AnyObject>

# Parameters

Name Type
id string

# Returns

default<AnyObject, AnyObject>

# Defined in

types/index.d.ts:1146 (opens new window)

# getPlugin

▸ getPlugin(id): Plugin<keyof ChartTypeRegistry, AnyObject>

# Parameters

Name Type
id string

# Returns

Plugin<keyof ChartTypeRegistry, AnyObject>

# Defined in

types/index.d.ts:1147 (opens new window)

# getScale

▸ getScale(id): Scale<CoreScaleOptions>

# Parameters

Name Type
id string

# Returns

Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:1148 (opens new window)

# remove

▸ remove(...args): void

# Parameters

Name Type
...args ChartComponentLike[]

# Returns

void

# Defined in

types/index.d.ts:1138 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/RenderTextOpts.html b/docs/master/api/interfaces/RenderTextOpts.html index 5fd809ebb6..a402dd07f4 100644 --- a/docs/master/api/interfaces/RenderTextOpts.html +++ b/docs/master/api/interfaces/RenderTextOpts.html @@ -7,7 +7,7 @@ - + @@ -39,13 +39,13 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: RenderTextOpts

# Properties

# backdrop

• Optional backdrop: BackdropOptions

Dimensions for drawing the label backdrop

# Defined in

types/index.d.ts:1459 (opens new window)

# color

• Optional color: Color

The fill color of the text. If unset, the existing -fillStyle property of the canvas is unchanged.

# Defined in

types/index.d.ts:1398 (opens new window)

# decorationWidth

• Optional decorationWidth: number

The width of the strikethrough / underline

Default

2

# Defined in

types/index.d.ts:1404 (opens new window)

# maxWidth

• Optional maxWidth: number

The max width of the text in pixels

# Defined in

types/index.d.ts:1409 (opens new window)

# rotation

• Optional rotation: number

A rotation to be applied to the canvas -This is applied after the translation is applied

# Defined in

types/index.d.ts:1415 (opens new window)

# strikethrough

• Optional strikethrough: boolean

Apply a strikethrough effect to the text

# Defined in

types/index.d.ts:1420 (opens new window)

# strokeColor

• Optional strokeColor: Color

The color of the text stroke. If unset, the existing -strokeStyle property of the context is unchanged

# Defined in

types/index.d.ts:1426 (opens new window)

# strokeWidth

• Optional strokeWidth: number

The text stroke width. If unset, the existing -lineWidth property of the context is unchanged

# Defined in

types/index.d.ts:1432 (opens new window)

# textAlign

• Optional textAlign: CanvasTextAlign

The text alignment to use. If unset, the existing -textAlign property of the context is unchanged

# Defined in

types/index.d.ts:1438 (opens new window)

# textBaseline

• Optional textBaseline: CanvasTextBaseline

The text baseline to use. If unset, the existing -textBaseline property of the context is unchanged

# Defined in

types/index.d.ts:1444 (opens new window)

# translation

• Optional translation: [number, number]

If specified, a translation to apply to the context

# Defined in

types/index.d.ts:1449 (opens new window)

# underline

• Optional underline: boolean

Underline the text

# Defined in

types/index.d.ts:1454 (opens new window)

+ (opens new window)

# Interface: RenderTextOpts

# Properties

# backdrop

• Optional backdrop: BackdropOptions

Dimensions for drawing the label backdrop

# Defined in

types/index.d.ts:1459 (opens new window)

# color

• Optional color: Color

The fill color of the text. If unset, the existing +fillStyle property of the canvas is unchanged.

# Defined in

types/index.d.ts:1398 (opens new window)

# decorationWidth

• Optional decorationWidth: number

The width of the strikethrough / underline

Default

2

# Defined in

types/index.d.ts:1404 (opens new window)

# maxWidth

• Optional maxWidth: number

The max width of the text in pixels

# Defined in

types/index.d.ts:1409 (opens new window)

# rotation

• Optional rotation: number

A rotation to be applied to the canvas +This is applied after the translation is applied

# Defined in

types/index.d.ts:1415 (opens new window)

# strikethrough

• Optional strikethrough: boolean

Apply a strikethrough effect to the text

# Defined in

types/index.d.ts:1420 (opens new window)

# strokeColor

• Optional strokeColor: Color

The color of the text stroke. If unset, the existing +strokeStyle property of the context is unchanged

# Defined in

types/index.d.ts:1426 (opens new window)

# strokeWidth

• Optional strokeWidth: number

The text stroke width. If unset, the existing +lineWidth property of the context is unchanged

# Defined in

types/index.d.ts:1432 (opens new window)

# textAlign

• Optional textAlign: CanvasTextAlign

The text alignment to use. If unset, the existing +textAlign property of the context is unchanged

# Defined in

types/index.d.ts:1438 (opens new window)

# textBaseline

• Optional textBaseline: CanvasTextBaseline

The text baseline to use. If unset, the existing +textBaseline property of the context is unchanged

# Defined in

types/index.d.ts:1444 (opens new window)

# translation

• Optional translation: [number, number]

If specified, a translation to apply to the context

# Defined in

types/index.d.ts:1449 (opens new window)

# underline

• Optional underline: boolean

Underline the text

# Defined in

types/index.d.ts:1454 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScaleTypeRegistry.html b/docs/master/api/interfaces/ScaleTypeRegistry.html index ef96f8133f..acd9afa899 100644 --- a/docs/master/api/interfaces/ScaleTypeRegistry.html +++ b/docs/master/api/interfaces/ScaleTypeRegistry.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScaleTypeRegistry

# Hierarchy

# Properties

# category

• category: Object

# Type declaration

Name Type
options CategoryScaleOptions

# Inherited from

CartesianScaleTypeRegistry.category

# Defined in

types/index.d.ts:3605 (opens new window)

# linear

• linear: Object

# Type declaration

Name Type
options LinearScaleOptions

# Inherited from

CartesianScaleTypeRegistry.linear

# Defined in

types/index.d.ts:3599 (opens new window)

# logarithmic

• logarithmic: Object

# Type declaration

Name Type
options LogarithmicScaleOptions

# Inherited from

CartesianScaleTypeRegistry.logarithmic

# Defined in

types/index.d.ts:3602 (opens new window)

# radialLinear

• radialLinear: Object

# Type declaration

Name Type
options RadialLinearScaleOptions

# Inherited from

RadialScaleTypeRegistry.radialLinear

# Defined in

types/index.d.ts:3617 (opens new window)

# time

• time: Object

# Type declaration

Name Type
options TimeScaleOptions

# Inherited from

CartesianScaleTypeRegistry.time

# Defined in

types/index.d.ts:3608 (opens new window)

# timeseries

• timeseries: Object

# Type declaration

Name Type
options TimeScaleOptions

# Inherited from

CartesianScaleTypeRegistry.timeseries

# Defined in

types/index.d.ts:3611 (opens new window)

+ (opens new window)

# Interface: ScaleTypeRegistry

# Hierarchy

# Properties

# category

• category: Object

# Type declaration

Name Type
options CategoryScaleOptions

# Inherited from

CartesianScaleTypeRegistry.category

# Defined in

types/index.d.ts:3605 (opens new window)

# linear

• linear: Object

# Type declaration

Name Type
options LinearScaleOptions

# Inherited from

CartesianScaleTypeRegistry.linear

# Defined in

types/index.d.ts:3599 (opens new window)

# logarithmic

• logarithmic: Object

# Type declaration

Name Type
options LogarithmicScaleOptions

# Inherited from

CartesianScaleTypeRegistry.logarithmic

# Defined in

types/index.d.ts:3602 (opens new window)

# radialLinear

• radialLinear: Object

# Type declaration

Name Type
options RadialLinearScaleOptions

# Inherited from

RadialScaleTypeRegistry.radialLinear

# Defined in

types/index.d.ts:3617 (opens new window)

# time

• time: Object

# Type declaration

Name Type
options TimeScaleOptions

# Inherited from

CartesianScaleTypeRegistry.time

# Defined in

types/index.d.ts:3608 (opens new window)

# timeseries

• timeseries: Object

# Type declaration

Name Type
options TimeScaleOptions

# Inherited from

CartesianScaleTypeRegistry.timeseries

# Defined in

types/index.d.ts:3611 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScriptableCartesianScaleContext.html b/docs/master/api/interfaces/ScriptableCartesianScaleContext.html index 644caaf789..dd8c73b95a 100644 --- a/docs/master/api/interfaces/ScriptableCartesianScaleContext.html +++ b/docs/master/api/interfaces/ScriptableCartesianScaleContext.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScriptableCartesianScaleContext

# Properties

# scale

• scale: keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3159 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:3160 (opens new window)

+ (opens new window)

# Interface: ScriptableCartesianScaleContext

# Properties

# scale

• scale: keyof CartesianScaleTypeRegistry

# Defined in

types/index.d.ts:3159 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:3160 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScriptableChartContext.html b/docs/master/api/interfaces/ScriptableChartContext.html index 7d77900708..044ba86fb7 100644 --- a/docs/master/api/interfaces/ScriptableChartContext.html +++ b/docs/master/api/interfaces/ScriptableChartContext.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScriptableChartContext

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:3164 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:3165 (opens new window)

+ (opens new window)

# Interface: ScriptableChartContext

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:3164 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:3165 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScriptableContext.html b/docs/master/api/interfaces/ScriptableContext.html index ef298b51b2..c5d78ec837 100644 --- a/docs/master/api/interfaces/ScriptableContext.html +++ b/docs/master/api/interfaces/ScriptableContext.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScriptableContext<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# active

• active: boolean

# Defined in

types/index.d.ts:24 (opens new window)

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:25 (opens new window)

# dataIndex

• dataIndex: number

# Defined in

types/index.d.ts:26 (opens new window)

# dataset

• dataset: UnionToIntersection<ChartDataset<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>>>

# Defined in

types/index.d.ts:27 (opens new window)

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:28 (opens new window)

# mode

• mode: string

# Defined in

types/index.d.ts:30 (opens new window)

# parsed

• parsed: UnionToIntersection<ParsedDataType<TType>>

# Defined in

types/index.d.ts:31 (opens new window)

# raw

• raw: unknown

# Defined in

types/index.d.ts:32 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:29 (opens new window)

+ (opens new window)

# Interface: ScriptableContext<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# active

• active: boolean

# Defined in

types/index.d.ts:24 (opens new window)

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:25 (opens new window)

# dataIndex

• dataIndex: number

# Defined in

types/index.d.ts:26 (opens new window)

# dataset

• dataset: UnionToIntersection<ChartDataset<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>>>

# Defined in

types/index.d.ts:27 (opens new window)

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:28 (opens new window)

# mode

• mode: string

# Defined in

types/index.d.ts:30 (opens new window)

# parsed

• parsed: UnionToIntersection<ParsedDataType<TType>>

# Defined in

types/index.d.ts:31 (opens new window)

# raw

• raw: unknown

# Defined in

types/index.d.ts:32 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:29 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScriptableLineSegmentContext.html b/docs/master/api/interfaces/ScriptableLineSegmentContext.html index 6a0c016e3c..a7c54b6cba 100644 --- a/docs/master/api/interfaces/ScriptableLineSegmentContext.html +++ b/docs/master/api/interfaces/ScriptableLineSegmentContext.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScriptableLineSegmentContext

# Properties

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:41 (opens new window)

# p0

• p0: PointElement

# Defined in

types/index.d.ts:37 (opens new window)

# p0DataIndex

• p0DataIndex: number

# Defined in

types/index.d.ts:39 (opens new window)

# p1

• p1: PointElement

# Defined in

types/index.d.ts:38 (opens new window)

# p1DataIndex

• p1DataIndex: number

# Defined in

types/index.d.ts:40 (opens new window)

# type

• type: "segment"

# Defined in

types/index.d.ts:36 (opens new window)

+ (opens new window)

# Interface: ScriptableLineSegmentContext

# Properties

# datasetIndex

• datasetIndex: number

# Defined in

types/index.d.ts:41 (opens new window)

# p0

• p0: PointElement

# Defined in

types/index.d.ts:37 (opens new window)

# p0DataIndex

• p0DataIndex: number

# Defined in

types/index.d.ts:39 (opens new window)

# p1

• p1: PointElement

# Defined in

types/index.d.ts:38 (opens new window)

# p1DataIndex

• p1DataIndex: number

# Defined in

types/index.d.ts:40 (opens new window)

# type

• type: "segment"

# Defined in

types/index.d.ts:36 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScriptableScaleContext.html b/docs/master/api/interfaces/ScriptableScaleContext.html index 225a5147b8..6c004133ee 100644 --- a/docs/master/api/interfaces/ScriptableScaleContext.html +++ b/docs/master/api/interfaces/ScriptableScaleContext.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScriptableScaleContext

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:1379 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:1381 (opens new window)

# scale

• scale: Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:1380 (opens new window)

# tick

• tick: Tick

# Defined in

types/index.d.ts:1382 (opens new window)

+ (opens new window)

# Interface: ScriptableScaleContext

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:1379 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:1381 (opens new window)

# scale

• scale: Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:1380 (opens new window)

# tick

• tick: Tick

# Defined in

types/index.d.ts:1382 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScriptableScalePointLabelContext.html b/docs/master/api/interfaces/ScriptableScalePointLabelContext.html index 3d0dbd95d2..fff4f8c0fe 100644 --- a/docs/master/api/interfaces/ScriptableScalePointLabelContext.html +++ b/docs/master/api/interfaces/ScriptableScalePointLabelContext.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScriptableScalePointLabelContext

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:1386 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:1388 (opens new window)

# label

• label: string

# Defined in

types/index.d.ts:1389 (opens new window)

# scale

• scale: Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:1387 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:1390 (opens new window)

+ (opens new window)

# Interface: ScriptableScalePointLabelContext

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Defined in

types/index.d.ts:1386 (opens new window)

# index

• index: number

# Defined in

types/index.d.ts:1388 (opens new window)

# label

• label: string

# Defined in

types/index.d.ts:1389 (opens new window)

# scale

• scale: Scale<CoreScaleOptions>

# Defined in

types/index.d.ts:1387 (opens new window)

# type

• type: string

# Defined in

types/index.d.ts:1390 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/ScriptableTooltipContext.html b/docs/master/api/interfaces/ScriptableTooltipContext.html index 272fc90c78..d141e0ce8d 100644 --- a/docs/master/api/interfaces/ScriptableTooltipContext.html +++ b/docs/master/api/interfaces/ScriptableTooltipContext.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: ScriptableTooltipContext<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# chart

• chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>

# Defined in

types/index.d.ts:2709 (opens new window)

# tooltip

• tooltip: TooltipModel<TType>

# Defined in

types/index.d.ts:2710 (opens new window)

# tooltipItems

• tooltipItems: TooltipItem<TType>[]

# Defined in

types/index.d.ts:2711 (opens new window)

+ (opens new window)

# Interface: ScriptableTooltipContext<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# chart

• chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>

# Defined in

types/index.d.ts:2709 (opens new window)

# tooltip

• tooltip: TooltipModel<TType>

# Defined in

types/index.d.ts:2710 (opens new window)

# tooltipItems

• tooltipItems: TooltipItem<TType>[]

# Defined in

types/index.d.ts:2711 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/Segment.html b/docs/master/api/interfaces/Segment.html index 69d406e12c..88490fcb2e 100644 --- a/docs/master/api/interfaces/Segment.html +++ b/docs/master/api/interfaces/Segment.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: Segment

# Properties

# end

• end: number

# Defined in

types/index.d.ts:1818 (opens new window)

# loop

• loop: boolean

# Defined in

types/index.d.ts:1819 (opens new window)

# start

• start: number

# Defined in

types/index.d.ts:1817 (opens new window)

+ (opens new window)

# Interface: Segment

# Properties

# end

• end: number

# Defined in

types/index.d.ts:1818 (opens new window)

# loop

• loop: boolean

# Defined in

types/index.d.ts:1819 (opens new window)

# start

• start: number

# Defined in

types/index.d.ts:1817 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/Tick.html b/docs/master/api/interfaces/Tick.html index 05a15b1885..bb6dfef3a8 100644 --- a/docs/master/api/interfaces/Tick.html +++ b/docs/master/api/interfaces/Tick.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: Tick

# Properties

# label

• Optional label: string | string[]

# Defined in

types/index.d.ts:1155 (opens new window)

# major

• Optional major: boolean

# Defined in

types/index.d.ts:1156 (opens new window)

# value

• value: number

# Defined in

types/index.d.ts:1154 (opens new window)

+ (opens new window)

# Interface: Tick

# Properties

# label

• Optional label: string | string[]

# Defined in

types/index.d.ts:1155 (opens new window)

# major

• Optional major: boolean

# Defined in

types/index.d.ts:1156 (opens new window)

# value

• value: number

# Defined in

types/index.d.ts:1154 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TickOptions.html b/docs/master/api/interfaces/TickOptions.html index bdd32d0740..71a7d972f0 100644 --- a/docs/master/api/interfaces/TickOptions.html +++ b/docs/master/api/interfaces/TickOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TickOptions

# Properties

# backdropColor

• backdropColor: Scriptable<Color, ScriptableScaleContext>

Color of label backdrops.

Default

'rgba(255, 255, 255, 0.75)'

# Defined in

types/index.d.ts:3031 (opens new window)

# backdropPadding

• backdropPadding: number | ChartArea

Padding of tick backdrop.

Default

2

# Defined in

types/index.d.ts:3036 (opens new window)

# callback

• callback: (this: Scale<CoreScaleOptions>, tickValue: string | number, index: number, ticks: Tick[]) => string | number | string[] | number[]

# Type declaration

▸ (this, tickValue, index, ticks): string | number | string[] | number[]

Returns the string representation of the tick value as it should be displayed on the chart. See callback.

# Parameters
Name Type
this Scale<CoreScaleOptions>
tickValue string | number
index number
ticks Tick[]
# Returns

string | number | string[] | number[]

# Defined in

types/index.d.ts:3041 (opens new window)

# color

• color: ScriptableAndArray<Color, ScriptableScaleContext>

Color of tick

See

Defaults.color

# Defined in

types/index.d.ts:3051 (opens new window)

# display

• display: boolean

If true, show tick labels.

Default

true

# Defined in

types/index.d.ts:3046 (opens new window)

# font

• font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScaleContext>

see Fonts

# Defined in

types/index.d.ts:3055 (opens new window)

# major

• major: Object

# Type declaration

Name Type Description
enabled boolean If true, major ticks are generated. A major tick will affect autoskipping and major will be defined on ticks in the scriptable options context. Default false

# Defined in

types/index.d.ts:3081 (opens new window)

# padding

• padding: number

Sets the offset of the tick labels from the axis

# Defined in

types/index.d.ts:3059 (opens new window)

# showLabelBackdrop

• showLabelBackdrop: Scriptable<boolean, ScriptableScaleContext>

If true, draw a background behind the tick labels.

Default

false

# Defined in

types/index.d.ts:3064 (opens new window)

# textStrokeColor

• textStrokeColor: Scriptable<Color, ScriptableScaleContext>

The color of the stroke around the text.

Default

undefined

# Defined in

types/index.d.ts:3069 (opens new window)

# textStrokeWidth

• textStrokeWidth: Scriptable<number, ScriptableScaleContext>

Stroke width around the text.

Default

0

# Defined in

types/index.d.ts:3074 (opens new window)

# z

• z: number

z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.

Default

0

# Defined in

types/index.d.ts:3079 (opens new window)

+ (opens new window)

# Interface: TickOptions

# Properties

# backdropColor

• backdropColor: Scriptable<Color, ScriptableScaleContext>

Color of label backdrops.

Default

'rgba(255, 255, 255, 0.75)'

# Defined in

types/index.d.ts:3031 (opens new window)

# backdropPadding

• backdropPadding: number | ChartArea

Padding of tick backdrop.

Default

2

# Defined in

types/index.d.ts:3036 (opens new window)

# callback

• callback: (this: Scale<CoreScaleOptions>, tickValue: string | number, index: number, ticks: Tick[]) => string | number | string[] | number[]

# Type declaration

▸ (this, tickValue, index, ticks): string | number | string[] | number[]

Returns the string representation of the tick value as it should be displayed on the chart. See callback.

# Parameters
Name Type
this Scale<CoreScaleOptions>
tickValue string | number
index number
ticks Tick[]
# Returns

string | number | string[] | number[]

# Defined in

types/index.d.ts:3041 (opens new window)

# color

• color: ScriptableAndArray<Color, ScriptableScaleContext>

Color of tick

See

Defaults.color

# Defined in

types/index.d.ts:3051 (opens new window)

# display

• display: boolean

If true, show tick labels.

Default

true

# Defined in

types/index.d.ts:3046 (opens new window)

# font

• font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableScaleContext>

see Fonts

# Defined in

types/index.d.ts:3055 (opens new window)

# major

• major: Object

# Type declaration

Name Type Description
enabled boolean If true, major ticks are generated. A major tick will affect autoskipping and major will be defined on ticks in the scriptable options context. Default false

# Defined in

types/index.d.ts:3081 (opens new window)

# padding

• padding: number

Sets the offset of the tick labels from the axis

# Defined in

types/index.d.ts:3059 (opens new window)

# showLabelBackdrop

• showLabelBackdrop: Scriptable<boolean, ScriptableScaleContext>

If true, draw a background behind the tick labels.

Default

false

# Defined in

types/index.d.ts:3064 (opens new window)

# textStrokeColor

• textStrokeColor: Scriptable<Color, ScriptableScaleContext>

The color of the stroke around the text.

Default

undefined

# Defined in

types/index.d.ts:3069 (opens new window)

# textStrokeWidth

• textStrokeWidth: Scriptable<number, ScriptableScaleContext>

Stroke width around the text.

Default

0

# Defined in

types/index.d.ts:3074 (opens new window)

# z

• z: number

z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.

Default

0

# Defined in

types/index.d.ts:3079 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TimeScale.html b/docs/master/api/interfaces/TimeScale.html index 9605a7d4a0..b312e79f56 100644 --- a/docs/master/api/interfaces/TimeScale.html +++ b/docs/master/api/interfaces/TimeScale.html @@ -7,7 +7,7 @@ - + @@ -39,12 +39,12 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TimeScale<O>

# Type parameters

Name Type
O extends TimeScaleOptions = TimeScaleOptions

# Hierarchy

# Properties

# $animations

• $animations: Record<never, Animation>

# Inherited from

Scale.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Scale.active

# Defined in

core/core.element.ts:13 (opens new window)

# axis

• axis: string

# Inherited from

Scale.axis

# Defined in

types/index.d.ts:1276 (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

types/layout.d.ts:41 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

Scale.chart

# Defined in

types/index.d.ts:1266 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Inherited from

Scale.ctx

# Defined in

types/index.d.ts:1265 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

Scale.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

Scale.height

# Defined in

types/layout.d.ts:25 (opens new window)

# id

• Readonly id: string

# Inherited from

Scale.id

# Defined in

types/index.d.ts:1263 (opens new window)

# labelRotation

• labelRotation: number

# Inherited from

Scale.labelRotation

# Defined in

types/index.d.ts:1277 (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

types/layout.d.ts:29 (opens new window)

# max

• max: number

# Inherited from

Scale.max

# Defined in

types/index.d.ts:1279 (opens new window)

# maxHeight

• maxHeight: number

# Inherited from

Scale.maxHeight

# Defined in

types/index.d.ts:1269 (opens new window)

# maxWidth

• maxWidth: number

# Inherited from

Scale.maxWidth

# Defined in

types/index.d.ts:1268 (opens new window)

# min

• min: number

# Inherited from

Scale.min

# Defined in

types/index.d.ts:1278 (opens new window)

# options

• options: O

# Inherited from

Scale.options

# Defined in

core/core.element.ts:14 (opens new window)

# paddingBottom

• paddingBottom: number

# Inherited from

Scale.paddingBottom

# Defined in

types/index.d.ts:1272 (opens new window)

# paddingLeft

• paddingLeft: number

# Inherited from

Scale.paddingLeft

# Defined in

types/index.d.ts:1273 (opens new window)

# paddingRight

• paddingRight: number

# Inherited from

Scale.paddingRight

# Defined in

types/index.d.ts:1274 (opens new window)

# paddingTop

• paddingTop: number

# Inherited from

Scale.paddingTop

# Defined in

types/index.d.ts:1271 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

Scale.position

# Defined in

types/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

types/layout.d.ts:37 (opens new window)

# ticks

• ticks: Tick[]

# Inherited from

Scale.ticks

# Defined in

types/index.d.ts:1280 (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

types/layout.d.ts:33 (opens new window)

# type

• Readonly type: string

# Inherited from

Scale.type

# Defined in

types/index.d.ts:1264 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

Scale.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Scale.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Scale.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(): void

# Returns

void

# Inherited from

Scale.afterBuildTicks

# Defined in

types/index.d.ts:1361 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.afterCalculateLabelRotation

# Defined in

types/index.d.ts:1367 (opens new window)

# afterDataLimits

▸ afterDataLimits(): void

# Returns

void

# Inherited from

Scale.afterDataLimits

# Defined in

types/index.d.ts:1358 (opens new window)

# afterFit

▸ afterFit(): void

# Returns

void

# Inherited from

Scale.afterFit

# Defined in

types/index.d.ts:1370 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(): void

# Returns

void

# Inherited from

Scale.afterSetDimensions

# Defined in

types/index.d.ts:1355 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.afterTickToLabelConversion

# Defined in

types/index.d.ts:1364 (opens new window)

# afterUpdate

▸ afterUpdate(): void

# Returns

void

# Inherited from

Scale.afterUpdate

# Defined in

types/index.d.ts:1352 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(): void

# Returns

void

# Inherited from

Scale.beforeBuildTicks

# Defined in

types/index.d.ts:1359 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.beforeCalculateLabelRotation

# Defined in

types/index.d.ts:1365 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(): void

# Returns

void

# Inherited from

Scale.beforeDataLimits

# Defined in

types/index.d.ts:1356 (opens new window)

# beforeFit

▸ beforeFit(): void

# Returns

void

# Inherited from

Scale.beforeFit

# Defined in

types/index.d.ts:1368 (opens new window)

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

Scale.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(): void

# Returns

void

# Inherited from

Scale.beforeSetDimensions

# Defined in

types/index.d.ts:1353 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.beforeTickToLabelConversion

# Defined in

types/index.d.ts:1362 (opens new window)

# beforeUpdate

▸ beforeUpdate(): void

# Returns

void

# Inherited from

Scale.beforeUpdate

# Defined in

types/index.d.ts:1350 (opens new window)

# buildTicks

▸ buildTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.buildTicks

# Defined in

types/index.d.ts:1360 (opens new window)

# calculateLabelRotation

▸ calculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.calculateLabelRotation

# Defined in

types/index.d.ts:1366 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

Scale.configure

# Defined in

types/index.d.ts:1351 (opens new window)

# determineDataLimits

▸ determineDataLimits(): void

# Returns

void

# Inherited from

Scale.determineDataLimits

# Defined in

types/index.d.ts:1357 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# drawGrid

▸ drawGrid(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawGrid

# Defined in

types/index.d.ts:1285 (opens new window)

# drawLabels

▸ drawLabels(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawLabels

# Defined in

types/index.d.ts:1284 (opens new window)

# drawTitle

▸ drawTitle(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawTitle

# Defined in

types/index.d.ts:1283 (opens new window)

# fit

▸ fit(): void

# Returns

void

# Inherited from

Scale.fit

# Defined in

types/index.d.ts:1369 (opens new window)

# format

▸ format(value, format?): string

# Parameters

Name Type
value number
format? string

# Returns

string

# Defined in

types/index.d.ts:3425 (opens new window)

# generateTickLabels

▸ generateTickLabels(ticks): void

# Parameters

Name Type
ticks Tick[]

# Returns

void

# Inherited from

Scale.generateTickLabels

# Defined in

types/index.d.ts:1363 (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.getBasePixel

# Defined in

types/index.d.ts:1341 (opens new window)

# getBaseValue

▸ getBaseValue(): number

# Returns

number

# Inherited from

Scale.getBaseValue

# Defined in

types/index.d.ts:1335 (opens new window)

# getDataTimestamps

▸ getDataTimestamps(): number[]

# Returns

number[]

# Defined in

types/index.d.ts:3426 (opens new window)

# getDecimalForPixel

▸ getDecimalForPixel(pixel): number

# Parameters

Name Type
pixel number

# Returns

number

# Inherited from

Scale.getDecimalForPixel

# Defined in

types/index.d.ts:1291 (opens new window)

# 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

# Inherited from

Scale.getLabelForValue

# Defined in

types/index.d.ts:1311 (opens new window)

# getLabelItems

▸ getLabelItems(chartArea?): LabelItem[]

# Parameters

Name Type
chartArea? ChartArea

# Returns

LabelItem[]

# Inherited from

Scale.getLabelItems

# Defined in

types/index.d.ts:1349 (opens new window)

# getLabelTimestamps

▸ getLabelTimestamps(): string[]

# Returns

string[]

# Defined in

types/index.d.ts:3427 (opens new window)

# getLabels

▸ getLabels(): string[]

# Returns

string[]

# Inherited from

Scale.getLabels

# Defined in

types/index.d.ts:1348 (opens new window)

# getLineWidthForValue

▸ getLineWidthForValue(value): number

Returns the grid line width at given value

# Parameters

Name Type
value number

# Returns

number

# Inherited from

Scale.getLineWidthForValue

# Defined in

types/index.d.ts:1316 (opens new window)

# 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>>[]

# Inherited from

Scale.getMatchingVisibleMetas

# Defined in

types/index.d.ts:1281 (opens new window)

# getMinMax

▸ getMinMax(canStack): Object

# Parameters

Name Type
canStack boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

Scale.getMinMax

# Defined in

types/index.d.ts:1346 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

Scale.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# 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

Scale.getPixelForDecimal

# Defined in

types/index.d.ts:1298 (opens new window)

# 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

Scale.getPixelForTick

# Defined in

types/index.d.ts:1305 (opens new window)

# 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

Scale.getPixelForValue

# Defined in

types/index.d.ts:1325 (opens new window)

# 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

Scale.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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

Scale.getProps

# Defined in

core/core.element.ts:32 (opens new window)

# getTicks

▸ getTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.getTicks

# Defined in

types/index.d.ts:1347 (opens new window)

# getUserBounds

▸ getUserBounds(): Object

# Returns

Object

Name Type
max number
maxDefined boolean
min number
minDefined boolean

# Inherited from

Scale.getUserBounds

# Defined in

types/index.d.ts:1345 (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

Scale.getValueForPixel

# Defined in

types/index.d.ts:1333 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Scale.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# init

▸ init(options): void

# Parameters

Name Type
options O

# Returns

void

# Inherited from

Scale.init

# Defined in

types/index.d.ts:1343 (opens new window)

# isFullSize

▸ isFullSize(): boolean

# Returns

boolean

# Inherited from

Scale.isFullSize

# Defined in

types/index.d.ts:1372 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

Scale.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# normalize

▸ normalize(values): number[]

# Parameters

Name Type
values number[]

# Returns

number[]

# Defined in

types/index.d.ts:3428 (opens new window)

# parse

▸ parse(raw, index?): unknown

# Parameters

Name Type
raw unknown
index? number

# Returns

unknown

# Inherited from

Scale.parse

# Defined in

types/index.d.ts:1344 (opens new window)

# setDimensions

▸ setDimensions(): void

# Returns

void

# Inherited from

Scale.setDimensions

# Defined in

types/index.d.ts:1354 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Scale.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

Scale.update

# Defined in

types/layout.d.ts:64 (opens new window)

+ (opens new window)

# Interface: TimeScale<O>

# Type parameters

Name Type
O extends TimeScaleOptions = TimeScaleOptions

# Hierarchy

# Properties

# $animations

• $animations: Record<never, Animation>

# Inherited from

Scale.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Scale.active

# Defined in

core/core.element.ts:13 (opens new window)

# axis

• axis: string

# Inherited from

Scale.axis

# Defined in

types/index.d.ts:1276 (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

types/layout.d.ts:41 (opens new window)

# chart

• Readonly chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

# Inherited from

Scale.chart

# Defined in

types/index.d.ts:1266 (opens new window)

# ctx

• Readonly ctx: CanvasRenderingContext2D

# Inherited from

Scale.ctx

# Defined in

types/index.d.ts:1265 (opens new window)

# fullSize

• fullSize: boolean

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

# Inherited from

Scale.fullSize

# Defined in

types/layout.d.ts:17 (opens new window)

# height

• height: number

Height of item. Must be valid after update()

# Inherited from

Scale.height

# Defined in

types/layout.d.ts:25 (opens new window)

# id

• Readonly id: string

# Inherited from

Scale.id

# Defined in

types/index.d.ts:1263 (opens new window)

# labelRotation

• labelRotation: number

# Inherited from

Scale.labelRotation

# Defined in

types/index.d.ts:1277 (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

types/layout.d.ts:29 (opens new window)

# max

• max: number

# Inherited from

Scale.max

# Defined in

types/index.d.ts:1279 (opens new window)

# maxHeight

• maxHeight: number

# Inherited from

Scale.maxHeight

# Defined in

types/index.d.ts:1269 (opens new window)

# maxWidth

• maxWidth: number

# Inherited from

Scale.maxWidth

# Defined in

types/index.d.ts:1268 (opens new window)

# min

• min: number

# Inherited from

Scale.min

# Defined in

types/index.d.ts:1278 (opens new window)

# options

• options: O

# Inherited from

Scale.options

# Defined in

core/core.element.ts:14 (opens new window)

# paddingBottom

• paddingBottom: number

# Inherited from

Scale.paddingBottom

# Defined in

types/index.d.ts:1272 (opens new window)

# paddingLeft

• paddingLeft: number

# Inherited from

Scale.paddingLeft

# Defined in

types/index.d.ts:1273 (opens new window)

# paddingRight

• paddingRight: number

# Inherited from

Scale.paddingRight

# Defined in

types/index.d.ts:1274 (opens new window)

# paddingTop

• paddingTop: number

# Inherited from

Scale.paddingTop

# Defined in

types/index.d.ts:1271 (opens new window)

# position

• position: LayoutPosition

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

# Inherited from

Scale.position

# Defined in

types/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

types/layout.d.ts:37 (opens new window)

# ticks

• ticks: Tick[]

# Inherited from

Scale.ticks

# Defined in

types/index.d.ts:1280 (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

types/layout.d.ts:33 (opens new window)

# type

• Readonly type: string

# Inherited from

Scale.type

# Defined in

types/index.d.ts:1264 (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

types/layout.d.ts:13 (opens new window)

# width

• width: number

Width of item. Must be valid after update()

# Inherited from

Scale.width

# Defined in

types/layout.d.ts:21 (opens new window)

# x

• x: number

# Inherited from

Scale.x

# Defined in

core/core.element.ts:11 (opens new window)

# y

• y: number

# Inherited from

Scale.y

# Defined in

core/core.element.ts:12 (opens new window)

# Methods

# afterBuildTicks

▸ afterBuildTicks(): void

# Returns

void

# Inherited from

Scale.afterBuildTicks

# Defined in

types/index.d.ts:1361 (opens new window)

# afterCalculateLabelRotation

▸ afterCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.afterCalculateLabelRotation

# Defined in

types/index.d.ts:1367 (opens new window)

# afterDataLimits

▸ afterDataLimits(): void

# Returns

void

# Inherited from

Scale.afterDataLimits

# Defined in

types/index.d.ts:1358 (opens new window)

# afterFit

▸ afterFit(): void

# Returns

void

# Inherited from

Scale.afterFit

# Defined in

types/index.d.ts:1370 (opens new window)

# afterSetDimensions

▸ afterSetDimensions(): void

# Returns

void

# Inherited from

Scale.afterSetDimensions

# Defined in

types/index.d.ts:1355 (opens new window)

# afterTickToLabelConversion

▸ afterTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.afterTickToLabelConversion

# Defined in

types/index.d.ts:1364 (opens new window)

# afterUpdate

▸ afterUpdate(): void

# Returns

void

# Inherited from

Scale.afterUpdate

# Defined in

types/index.d.ts:1352 (opens new window)

# beforeBuildTicks

▸ beforeBuildTicks(): void

# Returns

void

# Inherited from

Scale.beforeBuildTicks

# Defined in

types/index.d.ts:1359 (opens new window)

# beforeCalculateLabelRotation

▸ beforeCalculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.beforeCalculateLabelRotation

# Defined in

types/index.d.ts:1365 (opens new window)

# beforeDataLimits

▸ beforeDataLimits(): void

# Returns

void

# Inherited from

Scale.beforeDataLimits

# Defined in

types/index.d.ts:1356 (opens new window)

# beforeFit

▸ beforeFit(): void

# Returns

void

# Inherited from

Scale.beforeFit

# Defined in

types/index.d.ts:1368 (opens new window)

# beforeLayout

▸ Optional beforeLayout(): void

Called before the layout process starts

# Returns

void

# Inherited from

Scale.beforeLayout

# Defined in

types/layout.d.ts:46 (opens new window)

# beforeSetDimensions

▸ beforeSetDimensions(): void

# Returns

void

# Inherited from

Scale.beforeSetDimensions

# Defined in

types/index.d.ts:1353 (opens new window)

# beforeTickToLabelConversion

▸ beforeTickToLabelConversion(): void

# Returns

void

# Inherited from

Scale.beforeTickToLabelConversion

# Defined in

types/index.d.ts:1362 (opens new window)

# beforeUpdate

▸ beforeUpdate(): void

# Returns

void

# Inherited from

Scale.beforeUpdate

# Defined in

types/index.d.ts:1350 (opens new window)

# buildTicks

▸ buildTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.buildTicks

# Defined in

types/index.d.ts:1360 (opens new window)

# calculateLabelRotation

▸ calculateLabelRotation(): void

# Returns

void

# Inherited from

Scale.calculateLabelRotation

# Defined in

types/index.d.ts:1366 (opens new window)

# configure

▸ configure(): void

# Returns

void

# Inherited from

Scale.configure

# Defined in

types/index.d.ts:1351 (opens new window)

# determineDataLimits

▸ determineDataLimits(): void

# Returns

void

# Inherited from

Scale.determineDataLimits

# Defined in

types/index.d.ts:1357 (opens new window)

# draw

▸ draw(chartArea): void

Draws the element

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.draw

# Defined in

types/layout.d.ts:50 (opens new window)

# drawGrid

▸ drawGrid(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawGrid

# Defined in

types/index.d.ts:1285 (opens new window)

# drawLabels

▸ drawLabels(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawLabels

# Defined in

types/index.d.ts:1284 (opens new window)

# drawTitle

▸ drawTitle(chartArea): void

# Parameters

Name Type
chartArea ChartArea

# Returns

void

# Inherited from

Scale.drawTitle

# Defined in

types/index.d.ts:1283 (opens new window)

# fit

▸ fit(): void

# Returns

void

# Inherited from

Scale.fit

# Defined in

types/index.d.ts:1369 (opens new window)

# format

▸ format(value, format?): string

# Parameters

Name Type
value number
format? string

# Returns

string

# Defined in

types/index.d.ts:3425 (opens new window)

# generateTickLabels

▸ generateTickLabels(ticks): void

# Parameters

Name Type
ticks Tick[]

# Returns

void

# Inherited from

Scale.generateTickLabels

# Defined in

types/index.d.ts:1363 (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.getBasePixel

# Defined in

types/index.d.ts:1341 (opens new window)

# getBaseValue

▸ getBaseValue(): number

# Returns

number

# Inherited from

Scale.getBaseValue

# Defined in

types/index.d.ts:1335 (opens new window)

# getDataTimestamps

▸ getDataTimestamps(): number[]

# Returns

number[]

# Defined in

types/index.d.ts:3426 (opens new window)

# getDecimalForPixel

▸ getDecimalForPixel(pixel): number

# Parameters

Name Type
pixel number

# Returns

number

# Inherited from

Scale.getDecimalForPixel

# Defined in

types/index.d.ts:1291 (opens new window)

# 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

# Inherited from

Scale.getLabelForValue

# Defined in

types/index.d.ts:1311 (opens new window)

# getLabelItems

▸ getLabelItems(chartArea?): LabelItem[]

# Parameters

Name Type
chartArea? ChartArea

# Returns

LabelItem[]

# Inherited from

Scale.getLabelItems

# Defined in

types/index.d.ts:1349 (opens new window)

# getLabelTimestamps

▸ getLabelTimestamps(): string[]

# Returns

string[]

# Defined in

types/index.d.ts:3427 (opens new window)

# getLabels

▸ getLabels(): string[]

# Returns

string[]

# Inherited from

Scale.getLabels

# Defined in

types/index.d.ts:1348 (opens new window)

# getLineWidthForValue

▸ getLineWidthForValue(value): number

Returns the grid line width at given value

# Parameters

Name Type
value number

# Returns

number

# Inherited from

Scale.getLineWidthForValue

# Defined in

types/index.d.ts:1316 (opens new window)

# 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>>[]

# Inherited from

Scale.getMatchingVisibleMetas

# Defined in

types/index.d.ts:1281 (opens new window)

# getMinMax

▸ getMinMax(canStack): Object

# Parameters

Name Type
canStack boolean

# Returns

Object

Name Type
max number
min number

# Inherited from

Scale.getMinMax

# Defined in

types/index.d.ts:1346 (opens new window)

# getPadding

▸ Optional getPadding(): ChartArea

Returns an object with padding on the edges

# Returns

ChartArea

# Inherited from

Scale.getPadding

# Defined in

types/layout.d.ts:54 (opens new window)

# 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

Scale.getPixelForDecimal

# Defined in

types/index.d.ts:1298 (opens new window)

# 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

Scale.getPixelForTick

# Defined in

types/index.d.ts:1305 (opens new window)

# 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

Scale.getPixelForValue

# Defined in

types/index.d.ts:1325 (opens new window)

# 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

Scale.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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

Scale.getProps

# Defined in

core/core.element.ts:32 (opens new window)

# getTicks

▸ getTicks(): Tick[]

# Returns

Tick[]

# Inherited from

Scale.getTicks

# Defined in

types/index.d.ts:1347 (opens new window)

# getUserBounds

▸ getUserBounds(): Object

# Returns

Object

Name Type
max number
maxDefined boolean
min number
minDefined boolean

# Inherited from

Scale.getUserBounds

# Defined in

types/index.d.ts:1345 (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

Scale.getValueForPixel

# Defined in

types/index.d.ts:1333 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Scale.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# init

▸ init(options): void

# Parameters

Name Type
options O

# Returns

void

# Inherited from

Scale.init

# Defined in

types/index.d.ts:1343 (opens new window)

# isFullSize

▸ isFullSize(): boolean

# Returns

boolean

# Inherited from

Scale.isFullSize

# Defined in

types/index.d.ts:1372 (opens new window)

# isHorizontal

▸ isHorizontal(): boolean

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

# Returns

boolean

# Inherited from

Scale.isHorizontal

# Defined in

types/layout.d.ts:58 (opens new window)

# normalize

▸ normalize(values): number[]

# Parameters

Name Type
values number[]

# Returns

number[]

# Defined in

types/index.d.ts:3428 (opens new window)

# parse

▸ parse(raw, index?): unknown

# Parameters

Name Type
raw unknown
index? number

# Returns

unknown

# Inherited from

Scale.parse

# Defined in

types/index.d.ts:1344 (opens new window)

# setDimensions

▸ setDimensions(): void

# Returns

void

# Inherited from

Scale.setDimensions

# Defined in

types/index.d.ts:1354 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Scale.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

# 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

Scale.update

# Defined in

types/layout.d.ts:64 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TitleOptions.html b/docs/master/api/interfaces/TitleOptions.html index b26c4a7b67..be9ca77575 100644 --- a/docs/master/api/interfaces/TitleOptions.html +++ b/docs/master/api/interfaces/TitleOptions.html @@ -7,7 +7,7 @@ - + @@ -39,8 +39,8 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TitleOptions

# Properties

# align

• align: Align

Alignment of the title.

Default

'center'

# Defined in

types/index.d.ts:2516 (opens new window)

# color

• color: Color

Color of text

See

Defaults.color

# Defined in

types/index.d.ts:2531 (opens new window)

# display

• display: boolean

Is the title shown?

Default

false

# Defined in

types/index.d.ts:2521 (opens new window)

# font

• font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext>

# Defined in

types/index.d.ts:2532 (opens new window)

# fullSize

• fullSize: boolean

Marks that this box should take the full width/height of the canvas (moving other boxes). If set to false, places the box above/beside the -chart area

Default

true

# Defined in

types/index.d.ts:2539 (opens new window)

# padding

• padding: number | { bottom: number ; top: number }

Adds padding above and below the title text if a single number is specified. It is also possible to change top and bottom padding separately.

# Defined in

types/index.d.ts:2543 (opens new window)

# position

• position: "left" | "top" | "bottom" | "right"

Position of title

Default

'top'

# Defined in

types/index.d.ts:2526 (opens new window)

# text

• text: string | string[]

Title text to display. If specified as an array, text is rendered on multiple lines.

# Defined in

types/index.d.ts:2547 (opens new window)

+ (opens new window)

# Interface: TitleOptions

# Properties

# align

• align: Align

Alignment of the title.

Default

'center'

# Defined in

types/index.d.ts:2516 (opens new window)

# color

• color: Color

Color of text

See

Defaults.color

# Defined in

types/index.d.ts:2531 (opens new window)

# display

• display: boolean

Is the title shown?

Default

false

# Defined in

types/index.d.ts:2521 (opens new window)

# font

• font: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableChartContext>

# Defined in

types/index.d.ts:2532 (opens new window)

# fullSize

• fullSize: boolean

Marks that this box should take the full width/height of the canvas (moving other boxes). If set to false, places the box above/beside the +chart area

Default

true

# Defined in

types/index.d.ts:2539 (opens new window)

# padding

• padding: number | { bottom: number ; top: number }

Adds padding above and below the title text if a single number is specified. It is also possible to change top and bottom padding separately.

# Defined in

types/index.d.ts:2543 (opens new window)

# position

• position: "left" | "top" | "bottom" | "right"

Position of title

Default

'top'

# Defined in

types/index.d.ts:2526 (opens new window)

# text

• text: string | string[]

Title text to display. If specified as an array, text is rendered on multiple lines.

# Defined in

types/index.d.ts:2547 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/Tooltip.html b/docs/master/api/interfaces/Tooltip.html index 44a649733c..437c3e1e34 100644 --- a/docs/master/api/interfaces/Tooltip.html +++ b/docs/master/api/interfaces/Tooltip.html @@ -7,7 +7,7 @@ - + @@ -39,30 +39,30 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: Tooltip

# Hierarchy

# Properties

# defaults

• Optional defaults: Partial<AnyObject>

Default options used in the plugin

# Inherited from

Plugin.defaults

# Defined in

types/index.d.ts:1122 (opens new window)

# events

• Optional events: keyof HTMLElementEventMap[]

The events option defines the browser events that the plugin should listen.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Inherited from

Plugin.events

# Defined in

types/index.d.ts:823 (opens new window)

# id

• id: string

# Inherited from

Plugin.id

# Defined in

types/index.d.ts:817 (opens new window)

# positioners

• Readonly positioners: TooltipPositionerMap

# Defined in

types/index.d.ts:2653 (opens new window)

# Methods

# afterBuildTicks

▸ Optional afterBuildTicks(chart, args, options): void

Desc

Called after scale has build its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterBuildTicks

# Defined in

types/index.d.ts:982 (opens new window)

# afterDataLimits

▸ Optional afterDataLimits(chart, args, options): void

Desc

Called after scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDataLimits

# Defined in

types/index.d.ts:966 (opens new window)

# afterDatasetDraw

▸ Optional afterDatasetDraw(chart, args, options): void

Desc

Called after the chart datasets at the given args.index have been drawn + (opens new window)

# Interface: Tooltip

# Hierarchy

# Properties

# defaults

• Optional defaults: Partial<AnyObject>

Default options used in the plugin

# Inherited from

Plugin.defaults

# Defined in

types/index.d.ts:1122 (opens new window)

# events

• Optional events: keyof HTMLElementEventMap[]

The events option defines the browser events that the plugin should listen.

Default

['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']

# Inherited from

Plugin.events

# Defined in

types/index.d.ts:823 (opens new window)

# id

• id: string

# Inherited from

Plugin.id

# Defined in

types/index.d.ts:817 (opens new window)

# positioners

• Readonly positioners: TooltipPositionerMap

# Defined in

types/index.d.ts:2653 (opens new window)

# Methods

# afterBuildTicks

▸ Optional afterBuildTicks(chart, args, options): void

Desc

Called after scale has build its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterBuildTicks

# Defined in

types/index.d.ts:982 (opens new window)

# afterDataLimits

▸ Optional afterDataLimits(chart, args, options): void

Desc

Called after scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDataLimits

# Defined in

types/index.d.ts:966 (opens new window)

# afterDatasetDraw

▸ Optional afterDatasetDraw(chart, args, options): void

Desc

Called after the chart datasets at the given args.index have been drawn (datasets are drawn in the reverse order). Note that this hook will not be called -if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDatasetDraw

# Defined in

types/index.d.ts:1064 (opens new window)

# afterDatasetUpdate

▸ Optional afterDatasetUpdate(chart, args, options): void

Desc

Called after the chart datasets at the given args.index has been updated. Note -that this hook will not be called if the datasets update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDatasetUpdate

# Defined in

types/index.d.ts:941 (opens new window)

# afterDatasetsDraw

▸ Optional afterDatasetsDraw(chart, args, options, cancelable): void

Desc

Called after the chart datasets have been drawn. Note that this hook -will not be called if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.
cancelable false -

# Returns

void

# Inherited from

Plugin.afterDatasetsDraw

# Defined in

types/index.d.ts:1041 (opens new window)

# afterDatasetsUpdate

▸ Optional afterDatasetsUpdate(chart, args, options): void

Desc

Called after the chart datasets have been updated. Note that this hook -will not be called if the datasets update has been previously cancelled.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDatasetsUpdate

# Defined in

types/index.d.ts:918 (opens new window)

# afterDestroy

▸ Optional afterDestroy(chart, args, options): void

Called after the chart has been destroyed.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDestroy

# Defined in

types/index.d.ts:1109 (opens new window)

# afterDraw

▸ Optional afterDraw(chart, args, options): void

Desc

Called after the chart has been drawn. Note that this hook will not be called -if the drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDraw

# Defined in

types/index.d.ts:1024 (opens new window)

# afterEvent

▸ Optional afterEvent(chart, args, options): void

Desc

Called after the event has been consumed. Note that this hook -will not be called if the event has been previously discarded.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.changed? boolean Set to true if the plugin needs a render. Should only be changed to true, because this args object is passed through all plugins.
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterEvent

# Defined in

types/index.d.ts:1087 (opens new window)

# afterInit

▸ Optional afterInit(chart, args, options): void

Desc

Called after chart has been initialized and before the first update.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterInit

# Defined in

types/index.d.ts:862 (opens new window)

# afterLayout

▸ Optional afterLayout(chart, args, options): void

Desc

Called after the chart has been laid out. Note that this hook will not -be called if the layout update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterLayout

# Defined in

types/index.d.ts:990 (opens new window)

# afterRender

▸ Optional afterRender(chart, args, options): void

Desc

Called after the chart has been fully rendered (and animation completed). Note -that this hook will not be called if the rendering has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterRender

# Defined in

types/index.d.ts:1007 (opens new window)

# afterTooltipDraw

▸ Optional afterTooltipDraw(chart, args, options): void

Desc

Called after drawing the tooltip. Note that this hook will not -be called if the tooltip drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.tooltip TooltipModel<keyof ChartTypeRegistry> The tooltip.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterTooltipDraw

# Defined in

types/index.d.ts:2705 (opens new window)

# afterUpdate

▸ Optional afterUpdate(chart, args, options): void

Desc

Called after chart has been updated and before rendering. Note that this -hook will not be called if the chart update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterUpdate

# Defined in

types/index.d.ts:881 (opens new window)

# beforeBuildTicks

▸ Optional beforeBuildTicks(chart, args, options): void

Desc

Called before scale builds its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeBuildTicks

# Defined in

types/index.d.ts:974 (opens new window)

# beforeDataLimits

▸ Optional beforeDataLimits(chart, args, options): void

Desc

Called before scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeDataLimits

# Defined in

types/index.d.ts:958 (opens new window)

# beforeDatasetDraw

▸ Optional beforeDatasetDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart dataset at the given args.index (datasets +if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDatasetDraw

# Defined in

types/index.d.ts:1064 (opens new window)

# afterDatasetUpdate

▸ Optional afterDatasetUpdate(chart, args, options): void

Desc

Called after the chart datasets at the given args.index has been updated. Note +that this hook will not be called if the datasets update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDatasetUpdate

# Defined in

types/index.d.ts:941 (opens new window)

# afterDatasetsDraw

▸ Optional afterDatasetsDraw(chart, args, options, cancelable): void

Desc

Called after the chart datasets have been drawn. Note that this hook +will not be called if the datasets drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.
cancelable false -

# Returns

void

# Inherited from

Plugin.afterDatasetsDraw

# Defined in

types/index.d.ts:1041 (opens new window)

# afterDatasetsUpdate

▸ Optional afterDatasetsUpdate(chart, args, options): void

Desc

Called after the chart datasets have been updated. Note that this hook +will not be called if the datasets update has been previously cancelled.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDatasetsUpdate

# Defined in

types/index.d.ts:918 (opens new window)

# afterDestroy

▸ Optional afterDestroy(chart, args, options): void

Called after the chart has been destroyed.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDestroy

# Defined in

types/index.d.ts:1109 (opens new window)

# afterDraw

▸ Optional afterDraw(chart, args, options): void

Desc

Called after the chart has been drawn. Note that this hook will not be called +if the drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterDraw

# Defined in

types/index.d.ts:1024 (opens new window)

# afterEvent

▸ Optional afterEvent(chart, args, options): void

Desc

Called after the event has been consumed. Note that this hook +will not be called if the event has been previously discarded.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable false -
args.changed? boolean Set to true if the plugin needs a render. Should only be changed to true, because this args object is passed through all plugins.
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterEvent

# Defined in

types/index.d.ts:1087 (opens new window)

# afterInit

▸ Optional afterInit(chart, args, options): void

Desc

Called after chart has been initialized and before the first update.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterInit

# Defined in

types/index.d.ts:862 (opens new window)

# afterLayout

▸ Optional afterLayout(chart, args, options): void

Desc

Called after the chart has been laid out. Note that this hook will not +be called if the layout update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterLayout

# Defined in

types/index.d.ts:990 (opens new window)

# afterRender

▸ Optional afterRender(chart, args, options): void

Desc

Called after the chart has been fully rendered (and animation completed). Note +that this hook will not be called if the rendering has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterRender

# Defined in

types/index.d.ts:1007 (opens new window)

# afterTooltipDraw

▸ Optional afterTooltipDraw(chart, args, options): void

Desc

Called after drawing the tooltip. Note that this hook will not +be called if the tooltip drawing has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.tooltip TooltipModel<keyof ChartTypeRegistry> The tooltip.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterTooltipDraw

# Defined in

types/index.d.ts:2705 (opens new window)

# afterUpdate

▸ Optional afterUpdate(chart, args, options): void

Desc

Called after chart has been updated and before rendering. Note that this +hook will not be called if the chart update has been previously cancelled.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.afterUpdate

# Defined in

types/index.d.ts:881 (opens new window)

# beforeBuildTicks

▸ Optional beforeBuildTicks(chart, args, options): void

Desc

Called before scale builds its ticks. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeBuildTicks

# Defined in

types/index.d.ts:974 (opens new window)

# beforeDataLimits

▸ Optional beforeDataLimits(chart, args, options): void

Desc

Called before scale data limits are calculated. This hook is called separately for each scale in the chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.scale Scale<CoreScaleOptions> The scale.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeDataLimits

# Defined in

types/index.d.ts:958 (opens new window)

# beforeDatasetDraw

▸ Optional beforeDatasetDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart dataset at the given args.index (datasets are drawn in the reverse order). If any plugin returns false, the datasets drawing -is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Inherited from

Plugin.beforeDatasetDraw

# Defined in

types/index.d.ts:1053 (opens new window)

# beforeDatasetUpdate

▸ Optional beforeDatasetUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart dataset at the given args.index. If any plugin -returns false, the datasets update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Inherited from

Plugin.beforeDatasetUpdate

# Defined in

types/index.d.ts:930 (opens new window)

# beforeDatasetsDraw

▸ Optional beforeDatasetsDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart datasets. If any plugin returns false, -the datasets drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Inherited from

Plugin.beforeDatasetsDraw

# Defined in

types/index.d.ts:1033 (opens new window)

# beforeDatasetsUpdate

▸ Optional beforeDatasetsUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart datasets. If any plugin returns false, -the datasets update is cancelled until another update is triggered.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the datasets update.

# Inherited from

Plugin.beforeDatasetsUpdate

# Defined in

types/index.d.ts:908 (opens new window)

# beforeDestroy

▸ Optional beforeDestroy(chart, args, options): void

Called before the chart is being destroyed.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeDestroy

# Defined in

types/index.d.ts:1102 (opens new window)

# beforeDraw

▸ Optional beforeDraw(chart, args, options): boolean | void

Desc

Called before drawing chart at every animation frame. If any plugin returns false, -the frame drawing is cancelled untilanother render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart drawing.

# Inherited from

Plugin.beforeDraw

# Defined in

types/index.d.ts:1016 (opens new window)

# beforeElementsUpdate

▸ Optional beforeElementsUpdate(chart, args, options): void

Desc

Called during the update process, before any chart elements have been created. -This can be used for data decimation by changing the data array inside a dataset.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeElementsUpdate

# Defined in

types/index.d.ts:889 (opens new window)

# beforeEvent

▸ Optional beforeEvent(chart, args, options): boolean | void

Desc

Called before processing the specified event. If any plugin returns false, -the event will be discarded.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options AnyObject The plugin options.

# Returns

boolean | void

# Inherited from

Plugin.beforeEvent

# Defined in

types/index.d.ts:1075 (opens new window)

# beforeInit

▸ Optional beforeInit(chart, args, options): void

Desc

Called before initializing chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeInit

# Defined in

types/index.d.ts:855 (opens new window)

# beforeLayout

▸ Optional beforeLayout(chart, args, options): boolean | void

Desc

Called before laying out chart. If any plugin returns false, -the layout update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart layout.

# Inherited from

Plugin.beforeLayout

# Defined in

types/index.d.ts:950 (opens new window)

# beforeRender

▸ Optional beforeRender(chart, args, options): boolean | void

Desc

Called before rendering chart. If any plugin returns false, -the rendering is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart rendering.

# Inherited from

Plugin.beforeRender

# Defined in

types/index.d.ts:999 (opens new window)

# beforeTooltipDraw

▸ Optional beforeTooltipDraw(chart, args, options): boolean | void

Desc

Called before drawing the tooltip. If any plugin returns false, -the tooltip drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.tooltip TooltipModel<keyof ChartTypeRegistry> The tooltip.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart tooltip drawing.

# Inherited from

Plugin.beforeTooltipDraw

# Defined in

types/index.d.ts:2696 (opens new window)

# beforeUpdate

▸ Optional beforeUpdate(chart, args, options): boolean | void

Desc

Called before updating chart. If any plugin returns false, the update -is cancelled (and thus subsequent render(s)) until another update is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart update.

# Inherited from

Plugin.beforeUpdate

# Defined in

types/index.d.ts:872 (opens new window)

# install

▸ Optional install(chart, args, options): void

Desc

Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.install

# Defined in

types/index.d.ts:832 (opens new window)

# reset

▸ Optional reset(chart, args, options): void

Desc

Called during chart reset

Since

version 3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.reset

# Defined in

types/index.d.ts:897 (opens new window)

# resize

▸ Optional resize(chart, args, options): void

Desc

Called after the chart as been resized.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.size Object The new canvas display size (eq. canvas.style width & height).
args.size.height number -
args.size.width number -
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.resize

# Defined in

types/index.d.ts:1095 (opens new window)

# start

▸ Optional start(chart, args, options): void

Desc

Called when a plugin is starting. This happens when chart is created or plugin is enabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.start

# Defined in

types/index.d.ts:840 (opens new window)

# stop

▸ Optional stop(chart, args, options): void

Desc

Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.stop

# Defined in

types/index.d.ts:848 (opens new window)

# uninstall

▸ Optional uninstall(chart, args, options): void

Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.uninstall

# Defined in

types/index.d.ts:1117 (opens new window)

+is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Inherited from

Plugin.beforeDatasetDraw

# Defined in

types/index.d.ts:1053 (opens new window)

# beforeDatasetUpdate

▸ Optional beforeDatasetUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart dataset at the given args.index. If any plugin +returns false, the datasets update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.index number The dataset index.
args.meta ChartMeta<keyof ChartTypeRegistry, default<AnyObject, AnyObject>, default<AnyObject, AnyObject>> The dataset metadata.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Inherited from

Plugin.beforeDatasetUpdate

# Defined in

types/index.d.ts:930 (opens new window)

# beforeDatasetsDraw

▸ Optional beforeDatasetsDraw(chart, args, options): boolean | void

Desc

Called before drawing the chart datasets. If any plugin returns false, +the datasets drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart datasets drawing.

# Inherited from

Plugin.beforeDatasetsDraw

# Defined in

types/index.d.ts:1033 (opens new window)

# beforeDatasetsUpdate

▸ Optional beforeDatasetsUpdate(chart, args, options): boolean | void

Desc

Called before updating the chart datasets. If any plugin returns false, +the datasets update is cancelled until another update is triggered.

Since

version 2.1.5

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the datasets update.

# Inherited from

Plugin.beforeDatasetsUpdate

# Defined in

types/index.d.ts:908 (opens new window)

# beforeDestroy

▸ Optional beforeDestroy(chart, args, options): void

Called before the chart is being destroyed.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeDestroy

# Defined in

types/index.d.ts:1102 (opens new window)

# beforeDraw

▸ Optional beforeDraw(chart, args, options): boolean | void

Desc

Called before drawing chart at every animation frame. If any plugin returns false, +the frame drawing is cancelled untilanother render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart drawing.

# Inherited from

Plugin.beforeDraw

# Defined in

types/index.d.ts:1016 (opens new window)

# beforeElementsUpdate

▸ Optional beforeElementsUpdate(chart, args, options): void

Desc

Called during the update process, before any chart elements have been created. +This can be used for data decimation by changing the data array inside a dataset.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeElementsUpdate

# Defined in

types/index.d.ts:889 (opens new window)

# beforeEvent

▸ Optional beforeEvent(chart, args, options): boolean | void

Desc

Called before processing the specified event. If any plugin returns false, +the event will be discarded.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.event ChartEvent The event object.
args.inChartArea boolean The event position is inside chartArea
args.replay boolean True if this event is replayed from Chart.update
options AnyObject The plugin options.

# Returns

boolean | void

# Inherited from

Plugin.beforeEvent

# Defined in

types/index.d.ts:1075 (opens new window)

# beforeInit

▸ Optional beforeInit(chart, args, options): void

Desc

Called before initializing chart.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.beforeInit

# Defined in

types/index.d.ts:855 (opens new window)

# beforeLayout

▸ Optional beforeLayout(chart, args, options): boolean | void

Desc

Called before laying out chart. If any plugin returns false, +the layout update is cancelled until another update is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart layout.

# Inherited from

Plugin.beforeLayout

# Defined in

types/index.d.ts:950 (opens new window)

# beforeRender

▸ Optional beforeRender(chart, args, options): boolean | void

Desc

Called before rendering chart. If any plugin returns false, +the rendering is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart rendering.

# Inherited from

Plugin.beforeRender

# Defined in

types/index.d.ts:999 (opens new window)

# beforeTooltipDraw

▸ Optional beforeTooltipDraw(chart, args, options): boolean | void

Desc

Called before drawing the tooltip. If any plugin returns false, +the tooltip drawing is cancelled until another render is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.tooltip TooltipModel<keyof ChartTypeRegistry> The tooltip.
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart tooltip drawing.

# Inherited from

Plugin.beforeTooltipDraw

# Defined in

types/index.d.ts:2696 (opens new window)

# beforeUpdate

▸ Optional beforeUpdate(chart, args, options): boolean | void

Desc

Called before updating chart. If any plugin returns false, the update +is cancelled (and thus subsequent render(s)) until another update is triggered.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.cancelable true -
args.mode "none" | "hide" | "show" | "default" | "active" | "resize" | "reset" The update mode
options AnyObject The plugin options.

# Returns

boolean | void

false to cancel the chart update.

# Inherited from

Plugin.beforeUpdate

# Defined in

types/index.d.ts:872 (opens new window)

# install

▸ Optional install(chart, args, options): void

Desc

Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.install

# Defined in

types/index.d.ts:832 (opens new window)

# reset

▸ Optional reset(chart, args, options): void

Desc

Called during chart reset

Since

version 3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.reset

# Defined in

types/index.d.ts:897 (opens new window)

# resize

▸ Optional resize(chart, args, options): void

Desc

Called after the chart as been resized.

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args Object The call arguments.
args.size Object The new canvas display size (eq. canvas.style width & height).
args.size.height number -
args.size.width number -
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.resize

# Defined in

types/index.d.ts:1095 (opens new window)

# start

▸ Optional start(chart, args, options): void

Desc

Called when a plugin is starting. This happens when chart is created or plugin is enabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.start

# Defined in

types/index.d.ts:840 (opens new window)

# stop

▸ Optional stop(chart, args, options): void

Desc

Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.stop

# Defined in

types/index.d.ts:848 (opens new window)

# uninstall

▸ Optional uninstall(chart, args, options): void

Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).

Since

3.0.0

# Parameters

Name Type Description
chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown> The chart instance.
args EmptyObject The call arguments.
options AnyObject The plugin options.

# Returns

void

# Inherited from

Plugin.uninstall

# Defined in

types/index.d.ts:1117 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TooltipCallbacks.html b/docs/master/api/interfaces/TooltipCallbacks.html index a33cd2076b..2810ada2f2 100644 --- a/docs/master/api/interfaces/TooltipCallbacks.html +++ b/docs/master/api/interfaces/TooltipCallbacks.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TooltipCallbacks<TType, Model, Item>

# Type parameters

Name Type
TType extends ChartType
Model TooltipModel<TType>
Item TooltipItem<TType>

# Methods

# afterBody

▸ afterBody(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2668 (opens new window)

# afterFooter

▸ afterFooter(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2680 (opens new window)

# afterLabel

▸ afterLabel(this, tooltipItem): string | void | string[]

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2672 (opens new window)

# afterTitle

▸ afterTitle(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2665 (opens new window)

# beforeBody

▸ beforeBody(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2667 (opens new window)

# beforeFooter

▸ beforeFooter(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2678 (opens new window)

# beforeLabel

▸ beforeLabel(this, tooltipItem): string | void | string[]

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2670 (opens new window)

# beforeTitle

▸ beforeTitle(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2663 (opens new window)

▸ footer(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2679 (opens new window)

# label

▸ label(this, tooltipItem): string | void | string[]

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2671 (opens new window)

# labelColor

▸ labelColor(this, tooltipItem): void | TooltipLabelStyle

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

void | TooltipLabelStyle

# Defined in

types/index.d.ts:2674 (opens new window)

# labelPointStyle

▸ labelPointStyle(this, tooltipItem): void | { pointStyle: PointStyle ; rotation: number }

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

void | { pointStyle: PointStyle ; rotation: number }

# Defined in

types/index.d.ts:2676 (opens new window)

# labelTextColor

▸ labelTextColor(this, tooltipItem): void | Color

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

void | Color

# Defined in

types/index.d.ts:2675 (opens new window)

# title

▸ title(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2664 (opens new window)

+ (opens new window)

# Interface: TooltipCallbacks<TType, Model, Item>

# Type parameters

Name Type
TType extends ChartType
Model TooltipModel<TType>
Item TooltipItem<TType>

# Methods

# afterBody

▸ afterBody(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2668 (opens new window)

# afterFooter

▸ afterFooter(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2680 (opens new window)

# afterLabel

▸ afterLabel(this, tooltipItem): string | void | string[]

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2672 (opens new window)

# afterTitle

▸ afterTitle(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2665 (opens new window)

# beforeBody

▸ beforeBody(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2667 (opens new window)

# beforeFooter

▸ beforeFooter(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2678 (opens new window)

# beforeLabel

▸ beforeLabel(this, tooltipItem): string | void | string[]

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2670 (opens new window)

# beforeTitle

▸ beforeTitle(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2663 (opens new window)

▸ footer(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2679 (opens new window)

# label

▸ label(this, tooltipItem): string | void | string[]

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2671 (opens new window)

# labelColor

▸ labelColor(this, tooltipItem): void | TooltipLabelStyle

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

void | TooltipLabelStyle

# Defined in

types/index.d.ts:2674 (opens new window)

# labelPointStyle

▸ labelPointStyle(this, tooltipItem): void | { pointStyle: PointStyle ; rotation: number }

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

void | { pointStyle: PointStyle ; rotation: number }

# Defined in

types/index.d.ts:2676 (opens new window)

# labelTextColor

▸ labelTextColor(this, tooltipItem): void | Color

# Parameters

Name Type
this Model
tooltipItem Item

# Returns

void | Color

# Defined in

types/index.d.ts:2675 (opens new window)

# title

▸ title(this, tooltipItems): string | void | string[]

# Parameters

Name Type
this Model
tooltipItems Item[]

# Returns

string | void | string[]

# Defined in

types/index.d.ts:2664 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TooltipItem.html b/docs/master/api/interfaces/TooltipItem.html index c92ec768db..e6b121718a 100644 --- a/docs/master/api/interfaces/TooltipItem.html +++ b/docs/master/api/interfaces/TooltipItem.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TooltipItem<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

The chart the tooltip is being shown on

# Defined in

types/index.d.ts:2897 (opens new window)

# dataIndex

• dataIndex: number

Index of this data item in the dataset

# Defined in

types/index.d.ts:2932 (opens new window)

# dataset

• dataset: UnionToIntersection<ChartDataset<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>>>

The dataset the item comes from

# Defined in

types/index.d.ts:2922 (opens new window)

# datasetIndex

• datasetIndex: number

Index of the dataset the item comes from

# Defined in

types/index.d.ts:2927 (opens new window)

# element

• element: default<AnyObject, AnyObject>

The chart element (point, arc, bar, etc.) for this tooltip item

# Defined in

types/index.d.ts:2937 (opens new window)

# formattedValue

• formattedValue: string

Formatted value for the tooltip

# Defined in

types/index.d.ts:2917 (opens new window)

# label

• label: string

Label for the tooltip

# Defined in

types/index.d.ts:2902 (opens new window)

# parsed

• parsed: UnionToIntersection<ParsedDataType<TType>>

Parsed data values for the given dataIndex and datasetIndex

# Defined in

types/index.d.ts:2907 (opens new window)

# raw

• raw: unknown

Raw data values for the given dataIndex and datasetIndex

# Defined in

types/index.d.ts:2912 (opens new window)

+ (opens new window)

# Interface: TooltipItem<TType>

# Type parameters

Name Type
TType extends ChartType

# Properties

# chart

• chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>

The chart the tooltip is being shown on

# Defined in

types/index.d.ts:2897 (opens new window)

# dataIndex

• dataIndex: number

Index of this data item in the dataset

# Defined in

types/index.d.ts:2932 (opens new window)

# dataset

• dataset: UnionToIntersection<ChartDataset<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>>>

The dataset the item comes from

# Defined in

types/index.d.ts:2922 (opens new window)

# datasetIndex

• datasetIndex: number

Index of the dataset the item comes from

# Defined in

types/index.d.ts:2927 (opens new window)

# element

• element: default<AnyObject, AnyObject>

The chart element (point, arc, bar, etc.) for this tooltip item

# Defined in

types/index.d.ts:2937 (opens new window)

# formattedValue

• formattedValue: string

Formatted value for the tooltip

# Defined in

types/index.d.ts:2917 (opens new window)

# label

• label: string

Label for the tooltip

# Defined in

types/index.d.ts:2902 (opens new window)

# parsed

• parsed: UnionToIntersection<ParsedDataType<TType>>

Parsed data values for the given dataIndex and datasetIndex

# Defined in

types/index.d.ts:2907 (opens new window)

# raw

• raw: unknown

Raw data values for the given dataIndex and datasetIndex

# Defined in

types/index.d.ts:2912 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TooltipLabelStyle.html b/docs/master/api/interfaces/TooltipLabelStyle.html index 1d32d785f7..df48bca595 100644 --- a/docs/master/api/interfaces/TooltipLabelStyle.html +++ b/docs/master/api/interfaces/TooltipLabelStyle.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TooltipLabelStyle

# Properties

# backgroundColor

• backgroundColor: Color

# Defined in

types/index.d.ts:2554 (opens new window)

# borderColor

• borderColor: Color

# Defined in

types/index.d.ts:2553 (opens new window)

# borderDash

• Optional borderDash: [number, number]

Border dash

Since

3.1.0

# Defined in

types/index.d.ts:2566 (opens new window)

# borderDashOffset

• Optional borderDashOffset: number

Border dash offset

Since

3.1.0

# Defined in

types/index.d.ts:2572 (opens new window)

# borderRadius

• Optional borderRadius: number | BorderRadius

borderRadius

Since

3.1.0

# Defined in

types/index.d.ts:2578 (opens new window)

# borderWidth

• Optional borderWidth: number

Width of border line

Since

3.1.0

# Defined in

types/index.d.ts:2560 (opens new window)

+ (opens new window)

# Interface: TooltipLabelStyle

# Properties

# backgroundColor

• backgroundColor: Color

# Defined in

types/index.d.ts:2554 (opens new window)

# borderColor

• borderColor: Color

# Defined in

types/index.d.ts:2553 (opens new window)

# borderDash

• Optional borderDash: [number, number]

Border dash

Since

3.1.0

# Defined in

types/index.d.ts:2566 (opens new window)

# borderDashOffset

• Optional borderDashOffset: number

Border dash offset

Since

3.1.0

# Defined in

types/index.d.ts:2572 (opens new window)

# borderRadius

• Optional borderRadius: number | BorderRadius

borderRadius

Since

3.1.0

# Defined in

types/index.d.ts:2578 (opens new window)

# borderWidth

• Optional borderWidth: number

Width of border line

Since

3.1.0

# Defined in

types/index.d.ts:2560 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TooltipModel.html b/docs/master/api/interfaces/TooltipModel.html index 6edd66f1ce..cc9ab8ad5c 100644 --- a/docs/master/api/interfaces/TooltipModel.html +++ b/docs/master/api/interfaces/TooltipModel.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TooltipModel<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# $animations

• $animations: Record<string, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# afterBody

• afterBody: string[]

# Defined in

types/index.d.ts:2609 (opens new window)

# beforeBody

• beforeBody: string[]

# Defined in

types/index.d.ts:2607 (opens new window)

# body

• body: { after: string[] ; before: string[] ; lines: string[] }[]

# Defined in

types/index.d.ts:2605 (opens new window)

# caretX

• caretX: number

# Defined in

types/index.d.ts:2596 (opens new window)

# caretY

• caretY: number

# Defined in

types/index.d.ts:2597 (opens new window)

# chart

• Readonly chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>

# Defined in

types/index.d.ts:2581 (opens new window)

# dataPoints

• dataPoints: TooltipItem<TType>[]

# Defined in

types/index.d.ts:2584 (opens new window)

• footer: string[]

# Defined in

types/index.d.ts:2617 (opens new window)

# height

• height: number

# Defined in

types/index.d.ts:2594 (opens new window)

# labelColors

• labelColors: TooltipLabelStyle[]

# Defined in

types/index.d.ts:2620 (opens new window)

# labelPointStyles

• labelPointStyles: { pointStyle: PointStyle ; rotation: number }[]

# Defined in

types/index.d.ts:2622 (opens new window)

# labelTextColors

• labelTextColors: Color[]

# Defined in

types/index.d.ts:2621 (opens new window)

# opacity

• opacity: number

# Defined in

types/index.d.ts:2625 (opens new window)

# options

• options: TooltipOptions<TType>

# Overrides

Element.options

# Defined in

types/index.d.ts:2628 (opens new window)

# title

• title: string[]

# Defined in

types/index.d.ts:2613 (opens new window)

# width

• width: number

# Defined in

types/index.d.ts:2593 (opens new window)

# x

• x: number

# Overrides

Element.x

# Defined in

types/index.d.ts:2591 (opens new window)

# xAlign

• xAlign: TooltipXAlignment

# Defined in

types/index.d.ts:2587 (opens new window)

# y

• y: number

# Overrides

Element.y

# Defined in

types/index.d.ts:2592 (opens new window)

# yAlign

• yAlign: TooltipYAlignment

# Defined in

types/index.d.ts:2588 (opens new window)

# Methods

# getActiveElements

▸ getActiveElements(): ActiveElement[]

# Returns

ActiveElement[]

# Defined in

types/index.d.ts:2630 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<AnyObject, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends string[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<AnyObject, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# setActiveElements

▸ setActiveElements(active, eventPosition): void

# Parameters

Name Type
active ActiveDataPoint[]
eventPosition Point

# Returns

void

# Defined in

types/index.d.ts:2631 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

+ (opens new window)

# Interface: TooltipModel<TType>

# Type parameters

Name Type
TType extends ChartType

# Hierarchy

# Properties

# $animations

• $animations: Record<string, Animation>

# Inherited from

Element.$animations

# Defined in

core/core.element.ts:15 (opens new window)

# active

• active: boolean = false

# Inherited from

Element.active

# Defined in

core/core.element.ts:13 (opens new window)

# afterBody

• afterBody: string[]

# Defined in

types/index.d.ts:2609 (opens new window)

# beforeBody

• beforeBody: string[]

# Defined in

types/index.d.ts:2607 (opens new window)

# body

• body: { after: string[] ; before: string[] ; lines: string[] }[]

# Defined in

types/index.d.ts:2605 (opens new window)

# caretX

• caretX: number

# Defined in

types/index.d.ts:2596 (opens new window)

# caretY

• caretY: number

# Defined in

types/index.d.ts:2597 (opens new window)

# chart

• Readonly chart: Chart<TType, DistributiveArray<ChartTypeRegistry[TType]["defaultDataPoint"]>, unknown>

# Defined in

types/index.d.ts:2581 (opens new window)

# dataPoints

• dataPoints: TooltipItem<TType>[]

# Defined in

types/index.d.ts:2584 (opens new window)

• footer: string[]

# Defined in

types/index.d.ts:2617 (opens new window)

# height

• height: number

# Defined in

types/index.d.ts:2594 (opens new window)

# labelColors

• labelColors: TooltipLabelStyle[]

# Defined in

types/index.d.ts:2620 (opens new window)

# labelPointStyles

• labelPointStyles: { pointStyle: PointStyle ; rotation: number }[]

# Defined in

types/index.d.ts:2622 (opens new window)

# labelTextColors

• labelTextColors: Color[]

# Defined in

types/index.d.ts:2621 (opens new window)

# opacity

• opacity: number

# Defined in

types/index.d.ts:2625 (opens new window)

# options

• options: TooltipOptions<TType>

# Overrides

Element.options

# Defined in

types/index.d.ts:2628 (opens new window)

# title

• title: string[]

# Defined in

types/index.d.ts:2613 (opens new window)

# width

• width: number

# Defined in

types/index.d.ts:2593 (opens new window)

# x

• x: number

# Overrides

Element.x

# Defined in

types/index.d.ts:2591 (opens new window)

# xAlign

• xAlign: TooltipXAlignment

# Defined in

types/index.d.ts:2587 (opens new window)

# y

• y: number

# Overrides

Element.y

# Defined in

types/index.d.ts:2592 (opens new window)

# yAlign

• yAlign: TooltipYAlignment

# Defined in

types/index.d.ts:2588 (opens new window)

# Methods

# getActiveElements

▸ getActiveElements(): ActiveElement[]

# Returns

ActiveElement[]

# Defined in

types/index.d.ts:2630 (opens new window)

# getProps

▸ getProps<P>(props, final?): Pick<AnyObject, P[number]>

Gets the current or final value of each prop. Can return extra properties (whole object).

# Type parameters

Name Type
P extends string[]

# Parameters

Name Type Description
props P properties to get
final? boolean get the final value (animation target)

# Returns

Pick<AnyObject, P[number]>

# Inherited from

Element.getProps

# Defined in

core/core.element.ts:31 (opens new window)

▸ 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 (opens new window)

# hasValue

▸ hasValue(): boolean

# Returns

boolean

# Inherited from

Element.hasValue

# Defined in

core/core.element.ts:22 (opens new window)

# setActiveElements

▸ setActiveElements(active, eventPosition): void

# Parameters

Name Type
active ActiveDataPoint[]
eventPosition Point

# Returns

void

# Defined in

types/index.d.ts:2631 (opens new window)

# tooltipPosition

▸ tooltipPosition(useFinalPosition): Point

# Parameters

Name Type
useFinalPosition boolean

# Returns

Point

# Inherited from

Element.tooltipPosition

# Defined in

core/core.element.ts:17 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TooltipOptions.html b/docs/master/api/interfaces/TooltipOptions.html index e21ac84f76..c5ab9c4c44 100644 --- a/docs/master/api/interfaces/TooltipOptions.html +++ b/docs/master/api/interfaces/TooltipOptions.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TooltipOptions<TType>

# Type parameters

Name Type
TType extends ChartType = ChartType

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<TType>

# Defined in

types/index.d.ts:2888 (opens new window)

# animations

• animations: false | AnimationsSpec<TType>

# Defined in

types/index.d.ts:2889 (opens new window)

# axis

• axis: InteractionAxis

Defines which directions are used in calculating distances. Defaults to 'x' for 'index' mode and 'xy' in dataset and 'nearest' modes.

# Inherited from

CoreInteractionOptions.axis

# Defined in

types/index.d.ts:1579 (opens new window)

# backgroundColor

• backgroundColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Background color of the tooltip.

Default

'rgba(0, 0, 0, 0.8)'

# Defined in

types/index.d.ts:2746 (opens new window)

# bodyAlign

• bodyAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

Horizontal alignment of the body text lines.

Default

'left'

# Defined in

types/index.d.ts:2796 (opens new window)

# bodyColor

• bodyColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of body

Default

'#fff'

# Defined in

types/index.d.ts:2786 (opens new window)

# bodyFont

• bodyFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>

See Fonts.

Default

# Defined in

types/index.d.ts:2791 (opens new window)

# bodySpacing

• bodySpacing: Scriptable<number, ScriptableTooltipContext<TType>>

Spacing to add to top and bottom of each tooltip item.

Default

2

# Defined in

types/index.d.ts:2781 (opens new window)

# borderColor

• borderColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of the border.

Default

'rgba(0, 0, 0, 0)'

# Defined in

types/index.d.ts:2871 (opens new window)

# borderWidth

• borderWidth: Scriptable<number, ScriptableTooltipContext<TType>>

Size of the border.

Default

0

# Defined in

types/index.d.ts:2876 (opens new window)

# boxHeight

• boxHeight: Scriptable<number, ScriptableTooltipContext<TType>>

Height of the color box if displayColors is true.

Default

bodyFont.size

# Defined in

types/index.d.ts:2861 (opens new window)

# boxPadding

• boxPadding: number

Padding between the color box and the text.

Default

1

# Defined in

types/index.d.ts:2751 (opens new window)

# boxWidth

• boxWidth: Scriptable<number, ScriptableTooltipContext<TType>>

Width of the color box if displayColors is true.

Default

bodyFont.size

# Defined in

types/index.d.ts:2856 (opens new window)

# callbacks

• callbacks: TooltipCallbacks<TType, TooltipModel<TType>, TooltipItem<TType>>

# Defined in

types/index.d.ts:2890 (opens new window)

# caretPadding

• caretPadding: Scriptable<number, ScriptableTooltipContext<TType>>

Extra distance to move the end of the tooltip arrow away from the tooltip point.

Default

2

# Defined in

types/index.d.ts:2831 (opens new window)

# caretSize

• caretSize: Scriptable<number, ScriptableTooltipContext<TType>>

Size, in px, of the tooltip arrow.

Default

5

# Defined in

types/index.d.ts:2836 (opens new window)

# cornerRadius

• cornerRadius: Scriptable<number | BorderRadius, ScriptableTooltipContext<TType>>

Radius of tooltip corner curves.

Default

6

# Defined in

types/index.d.ts:2841 (opens new window)

# displayColors

• displayColors: Scriptable<boolean, ScriptableTooltipContext<TType>>

If true, color boxes are shown in the tooltip.

Default

true

# Defined in

types/index.d.ts:2851 (opens new window)

# enabled

• enabled: Scriptable<boolean, ScriptableTooltipContext<TType>>

Are on-canvas tooltips enabled?

Default

true

# Defined in

types/index.d.ts:2719 (opens new window)

# filter

• filter: (e: TooltipItem<TType>, index: number, array: TooltipItem<TType>[], data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => boolean

# Type declaration

▸ (e, index, array, data): boolean

# Parameters
Name Type
e TooltipItem<TType>
index number
array TooltipItem<TType>[]
data ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
# Returns

boolean

# Defined in

types/index.d.ts:2740 (opens new window)

# footerAlign

• footerAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

Horizontal alignment of the footer text lines.

Default

'left'

# Defined in

types/index.d.ts:2821 (opens new window)

# footerColor

• footerColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of footer

Default

'#fff'

# Defined in

types/index.d.ts:2811 (opens new window)

# footerFont

• footerFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>

See Fonts

Default

# Defined in

types/index.d.ts:2816 (opens new window)

# footerMarginTop

• footerMarginTop: Scriptable<number, ScriptableTooltipContext<TType>>

Margin to add before drawing the footer.

Default

6

# Defined in

types/index.d.ts:2806 (opens new window)

# footerSpacing

• footerSpacing: Scriptable<number, ScriptableTooltipContext<TType>>

Spacing to add to top and bottom of each footer line.

Default

2

# Defined in

types/index.d.ts:2801 (opens new window)

# includeInvisible

• includeInvisible: boolean

if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.

Default

false

# Inherited from

CoreInteractionOptions.includeInvisible

# Defined in

types/index.d.ts:1585 (opens new window)

# intersect

• intersect: boolean

if true, the hover mode only applies when the mouse position intersects an item on the chart.

Default

true

# Inherited from

CoreInteractionOptions.intersect

# Defined in

types/index.d.ts:1574 (opens new window)

# itemSort

• itemSort: (a: TooltipItem<TType>, b: TooltipItem<TType>, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => number

# Type declaration

▸ (a, b, data): number

Sort tooltip items.

# Parameters
Name Type
a TooltipItem<TType>
b TooltipItem<TType>
data ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
# Returns

number

# Defined in

types/index.d.ts:2738 (opens new window)

# mode

• mode: keyof InteractionModeMap

Sets which elements appear in the tooltip. See Interaction Modes for details.

Default

'nearest'

# Inherited from

CoreInteractionOptions.mode

# Defined in

types/index.d.ts:1569 (opens new window)

# multiKeyBackground

• multiKeyBackground: Scriptable<Color, ScriptableTooltipContext<TType>>

Color to draw behind the colored boxes when multiple items are in the tooltip.

Default

'#fff'

# Defined in

types/index.d.ts:2846 (opens new window)

# padding

• padding: Scriptable<Padding, ScriptableTooltipContext<TType>>

Padding to add to the tooltip

Default

6

# Defined in

types/index.d.ts:2826 (opens new window)

# position

• position: Scriptable<keyof TooltipPositionerMap, ScriptableTooltipContext<TType>>

The mode for positioning the tooltip

# Defined in

types/index.d.ts:2727 (opens new window)

# rtl

• rtl: Scriptable<boolean, ScriptableTooltipContext<TType>>

true for rendering the legends from right to left.

# Defined in

types/index.d.ts:2880 (opens new window)

# textDirection

• textDirection: Scriptable<string, ScriptableTooltipContext<TType>>

This will force the text direction 'rtl' or 'ltr on the canvas for rendering the tooltips, regardless of the css specified on the canvas

Default

canvas's default

# Defined in

types/index.d.ts:2886 (opens new window)

# titleAlign

• titleAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

Horizontal alignment of the title text lines.

Default

'left'

# Defined in

types/index.d.ts:2776 (opens new window)

# titleColor

• titleColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of title

Default

'#fff'

# Defined in

types/index.d.ts:2756 (opens new window)

# titleFont

• titleFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>

See Fonts

Default

# Defined in

types/index.d.ts:2761 (opens new window)

# titleMarginBottom

• titleMarginBottom: Scriptable<number, ScriptableTooltipContext<TType>>

Margin to add on bottom of title section.

Default

6

# Defined in

types/index.d.ts:2771 (opens new window)

# titleSpacing

• titleSpacing: Scriptable<number, ScriptableTooltipContext<TType>>

Spacing to add to top and bottom of each title line.

Default

2

# Defined in

types/index.d.ts:2766 (opens new window)

# usePointStyle

• usePointStyle: Scriptable<boolean, ScriptableTooltipContext<TType>>

Use the corresponding point style (from dataset options) instead of color boxes, ex: star, triangle etc. (size is based on the minimum value between boxWidth and boxHeight)

Default

false

# Defined in

types/index.d.ts:2866 (opens new window)

# xAlign

• xAlign: Scriptable<TooltipXAlignment, ScriptableTooltipContext<TType>>

Override the tooltip alignment calculations

# Defined in

types/index.d.ts:2732 (opens new window)

# yAlign

• yAlign: Scriptable<TooltipYAlignment, ScriptableTooltipContext<TType>>

# Defined in

types/index.d.ts:2733 (opens new window)

# Methods

# external

▸ external(this, args): void

See external tooltip section.

# Parameters

Name Type
this TooltipModel<TType>
args Object
args.chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
args.tooltip TooltipModel<TType>

# Returns

void

# Defined in

types/index.d.ts:2723 (opens new window)

+ (opens new window)

# Interface: TooltipOptions<TType>

# Type parameters

Name Type
TType extends ChartType = ChartType

# Hierarchy

# Properties

# animation

• animation: false | AnimationSpec<TType>

# Defined in

types/index.d.ts:2888 (opens new window)

# animations

• animations: false | AnimationsSpec<TType>

# Defined in

types/index.d.ts:2889 (opens new window)

# axis

• axis: InteractionAxis

Defines which directions are used in calculating distances. Defaults to 'x' for 'index' mode and 'xy' in dataset and 'nearest' modes.

# Inherited from

CoreInteractionOptions.axis

# Defined in

types/index.d.ts:1579 (opens new window)

# backgroundColor

• backgroundColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Background color of the tooltip.

Default

'rgba(0, 0, 0, 0.8)'

# Defined in

types/index.d.ts:2746 (opens new window)

# bodyAlign

• bodyAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

Horizontal alignment of the body text lines.

Default

'left'

# Defined in

types/index.d.ts:2796 (opens new window)

# bodyColor

• bodyColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of body

Default

'#fff'

# Defined in

types/index.d.ts:2786 (opens new window)

# bodyFont

• bodyFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>

See Fonts.

Default

# Defined in

types/index.d.ts:2791 (opens new window)

# bodySpacing

• bodySpacing: Scriptable<number, ScriptableTooltipContext<TType>>

Spacing to add to top and bottom of each tooltip item.

Default

2

# Defined in

types/index.d.ts:2781 (opens new window)

# borderColor

• borderColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of the border.

Default

'rgba(0, 0, 0, 0)'

# Defined in

types/index.d.ts:2871 (opens new window)

# borderWidth

• borderWidth: Scriptable<number, ScriptableTooltipContext<TType>>

Size of the border.

Default

0

# Defined in

types/index.d.ts:2876 (opens new window)

# boxHeight

• boxHeight: Scriptable<number, ScriptableTooltipContext<TType>>

Height of the color box if displayColors is true.

Default

bodyFont.size

# Defined in

types/index.d.ts:2861 (opens new window)

# boxPadding

• boxPadding: number

Padding between the color box and the text.

Default

1

# Defined in

types/index.d.ts:2751 (opens new window)

# boxWidth

• boxWidth: Scriptable<number, ScriptableTooltipContext<TType>>

Width of the color box if displayColors is true.

Default

bodyFont.size

# Defined in

types/index.d.ts:2856 (opens new window)

# callbacks

• callbacks: TooltipCallbacks<TType, TooltipModel<TType>, TooltipItem<TType>>

# Defined in

types/index.d.ts:2890 (opens new window)

# caretPadding

• caretPadding: Scriptable<number, ScriptableTooltipContext<TType>>

Extra distance to move the end of the tooltip arrow away from the tooltip point.

Default

2

# Defined in

types/index.d.ts:2831 (opens new window)

# caretSize

• caretSize: Scriptable<number, ScriptableTooltipContext<TType>>

Size, in px, of the tooltip arrow.

Default

5

# Defined in

types/index.d.ts:2836 (opens new window)

# cornerRadius

• cornerRadius: Scriptable<number | BorderRadius, ScriptableTooltipContext<TType>>

Radius of tooltip corner curves.

Default

6

# Defined in

types/index.d.ts:2841 (opens new window)

# displayColors

• displayColors: Scriptable<boolean, ScriptableTooltipContext<TType>>

If true, color boxes are shown in the tooltip.

Default

true

# Defined in

types/index.d.ts:2851 (opens new window)

# enabled

• enabled: Scriptable<boolean, ScriptableTooltipContext<TType>>

Are on-canvas tooltips enabled?

Default

true

# Defined in

types/index.d.ts:2719 (opens new window)

# filter

• filter: (e: TooltipItem<TType>, index: number, array: TooltipItem<TType>[], data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => boolean

# Type declaration

▸ (e, index, array, data): boolean

# Parameters
Name Type
e TooltipItem<TType>
index number
array TooltipItem<TType>[]
data ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
# Returns

boolean

# Defined in

types/index.d.ts:2740 (opens new window)

# footerAlign

• footerAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

Horizontal alignment of the footer text lines.

Default

'left'

# Defined in

types/index.d.ts:2821 (opens new window)

# footerColor

• footerColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of footer

Default

'#fff'

# Defined in

types/index.d.ts:2811 (opens new window)

# footerFont

• footerFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>

See Fonts

Default

# Defined in

types/index.d.ts:2816 (opens new window)

# footerMarginTop

• footerMarginTop: Scriptable<number, ScriptableTooltipContext<TType>>

Margin to add before drawing the footer.

Default

6

# Defined in

types/index.d.ts:2806 (opens new window)

# footerSpacing

• footerSpacing: Scriptable<number, ScriptableTooltipContext<TType>>

Spacing to add to top and bottom of each footer line.

Default

2

# Defined in

types/index.d.ts:2801 (opens new window)

# includeInvisible

• includeInvisible: boolean

if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.

Default

false

# Inherited from

CoreInteractionOptions.includeInvisible

# Defined in

types/index.d.ts:1585 (opens new window)

# intersect

• intersect: boolean

if true, the hover mode only applies when the mouse position intersects an item on the chart.

Default

true

# Inherited from

CoreInteractionOptions.intersect

# Defined in

types/index.d.ts:1574 (opens new window)

# itemSort

• itemSort: (a: TooltipItem<TType>, b: TooltipItem<TType>, data: ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => number

# Type declaration

▸ (a, b, data): number

Sort tooltip items.

# Parameters
Name Type
a TooltipItem<TType>
b TooltipItem<TType>
data ChartData<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
# Returns

number

# Defined in

types/index.d.ts:2738 (opens new window)

# mode

• mode: keyof InteractionModeMap

Sets which elements appear in the tooltip. See Interaction Modes for details.

Default

'nearest'

# Inherited from

CoreInteractionOptions.mode

# Defined in

types/index.d.ts:1569 (opens new window)

# multiKeyBackground

• multiKeyBackground: Scriptable<Color, ScriptableTooltipContext<TType>>

Color to draw behind the colored boxes when multiple items are in the tooltip.

Default

'#fff'

# Defined in

types/index.d.ts:2846 (opens new window)

# padding

• padding: Scriptable<Padding, ScriptableTooltipContext<TType>>

Padding to add to the tooltip

Default

6

# Defined in

types/index.d.ts:2826 (opens new window)

# position

• position: Scriptable<keyof TooltipPositionerMap, ScriptableTooltipContext<TType>>

The mode for positioning the tooltip

# Defined in

types/index.d.ts:2727 (opens new window)

# rtl

• rtl: Scriptable<boolean, ScriptableTooltipContext<TType>>

true for rendering the legends from right to left.

# Defined in

types/index.d.ts:2880 (opens new window)

# textDirection

• textDirection: Scriptable<string, ScriptableTooltipContext<TType>>

This will force the text direction 'rtl' or 'ltr on the canvas for rendering the tooltips, regardless of the css specified on the canvas

Default

canvas's default

# Defined in

types/index.d.ts:2886 (opens new window)

# titleAlign

• titleAlign: Scriptable<TextAlign, ScriptableTooltipContext<TType>>

Horizontal alignment of the title text lines.

Default

'left'

# Defined in

types/index.d.ts:2776 (opens new window)

# titleColor

• titleColor: Scriptable<Color, ScriptableTooltipContext<TType>>

Color of title

Default

'#fff'

# Defined in

types/index.d.ts:2756 (opens new window)

# titleFont

• titleFont: ScriptableAndScriptableOptions<Partial<FontSpec>, ScriptableTooltipContext<TType>>

See Fonts

Default

# Defined in

types/index.d.ts:2761 (opens new window)

# titleMarginBottom

• titleMarginBottom: Scriptable<number, ScriptableTooltipContext<TType>>

Margin to add on bottom of title section.

Default

6

# Defined in

types/index.d.ts:2771 (opens new window)

# titleSpacing

• titleSpacing: Scriptable<number, ScriptableTooltipContext<TType>>

Spacing to add to top and bottom of each title line.

Default

2

# Defined in

types/index.d.ts:2766 (opens new window)

# usePointStyle

• usePointStyle: Scriptable<boolean, ScriptableTooltipContext<TType>>

Use the corresponding point style (from dataset options) instead of color boxes, ex: star, triangle etc. (size is based on the minimum value between boxWidth and boxHeight)

Default

false

# Defined in

types/index.d.ts:2866 (opens new window)

# xAlign

• xAlign: Scriptable<TooltipXAlignment, ScriptableTooltipContext<TType>>

Override the tooltip alignment calculations

# Defined in

types/index.d.ts:2732 (opens new window)

# yAlign

• yAlign: Scriptable<TooltipYAlignment, ScriptableTooltipContext<TType>>

# Defined in

types/index.d.ts:2733 (opens new window)

# Methods

# external

▸ external(this, args): void

See external tooltip section.

# Parameters

Name Type
this TooltipModel<TType>
args Object
args.chart Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>
args.tooltip TooltipModel<TType>

# Returns

void

# Defined in

types/index.d.ts:2723 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TooltipPosition.html b/docs/master/api/interfaces/TooltipPosition.html index 944dcac0b0..16db8a5633 100644 --- a/docs/master/api/interfaces/TooltipPosition.html +++ b/docs/master/api/interfaces/TooltipPosition.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TooltipPosition

# Hierarchy

  • Point

    ↳ TooltipPosition

# Properties

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# xAlign

• Optional xAlign: TooltipXAlignment

# Defined in

types/index.d.ts:2635 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

# yAlign

• Optional yAlign: TooltipYAlignment

# Defined in

types/index.d.ts:2636 (opens new window)

+ (opens new window)

# Interface: TooltipPosition

# Hierarchy

  • Point

    ↳ TooltipPosition

# Properties

# x

• x: number

# Inherited from

Point.x

# Defined in

types/geometric.d.ts:11 (opens new window)

# xAlign

• Optional xAlign: TooltipXAlignment

# Defined in

types/index.d.ts:2635 (opens new window)

# y

• y: number

# Inherited from

Point.y

# Defined in

types/geometric.d.ts:12 (opens new window)

# yAlign

• Optional yAlign: TooltipYAlignment

# Defined in

types/index.d.ts:2636 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TooltipPositionerMap.html b/docs/master/api/interfaces/TooltipPositionerMap.html index 6d9408814b..495259ce5f 100644 --- a/docs/master/api/interfaces/TooltipPositionerMap.html +++ b/docs/master/api/interfaces/TooltipPositionerMap.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TooltipPositionerMap

# Properties

# average

• average: TooltipPositionerFunction<keyof ChartTypeRegistry>

# Defined in

types/index.d.ts:2646 (opens new window)

# nearest

• nearest: TooltipPositionerFunction<keyof ChartTypeRegistry>

# Defined in

types/index.d.ts:2647 (opens new window)

+ (opens new window)

# Interface: TooltipPositionerMap

# Properties

# average

• average: TooltipPositionerFunction<keyof ChartTypeRegistry>

# Defined in

types/index.d.ts:2646 (opens new window)

# nearest

• nearest: TooltipPositionerFunction<keyof ChartTypeRegistry>

# Defined in

types/index.d.ts:2647 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/TypedRegistry.html b/docs/master/api/interfaces/TypedRegistry.html index 230f0f2e58..df188bdb4a 100644 --- a/docs/master/api/interfaces/TypedRegistry.html +++ b/docs/master/api/interfaces/TypedRegistry.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: TypedRegistry<T>

# Type parameters

Name
T

# Methods

# get

▸ get(id): T

# Parameters

Name Type
id string

# Returns

T

# Defined in

types/index.d.ts:1529 (opens new window)

# register

▸ register(item): string

# Parameters

Name Type
item ChartComponent

# Returns

string

The scope where items defaults were registered to.

# Defined in

types/index.d.ts:1528 (opens new window)

# unregister

▸ unregister(item): void

# Parameters

Name Type
item ChartComponent

# Returns

void

# Defined in

types/index.d.ts:1530 (opens new window)

+ (opens new window)

# Interface: TypedRegistry<T>

# Type parameters

Name
T

# Methods

# get

▸ get(id): T

# Parameters

Name Type
id string

# Returns

T

# Defined in

types/index.d.ts:1529 (opens new window)

# register

▸ register(item): string

# Parameters

Name Type
item ChartComponent

# Returns

string

The scope where items defaults were registered to.

# Defined in

types/index.d.ts:1528 (opens new window)

# unregister

▸ unregister(item): void

# Parameters

Name Type
item ChartComponent

# Returns

void

# Defined in

types/index.d.ts:1530 (opens new window)

← →

- + diff --git a/docs/master/api/interfaces/VisualElement.html b/docs/master/api/interfaces/VisualElement.html index 8c4d2264fa..a7414be28d 100644 --- a/docs/master/api/interfaces/VisualElement.html +++ b/docs/master/api/interfaces/VisualElement.html @@ -7,7 +7,7 @@ - + @@ -39,11 +39,11 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Interface: VisualElement

# Hierarchy

# Methods

# draw

▸ draw(ctx, area?): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area? ChartArea

# Returns

void

# Defined in

types/index.d.ts:1796 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Point

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Point

# Defined in

types/index.d.ts:1800 (opens new window)

# getRange

▸ Optional getRange(axis): number

# Parameters

Name Type
axis "x" | "y"

# Returns

number

# Defined in

types/index.d.ts:1801 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

types/index.d.ts:1797 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Defined in

types/index.d.ts:1798 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

types/index.d.ts:1799 (opens new window)

+ (opens new window)

# Interface: VisualElement

# Hierarchy

# Methods

# draw

▸ draw(ctx, area?): void

# Parameters

Name Type
ctx CanvasRenderingContext2D
area? ChartArea

# Returns

void

# Defined in

types/index.d.ts:1796 (opens new window)

# getCenterPoint

▸ getCenterPoint(useFinalPosition?): Point

# Parameters

Name Type
useFinalPosition? boolean

# Returns

Point

# Defined in

types/index.d.ts:1800 (opens new window)

# getRange

▸ Optional getRange(axis): number

# Parameters

Name Type
axis "x" | "y"

# Returns

number

# Defined in

types/index.d.ts:1801 (opens new window)

# inRange

▸ inRange(mouseX, mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

types/index.d.ts:1797 (opens new window)

# inXRange

▸ inXRange(mouseX, useFinalPosition?): boolean

# Parameters

Name Type
mouseX number
useFinalPosition? boolean

# Returns

boolean

# Defined in

types/index.d.ts:1798 (opens new window)

# inYRange

▸ inYRange(mouseY, useFinalPosition?): boolean

# Parameters

Name Type
mouseY number
useFinalPosition? boolean

# Returns

boolean

# Defined in

types/index.d.ts:1799 (opens new window)

←

- + diff --git a/docs/master/assets/js/10.a1b030ae.js b/docs/master/assets/js/10.273b2ce1.js similarity index 99% rename from docs/master/assets/js/10.a1b030ae.js rename to docs/master/assets/js/10.273b2ce1.js index 7eb9b597e3..ba8c211047 100644 --- a/docs/master/assets/js/10.a1b030ae.js +++ b/docs/master/assets/js/10.273b2ce1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{319:function(t,s,a){t.exports=a.p+"assets/img/preview.0cc909a8.png"},514:function(t,s,a){"use strict";a.r(s);var n=a(3),r=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"getting-started"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[t._v("#")]),t._v(" Getting Started")]),t._v(" "),s("p",[t._v("Let's get started with Chart.js!")]),t._v(" "),s("ul",[s("li",[s("strong",[s("a",{attrs:{href:"./usage"}},[t._v("Follow a step-by-step guide")]),t._v(" to get up to speed with Chart.js")])]),t._v(" "),s("li",[s("a",{attrs:{href:"./installation"}},[t._v("Install Chart.js")]),t._v(" from npm or a CDN")]),t._v(" "),s("li",[s("a",{attrs:{href:"./integration"}},[t._v("Integrate Chart.js")]),t._v(" with bundlers, loaders, and front-end frameworks")])]),t._v(" "),s("p",[t._v("Alternatively, see the example below or check "),s("a",{attrs:{href:"../samples"}},[t._v("samples")]),t._v(".")]),t._v(" "),s("h2",{attrs:{id:"create-a-chart"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-chart"}},[t._v("#")]),t._v(" Create a Chart")]),t._v(" "),s("p",[t._v("In this example, we create a bar chart for a single dataset and render it on an HTML page. Add this code snippet to your page:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("div")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("myChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/chart.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}},[s("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementById")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myChart'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Green'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purple'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Orange'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'# of Votes'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("19")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderWidth")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("beginAtZero")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("You should get a chart like this:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(319),alt:"demo"}})]),t._v(" "),s("p",[t._v("Let's break this code down.")]),t._v(" "),s("p",[t._v("First, we need to have a canvas in our page. It's recommended to give the chart its own container for "),s("RouterLink",{attrs:{to:"/configuration/responsive.html"}},[t._v("responsiveness")]),t._v(".")],1),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("div")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("myChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("Now that we have a canvas, we can include Chart.js from a CDN.")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/chart.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("Finally, we can create a chart. We add a script that acquires the "),s("code",[t._v("myChart")]),t._v(" canvas element and instantiates "),s("code",[t._v("new Chart")]),t._v(" with desired configuration: "),s("code",[t._v("bar")]),t._v(" chart type, labels, data points, and options.")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}},[s("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementById")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myChart'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Green'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purple'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Orange'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'# of Votes'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("19")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderWidth")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("beginAtZero")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("You can see all the ways to use Chart.js in the "),s("a",{attrs:{href:"./usage"}},[t._v("step-by-step guide")]),t._v(".")])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{319:function(t,s,a){t.exports=a.p+"assets/img/preview.0cc909a8.png"},517:function(t,s,a){"use strict";a.r(s);var n=a(3),r=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"getting-started"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[t._v("#")]),t._v(" Getting Started")]),t._v(" "),s("p",[t._v("Let's get started with Chart.js!")]),t._v(" "),s("ul",[s("li",[s("strong",[s("a",{attrs:{href:"./usage"}},[t._v("Follow a step-by-step guide")]),t._v(" to get up to speed with Chart.js")])]),t._v(" "),s("li",[s("a",{attrs:{href:"./installation"}},[t._v("Install Chart.js")]),t._v(" from npm or a CDN")]),t._v(" "),s("li",[s("a",{attrs:{href:"./integration"}},[t._v("Integrate Chart.js")]),t._v(" with bundlers, loaders, and front-end frameworks")])]),t._v(" "),s("p",[t._v("Alternatively, see the example below or check "),s("a",{attrs:{href:"../samples"}},[t._v("samples")]),t._v(".")]),t._v(" "),s("h2",{attrs:{id:"create-a-chart"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-chart"}},[t._v("#")]),t._v(" Create a Chart")]),t._v(" "),s("p",[t._v("In this example, we create a bar chart for a single dataset and render it on an HTML page. Add this code snippet to your page:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("div")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("myChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/chart.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}},[s("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementById")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myChart'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Green'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purple'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Orange'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'# of Votes'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("19")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderWidth")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("beginAtZero")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("You should get a chart like this:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(319),alt:"demo"}})]),t._v(" "),s("p",[t._v("Let's break this code down.")]),t._v(" "),s("p",[t._v("First, we need to have a canvas in our page. It's recommended to give the chart its own container for "),s("RouterLink",{attrs:{to:"/configuration/responsive.html"}},[t._v("responsiveness")]),t._v(".")],1),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("div")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("myChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("Now that we have a canvas, we can include Chart.js from a CDN.")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("https://cdn.jsdelivr.net/npm/chart.js"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}}),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("Finally, we can create a chart. We add a script that acquires the "),s("code",[t._v("myChart")]),t._v(" canvas element and instantiates "),s("code",[t._v("new Chart")]),t._v(" with desired configuration: "),s("code",[t._v("bar")]),t._v(" chart type, labels, data points, and options.")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token script"}},[s("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementById")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myChart'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Green'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purple'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Orange'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'# of Votes'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("19")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderWidth")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("beginAtZero")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),s("p",[t._v("You can see all the ways to use Chart.js in the "),s("a",{attrs:{href:"./usage"}},[t._v("step-by-step guide")]),t._v(".")])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/100.26a68ecc.js b/docs/master/assets/js/100.c6550008.js similarity index 89% rename from docs/master/assets/js/100.26a68ecc.js rename to docs/master/assets/js/100.c6550008.js index e949cc6fd5..c6df109a2a 100644 --- a/docs/master/assets/js/100.26a68ecc.js +++ b/docs/master/assets/js/100.c6550008.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{432:function(t,e,r){"use strict";r.r(e);var n=r(3),o=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-pointprefixedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-pointprefixedoptions"}},[t._v("#")]),t._v(" Interface: PointPrefixedOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"pointbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointbackgroundcolor"}},[t._v("#")]),t._v(" pointBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The fill color for points.")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2023",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2023"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointbordercolor"}},[t._v("#")]),t._v(" pointBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The border color for points.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2027",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2027"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointborderwidth"}},[t._v("#")]),t._v(" pointBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBorderWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The width of the point border in pixels.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2031",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2031"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointhitradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointhitradius"}},[t._v("#")]),t._v(" pointHitRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointHitRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The pixel size of the non-displayed point that reacts to mouse events.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2035",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2035"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointradius"}},[t._v("#")]),t._v(" pointRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The radius of the point shape. If set to 0, the point is not rendered.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2039",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2039"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointrotation"}},[t._v("#")]),t._v(" pointRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The rotation of the point in degrees.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2043",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2043"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" pointStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])])],1),t._v(" "),e("p",[t._v("Style of the point.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2047",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2047"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{434:function(t,e,r){"use strict";r.r(e);var n=r(3),o=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-pointprefixedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-pointprefixedoptions"}},[t._v("#")]),t._v(" Interface: PointPrefixedOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"pointbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointbackgroundcolor"}},[t._v("#")]),t._v(" pointBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The fill color for points.")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2023",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2023"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointbordercolor"}},[t._v("#")]),t._v(" pointBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The border color for points.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2027",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2027"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointborderwidth"}},[t._v("#")]),t._v(" pointBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBorderWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The width of the point border in pixels.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2031",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2031"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointhitradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointhitradius"}},[t._v("#")]),t._v(" pointHitRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointHitRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The pixel size of the non-displayed point that reacts to mouse events.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2035",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2035"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointradius"}},[t._v("#")]),t._v(" pointRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The radius of the point shape. If set to 0, the point is not rendered.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2039",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2039"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointrotation"}},[t._v("#")]),t._v(" pointRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The rotation of the point in degrees.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2043",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2043"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" pointStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])])],1),t._v(" "),e("p",[t._v("Style of the point.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2047",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2047"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/101.956eb55a.js b/docs/master/assets/js/101.a8cb6a8d.js similarity index 95% rename from docs/master/assets/js/101.956eb55a.js rename to docs/master/assets/js/101.a8cb6a8d.js index 206cc80c0a..8b4c9d2225 100644 --- a/docs/master/assets/js/101.956eb55a.js +++ b/docs/master/assets/js/101.a8cb6a8d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{433:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-polarareacontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-polarareacontroller"}},[t._v("#")]),t._v(" Interface: PolarAreaController")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("PolarAreaController")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"cachedmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cachedmeta"}},[t._v("#")]),t._v(" _cachedMeta")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("_cachedMeta")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController._cachedMeta")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L592",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:592"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.chart")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L590",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:590"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"enableoptionsharing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enableoptionsharing"}},[t._v("#")]),t._v(" enableOptionSharing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("enableOptionSharing")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.enableOptionSharing")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.index")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"innerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#innerradius"}},[t._v("#")]),t._v(" innerRadius")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("innerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.innerRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"offsetx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offsetx"}},[t._v("#")]),t._v(" offsetX")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("offsetX")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.offsetX")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"offsety"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offsety"}},[t._v("#")]),t._v(" offsetY")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("offsetY")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.offsetY")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"outerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#outerradius"}},[t._v("#")]),t._v(" outerRadius")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("outerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.outerRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L342",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:342"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"supportsdecimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#supportsdecimation"}},[t._v("#")]),t._v(" supportsDecimation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("supportsDecimation")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.supportsDecimation")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L597",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:597"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"addelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addelements"}},[t._v("#")]),t._v(" addElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addElements")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.addElements")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L613",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:613"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"applystack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#applystack"}},[t._v("#")]),t._v(" applyStack")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("applyStack")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.applyStack")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L649",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:649"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdateelements"}},[t._v("#")]),t._v(" buildOrUpdateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateElements")]),t._v("("),e("code",[t._v("resetNewElements?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("resetNewElements?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.buildOrUpdateElements")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L614",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:614"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatecircumference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatecircumference"}},[t._v("#")]),t._v(" calculateCircumference")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateCircumference")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.calculateCircumference")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatetotal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatetotal"}},[t._v("#")]),t._v(" calculateTotal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateTotal")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.calculateTotal")]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.configure")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L611",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:611"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"countvisibleelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#countvisibleelements"}},[t._v("#")]),t._v(" countVisibleElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("countVisibleElements")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L393",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:393"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.draw")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L606",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:606"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getallparsedvalues"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getallparsedvalues"}},[t._v("#")]),t._v(" getAllParsedValues")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getAllParsedValues")]),t._v("("),e("code",[t._v("scale")]),t._v("): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getAllParsedValues")]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L600",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:600"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdataset"}},[t._v("#")]),t._v(" getDataset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataset")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getDataset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L608",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:608"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelandvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelandvalue"}},[t._v("#")]),t._v(" getLabelAndValue")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getLabelAndValue")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("label")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getLabelAndValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L601",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:601"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaxoverflow"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaxoverflow"}},[t._v("#")]),t._v(" getMaxOverflow")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMaxOverflow")]),t._v("(): "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getMaxOverflow")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmeta"}},[t._v("#")]),t._v(" getMeta")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMeta")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getMeta")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L609",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:609"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("canStack?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getMinMax")]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L656",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:656"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getparsed"}},[t._v("#")]),t._v(" getParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getParsed")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")])],1),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getParsed")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L648",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:648"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getscaleforid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getscaleforid"}},[t._v("#")]),t._v(" getScaleForId")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getScaleForId")]),t._v("("),e("code",[t._v("scaleID")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scaleID")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getScaleForId")]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L610",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:610"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getsharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getsharedoptions"}},[t._v("#")]),t._v(" getSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getSharedOptions")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("p",[t._v("Utility for checking if the options are shared and should be animated separately.")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getSharedOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L623",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:623"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getstyle"}},[t._v("#")]),t._v(" getStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getStyle")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("active")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L616",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:616"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"includeoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#includeoptions"}},[t._v("#")]),t._v(" includeOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("includeOptions")]),t._v("("),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("sharedOptions")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Utility for determining if "),e("code",[t._v("options")]),t._v(" should be included in the updated properties")]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.includeOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L628",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:628"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"initialize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#initialize"}},[t._v("#")]),t._v(" initialize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("initialize")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.initialize")]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L612",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:612"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linkscales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linkscales"}},[t._v("#")]),t._v(" linkScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("linkScales")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.linkScales")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L599",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:599"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parse")]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L644",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:644"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsearraydata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsearraydata"}},[t._v("#")]),t._v(" parseArrayData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseArrayData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parseArrayData")]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L646",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:646"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseobjectdata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseobjectdata"}},[t._v("#")]),t._v(" parseObjectData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseObjectData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parseObjectData")]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L647",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:647"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseprimitivedata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseprimitivedata"}},[t._v("#")]),t._v(" parsePrimitiveData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parsePrimitiveData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parsePrimitiveData")]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L645",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:645"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removehoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removehoverstyle"}},[t._v("#")]),t._v(" removeHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.removeHoverStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L641",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:641"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("reset")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.reset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L607",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:607"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedataelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedataelementoptions"}},[t._v("#")]),t._v(" resolveDataElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDataElementOptions")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.resolveDataElementOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L618",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:618"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedatasetelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedatasetelementoptions"}},[t._v("#")]),t._v(" resolveDatasetElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDatasetElementOptions")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.resolveDatasetElementOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"sethoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sethoverstyle"}},[t._v("#")]),t._v(" setHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.setHoverStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L642",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:642"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.update")]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L603",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:603"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelement"}},[t._v("#")]),t._v(" updateElement")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateElement")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("properties")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility for updating an element with new properties, using animations when appropriate.")]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("properties")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateElement")]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L634",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:634"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelements"}},[t._v("#")]),t._v(" updateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateElements")]),t._v("("),e("code",[t._v("elements")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("elements")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateElements")]),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L602",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:602"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateindex"}},[t._v("#")]),t._v(" updateIndex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateIndex")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateIndex")]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L604",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:604"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updaterangefromparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updaterangefromparsed"}},[t._v("#")]),t._v(" updateRangeFromParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateRangeFromParsed")]),t._v("("),e("code",[t._v("range")]),t._v(", "),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v(", "),e("code",[t._v("stack")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("stack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateRangeFromParsed")]),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L650",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:650"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatesharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatesharedoptions"}},[t._v("#")]),t._v(" updateSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateSharedOptions")]),t._v("("),e("code",[t._v("sharedOptions")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("newOptions")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility to animate the shared options, that are potentially affecting multiple elements.")]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("newOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateSharedOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L640",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:640"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{432:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-polarareacontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-polarareacontroller"}},[t._v("#")]),t._v(" Interface: PolarAreaController")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("PolarAreaController")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"cachedmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cachedmeta"}},[t._v("#")]),t._v(" _cachedMeta")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("_cachedMeta")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController._cachedMeta")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L592",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:592"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.chart")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L590",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:590"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"enableoptionsharing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enableoptionsharing"}},[t._v("#")]),t._v(" enableOptionSharing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("enableOptionSharing")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.enableOptionSharing")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.index")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"innerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#innerradius"}},[t._v("#")]),t._v(" innerRadius")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("innerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.innerRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"offsetx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offsetx"}},[t._v("#")]),t._v(" offsetX")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("offsetX")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.offsetX")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"offsety"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offsety"}},[t._v("#")]),t._v(" offsetY")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("offsetY")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.offsetY")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"outerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#outerradius"}},[t._v("#")]),t._v(" outerRadius")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("outerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.outerRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L342",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:342"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"supportsdecimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#supportsdecimation"}},[t._v("#")]),t._v(" supportsDecimation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("supportsDecimation")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.supportsDecimation")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L597",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:597"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"addelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addelements"}},[t._v("#")]),t._v(" addElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addElements")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.addElements")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L613",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:613"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"applystack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#applystack"}},[t._v("#")]),t._v(" applyStack")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("applyStack")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.applyStack")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L649",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:649"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdateelements"}},[t._v("#")]),t._v(" buildOrUpdateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateElements")]),t._v("("),e("code",[t._v("resetNewElements?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("resetNewElements?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.buildOrUpdateElements")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L614",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:614"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatecircumference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatecircumference"}},[t._v("#")]),t._v(" calculateCircumference")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateCircumference")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.calculateCircumference")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatetotal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatetotal"}},[t._v("#")]),t._v(" calculateTotal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateTotal")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.calculateTotal")]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.configure")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L611",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:611"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"countvisibleelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#countvisibleelements"}},[t._v("#")]),t._v(" countVisibleElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("countVisibleElements")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L393",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:393"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.draw")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L606",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:606"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getallparsedvalues"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getallparsedvalues"}},[t._v("#")]),t._v(" getAllParsedValues")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getAllParsedValues")]),t._v("("),e("code",[t._v("scale")]),t._v("): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getAllParsedValues")]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L600",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:600"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdataset"}},[t._v("#")]),t._v(" getDataset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataset")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getDataset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L608",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:608"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelandvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelandvalue"}},[t._v("#")]),t._v(" getLabelAndValue")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getLabelAndValue")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("label")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getLabelAndValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L601",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:601"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaxoverflow"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaxoverflow"}},[t._v("#")]),t._v(" getMaxOverflow")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMaxOverflow")]),t._v("(): "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getMaxOverflow")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmeta"}},[t._v("#")]),t._v(" getMeta")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMeta")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getMeta")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L609",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:609"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("canStack?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getMinMax")]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L656",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:656"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getparsed"}},[t._v("#")]),t._v(" getParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getParsed")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")])],1),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getParsed")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L648",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:648"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getscaleforid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getscaleforid"}},[t._v("#")]),t._v(" getScaleForId")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getScaleForId")]),t._v("("),e("code",[t._v("scaleID")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scaleID")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getScaleForId")]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L610",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:610"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getsharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getsharedoptions"}},[t._v("#")]),t._v(" getSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getSharedOptions")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("p",[t._v("Utility for checking if the options are shared and should be animated separately.")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getSharedOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L623",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:623"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getstyle"}},[t._v("#")]),t._v(" getStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getStyle")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("active")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.getStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L616",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:616"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"includeoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#includeoptions"}},[t._v("#")]),t._v(" includeOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("includeOptions")]),t._v("("),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("sharedOptions")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Utility for determining if "),e("code",[t._v("options")]),t._v(" should be included in the updated properties")]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.includeOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L628",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:628"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"initialize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#initialize"}},[t._v("#")]),t._v(" initialize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("initialize")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.initialize")]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L612",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:612"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linkscales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linkscales"}},[t._v("#")]),t._v(" linkScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("linkScales")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.linkScales")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L599",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:599"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parse")]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L644",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:644"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsearraydata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsearraydata"}},[t._v("#")]),t._v(" parseArrayData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseArrayData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parseArrayData")]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L646",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:646"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseobjectdata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseobjectdata"}},[t._v("#")]),t._v(" parseObjectData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseObjectData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parseObjectData")]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L647",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:647"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseprimitivedata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseprimitivedata"}},[t._v("#")]),t._v(" parsePrimitiveData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parsePrimitiveData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.parsePrimitiveData")]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L645",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:645"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removehoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removehoverstyle"}},[t._v("#")]),t._v(" removeHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.removeHoverStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L641",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:641"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("reset")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.reset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L607",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:607"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedataelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedataelementoptions"}},[t._v("#")]),t._v(" resolveDataElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDataElementOptions")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.resolveDataElementOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L618",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:618"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedatasetelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedatasetelementoptions"}},[t._v("#")]),t._v(" resolveDatasetElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDatasetElementOptions")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.resolveDatasetElementOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"sethoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sethoverstyle"}},[t._v("#")]),t._v(" setHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.setHoverStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L642",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:642"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.update")]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L603",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:603"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelement"}},[t._v("#")]),t._v(" updateElement")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateElement")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("properties")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility for updating an element with new properties, using animations when appropriate.")]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("properties")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateElement")]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L634",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:634"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelements"}},[t._v("#")]),t._v(" updateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateElements")]),t._v("("),e("code",[t._v("elements")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("elements")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateElements")]),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L602",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:602"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateindex"}},[t._v("#")]),t._v(" updateIndex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateIndex")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateIndex")]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L604",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:604"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updaterangefromparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updaterangefromparsed"}},[t._v("#")]),t._v(" updateRangeFromParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateRangeFromParsed")]),t._v("("),e("code",[t._v("range")]),t._v(", "),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v(", "),e("code",[t._v("stack")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("stack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateRangeFromParsed")]),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L650",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:650"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatesharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatesharedoptions"}},[t._v("#")]),t._v(" updateSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateSharedOptions")]),t._v("("),e("code",[t._v("sharedOptions")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("newOptions")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility to animate the shared options, that are potentially affecting multiple elements.")]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("newOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("DoughnutController.updateSharedOptions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L640",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:640"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/102.11a2b87f.js b/docs/master/assets/js/102.11a2b87f.js new file mode 100644 index 0000000000..0c370d09bc --- /dev/null +++ b/docs/master/assets/js/102.11a2b87f.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{433:function(t,r,a){"use strict";a.r(r);var e=a(3),n=Object(e.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"interface-polarareacontrollerchartoptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-polarareacontrollerchartoptions"}},[t._v("#")]),t._v(" Interface: PolarAreaControllerChartOptions")]),t._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("h3",{attrs:{id:"animation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("animation")]),t._v(": "),r("code",[t._v("false")]),t._v(" | "),r("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[r("code",[t._v("DoughnutAnimationOptions")])])],1),t._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L389",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:389"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"startangle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#startangle"}},[t._v("#")]),t._v(" startAngle")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("startAngle")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("p",[t._v("Starting angle to draw arcs for the first item in a dataset. In degrees, 0 is at top.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("0")]),t._v(" "),r("h4",{attrs:{id:"defined-in-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L387",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:387"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/102.d544609b.js b/docs/master/assets/js/102.d544609b.js deleted file mode 100644 index 50253f51d8..0000000000 --- a/docs/master/assets/js/102.d544609b.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{436:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-polarareacontrollerchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-polarareacontrollerchartoptions"}},[t._v("#")]),t._v(" Interface: PolarAreaControllerChartOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[e("code",[t._v("DoughnutAnimationOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L389",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:389"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"startangle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#startangle"}},[t._v("#")]),t._v(" startAngle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("startAngle")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Starting angle to draw arcs for the first item in a dataset. In degrees, 0 is at top.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L387",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:387"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/103.34b70175.js b/docs/master/assets/js/103.d71af857.js similarity index 95% rename from docs/master/assets/js/103.34b70175.js rename to docs/master/assets/js/103.d71af857.js index 94ec4a5f90..fbb06f9872 100644 --- a/docs/master/assets/js/103.34b70175.js +++ b/docs/master/assets/js/103.d71af857.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{435:function(t,e,r){"use strict";r.r(e);var a=r(3),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-polarareacontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-polarareacontrollerdatasetoptions"}},[t._v("#")]),t._v(" Interface: PolarAreaControllerDatasetOptions")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[e("code",[t._v("DoughnutControllerDatasetOptions")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("PolarAreaControllerDatasetOptions")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"angle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#angle"}},[t._v("#")]),t._v(" angle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("angle")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Arc angle to cover. - for polar only")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("circumference / (arc count)")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L377",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:377"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v("> & { "),e("code",[t._v("onComplete?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" ; "),e("code",[t._v("onProgress?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#animation"}},[t._v("animation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1747"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animations")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#animations"}},[t._v("animations")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1757",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1757"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#backgroundcolor"}},[t._v("backgroundColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1807"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderalign"}},[t._v("#")]),t._v(" borderAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"inner"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Arc stroke alignment.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderalign"}},[t._v("borderAlign")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1833",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1833"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#bordercolor"}},[t._v("borderColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1806"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[t._v("#")]),t._v(" borderDash")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line dash. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderdash"}},[t._v("borderDash")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1838",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1838"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[t._v("#")]),t._v(" borderDashOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line dash offset. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0.0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderdashoffset"}},[t._v("borderDashOffset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1843",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1843"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderjoinstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderjoinstyle"}},[t._v("#")]),t._v(" borderJoinStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderJoinStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("CanvasLineJoin")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line join style. See MDN. Default is 'round' when "),e("code",[t._v("borderAlign")]),t._v(" is 'inner', else 'bevel'.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderjoinstyle"}},[t._v("borderJoinStyle")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1847",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1847"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[t._v("#")]),t._v(" borderRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcBorderRadius.html"}},[e("code",[t._v("ArcBorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Sets the border radius for arcs")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderradius"}},[t._v("borderRadius")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1853",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1853"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderwidth"}},[t._v("borderWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1805",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1805"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"circular"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#circular"}},[t._v("#")]),t._v(" circular")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("circular")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("If false, Arc will be flat.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#circular"}},[t._v("circular")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1864",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1864"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"circumference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#circumference"}},[t._v("#")]),t._v(" circumference")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("circumference")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Sweep to allow arcs to cover.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("360")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#circumference"}},[t._v("circumference")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L257",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:257"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"clip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clip"}},[t._v("#")]),t._v(" clip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("clip")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#clip"}},[t._v("clip")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:75"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hidden"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hidden"}},[t._v("#")]),t._v(" hidden")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hidden")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hidden"}},[t._v("hidden")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:93"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[t._v("#")]),t._v(" hoverBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverbackgroundcolor"}},[t._v("hoverBackgroundColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1813"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[t._v("#")]),t._v(" hoverBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverbordercolor"}},[t._v("hoverBorderColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1812"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdash"}},[t._v("#")]),t._v(" hoverBorderDash")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverborderdash"}},[t._v("hoverBorderDash")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1873",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1873"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdashoffset"}},[t._v("#")]),t._v(" hoverBorderDashOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverborderdashoffset"}},[t._v("hoverBorderDashOffset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1874",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1874"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[t._v("#")]),t._v(" hoverBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverborderwidth"}},[t._v("hoverBorderWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1811"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoveroffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoveroffset"}},[t._v("#")]),t._v(" hoverOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoveroffset"}},[t._v("hoverOffset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1875",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1875"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"indexaxis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#indexaxis"}},[t._v("#")]),t._v(" indexAxis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("indexAxis")]),t._v(": "),e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])]),t._v(" "),e("p",[t._v("The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'x'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#indexaxis"}},[t._v("indexAxis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:71"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The label for the dataset which appears in the legend and tooltips.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#label"}},[t._v("label")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:79"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"normalized"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#normalized"}},[t._v("#")]),t._v(" normalized")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("normalized")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#normalized"}},[t._v("normalized")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:63"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"offset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offset"}},[t._v("#")]),t._v(" offset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("offset")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("p",[t._v("Arc offset (in pixels).")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#offset"}},[t._v("offset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L262",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:262"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"order"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#order"}},[t._v("#")]),t._v(" order")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("order")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#order"}},[t._v("order")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:83"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsing")]),t._v(": "),e("code",[t._v("false")]),t._v(" | { "),e("code",[t._v("[key: string]")]),t._v(": "),e("code",[t._v("string")]),t._v("; }")]),t._v(" "),e("p",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#parsing"}},[t._v("parsing")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"rotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" rotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Starting angle to draw this dataset from.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#rotation"}},[t._v("rotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"spacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spacing"}},[t._v("#")]),t._v(" spacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("spacing")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Similar to the "),e("code",[t._v("offset")]),t._v(" option, but applies to all arcs. This can be used to to add spaces\nbetween arcs")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#spacing"}},[t._v("spacing")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("stack")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#stack"}},[t._v("stack")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:88"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("transitions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[e("code",[t._v("TransitionsSpec")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#transitions"}},[t._v("transitions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1758"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("1")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:274"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{435:function(t,e,r){"use strict";r.r(e);var a=r(3),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-polarareacontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-polarareacontrollerdatasetoptions"}},[t._v("#")]),t._v(" Interface: PolarAreaControllerDatasetOptions")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[e("code",[t._v("DoughnutControllerDatasetOptions")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("PolarAreaControllerDatasetOptions")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"angle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#angle"}},[t._v("#")]),t._v(" angle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("angle")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Arc angle to cover. - for polar only")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("circumference / (arc count)")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L377",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:377"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v("> & { "),e("code",[t._v("onComplete?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" ; "),e("code",[t._v("onProgress?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#animation"}},[t._v("animation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1747"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animations")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#animations"}},[t._v("animations")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1757",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1757"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#backgroundcolor"}},[t._v("backgroundColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1807"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderalign"}},[t._v("#")]),t._v(" borderAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"inner"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Arc stroke alignment.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderalign"}},[t._v("borderAlign")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1833",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1833"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#bordercolor"}},[t._v("borderColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1806"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[t._v("#")]),t._v(" borderDash")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line dash. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderdash"}},[t._v("borderDash")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1838",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1838"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[t._v("#")]),t._v(" borderDashOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line dash offset. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0.0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderdashoffset"}},[t._v("borderDashOffset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1843",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1843"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderjoinstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderjoinstyle"}},[t._v("#")]),t._v(" borderJoinStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderJoinStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("CanvasLineJoin")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line join style. See MDN. Default is 'round' when "),e("code",[t._v("borderAlign")]),t._v(" is 'inner', else 'bevel'.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderjoinstyle"}},[t._v("borderJoinStyle")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1847",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1847"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[t._v("#")]),t._v(" borderRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcBorderRadius.html"}},[e("code",[t._v("ArcBorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Sets the border radius for arcs")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderradius"}},[t._v("borderRadius")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1853",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1853"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#borderwidth"}},[t._v("borderWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1805",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1805"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"circular"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#circular"}},[t._v("#")]),t._v(" circular")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("circular")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("If false, Arc will be flat.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#circular"}},[t._v("circular")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1864",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1864"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"circumference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#circumference"}},[t._v("#")]),t._v(" circumference")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("circumference")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Sweep to allow arcs to cover.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("360")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#circumference"}},[t._v("circumference")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L257",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:257"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"clip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clip"}},[t._v("#")]),t._v(" clip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("clip")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#clip"}},[t._v("clip")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:75"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hidden"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hidden"}},[t._v("#")]),t._v(" hidden")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hidden")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hidden"}},[t._v("hidden")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:93"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[t._v("#")]),t._v(" hoverBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverbackgroundcolor"}},[t._v("hoverBackgroundColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1813"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[t._v("#")]),t._v(" hoverBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverbordercolor"}},[t._v("hoverBorderColor")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1812"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdash"}},[t._v("#")]),t._v(" hoverBorderDash")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverborderdash"}},[t._v("hoverBorderDash")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1873",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1873"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdashoffset"}},[t._v("#")]),t._v(" hoverBorderDashOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverborderdashoffset"}},[t._v("hoverBorderDashOffset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1874",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1874"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[t._v("#")]),t._v(" hoverBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoverborderwidth"}},[t._v("hoverBorderWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1811"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoveroffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoveroffset"}},[t._v("#")]),t._v(" hoverOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#hoveroffset"}},[t._v("hoverOffset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1875",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1875"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"indexaxis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#indexaxis"}},[t._v("#")]),t._v(" indexAxis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("indexAxis")]),t._v(": "),e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])]),t._v(" "),e("p",[t._v("The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'x'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#indexaxis"}},[t._v("indexAxis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:71"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The label for the dataset which appears in the legend and tooltips.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#label"}},[t._v("label")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:79"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"normalized"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#normalized"}},[t._v("#")]),t._v(" normalized")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("normalized")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#normalized"}},[t._v("normalized")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:63"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"offset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offset"}},[t._v("#")]),t._v(" offset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("offset")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("p",[t._v("Arc offset (in pixels).")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#offset"}},[t._v("offset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L262",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:262"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"order"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#order"}},[t._v("#")]),t._v(" order")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("order")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#order"}},[t._v("order")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:83"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsing")]),t._v(": "),e("code",[t._v("false")]),t._v(" | { "),e("code",[t._v("[key: string]")]),t._v(": "),e("code",[t._v("string")]),t._v("; }")]),t._v(" "),e("p",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#parsing"}},[t._v("parsing")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"rotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" rotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Starting angle to draw this dataset from.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#rotation"}},[t._v("rotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"spacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spacing"}},[t._v("#")]),t._v(" spacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("spacing")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Similar to the "),e("code",[t._v("offset")]),t._v(" option, but applies to all arcs. This can be used to to add spaces\nbetween arcs")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#spacing"}},[t._v("spacing")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("stack")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#stack"}},[t._v("stack")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:88"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("transitions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[e("code",[t._v("TransitionsSpec")])]),t._v("<"),e("code",[t._v('"doughnut"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#transitions"}},[t._v("transitions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1758"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("1")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:274"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/104.12559c72.js b/docs/master/assets/js/104.12559c72.js new file mode 100644 index 0000000000..014bd5e0e0 --- /dev/null +++ b/docs/master/assets/js/104.12559c72.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{436:function(t,r,e){"use strict";e.r(r);var a=e(3),i=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"interface-radarcontrollerdatasetoptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-radarcontrollerdatasetoptions"}},[t._v("#")]),t._v(" Interface: RadarControllerDatasetOptions")]),t._v(" "),r("h2",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("ul",[r("li",[r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[r("code",[t._v("ControllerDatasetOptions")])])],1)]),t._v(" "),r("li",[r("p",[r("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[r("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[r("code",[t._v("PointOptions")])]),t._v(" & "),r("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[r("code",[t._v("PointHoverOptions")])]),t._v(" & "),r("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedOptions.html"}},[r("code",[t._v("PointPrefixedOptions")])]),t._v(" & "),r("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedHoverOptions.html"}},[r("code",[t._v("PointPrefixedHoverOptions")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1)]),t._v(" "),r("li",[r("p",[r("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[r("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/interfaces/LineOptions.html"}},[r("code",[t._v("LineOptions")])]),t._v(" & "),r("RouterLink",{attrs:{to:"/api/interfaces/LineHoverOptions.html"}},[r("code",[t._v("LineHoverOptions")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1)]),t._v(" "),r("li",[r("p",[r("RouterLink",{attrs:{to:"/api/#animationoptions"}},[r("code",[t._v("AnimationOptions")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">")],1),t._v(" "),r("p",[t._v("↳ "),r("strong",[r("code",[t._v("RadarControllerDatasetOptions")])])])])]),t._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("h3",{attrs:{id:"animation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("animation")]),t._v(": "),r("code",[t._v("false")]),t._v(" | "),r("RouterLink",{attrs:{to:"/api/#animationspec"}},[r("code",[t._v("AnimationSpec")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v("> & { "),r("code",[t._v("onComplete?")]),t._v(": ("),r("code",[t._v("this")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[r("code",[t._v("Chart")])]),t._v(", "),r("code",[t._v("event")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[r("code",[t._v("AnimationEvent")])]),t._v(") => "),r("code",[t._v("void")]),t._v(" ; "),r("code",[t._v("onProgress?")]),t._v(": ("),r("code",[t._v("this")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[r("code",[t._v("Chart")])]),t._v(", "),r("code",[t._v("event")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[r("code",[t._v("AnimationEvent")])]),t._v(") => "),r("code",[t._v("void")]),t._v(" }")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("AnimationOptions.animation")]),t._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1747"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"animations"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("animations")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#animationsspec"}},[r("code",[t._v("AnimationsSpec")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("AnimationOptions.animations")]),t._v(" "),r("h4",{attrs:{id:"defined-in-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1757",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1757"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"backgroundcolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("backgroundColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.backgroundColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1807"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"bordercapstyle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bordercapstyle"}},[t._v("#")]),t._v(" borderCapStyle")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("borderCapStyle")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("CanvasLineCap")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Line cap style. See MDN.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("'butt'")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.borderCapStyle")]),t._v(" "),r("h4",{attrs:{id:"defined-in-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1887",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1887"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"bordercolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("borderColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.borderColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1806"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"borderdash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[t._v("#")]),t._v(" borderDash")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("borderDash")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v("[], "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Line dash. See MDN.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("[]")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.borderDash")]),t._v(" "),r("h4",{attrs:{id:"defined-in-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1892",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1892"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"borderdashoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[t._v("#")]),t._v(" borderDashOffset")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("borderDashOffset")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Line dash offset. See MDN.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("0.0")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.borderDashOffset")]),t._v(" "),r("h4",{attrs:{id:"defined-in-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1897",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1897"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"borderjoinstyle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderjoinstyle"}},[t._v("#")]),t._v(" borderJoinStyle")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("borderJoinStyle")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("CanvasLineJoin")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Line join style. See MDN.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("'miter'")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.borderJoinStyle")]),t._v(" "),r("h4",{attrs:{id:"defined-in-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1902",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1902"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"borderwidth"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("borderWidth")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.borderWidth")]),t._v(" "),r("h4",{attrs:{id:"defined-in-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1805",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1805"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"capbezierpoints"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#capbezierpoints"}},[t._v("#")]),t._v(" capBezierPoints")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("capBezierPoints")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("boolean")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("true to keep Bézier control inside the chart, false for no restriction.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("true")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.capBezierPoints")]),t._v(" "),r("h4",{attrs:{id:"defined-in-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1907",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1907"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"clip"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#clip"}},[t._v("#")]),t._v(" clip")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("clip")]),t._v(": "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("false")]),t._v(" | "),r("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[r("code",[t._v("ChartArea")])])],1),t._v(" "),r("p",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: "),r("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),r("h4",{attrs:{id:"inherited-from-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#clip"}},[t._v("clip")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:75"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"cubicinterpolationmode"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#cubicinterpolationmode"}},[t._v("#")]),t._v(" cubicInterpolationMode")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("cubicInterpolationMode")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v('"default"')]),t._v(" | "),r("code",[t._v('"monotone"')]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Interpolation mode to apply.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("'default'")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.cubicInterpolationMode")]),t._v(" "),r("h4",{attrs:{id:"defined-in-12"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1912",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1912"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"drawactiveelementsontop"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#drawactiveelementsontop"}},[t._v("#")]),t._v(" drawActiveElementsOnTop")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("drawActiveElementsOnTop")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("boolean")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Draw the active elements over the other elements of the dataset,")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("true")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.drawActiveElementsOnTop")]),t._v(" "),r("h4",{attrs:{id:"defined-in-13"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2008",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2008"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"fill"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#fill"}},[t._v("#")]),t._v(" fill")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("fill")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#filltarget"}},[r("code",[t._v("FillTarget")])]),t._v(" | "),r("RouterLink",{attrs:{to:"/api/interfaces/ComplexFillTarget.html"}},[r("code",[t._v("ComplexFillTarget")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-14"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.fill")]),t._v(" "),r("h4",{attrs:{id:"defined-in-14"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1926",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1926"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hidden"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hidden"}},[t._v("#")]),t._v(" hidden")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hidden")]),t._v(": "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[t._v("Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("false")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-15"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#hidden"}},[t._v("hidden")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-15"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:93"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hitradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hitradius"}},[t._v("#")]),t._v(" hitRadius")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hitRadius")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Extra radius added to point radius for hit detection.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("1")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-16"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hitRadius")]),t._v(" "),r("h4",{attrs:{id:"defined-in-16"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1993",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1993"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverbackgroundcolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[t._v("#")]),t._v(" hoverBackgroundColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverBackgroundColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-17"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverBackgroundColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-17"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1813"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverbordercapstyle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercapstyle"}},[t._v("#")]),t._v(" hoverBorderCapStyle")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverBorderCapStyle")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("CanvasLineCap")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-18"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverBorderCapStyle")]),t._v(" "),r("h4",{attrs:{id:"defined-in-18"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1944",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1944"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverbordercolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[t._v("#")]),t._v(" hoverBorderColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverBorderColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-19"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverBorderColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-19"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1812"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverborderdash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdash"}},[t._v("#")]),t._v(" hoverBorderDash")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverBorderDash")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v("[], "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-20"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverBorderDash")]),t._v(" "),r("h4",{attrs:{id:"defined-in-20"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1945",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1945"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverborderdashoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdashoffset"}},[t._v("#")]),t._v(" hoverBorderDashOffset")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverBorderDashOffset")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-21"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverBorderDashOffset")]),t._v(" "),r("h4",{attrs:{id:"defined-in-21"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1946",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1946"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverborderjoinstyle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderjoinstyle"}},[t._v("#")]),t._v(" hoverBorderJoinStyle")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverBorderJoinStyle")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("CanvasLineJoin")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-22"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverBorderJoinStyle")]),t._v(" "),r("h4",{attrs:{id:"defined-in-22"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1947",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1947"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverborderwidth"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[t._v("#")]),t._v(" hoverBorderWidth")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverBorderWidth")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-23"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverBorderWidth")]),t._v(" "),r("h4",{attrs:{id:"defined-in-23"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1811"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"hoverradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hoverradius"}},[t._v("#")]),t._v(" hoverRadius")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("hoverRadius")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Point radius when hovered.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("4")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-24"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.hoverRadius")]),t._v(" "),r("h4",{attrs:{id:"defined-in-24"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2016",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2016"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"indexaxis"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#indexaxis"}},[t._v("#")]),t._v(" indexAxis")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("indexAxis")]),t._v(": "),r("code",[t._v('"x"')]),t._v(" | "),r("code",[t._v('"y"')])]),t._v(" "),r("p",[t._v("The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("'x'")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-25"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#indexaxis"}},[t._v("indexAxis")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-25"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:71"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"label"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("label")]),t._v(": "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("The label for the dataset which appears in the legend and tooltips.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-26"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#label"}},[t._v("label")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-26"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:79"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"normalized"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#normalized"}},[t._v("#")]),t._v(" normalized")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("normalized")]),t._v(": "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-27"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#normalized"}},[t._v("normalized")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-27"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:63"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"order"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#order"}},[t._v("#")]),t._v(" order")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("order")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("p",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-28"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#order"}},[t._v("order")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-28"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:83"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"parsing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("parsing")]),t._v(": "),r("code",[t._v("false")]),t._v(" | { "),r("code",[t._v("[key: string]")]),t._v(": "),r("code",[t._v("string")]),t._v("; }")]),t._v(" "),r("p",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-29"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#parsing"}},[t._v("parsing")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-29"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:54"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointbackgroundcolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointbackgroundcolor"}},[t._v("#")]),t._v(" pointBackgroundColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointBackgroundColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("The fill color for points.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-30"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointBackgroundColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-30"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2023",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2023"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointbordercolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointbordercolor"}},[t._v("#")]),t._v(" pointBorderColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointBorderColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("The border color for points.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-31"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointBorderColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-31"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2027",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2027"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointborderwidth"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointborderwidth"}},[t._v("#")]),t._v(" pointBorderWidth")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointBorderWidth")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("The width of the point border in pixels.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-32"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointBorderWidth")]),t._v(" "),r("h4",{attrs:{id:"defined-in-32"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2031",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2031"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointhitradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointhitradius"}},[t._v("#")]),t._v(" pointHitRadius")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointHitRadius")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("The pixel size of the non-displayed point that reacts to mouse events.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-33"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointHitRadius")]),t._v(" "),r("h4",{attrs:{id:"defined-in-33"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2035",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2035"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointhoverbackgroundcolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverbackgroundcolor"}},[t._v("#")]),t._v(" pointHoverBackgroundColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointHoverBackgroundColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Point background color when hovered.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-34"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointHoverBackgroundColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-34"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2054",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2054"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointhoverbordercolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverbordercolor"}},[t._v("#")]),t._v(" pointHoverBorderColor")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointHoverBorderColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Point border color when hovered.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-35"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointHoverBorderColor")]),t._v(" "),r("h4",{attrs:{id:"defined-in-35"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2058",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2058"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointhoverborderwidth"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverborderwidth"}},[t._v("#")]),t._v(" pointHoverBorderWidth")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointHoverBorderWidth")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Border width of point when hovered.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-36"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointHoverBorderWidth")]),t._v(" "),r("h4",{attrs:{id:"defined-in-36"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2062",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2062"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointhoverradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverradius"}},[t._v("#")]),t._v(" pointHoverRadius")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointHoverRadius")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("The radius of the point when hovered.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-37"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointHoverRadius")]),t._v(" "),r("h4",{attrs:{id:"defined-in-37"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2066",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2066"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointradius"}},[t._v("#")]),t._v(" pointRadius")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointRadius")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("The radius of the point shape. If set to 0, the point is not rendered.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-38"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointRadius")]),t._v(" "),r("h4",{attrs:{id:"defined-in-38"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2039",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2039"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointrotation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointrotation"}},[t._v("#")]),t._v(" pointRotation")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointRotation")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("The rotation of the point in degrees.")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-39"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointRotation")]),t._v(" "),r("h4",{attrs:{id:"defined-in-39"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2043",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2043"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"pointstyle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" pointStyle")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("pointStyle")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#pointstyle"}},[r("code",[t._v("PointStyle")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Point style")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("'circle;")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-40"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.pointStyle")]),t._v(" "),r("h4",{attrs:{id:"defined-in-40"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1998",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1998"),r("OutboundLink")],1)]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2047",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2047"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"radius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#radius"}},[t._v("#")]),t._v(" radius")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("radius")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Point radius")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("3")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-41"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.radius")]),t._v(" "),r("h4",{attrs:{id:"defined-in-41"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1988",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1988"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"rotation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" rotation")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("rotation")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Point rotation (in degrees).")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("0")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-42"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.rotation")]),t._v(" "),r("h4",{attrs:{id:"defined-in-42"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2003",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2003"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"segment"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#segment"}},[t._v("#")]),t._v(" segment")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("segment")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<{ "),r("code",[t._v("backgroundColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptable"}},[r("code",[t._v("Scriptable")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[r("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),r("code",[t._v("borderCapStyle")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptable"}},[r("code",[t._v("Scriptable")])]),t._v("<"),r("code",[t._v("CanvasLineCap")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[r("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),r("code",[t._v("borderColor")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptable"}},[r("code",[t._v("Scriptable")])]),t._v("<"),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[t._v("Color")])]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[r("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),r("code",[t._v("borderDash")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptable"}},[r("code",[t._v("Scriptable")])]),t._v("<"),r("code",[t._v("number")]),t._v("[], "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[r("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),r("code",[t._v("borderDashOffset")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptable"}},[r("code",[t._v("Scriptable")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[r("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),r("code",[t._v("borderJoinStyle")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptable"}},[r("code",[t._v("Scriptable")])]),t._v("<"),r("code",[t._v("CanvasLineJoin")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[r("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),r("code",[t._v("borderWidth")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptable"}},[r("code",[t._v("Scriptable")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[r("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> }, "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-43"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.segment")]),t._v(" "),r("h4",{attrs:{id:"defined-in-43"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1932",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1932"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"showline"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#showline"}},[t._v("#")]),t._v(" showLine")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("showLine")]),t._v(": "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[t._v("If false, the line is not drawn for this dataset.")]),t._v(" "),r("h4",{attrs:{id:"defined-in-44"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L422",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:422"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"spangaps"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#spangaps"}},[t._v("#")]),t._v(" spanGaps")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("spanGaps")]),t._v(": "),r("code",[t._v("number")]),t._v(" | "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[t._v("If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.")]),t._v(" "),r("h4",{attrs:{id:"overrides"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.spanGaps")]),t._v(" "),r("h4",{attrs:{id:"defined-in-45"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L417",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:417"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"stack"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stack"}},[t._v("#")]),t._v(" stack")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("stack")]),t._v(": "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-44"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#stack"}},[t._v("stack")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-46"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:88"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"stepped"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#stepped"}},[t._v("#")]),t._v(" stepped")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("stepped")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("boolean")]),t._v(" | "),r("code",[t._v('"middle"')]),t._v(" | "),r("code",[t._v('"after"')]),t._v(" | "),r("code",[t._v('"before"')]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("true to show the line as a stepped line (tension will be ignored).")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("false")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-45"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-45"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.stepped")]),t._v(" "),r("h4",{attrs:{id:"defined-in-47"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1922",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1922"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"tension"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#tension"}},[t._v("#")]),t._v(" tension")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("tension")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[r("code",[t._v("ScriptableAndArray")])]),t._v("<"),r("code",[t._v("number")]),t._v(", "),r("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[r("code",[t._v("ScriptableContext")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),r("p",[t._v("Bézier curve tension (0 for no Bézier curves).")]),t._v(" "),r("p",[r("strong",[r("code",[t._v("Default")])])]),t._v(" "),r("p",[t._v("0")]),t._v(" "),r("h4",{attrs:{id:"inherited-from-46"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-46"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("ScriptableAndArrayOptions.tension")]),t._v(" "),r("h4",{attrs:{id:"defined-in-48"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1917",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1917"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"transitions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("transitions")]),t._v(": "),r("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[r("code",[t._v("TransitionsSpec")])]),t._v("<"),r("code",[t._v('"radar"')]),t._v(">")],1),t._v(" "),r("h4",{attrs:{id:"inherited-from-47"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-47"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[t._v("AnimationOptions.transitions")]),t._v(" "),r("h4",{attrs:{id:"defined-in-49"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1758"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"xaxisid"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#xaxisid"}},[t._v("#")]),t._v(" xAxisID")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("xAxisID")]),t._v(": "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("The ID of the x axis to plot this dataset on.")]),t._v(" "),r("h4",{attrs:{id:"defined-in-50"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L408",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:408"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"yaxisid"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#yaxisid"}},[t._v("#")]),t._v(" yAxisID")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("yAxisID")]),t._v(": "),r("code",[t._v("string")])]),t._v(" "),r("p",[t._v("The ID of the y axis to plot this dataset on.")]),t._v(" "),r("h4",{attrs:{id:"defined-in-51"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L412",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:412"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/104.9a5c742f.js b/docs/master/assets/js/104.9a5c742f.js deleted file mode 100644 index 7fb7feeb76..0000000000 --- a/docs/master/assets/js/104.9a5c742f.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{437:function(t,e,r){"use strict";r.r(e);var a=r(3),i=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-radarcontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-radarcontrollerdatasetoptions"}},[t._v("#")]),t._v(" Interface: RadarControllerDatasetOptions")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[e("code",[t._v("ControllerDatasetOptions")])])],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[e("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[e("code",[t._v("PointOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[e("code",[t._v("PointHoverOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedOptions.html"}},[e("code",[t._v("PointPrefixedOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedHoverOptions.html"}},[e("code",[t._v("PointPrefixedHoverOptions")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[e("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/LineOptions.html"}},[e("code",[t._v("LineOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/LineHoverOptions.html"}},[e("code",[t._v("LineHoverOptions")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#animationoptions"}},[e("code",[t._v("AnimationOptions")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("RadarControllerDatasetOptions")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v("> & { "),e("code",[t._v("onComplete?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" ; "),e("code",[t._v("onProgress?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.animation")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1747"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animations")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1757",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1757"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.backgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1807"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercapstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercapstyle"}},[t._v("#")]),t._v(" borderCapStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderCapStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("CanvasLineCap")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line cap style. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'butt'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderCapStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1887",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1887"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1806"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[t._v("#")]),t._v(" borderDash")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line dash. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderDash")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1892",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1892"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[t._v("#")]),t._v(" borderDashOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line dash offset. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0.0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderDashOffset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1897",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1897"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderjoinstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderjoinstyle"}},[t._v("#")]),t._v(" borderJoinStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderJoinStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("CanvasLineJoin")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Line join style. See MDN.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'miter'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderJoinStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1902",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1902"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1805",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1805"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"capbezierpoints"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#capbezierpoints"}},[t._v("#")]),t._v(" capBezierPoints")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("capBezierPoints")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("true to keep Bézier control inside the chart, false for no restriction.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.capBezierPoints")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1907",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1907"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"clip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clip"}},[t._v("#")]),t._v(" clip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("clip")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#clip"}},[t._v("clip")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:75"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"cubicinterpolationmode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cubicinterpolationmode"}},[t._v("#")]),t._v(" cubicInterpolationMode")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("cubicInterpolationMode")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"monotone"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Interpolation mode to apply.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'default'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.cubicInterpolationMode")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1912",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1912"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawactiveelementsontop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawactiveelementsontop"}},[t._v("#")]),t._v(" drawActiveElementsOnTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("drawActiveElementsOnTop")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Draw the active elements over the other elements of the dataset,")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.drawActiveElementsOnTop")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2008",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2008"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fill"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fill"}},[t._v("#")]),t._v(" fill")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fill")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#filltarget"}},[e("code",[t._v("FillTarget")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ComplexFillTarget.html"}},[e("code",[t._v("ComplexFillTarget")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Both line and radar charts support a fill option on the dataset object which can be used to create area between two datasets or a dataset and a boundary, i.e. the scale origin, start or end")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.fill")]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1926",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1926"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hidden"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hidden"}},[t._v("#")]),t._v(" hidden")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hidden")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#hidden"}},[t._v("hidden")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:93"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hitradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hitradius"}},[t._v("#")]),t._v(" hitRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hitRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Extra radius added to point radius for hit detection.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("1")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hitRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1993",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1993"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[t._v("#")]),t._v(" hoverBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBackgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1813"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbordercapstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercapstyle"}},[t._v("#")]),t._v(" hoverBorderCapStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderCapStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("CanvasLineCap")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderCapStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1944",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1944"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[t._v("#")]),t._v(" hoverBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1812"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdash"}},[t._v("#")]),t._v(" hoverBorderDash")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderDash")]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1945",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1945"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdashoffset"}},[t._v("#")]),t._v(" hoverBorderDashOffset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderDashOffset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1946",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1946"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderjoinstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderjoinstyle"}},[t._v("#")]),t._v(" hoverBorderJoinStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderJoinStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("CanvasLineJoin")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderJoinStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1947",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1947"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[t._v("#")]),t._v(" hoverBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1811"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverradius"}},[t._v("#")]),t._v(" hoverRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Point radius when hovered.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("4")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2016",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2016"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"indexaxis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#indexaxis"}},[t._v("#")]),t._v(" indexAxis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("indexAxis")]),t._v(": "),e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])]),t._v(" "),e("p",[t._v("The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'x'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#indexaxis"}},[t._v("indexAxis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:71"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The label for the dataset which appears in the legend and tooltips.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#label"}},[t._v("label")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:79"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"normalized"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#normalized"}},[t._v("#")]),t._v(" normalized")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("normalized")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#normalized"}},[t._v("normalized")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:63"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"order"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#order"}},[t._v("#")]),t._v(" order")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("order")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#order"}},[t._v("order")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:83"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsing")]),t._v(": "),e("code",[t._v("false")]),t._v(" | { "),e("code",[t._v("[key: string]")]),t._v(": "),e("code",[t._v("string")]),t._v("; }")]),t._v(" "),e("p",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#parsing"}},[t._v("parsing")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointbackgroundcolor"}},[t._v("#")]),t._v(" pointBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The fill color for points.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointBackgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2023",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2023"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointbordercolor"}},[t._v("#")]),t._v(" pointBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The border color for points.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointBorderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2027",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2027"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointborderwidth"}},[t._v("#")]),t._v(" pointBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointBorderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The width of the point border in pixels.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointBorderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2031",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2031"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointhitradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointhitradius"}},[t._v("#")]),t._v(" pointHitRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointHitRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The pixel size of the non-displayed point that reacts to mouse events.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointHitRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2035",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2035"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointhoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverbackgroundcolor"}},[t._v("#")]),t._v(" pointHoverBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointHoverBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Point background color when hovered.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointHoverBackgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2054",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2054"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointhoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverbordercolor"}},[t._v("#")]),t._v(" pointHoverBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointHoverBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Point border color when hovered.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointHoverBorderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2058",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2058"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointhoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverborderwidth"}},[t._v("#")]),t._v(" pointHoverBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointHoverBorderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Border width of point when hovered.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointHoverBorderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2062",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2062"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointhoverradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointhoverradius"}},[t._v("#")]),t._v(" pointHoverRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointHoverRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The radius of the point when hovered.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointHoverRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2066",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2066"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointradius"}},[t._v("#")]),t._v(" pointRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The radius of the point shape. If set to 0, the point is not rendered.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2039",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2039"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointrotation"}},[t._v("#")]),t._v(" pointRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointRotation")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The rotation of the point in degrees.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointRotation")]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2043",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2043"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" pointStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Point style")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'circle;")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.pointStyle")]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1998",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1998"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2047",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2047"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radius"}},[t._v("#")]),t._v(" radius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("radius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Point radius")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("3")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.radius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1988",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1988"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"rotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" rotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("rotation")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Point rotation (in degrees).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.rotation")]),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2003",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2003"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"segment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#segment"}},[t._v("#")]),t._v(" segment")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("segment")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<{ "),e("code",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[e("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),e("code",[t._v("borderCapStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("CanvasLineCap")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[e("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),e("code",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[e("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),e("code",[t._v("borderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[e("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),e("code",[t._v("borderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[e("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),e("code",[t._v("borderJoinStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("CanvasLineJoin")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[e("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> ; "),e("code",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[e("code",[t._v("ScriptableLineSegmentContext")])]),t._v("> }, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.segment")]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1932",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1932"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"showline"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#showline"}},[t._v("#")]),t._v(" showLine")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("showLine")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("If false, the line is not drawn for this dataset.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L422",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:422"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"spangaps"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spangaps"}},[t._v("#")]),t._v(" spanGaps")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("spanGaps")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("If true, lines will be drawn between points with no or null data. If false, points with NaN data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used.")]),t._v(" "),e("h4",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.spanGaps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L417",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:417"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("stack")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#stack"}},[t._v("stack")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:88"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stepped"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stepped"}},[t._v("#")]),t._v(" stepped")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("stepped")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v('"middle"')]),t._v(" | "),e("code",[t._v('"after"')]),t._v(" | "),e("code",[t._v('"before"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("true to show the line as a stepped line (tension will be ignored).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-45"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.stepped")]),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1922",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1922"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tension"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tension"}},[t._v("#")]),t._v(" tension")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("tension")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Bézier curve tension (0 for no Bézier curves).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-46"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.tension")]),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1917",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1917"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("transitions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[e("code",[t._v("TransitionsSpec")])]),t._v("<"),e("code",[t._v('"radar"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-47"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.transitions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1758"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xaxisid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xaxisid"}},[t._v("#")]),t._v(" xAxisID")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("xAxisID")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the x axis to plot this dataset on.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L408",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:408"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yaxisid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yaxisid"}},[t._v("#")]),t._v(" yAxisID")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("yAxisID")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the y axis to plot this dataset on.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L412",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:412"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/105.49ce200c.js b/docs/master/assets/js/105.a18eab0b.js similarity index 94% rename from docs/master/assets/js/105.49ce200c.js rename to docs/master/assets/js/105.a18eab0b.js index 885f18b6c8..2f62d37a9c 100644 --- a/docs/master/assets/js/105.49ce200c.js +++ b/docs/master/assets/js/105.a18eab0b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{438:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-radiallinearscale-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-radiallinearscale-o"}},[t._v("#")]),t._v(" Interface: RadialLinearScale")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("RadialLinearScale")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("never")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#animations"}},[t._v("$animations")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#active"}},[t._v("active")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#axis"}},[t._v("axis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1276",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1276"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bottom"}},[t._v("#")]),t._v(" bottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Bottom edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#bottom"}},[t._v("bottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#chart"}},[t._v("chart")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1266",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1266"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ctx"}},[t._v("ctx")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1265",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1265"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, and the item is horizontal, then push vertical boxes down")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fullsize"}},[t._v("fullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#height"}},[t._v("height")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#id"}},[t._v("id")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelrotation"}},[t._v("#")]),t._v(" labelRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#labelrotation"}},[t._v("labelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1277",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1277"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#left"}},[t._v("left")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:29"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"max"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#max"}},[t._v("#")]),t._v(" max")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("max")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#max"}},[t._v("max")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1279",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1279"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxheight"}},[t._v("#")]),t._v(" maxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxHeight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxheight"}},[t._v("maxHeight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1269",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1269"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxwidth"}},[t._v("maxWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"min"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min"}},[t._v("#")]),t._v(" min")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("min")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#min"}},[t._v("min")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1278",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1278"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#options"}},[t._v("options")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingbottom"}},[t._v("#")]),t._v(" paddingBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingBottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingbottom"}},[t._v("paddingBottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1272",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1272"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingleft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingleft"}},[t._v("#")]),t._v(" paddingLeft")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingLeft")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingleft"}},[t._v("paddingLeft")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1273",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1273"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingright"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingright"}},[t._v("#")]),t._v(" paddingRight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingRight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingright"}},[t._v("paddingRight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1274"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingtop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingtop"}},[t._v("#")]),t._v(" paddingTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingTop")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingtop"}},[t._v("paddingTop")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1271",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1271"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])])],1),t._v(" "),e("p",[t._v("The position of the item in the chart layout. Possible values are")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#position"}},[t._v("position")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"right"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#right"}},[t._v("#")]),t._v(" right")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("right")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Right edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#right"}},[t._v("right")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" ticks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ticks"}},[t._v("ticks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1280",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1280"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#top"}},[t._v("top")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:33"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#type"}},[t._v("type")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1264",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1264"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The weight used to sort the item. Higher weights are further away from the chart area")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#width"}},[t._v("width")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#x"}},[t._v("x")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#y"}},[t._v("y")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterbuildticks"}},[t._v("afterBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftercalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftercalculatelabelrotation"}},[t._v("#")]),t._v(" afterCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftercalculatelabelrotation"}},[t._v("afterCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterdatalimits"}},[t._v("afterDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1358"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfit"}},[t._v("#")]),t._v(" afterFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterfit"}},[t._v("afterFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1370",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1370"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftersetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftersetdimensions"}},[t._v("#")]),t._v(" afterSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftersetdimensions"}},[t._v("afterSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1355",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterticktolabelconversion"}},[t._v("#")]),t._v(" afterTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterticktolabelconversion"}},[t._v("afterTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterupdate"}},[t._v("afterUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1352",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1352"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforebuildticks"}},[t._v("beforeBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforecalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforecalculatelabelrotation"}},[t._v("#")]),t._v(" beforeCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforecalculatelabelrotation"}},[t._v("beforeCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1365",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1365"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforedatalimits"}},[t._v("beforeDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1356",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1356"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefit"}},[t._v("#")]),t._v(" beforeFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforefit"}},[t._v("beforeFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1368",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1368"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the layout process starts")]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforesetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforesetdimensions"}},[t._v("#")]),t._v(" beforeSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforesetdimensions"}},[t._v("beforeSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1353",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1353"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeticktolabelconversion"}},[t._v("#")]),t._v(" beforeTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeticktolabelconversion"}},[t._v("beforeTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1362",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1362"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeupdate"}},[t._v("beforeUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildticks"}},[t._v("#")]),t._v(" buildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-45"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#buildticks"}},[t._v("buildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatelabelrotation"}},[t._v("#")]),t._v(" calculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-46"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#calculatelabelrotation"}},[t._v("calculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1366"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-47"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#configure"}},[t._v("configure")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1351",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1351"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"determinedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#determinedatalimits"}},[t._v("#")]),t._v(" determineDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("determineDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-48"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#determinedatalimits"}},[t._v("determineDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1357",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1357"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Draws the element")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-49"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:50"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawgrid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawgrid"}},[t._v("#")]),t._v(" drawGrid")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawGrid")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-50"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawgrid"}},[t._v("drawGrid")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1285",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawlabels"}},[t._v("#")]),t._v(" drawLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawLabels")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-51"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawlabels"}},[t._v("drawLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1284",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1284"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawtitle"}},[t._v("#")]),t._v(" drawTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawTitle")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-52"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawtitle"}},[t._v("drawTitle")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1283",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1283"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fit"}},[t._v("#")]),t._v(" fit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-53"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fit"}},[t._v("fit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1369",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1369"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"generateticklabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#generateticklabels"}},[t._v("#")]),t._v(" generateTickLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("generateTickLabels")]),t._v("("),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-54"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#generateticklabels"}},[t._v("generateTickLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasepixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasepixel"}},[t._v("#")]),t._v(" getBasePixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePixel")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the pixel for the minimum chart value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-55"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasepixel"}},[t._v("getBasePixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbaseposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbaseposition"}},[t._v("#")]),t._v(" getBasePosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePosition")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasevalue"}},[t._v("#")]),t._v(" getBaseValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBaseValue")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-56"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasevalue"}},[t._v("getBaseValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1335",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1335"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdecimalforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdecimalforpixel"}},[t._v("#")]),t._v(" getDecimalForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDecimalForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-57"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getdecimalforpixel"}},[t._v("getDecimalForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1291",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdistancefromcenterforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdistancefromcenterforvalue"}},[t._v("#")]),t._v(" getDistanceFromCenterForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDistanceFromCenterForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3586",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3586"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getindexangle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getindexangle"}},[t._v("#")]),t._v(" getIndexAngle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getIndexAngle")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3585",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3585"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelforvalue"}},[t._v("#")]),t._v(" getLabelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Used to get the label to display in the tooltip for the given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-58"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelforvalue"}},[t._v("getLabelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1311",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1311"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelitems"}},[t._v("#")]),t._v(" getLabelItems")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelItems")]),t._v("("),e("code",[t._v("chartArea?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-59"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelitems"}},[t._v("getLabelItems")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1349",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1349"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabels"}},[t._v("#")]),t._v(" getLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabels")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-60"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabels"}},[t._v("getLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1348",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1348"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlinewidthforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlinewidthforvalue"}},[t._v("#")]),t._v(" getLineWidthForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLineWidthForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the grid line width at given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-61"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlinewidthforvalue"}},[t._v("getLineWidthForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1316",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1316"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmatchingvisiblemetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmatchingvisiblemetas"}},[t._v("#")]),t._v(" getMatchingVisibleMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMatchingVisibleMetas")]),t._v("("),e("code",[t._v("type?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-62"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getmatchingvisiblemetas"}},[t._v("getMatchingVisibleMetas")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("canStack")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-37"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-63"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getminmax"}},[t._v("getMinMax")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpadding"}},[t._v("#")]),t._v(" getPadding")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getPadding")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Returns an object with padding on the edges")]),t._v(" "),e("h4",{attrs:{id:"returns-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-38"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-64"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpadding"}},[t._v("getPadding")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfordecimal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfordecimal"}},[t._v("#")]),t._v(" getPixelForDecimal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForDecimal")]),t._v("("),e("code",[t._v("decimal")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Utility for getting the pixel location of a percentage of scale\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("decimal")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-39"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-65"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfordecimal"}},[t._v("getPixelForDecimal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1298",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1298"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfortick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfortick"}},[t._v("#")]),t._v(" getPixelForTick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForTick")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the tick at the given index\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-40"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-66"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfortick"}},[t._v("getPixelForTick")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1305",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1305"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelforvalue"}},[t._v("#")]),t._v(" getPixelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForValue")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the given data point. Value can either be an index or a numerical value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-41"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-67"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelforvalue"}},[t._v("getPixelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1325",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1325"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpointlabelposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpointlabelposition"}},[t._v("#")]),t._v(" getPointLabelPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPointLabelPosition")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-42"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3590",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3590"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpointposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpointposition"}},[t._v("#")]),t._v(" getPointPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPointPosition")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("distanceFromCenter")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("distanceFromCenter")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-43"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3588",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3588"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpointpositionforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpointpositionforvalue"}},[t._v("#")]),t._v(" getPointPositionForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPointPositionForValue")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-44"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3589",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3589"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("never")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-45"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-68"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-46"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-69"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getticks"}},[t._v("#")]),t._v(" getTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-47"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-70"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getticks"}},[t._v("getTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getuserbounds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getuserbounds"}},[t._v("#")]),t._v(" getUserBounds")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getUserBounds")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-48"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("maxDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-71"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getuserbounds"}},[t._v("getUserBounds")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1345",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1345"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvaluefordistancefromcenter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvaluefordistancefromcenter"}},[t._v("#")]),t._v(" getValueForDistanceFromCenter")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForDistanceFromCenter")]),t._v("("),e("code",[t._v("distance")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("distance")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-49"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3587",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3587"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvalueforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvalueforpixel"}},[t._v("#")]),t._v(" getValueForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Used to get the data value from a given pixel. This is the inverse of getPixelForValue\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-50"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-72"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getvalueforpixel"}},[t._v("getValueForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1333",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-51"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-73"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#hasvalue"}},[t._v("hasValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"init"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#init"}},[t._v("#")]),t._v(" init")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("init")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-52"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-74"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#init"}},[t._v("init")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isfullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isfullsize"}},[t._v("#")]),t._v(" isFullSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isFullSize")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-53"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-75"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#isfullsize"}},[t._v("isFullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-82"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-82"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1372",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1372"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ishorizontal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ishorizontal"}},[t._v("#")]),t._v(" isHorizontal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isHorizontal")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("returns true if the layout item is horizontal (ie. top or bottom)")]),t._v(" "),e("h4",{attrs:{id:"returns-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-54"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-76"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ishorizontal"}},[t._v("isHorizontal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-83"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-83"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:58"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("raw")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"parameters-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-26"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("raw")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-55"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-77"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#parse"}},[t._v("parse")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-84"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-84"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setcenterpoint"}},[t._v("#")]),t._v(" setCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setCenterPoint")]),t._v("("),e("code",[t._v("leftMovement")]),t._v(", "),e("code",[t._v("rightMovement")]),t._v(", "),e("code",[t._v("topMovement")]),t._v(", "),e("code",[t._v("bottomMovement")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-27"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("leftMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("rightMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("topMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("bottomMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-56"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-85"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-85"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3584",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3584"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdimensions"}},[t._v("#")]),t._v(" setDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-57"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-78"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#setdimensions"}},[t._v("setDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-86"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-86"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1354",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1354"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-28"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-58"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-79"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#tooltipposition"}},[t._v("tooltipPosition")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-87"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-87"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("width")]),t._v(", "),e("code",[t._v("height")]),t._v(", "),e("code",[t._v("margins?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Takes two parameters: width and height.")]),t._v(" "),e("h4",{attrs:{id:"parameters-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-29"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("margins?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-59"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-80"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#update"}},[t._v("update")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-88"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-88"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:64"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{437:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-radiallinearscale-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-radiallinearscale-o"}},[t._v("#")]),t._v(" Interface: RadialLinearScale")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("RadialLinearScale")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("never")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#animations"}},[t._v("$animations")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#active"}},[t._v("active")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#axis"}},[t._v("axis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1276",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1276"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bottom"}},[t._v("#")]),t._v(" bottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Bottom edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#bottom"}},[t._v("bottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#chart"}},[t._v("chart")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1266",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1266"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ctx"}},[t._v("ctx")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1265",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1265"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, and the item is horizontal, then push vertical boxes down")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fullsize"}},[t._v("fullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#height"}},[t._v("height")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#id"}},[t._v("id")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelrotation"}},[t._v("#")]),t._v(" labelRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#labelrotation"}},[t._v("labelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1277",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1277"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#left"}},[t._v("left")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:29"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"max"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#max"}},[t._v("#")]),t._v(" max")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("max")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#max"}},[t._v("max")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1279",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1279"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxheight"}},[t._v("#")]),t._v(" maxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxHeight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxheight"}},[t._v("maxHeight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1269",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1269"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxwidth"}},[t._v("maxWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"min"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min"}},[t._v("#")]),t._v(" min")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("min")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#min"}},[t._v("min")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1278",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1278"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#options"}},[t._v("options")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingbottom"}},[t._v("#")]),t._v(" paddingBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingBottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingbottom"}},[t._v("paddingBottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1272",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1272"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingleft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingleft"}},[t._v("#")]),t._v(" paddingLeft")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingLeft")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingleft"}},[t._v("paddingLeft")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1273",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1273"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingright"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingright"}},[t._v("#")]),t._v(" paddingRight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingRight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingright"}},[t._v("paddingRight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1274"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingtop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingtop"}},[t._v("#")]),t._v(" paddingTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingTop")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingtop"}},[t._v("paddingTop")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1271",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1271"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])])],1),t._v(" "),e("p",[t._v("The position of the item in the chart layout. Possible values are")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#position"}},[t._v("position")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"right"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#right"}},[t._v("#")]),t._v(" right")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("right")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Right edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#right"}},[t._v("right")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" ticks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ticks"}},[t._v("ticks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1280",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1280"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#top"}},[t._v("top")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:33"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#type"}},[t._v("type")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1264",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1264"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The weight used to sort the item. Higher weights are further away from the chart area")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#width"}},[t._v("width")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#x"}},[t._v("x")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#y"}},[t._v("y")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterbuildticks"}},[t._v("afterBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftercalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftercalculatelabelrotation"}},[t._v("#")]),t._v(" afterCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftercalculatelabelrotation"}},[t._v("afterCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterdatalimits"}},[t._v("afterDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1358"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfit"}},[t._v("#")]),t._v(" afterFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterfit"}},[t._v("afterFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1370",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1370"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftersetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftersetdimensions"}},[t._v("#")]),t._v(" afterSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftersetdimensions"}},[t._v("afterSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1355",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterticktolabelconversion"}},[t._v("#")]),t._v(" afterTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterticktolabelconversion"}},[t._v("afterTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterupdate"}},[t._v("afterUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1352",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1352"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforebuildticks"}},[t._v("beforeBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforecalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforecalculatelabelrotation"}},[t._v("#")]),t._v(" beforeCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforecalculatelabelrotation"}},[t._v("beforeCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1365",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1365"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforedatalimits"}},[t._v("beforeDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1356",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1356"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefit"}},[t._v("#")]),t._v(" beforeFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforefit"}},[t._v("beforeFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1368",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1368"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the layout process starts")]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforesetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforesetdimensions"}},[t._v("#")]),t._v(" beforeSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforesetdimensions"}},[t._v("beforeSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1353",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1353"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeticktolabelconversion"}},[t._v("#")]),t._v(" beforeTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeticktolabelconversion"}},[t._v("beforeTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1362",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1362"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeupdate"}},[t._v("beforeUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildticks"}},[t._v("#")]),t._v(" buildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-45"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#buildticks"}},[t._v("buildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatelabelrotation"}},[t._v("#")]),t._v(" calculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-46"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#calculatelabelrotation"}},[t._v("calculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1366"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-47"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#configure"}},[t._v("configure")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1351",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1351"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"determinedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#determinedatalimits"}},[t._v("#")]),t._v(" determineDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("determineDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-48"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#determinedatalimits"}},[t._v("determineDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1357",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1357"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Draws the element")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-49"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:50"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawgrid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawgrid"}},[t._v("#")]),t._v(" drawGrid")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawGrid")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-50"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawgrid"}},[t._v("drawGrid")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1285",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawlabels"}},[t._v("#")]),t._v(" drawLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawLabels")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-51"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawlabels"}},[t._v("drawLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1284",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1284"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawtitle"}},[t._v("#")]),t._v(" drawTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawTitle")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-52"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawtitle"}},[t._v("drawTitle")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1283",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1283"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fit"}},[t._v("#")]),t._v(" fit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-53"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fit"}},[t._v("fit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1369",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1369"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"generateticklabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#generateticklabels"}},[t._v("#")]),t._v(" generateTickLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("generateTickLabels")]),t._v("("),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-54"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#generateticklabels"}},[t._v("generateTickLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasepixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasepixel"}},[t._v("#")]),t._v(" getBasePixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePixel")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the pixel for the minimum chart value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-55"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasepixel"}},[t._v("getBasePixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbaseposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbaseposition"}},[t._v("#")]),t._v(" getBasePosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePosition")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasevalue"}},[t._v("#")]),t._v(" getBaseValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBaseValue")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-56"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasevalue"}},[t._v("getBaseValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1335",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1335"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdecimalforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdecimalforpixel"}},[t._v("#")]),t._v(" getDecimalForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDecimalForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-57"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getdecimalforpixel"}},[t._v("getDecimalForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1291",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdistancefromcenterforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdistancefromcenterforvalue"}},[t._v("#")]),t._v(" getDistanceFromCenterForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDistanceFromCenterForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3586",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3586"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getindexangle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getindexangle"}},[t._v("#")]),t._v(" getIndexAngle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getIndexAngle")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3585",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3585"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelforvalue"}},[t._v("#")]),t._v(" getLabelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Used to get the label to display in the tooltip for the given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-58"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelforvalue"}},[t._v("getLabelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1311",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1311"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelitems"}},[t._v("#")]),t._v(" getLabelItems")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelItems")]),t._v("("),e("code",[t._v("chartArea?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-59"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelitems"}},[t._v("getLabelItems")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1349",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1349"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabels"}},[t._v("#")]),t._v(" getLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabels")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-60"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabels"}},[t._v("getLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1348",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1348"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlinewidthforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlinewidthforvalue"}},[t._v("#")]),t._v(" getLineWidthForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLineWidthForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the grid line width at given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-61"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlinewidthforvalue"}},[t._v("getLineWidthForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1316",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1316"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmatchingvisiblemetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmatchingvisiblemetas"}},[t._v("#")]),t._v(" getMatchingVisibleMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMatchingVisibleMetas")]),t._v("("),e("code",[t._v("type?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-62"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getmatchingvisiblemetas"}},[t._v("getMatchingVisibleMetas")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("canStack")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-37"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-63"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getminmax"}},[t._v("getMinMax")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpadding"}},[t._v("#")]),t._v(" getPadding")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getPadding")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Returns an object with padding on the edges")]),t._v(" "),e("h4",{attrs:{id:"returns-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-38"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-64"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpadding"}},[t._v("getPadding")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfordecimal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfordecimal"}},[t._v("#")]),t._v(" getPixelForDecimal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForDecimal")]),t._v("("),e("code",[t._v("decimal")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Utility for getting the pixel location of a percentage of scale\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("decimal")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-39"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-65"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfordecimal"}},[t._v("getPixelForDecimal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1298",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1298"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfortick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfortick"}},[t._v("#")]),t._v(" getPixelForTick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForTick")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the tick at the given index\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-40"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-66"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfortick"}},[t._v("getPixelForTick")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1305",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1305"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelforvalue"}},[t._v("#")]),t._v(" getPixelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForValue")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the given data point. Value can either be an index or a numerical value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-41"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-67"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelforvalue"}},[t._v("getPixelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1325",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1325"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpointlabelposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpointlabelposition"}},[t._v("#")]),t._v(" getPointLabelPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPointLabelPosition")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-42"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3590",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3590"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpointposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpointposition"}},[t._v("#")]),t._v(" getPointPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPointPosition")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("distanceFromCenter")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("distanceFromCenter")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-43"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3588",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3588"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpointpositionforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpointpositionforvalue"}},[t._v("#")]),t._v(" getPointPositionForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPointPositionForValue")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-44"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3589",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3589"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("never")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-45"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-68"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-46"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-69"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getticks"}},[t._v("#")]),t._v(" getTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-47"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-70"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getticks"}},[t._v("getTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getuserbounds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getuserbounds"}},[t._v("#")]),t._v(" getUserBounds")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getUserBounds")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-48"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("maxDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-71"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getuserbounds"}},[t._v("getUserBounds")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1345",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1345"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvaluefordistancefromcenter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvaluefordistancefromcenter"}},[t._v("#")]),t._v(" getValueForDistanceFromCenter")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForDistanceFromCenter")]),t._v("("),e("code",[t._v("distance")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("distance")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-49"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3587",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3587"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvalueforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvalueforpixel"}},[t._v("#")]),t._v(" getValueForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Used to get the data value from a given pixel. This is the inverse of getPixelForValue\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-50"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-72"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getvalueforpixel"}},[t._v("getValueForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1333",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-51"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-73"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#hasvalue"}},[t._v("hasValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"init"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#init"}},[t._v("#")]),t._v(" init")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("init")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-52"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-74"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#init"}},[t._v("init")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isfullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isfullsize"}},[t._v("#")]),t._v(" isFullSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isFullSize")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-53"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-75"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#isfullsize"}},[t._v("isFullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-82"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-82"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1372",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1372"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ishorizontal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ishorizontal"}},[t._v("#")]),t._v(" isHorizontal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isHorizontal")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("returns true if the layout item is horizontal (ie. top or bottom)")]),t._v(" "),e("h4",{attrs:{id:"returns-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-54"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-76"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ishorizontal"}},[t._v("isHorizontal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-83"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-83"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:58"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("raw")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"parameters-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-26"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("raw")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-55"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-77"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#parse"}},[t._v("parse")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-84"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-84"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setcenterpoint"}},[t._v("#")]),t._v(" setCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setCenterPoint")]),t._v("("),e("code",[t._v("leftMovement")]),t._v(", "),e("code",[t._v("rightMovement")]),t._v(", "),e("code",[t._v("topMovement")]),t._v(", "),e("code",[t._v("bottomMovement")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-27"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("leftMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("rightMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("topMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("bottomMovement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-56"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-85"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-85"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3584",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3584"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdimensions"}},[t._v("#")]),t._v(" setDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-57"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-78"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#setdimensions"}},[t._v("setDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-86"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-86"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1354",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1354"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-28"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-58"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-79"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#tooltipposition"}},[t._v("tooltipPosition")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-87"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-87"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("width")]),t._v(", "),e("code",[t._v("height")]),t._v(", "),e("code",[t._v("margins?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Takes two parameters: width and height.")]),t._v(" "),e("h4",{attrs:{id:"parameters-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-29"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("margins?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-59"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-80"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#update"}},[t._v("update")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-88"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-88"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:64"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/106.a6cc43ec.js b/docs/master/assets/js/106.fe0323d5.js similarity index 91% rename from docs/master/assets/js/106.a6cc43ec.js rename to docs/master/assets/js/106.fe0323d5.js index d43be31168..faeba4d4f0 100644 --- a/docs/master/assets/js/106.a6cc43ec.js +++ b/docs/master/assets/js/106.fe0323d5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{439:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-radialscaletyperegistry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-radialscaletyperegistry"}},[t._v("#")]),t._v(" Interface: RadialScaleTypeRegistry")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("RadialScaleTypeRegistry")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/ScaleTypeRegistry.html"}},[e("code",[t._v("ScaleTypeRegistry")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"radiallinear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinear"}},[t._v("#")]),t._v(" radialLinear")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("radialLinear")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3617"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{438:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-radialscaletyperegistry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-radialscaletyperegistry"}},[t._v("#")]),t._v(" Interface: RadialScaleTypeRegistry")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("RadialScaleTypeRegistry")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/ScaleTypeRegistry.html"}},[e("code",[t._v("ScaleTypeRegistry")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"radiallinear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinear"}},[t._v("#")]),t._v(" radialLinear")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("radialLinear")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3617"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/107.3de03ada.js b/docs/master/assets/js/107.3026526b.js similarity index 95% rename from docs/master/assets/js/107.3de03ada.js rename to docs/master/assets/js/107.3026526b.js index b5fb611a6f..e439adb1db 100644 --- a/docs/master/assets/js/107.3de03ada.js +++ b/docs/master/assets/js/107.3026526b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{440:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-registry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-registry"}},[t._v("#")]),t._v(" Interface: Registry")]),t._v(" "),e("p",[t._v("Please use the module's default export which provides a singleton instance\nNote: class is exported for typedoc")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"controllers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#controllers"}},[t._v("#")]),t._v(" controllers")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("controllers")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">, "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1132",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1132"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"elements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#elements"}},[t._v("#")]),t._v(" elements")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("elements")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1133",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1133"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"plugins"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugins"}},[t._v("#")]),t._v(" plugins")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("plugins")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1134",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1134"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scales"}},[t._v("#")]),t._v(" scales")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("scales")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1135",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1135"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add"}},[t._v("#")]),t._v(" add")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("add")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1137",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1137"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addcontrollers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addcontrollers"}},[t._v("#")]),t._v(" addControllers")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addControllers")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1140",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1140"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addelements"}},[t._v("#")]),t._v(" addElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addElements")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1141",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1141"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addplugins"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addplugins"}},[t._v("#")]),t._v(" addPlugins")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addPlugins")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1142",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1142"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addscales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addscales"}},[t._v("#")]),t._v(" addScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addScales")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1143",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1143"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcontroller"}},[t._v("#")]),t._v(" getController")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getController")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">, "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">, "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1145",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1145"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getelement"}},[t._v("#")]),t._v(" getElement")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getElement")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1146",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1146"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getplugin"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getplugin"}},[t._v("#")]),t._v(" getPlugin")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPlugin")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getscale"}},[t._v("#")]),t._v(" getScale")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getScale")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1148",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1148"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove"}},[t._v("#")]),t._v(" remove")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("remove")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1138",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1138"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{439:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-registry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-registry"}},[t._v("#")]),t._v(" Interface: Registry")]),t._v(" "),e("p",[t._v("Please use the module's default export which provides a singleton instance\nNote: class is exported for typedoc")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"controllers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#controllers"}},[t._v("#")]),t._v(" controllers")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("controllers")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">, "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1132",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1132"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"elements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#elements"}},[t._v("#")]),t._v(" elements")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("elements")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1133",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1133"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"plugins"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugins"}},[t._v("#")]),t._v(" plugins")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("plugins")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1134",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1134"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scales"}},[t._v("#")]),t._v(" scales")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("scales")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[e("code",[t._v("TypedRegistry")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1135",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1135"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add"}},[t._v("#")]),t._v(" add")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("add")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1137",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1137"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addcontrollers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addcontrollers"}},[t._v("#")]),t._v(" addControllers")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addControllers")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1140",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1140"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addelements"}},[t._v("#")]),t._v(" addElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addElements")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1141",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1141"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addplugins"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addplugins"}},[t._v("#")]),t._v(" addPlugins")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addPlugins")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1142",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1142"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addscales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addscales"}},[t._v("#")]),t._v(" addScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addScales")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1143",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1143"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcontroller"}},[t._v("#")]),t._v(" getController")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getController")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">, "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">, "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])]),t._v(" | "),e("code",[t._v("BarParsedData")]),t._v(" | "),e("code",[t._v("BubbleParsedData")]),t._v(" | "),e("code",[t._v("RadialParsedData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1145",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1145"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getelement"}},[t._v("#")]),t._v(" getElement")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getElement")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1146",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1146"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getplugin"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getplugin"}},[t._v("#")]),t._v(" getPlugin")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPlugin")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getscale"}},[t._v("#")]),t._v(" getScale")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getScale")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1148",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1148"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove"}},[t._v("#")]),t._v(" remove")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("remove")]),t._v("("),e("code",[t._v("...args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1138",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1138"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/108.e8dea1b0.js b/docs/master/assets/js/108.331a21d8.js similarity index 91% rename from docs/master/assets/js/108.e8dea1b0.js rename to docs/master/assets/js/108.331a21d8.js index 14178dd94c..36b994485c 100644 --- a/docs/master/assets/js/108.e8dea1b0.js +++ b/docs/master/assets/js/108.331a21d8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{441:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-rendertextopts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-rendertextopts"}},[t._v("#")]),t._v(" Interface: RenderTextOpts")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"backdrop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backdrop"}},[t._v("#")]),t._v(" backdrop")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("backdrop")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/BackdropOptions.html"}},[e("code",[t._v("BackdropOptions")])])],1),t._v(" "),e("p",[t._v("Dimensions for drawing the label backdrop")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1459",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1459"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The fill color of the text. If unset, the existing\nfillStyle property of the canvas is unchanged.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1398",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1398"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"decorationwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decorationwidth"}},[t._v("#")]),t._v(" decorationWidth")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("decorationWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The width of the strikethrough / underline")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1404",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1404"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The max width of the text in pixels")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1409",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1409"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"rotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" rotation")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("A rotation to be applied to the canvas\nThis is applied after the translation is applied")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1415",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1415"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"strikethrough"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#strikethrough"}},[t._v("#")]),t._v(" strikethrough")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("strikethrough")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Apply a strikethrough effect to the text")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1420",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1420"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"strokecolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#strokecolor"}},[t._v("#")]),t._v(" strokeColor")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("strokeColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The color of the text stroke. If unset, the existing\nstrokeStyle property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1426",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1426"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"strokewidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#strokewidth"}},[t._v("#")]),t._v(" strokeWidth")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("strokeWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The text stroke width. If unset, the existing\nlineWidth property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1432",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1432"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textalign"}},[t._v("#")]),t._v(" textAlign")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("textAlign")]),t._v(": "),e("code",[t._v("CanvasTextAlign")])]),t._v(" "),e("p",[t._v("The text alignment to use. If unset, the existing\ntextAlign property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1438",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1438"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textbaseline"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textbaseline"}},[t._v("#")]),t._v(" textBaseline")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("textBaseline")]),t._v(": "),e("code",[t._v("CanvasTextBaseline")])]),t._v(" "),e("p",[t._v("The text baseline to use. If unset, the existing\ntextBaseline property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1444",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1444"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"translation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#translation"}},[t._v("#")]),t._v(" translation")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("translation")]),t._v(": ["),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("number")]),t._v("]")]),t._v(" "),e("p",[t._v("If specified, a translation to apply to the context")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1449",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1449"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"underline"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#underline"}},[t._v("#")]),t._v(" underline")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("underline")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Underline the text")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1454",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1454"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{440:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-rendertextopts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-rendertextopts"}},[t._v("#")]),t._v(" Interface: RenderTextOpts")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"backdrop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backdrop"}},[t._v("#")]),t._v(" backdrop")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("backdrop")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/BackdropOptions.html"}},[e("code",[t._v("BackdropOptions")])])],1),t._v(" "),e("p",[t._v("Dimensions for drawing the label backdrop")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1459",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1459"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The fill color of the text. If unset, the existing\nfillStyle property of the canvas is unchanged.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1398",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1398"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"decorationwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decorationwidth"}},[t._v("#")]),t._v(" decorationWidth")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("decorationWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The width of the strikethrough / underline")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1404",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1404"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The max width of the text in pixels")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1409",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1409"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"rotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" rotation")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("A rotation to be applied to the canvas\nThis is applied after the translation is applied")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1415",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1415"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"strikethrough"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#strikethrough"}},[t._v("#")]),t._v(" strikethrough")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("strikethrough")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Apply a strikethrough effect to the text")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1420",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1420"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"strokecolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#strokecolor"}},[t._v("#")]),t._v(" strokeColor")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("strokeColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("The color of the text stroke. If unset, the existing\nstrokeStyle property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1426",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1426"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"strokewidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#strokewidth"}},[t._v("#")]),t._v(" strokeWidth")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("strokeWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The text stroke width. If unset, the existing\nlineWidth property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1432",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1432"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textalign"}},[t._v("#")]),t._v(" textAlign")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("textAlign")]),t._v(": "),e("code",[t._v("CanvasTextAlign")])]),t._v(" "),e("p",[t._v("The text alignment to use. If unset, the existing\ntextAlign property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1438",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1438"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textbaseline"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textbaseline"}},[t._v("#")]),t._v(" textBaseline")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("textBaseline")]),t._v(": "),e("code",[t._v("CanvasTextBaseline")])]),t._v(" "),e("p",[t._v("The text baseline to use. If unset, the existing\ntextBaseline property of the context is unchanged")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1444",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1444"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"translation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#translation"}},[t._v("#")]),t._v(" translation")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("translation")]),t._v(": ["),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("number")]),t._v("]")]),t._v(" "),e("p",[t._v("If specified, a translation to apply to the context")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1449",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1449"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"underline"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#underline"}},[t._v("#")]),t._v(" underline")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("underline")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Underline the text")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1454",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1454"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/109.ded921d9.js b/docs/master/assets/js/109.009a0f06.js similarity index 95% rename from docs/master/assets/js/109.ded921d9.js rename to docs/master/assets/js/109.009a0f06.js index bc3673c862..99a98b7d9c 100644 --- a/docs/master/assets/js/109.ded921d9.js +++ b/docs/master/assets/js/109.009a0f06.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{442:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scaletyperegistry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scaletyperegistry"}},[t._v("#")]),t._v(" Interface: ScaleTypeRegistry")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[e("code",[t._v("CartesianScaleTypeRegistry")])])],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html"}},[e("code",[t._v("RadialScaleTypeRegistry")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("ScaleTypeRegistry")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category"}},[t._v("#")]),t._v(" category")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("category")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#categoryscaleoptions"}},[e("code",[t._v("CategoryScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#category"}},[t._v("category")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear"}},[t._v("#")]),t._v(" linear")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("linear")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#linearscaleoptions"}},[e("code",[t._v("LinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#linear"}},[t._v("linear")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3599",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3599"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmic"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmic"}},[t._v("#")]),t._v(" logarithmic")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("logarithmic")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#logarithmicscaleoptions"}},[e("code",[t._v("LogarithmicScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#logarithmic"}},[t._v("logarithmic")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3602",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3602"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radiallinear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinear"}},[t._v("#")]),t._v(" radialLinear")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("radialLinear")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html"}},[t._v("RadialScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html#radiallinear"}},[t._v("radialLinear")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"time"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#time"}},[t._v("#")]),t._v(" time")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("time")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#time"}},[t._v("time")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3608",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3608"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timeseries"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timeseries"}},[t._v("#")]),t._v(" timeseries")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("timeseries")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#timeseries"}},[t._v("timeseries")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3611",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3611"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{441:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scaletyperegistry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scaletyperegistry"}},[t._v("#")]),t._v(" Interface: ScaleTypeRegistry")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[e("code",[t._v("CartesianScaleTypeRegistry")])])],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html"}},[e("code",[t._v("RadialScaleTypeRegistry")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("ScaleTypeRegistry")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"category"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category"}},[t._v("#")]),t._v(" category")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("category")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#categoryscaleoptions"}},[e("code",[t._v("CategoryScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#category"}},[t._v("category")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear"}},[t._v("#")]),t._v(" linear")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("linear")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#linearscaleoptions"}},[e("code",[t._v("LinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#linear"}},[t._v("linear")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3599",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3599"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmic"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmic"}},[t._v("#")]),t._v(" logarithmic")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("logarithmic")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#logarithmicscaleoptions"}},[e("code",[t._v("LogarithmicScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#logarithmic"}},[t._v("logarithmic")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3602",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3602"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radiallinear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinear"}},[t._v("#")]),t._v(" radialLinear")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("radialLinear")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#radiallinearscaleoptions"}},[e("code",[t._v("RadialLinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html"}},[t._v("RadialScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html#radiallinear"}},[t._v("radialLinear")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"time"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#time"}},[t._v("#")]),t._v(" time")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("time")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#time"}},[t._v("time")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3608",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3608"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timeseries"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timeseries"}},[t._v("#")]),t._v(" timeseries")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("timeseries")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html#timeseries"}},[t._v("timeseries")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3611",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3611"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/110.88592d3b.js b/docs/master/assets/js/110.bf75d5fb.js similarity index 93% rename from docs/master/assets/js/110.88592d3b.js rename to docs/master/assets/js/110.bf75d5fb.js index ee8e82f5b8..0e033823c1 100644 --- a/docs/master/assets/js/110.88592d3b.js +++ b/docs/master/assets/js/110.bf75d5fb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{443:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablecartesianscalecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablecartesianscalecontext"}},[t._v("#")]),t._v(" Interface: ScriptableCartesianScaleContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("scale")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[e("code",[t._v("CartesianScaleTypeRegistry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3159",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3159"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3160",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3160"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{443:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablecartesianscalecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablecartesianscalecontext"}},[t._v("#")]),t._v(" Interface: ScriptableCartesianScaleContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("scale")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[e("code",[t._v("CartesianScaleTypeRegistry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3159",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3159"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3160",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3160"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/111.192d562f.js b/docs/master/assets/js/111.58993475.js similarity index 89% rename from docs/master/assets/js/111.192d562f.js rename to docs/master/assets/js/111.58993475.js index f5bf90557f..1b700eb812 100644 --- a/docs/master/assets/js/111.192d562f.js +++ b/docs/master/assets/js/111.58993475.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{444:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablechartcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablechartcontext"}},[t._v("#")]),t._v(" Interface: ScriptableChartContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3164",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3164"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3165"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{442:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablechartcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablechartcontext"}},[t._v("#")]),t._v(" Interface: ScriptableChartContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3164",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3164"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3165"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/112.ad6699dc.js b/docs/master/assets/js/112.2a996bcc.js similarity index 91% rename from docs/master/assets/js/112.ad6699dc.js rename to docs/master/assets/js/112.2a996bcc.js index 959561bfd5..b972dac278 100644 --- a/docs/master/assets/js/112.ad6699dc.js +++ b/docs/master/assets/js/112.2a996bcc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{445:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablecontext-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablecontext-ttype"}},[t._v("#")]),t._v(" Interface: ScriptableContext")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:24"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataindex"}},[t._v("#")]),t._v(" dataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:26"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataset")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>>>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:27"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:28"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"mode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mode"}},[t._v("#")]),t._v(" mode")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("mode")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:30"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsed"}},[t._v("#")]),t._v(" parsed")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsed")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"raw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#raw"}},[t._v("#")]),t._v(" raw")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("raw")]),t._v(": "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:29"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{445:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablecontext-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablecontext-ttype"}},[t._v("#")]),t._v(" Interface: ScriptableContext")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:24"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataindex"}},[t._v("#")]),t._v(" dataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:26"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataset")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>>>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:27"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L28",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:28"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"mode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mode"}},[t._v("#")]),t._v(" mode")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("mode")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L30",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:30"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsed"}},[t._v("#")]),t._v(" parsed")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsed")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"raw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#raw"}},[t._v("#")]),t._v(" raw")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("raw")]),t._v(": "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:29"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/113.acd601d6.js b/docs/master/assets/js/113.eebf70f2.js similarity index 89% rename from docs/master/assets/js/113.acd601d6.js rename to docs/master/assets/js/113.eebf70f2.js index 83f4c57ff7..8460ed1e5f 100644 --- a/docs/master/assets/js/113.acd601d6.js +++ b/docs/master/assets/js/113.eebf70f2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{446:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablelinesegmentcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablelinesegmentcontext"}},[t._v("#")]),t._v(" Interface: ScriptableLineSegmentContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p0"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p0"}},[t._v("#")]),t._v(" p0")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p0")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/PointElement.html"}},[e("code",[t._v("PointElement")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p0dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p0dataindex"}},[t._v("#")]),t._v(" p0DataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p0DataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:39"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p1"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p1"}},[t._v("#")]),t._v(" p1")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p1")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/PointElement.html"}},[e("code",[t._v("PointElement")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:38"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p1dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p1dataindex"}},[t._v("#")]),t._v(" p1DataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p1DataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:40"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v('"segment"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:36"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{444:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablelinesegmentcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablelinesegmentcontext"}},[t._v("#")]),t._v(" Interface: ScriptableLineSegmentContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p0"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p0"}},[t._v("#")]),t._v(" p0")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p0")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/PointElement.html"}},[e("code",[t._v("PointElement")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p0dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p0dataindex"}},[t._v("#")]),t._v(" p0DataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p0DataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L39",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:39"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p1"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p1"}},[t._v("#")]),t._v(" p1")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p1")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/PointElement.html"}},[e("code",[t._v("PointElement")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L38",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:38"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"p1dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#p1dataindex"}},[t._v("#")]),t._v(" p1DataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("p1DataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L40",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:40"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v('"segment"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L36",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:36"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/114.122e4568.js b/docs/master/assets/js/114.79380d27.js similarity index 89% rename from docs/master/assets/js/114.122e4568.js rename to docs/master/assets/js/114.79380d27.js index 84456c3c6b..c72df95e4a 100644 --- a/docs/master/assets/js/114.122e4568.js +++ b/docs/master/assets/js/114.79380d27.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{447:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablescalecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablescalecontext"}},[t._v("#")]),t._v(" Interface: ScriptableScaleContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1379",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1379"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1381",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1381"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("scale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1380",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1380"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick"}},[t._v("#")]),t._v(" tick")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("tick")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1382",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1382"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{446:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablescalecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablescalecontext"}},[t._v("#")]),t._v(" Interface: ScriptableScaleContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1379",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1379"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1381",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1381"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("scale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1380",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1380"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick"}},[t._v("#")]),t._v(" tick")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("tick")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1382",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1382"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/115.23afb1cd.js b/docs/master/assets/js/115.cb1c2cd6.js similarity index 91% rename from docs/master/assets/js/115.23afb1cd.js rename to docs/master/assets/js/115.cb1c2cd6.js index ee45cb9329..8f8a844c70 100644 --- a/docs/master/assets/js/115.23afb1cd.js +++ b/docs/master/assets/js/115.cb1c2cd6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{448:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablescalepointlabelcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablescalepointlabelcontext"}},[t._v("#")]),t._v(" Interface: ScriptableScalePointLabelContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1386",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1386"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1388",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1388"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1389",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1389"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("scale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1387",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1387"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1390",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1390"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{447:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptablescalepointlabelcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptablescalepointlabelcontext"}},[t._v("#")]),t._v(" Interface: ScriptableScalePointLabelContext")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1386",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1386"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1388",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1388"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1389",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1389"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("scale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1387",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1387"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1390",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1390"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/116.6c92f007.js b/docs/master/assets/js/116.44e48fd1.js similarity index 93% rename from docs/master/assets/js/116.6c92f007.js rename to docs/master/assets/js/116.44e48fd1.js index 6e04971fd4..2f7bf1030c 100644 --- a/docs/master/assets/js/116.6c92f007.js +++ b/docs/master/assets/js/116.44e48fd1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[116],{453:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptabletooltipcontext-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptabletooltipcontext-ttype"}},[t._v("#")]),t._v(" Interface: ScriptableTooltipContext")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>, "),e("code",[t._v("unknown")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2709",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2709"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" tooltip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("tooltip")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2710",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2710"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipitems"}},[t._v("#")]),t._v(" tooltipItems")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("tooltipItems")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2711",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2711"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[116],{448:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-scriptabletooltipcontext-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-scriptabletooltipcontext-ttype"}},[t._v("#")]),t._v(" Interface: ScriptableTooltipContext")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>, "),e("code",[t._v("unknown")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2709",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2709"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" tooltip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("tooltip")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2710",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2710"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipitems"}},[t._v("#")]),t._v(" tooltipItems")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("tooltipItems")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2711",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2711"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/117.7dc658cc.js b/docs/master/assets/js/117.b0f7a3d1.js similarity index 86% rename from docs/master/assets/js/117.7dc658cc.js rename to docs/master/assets/js/117.b0f7a3d1.js index b6574fa47b..d7787a72dc 100644 --- a/docs/master/assets/js/117.7dc658cc.js +++ b/docs/master/assets/js/117.b0f7a3d1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[117],{450:function(t,e,r){"use strict";r.r(e);var s=r(3),a=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-segment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-segment"}},[t._v("#")]),t._v(" Interface: Segment")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"end"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#end"}},[t._v("#")]),t._v(" end")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("end")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1818",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1818"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"loop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#loop"}},[t._v("#")]),t._v(" loop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("loop")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1819",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1819"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"start"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start"}},[t._v("#")]),t._v(" start")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("start")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1817",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1817"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[117],{449:function(t,e,r){"use strict";r.r(e);var s=r(3),a=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-segment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-segment"}},[t._v("#")]),t._v(" Interface: Segment")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"end"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#end"}},[t._v("#")]),t._v(" end")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("end")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1818",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1818"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"loop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#loop"}},[t._v("#")]),t._v(" loop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("loop")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1819",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1819"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"start"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start"}},[t._v("#")]),t._v(" start")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("start")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1817",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1817"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/118.0c9a4cf9.js b/docs/master/assets/js/118.9c0bcc84.js similarity index 87% rename from docs/master/assets/js/118.0c9a4cf9.js rename to docs/master/assets/js/118.9c0bcc84.js index b79922208c..5ea08efe10 100644 --- a/docs/master/assets/js/118.0c9a4cf9.js +++ b/docs/master/assets/js/118.9c0bcc84.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{452:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tick"}},[t._v("#")]),t._v(" Interface: Tick")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1155",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1155"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"major"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#major"}},[t._v("#")]),t._v(" major")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("major")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1156",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1156"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"value"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#value"}},[t._v("#")]),t._v(" value")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("value")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1154",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1154"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{463:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tick"}},[t._v("#")]),t._v(" Interface: Tick")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1155",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1155"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"major"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#major"}},[t._v("#")]),t._v(" major")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("major")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1156",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1156"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"value"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#value"}},[t._v("#")]),t._v(" value")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("value")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1154",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1154"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/119.4d5f1eef.js b/docs/master/assets/js/119.2f1427cc.js similarity index 93% rename from docs/master/assets/js/119.4d5f1eef.js rename to docs/master/assets/js/119.2f1427cc.js index 1a3fb5684a..3d4ab370b3 100644 --- a/docs/master/assets/js/119.4d5f1eef.js +++ b/docs/master/assets/js/119.2f1427cc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{449:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tickoptions"}},[t._v("#")]),t._v(" Interface: TickOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"backdropcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backdropcolor"}},[t._v("#")]),t._v(" backdropColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backdropColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Color of label backdrops.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'rgba(255, 255, 255, 0.75)'")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3031",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3031"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backdroppadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backdroppadding"}},[t._v("#")]),t._v(" backdropPadding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backdropPadding")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Padding of tick backdrop.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3036",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3036"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"callback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#callback"}},[t._v("#")]),t._v(" callback")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("callback")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">, "),e("code",[t._v("tickValue")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]) => "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tickValue")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("p",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See callback.")]),t._v(" "),e("h5",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tickValue")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3041",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3041"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Color of tick")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("See")])])]),t._v(" "),e("p",[t._v("Defaults.color")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3051",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3051"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"display"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#display"}},[t._v("#")]),t._v(" display")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("If true, show tick labels.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3046",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3046"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"font"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#font"}},[t._v("#")]),t._v(" font")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("font")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("see Fonts")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3055",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3055"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"major"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#major"}},[t._v("#")]),t._v(" major")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("major")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("enabled")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If true, major ticks are generated. A major tick will affect autoskipping and major will be defined on ticks in the scriptable options context. "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3081",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3081"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"padding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" padding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("padding")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Sets the offset of the tick labels from the axis")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3059",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3059"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"showlabelbackdrop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#showlabelbackdrop"}},[t._v("#")]),t._v(" showLabelBackdrop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("showLabelBackdrop")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("If true, draw a background behind the tick labels.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3064",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3064"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textstrokecolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textstrokecolor"}},[t._v("#")]),t._v(" textStrokeColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("textStrokeColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("The color of the stroke around the text.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("undefined")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3069",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3069"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textstrokewidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textstrokewidth"}},[t._v("#")]),t._v(" textStrokeWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("textStrokeWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Stroke width around the text.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3074",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3074"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"z"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#z"}},[t._v("#")]),t._v(" z")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("z")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3079",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3079"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{450:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tickoptions"}},[t._v("#")]),t._v(" Interface: TickOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"backdropcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backdropcolor"}},[t._v("#")]),t._v(" backdropColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backdropColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Color of label backdrops.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'rgba(255, 255, 255, 0.75)'")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3031",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3031"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backdroppadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backdroppadding"}},[t._v("#")]),t._v(" backdropPadding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backdropPadding")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Padding of tick backdrop.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3036",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3036"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"callback"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#callback"}},[t._v("#")]),t._v(" callback")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("callback")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">, "),e("code",[t._v("tickValue")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]) => "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tickValue")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("p",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See callback.")]),t._v(" "),e("h5",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tickValue")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3041",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3041"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Color of tick")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("See")])])]),t._v(" "),e("p",[t._v("Defaults.color")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3051",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3051"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"display"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#display"}},[t._v("#")]),t._v(" display")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("If true, show tick labels.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3046",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3046"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"font"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#font"}},[t._v("#")]),t._v(" font")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("font")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("see Fonts")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3055",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3055"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"major"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#major"}},[t._v("#")]),t._v(" major")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("major")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("enabled")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If true, major ticks are generated. A major tick will affect autoskipping and major will be defined on ticks in the scriptable options context. "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3081",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3081"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"padding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" padding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("padding")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Sets the offset of the tick labels from the axis")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3059",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3059"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"showlabelbackdrop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#showlabelbackdrop"}},[t._v("#")]),t._v(" showLabelBackdrop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("showLabelBackdrop")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("If true, draw a background behind the tick labels.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3064",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3064"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textstrokecolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textstrokecolor"}},[t._v("#")]),t._v(" textStrokeColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("textStrokeColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("The color of the stroke around the text.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("undefined")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3069",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3069"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textstrokewidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textstrokewidth"}},[t._v("#")]),t._v(" textStrokeWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("textStrokeWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Stroke width around the text.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3074",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3074"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"z"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#z"}},[t._v("#")]),t._v(" z")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("z")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3079",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3079"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/12.18c98731.js b/docs/master/assets/js/12.4179f1a2.js similarity index 94% rename from docs/master/assets/js/12.18c98731.js rename to docs/master/assets/js/12.4179f1a2.js index 423bb46b0e..9d94a684b9 100644 --- a/docs/master/assets/js/12.18c98731.js +++ b/docs/master/assets/js/12.4179f1a2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{346:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"chart-js-v4-4-1"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart-js-v4-4-1"}},[t._v("#")]),t._v(" Chart.js - v4.4.1")]),t._v(" "),e("h2",{attrs:{id:"enumerations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enumerations"}},[t._v("#")]),t._v(" Enumerations")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/api/enums/DecimationAlgorithm.html"}},[t._v("DecimationAlgorithm")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/enums/UpdateModeEnum.html"}},[t._v("UpdateModeEnum")])],1)]),t._v(" "),e("h2",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[t._v("Animation")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Animations.html"}},[t._v("Animations")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Animator.html"}},[t._v("Animator")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/ArcElement.html"}},[t._v("ArcElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/BasicPlatform.html"}},[t._v("BasicPlatform")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[t._v("Chart")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[t._v("DatasetController")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/DomPlatform.html"}},[t._v("DomPlatform")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/PointElement.html"}},[t._v("PointElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")])],1)]),t._v(" "),e("h2",{attrs:{id:"interfaces"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interfaces"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[t._v("ActiveDataPoint")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[t._v("ActiveElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[t._v("AnimationEvent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcBorderRadius.html"}},[t._v("ArcBorderRadius")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcHoverOptions.html"}},[t._v("ArcHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcOptions.html"}},[t._v("ArcOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[t._v("ArcProps")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BackdropOptions.html"}},[t._v("BackdropOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarControllerChartOptions.html"}},[t._v("BarControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarControllerDatasetOptions.html"}},[t._v("BarControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarElement.html"}},[t._v("BarElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarHoverOptions.html"}},[t._v("BarHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[t._v("BarOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[t._v("BarProps")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BorderOptions.html"}},[t._v("BorderOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[t._v("BorderRadius")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BubbleControllerDatasetOptions.html"}},[t._v("BubbleControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BubbleDataPoint.html"}},[t._v("BubbleDataPoint")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CanvasFontSpec.html"}},[t._v("CanvasFontSpec")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[t._v("CartesianParsedData")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[t._v("CartesianScaleOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[t._v("ChartArea")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[t._v("ChartComponent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[t._v("ChartConfiguration")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[t._v("ChartConfigurationCustomTypesPerDataset")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[t._v("ChartData")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartDataCustomTypesPerDataset.html"}},[t._v("ChartDataCustomTypesPerDataset")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetProperties.html"}},[t._v("ChartDatasetProperties")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html"}},[t._v("ChartDatasetPropertiesCustomTypesPerDataset")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[t._v("ChartTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[t._v("CommonElementOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[t._v("CommonHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ComplexFillTarget.html"}},[t._v("ComplexFillTarget")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreChartOptions.html"}},[t._v("CoreChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[t._v("CoreScaleOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DatasetControllerChartComponent.html"}},[t._v("DatasetControllerChartComponent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Defaults.html"}},[t._v("Defaults")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[t._v("DoughnutAnimationOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutController.html"}},[t._v("DoughnutController")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerChartOptions.html"}},[t._v("DoughnutControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutMetaExtensions.html"}},[t._v("DoughnutMetaExtensions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ElementOptionsByType.html"}},[t._v("ElementOptionsByType")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ExtendedPlugin.html"}},[t._v("ExtendedPlugin")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/FillerControllerDatasetOptions.html"}},[t._v("FillerControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/FillerOptions.html"}},[t._v("FillerOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[t._v("FontSpec")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/GridLineOptions.html"}},[t._v("GridLineOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[t._v("InteractionItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[t._v("InteractionModeMap")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[t._v("InteractionOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[t._v("LabelItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LegendElement.html"}},[t._v("LegendElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LegendItem.html"}},[t._v("LegendItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LegendOptions.html"}},[t._v("LegendOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerChartOptions.html"}},[t._v("LineControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerDatasetOptions.html"}},[t._v("LineControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineElement.html"}},[t._v("LineElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineHoverOptions.html"}},[t._v("LineHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineOptions.html"}},[t._v("LineOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineProps.html"}},[t._v("LineProps")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ParsingOptions.html"}},[t._v("ParsingOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PluginChartOptions.html"}},[t._v("PluginChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PluginOptionsByType.html"}},[t._v("PluginOptionsByType")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[t._v("PointHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[t._v("PointOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedHoverOptions.html"}},[t._v("PointPrefixedHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedOptions.html"}},[t._v("PointPrefixedOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PolarAreaController.html"}},[t._v("PolarAreaController")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PolarAreaControllerChartOptions.html"}},[t._v("PolarAreaControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PolarAreaControllerDatasetOptions.html"}},[t._v("PolarAreaControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RadarControllerDatasetOptions.html"}},[t._v("RadarControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialLinearScale.html"}},[t._v("RadialLinearScale")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html"}},[t._v("RadialScaleTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Registry.html"}},[t._v("Registry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RenderTextOpts.html"}},[t._v("RenderTextOpts")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScaleTypeRegistry.html"}},[t._v("ScaleTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableCartesianScaleContext.html"}},[t._v("ScriptableCartesianScaleContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableChartContext.html"}},[t._v("ScriptableChartContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[t._v("ScriptableContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[t._v("ScriptableLineSegmentContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[t._v("ScriptableScaleContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[t._v("ScriptableScalePointLabelContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[t._v("ScriptableTooltipContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Segment.html"}},[t._v("Segment")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[t._v("Tick")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TickOptions.html"}},[t._v("TickOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TimeScale.html"}},[t._v("TimeScale")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TitleOptions.html"}},[t._v("TitleOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Tooltip.html"}},[t._v("Tooltip")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipCallbacks.html"}},[t._v("TooltipCallbacks")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[t._v("TooltipItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[t._v("TooltipLabelStyle")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[t._v("TooltipModel")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipOptions.html"}},[t._v("TooltipOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[t._v("TooltipPosition")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPositionerMap.html"}},[t._v("TooltipPositionerMap")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[t._v("TypedRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")])],1)]),t._v(" "),e("h2",{attrs:{id:"type-aliases"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases"}},[t._v("#")]),t._v(" Type Aliases")]),t._v(" "),e("h3",{attrs:{id:"align"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" Align")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Align")]),t._v(": "),e("code",[t._v('"start"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"end"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1793",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1793"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animationoptions"}},[t._v("#")]),t._v(" AnimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("AnimationOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animation")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & { "),e("code",[t._v("onComplete?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" ; "),e("code",[t._v("onProgress?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" }")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("transitions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[e("code",[t._v("TransitionsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1746",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1746"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animationspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animationspec"}},[t._v("#")]),t._v(" AnimationSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("AnimationSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("delay?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Delay before starting the animations. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 0")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("duration?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The number of milliseconds an animation takes. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 1000")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("easing?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#easingfunction"}},[e("code",[t._v("EasingFunction")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Easing function to use "),e("strong",[e("code",[t._v("Default")])]),t._v(" 'easeOutQuart'")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("loop?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If set to true, the animations loop endlessly. "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1690",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1690"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animationsspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animationsspec"}},[t._v("#")]),t._v(" AnimationsSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("AnimationsSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"index-signature"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [name: "),e("code",[t._v("string")]),t._v("]: "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & { "),e("code",[t._v("fn")]),t._v(": ("),e("code",[t._v("from")]),t._v(": "),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("to")]),t._v(": "),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("factor")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("T")]),t._v(" ; "),e("code",[t._v("from")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">> ; "),e("code",[t._v("properties")]),t._v(": "),e("code",[t._v("string")]),t._v("[] ; "),e("code",[t._v("to")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">> ; "),e("code",[t._v("type")]),t._v(": "),e("code",[t._v('"color"')]),t._v(" | "),e("code",[t._v('"number"')]),t._v(" | "),e("code",[t._v('"boolean"')]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1715",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1715"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barcontroller"}},[t._v("#")]),t._v(" BarController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("BarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:156"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bubblecontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bubblecontroller"}},[t._v("#")]),t._v(" BubbleController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("BubbleController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:183"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"cartesiantickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cartesiantickoptions"}},[t._v("#")]),t._v(" CartesianTickOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("CartesianTickOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TickOptions.html"}},[e("code",[t._v("TickOptions")])]),t._v(" & { "),e("code",[t._v("align")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#align"}},[e("code",[t._v("Align")])]),t._v(" | "),e("code",[t._v('"inner"')]),t._v(" ; "),e("code",[t._v("autoSkip")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("autoSkipPadding")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("crossAlign")]),t._v(": "),e("code",[t._v('"near"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"far"')]),t._v(" ; "),e("code",[t._v("includeBounds")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("labelOffset")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("maxRotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("maxTicksLimit")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("minRotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("mirror")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("padding")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("sampleSize")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3090",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3090"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categoryscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categoryscale"}},[t._v("#")]),t._v(" CategoryScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("CategoryScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-4"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#categoryscaleoptions"}},[e("code",[t._v("CategoryScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#categoryscaleoptions"}},[e("code",[t._v("CategoryScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3257",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3257"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3258",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3258"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categoryscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categoryscaleoptions"}},[t._v("#")]),t._v(" CategoryScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("CategoryScaleOptions")]),t._v(": "),e("code",[t._v("Omit")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(", "),e("code",[t._v('"min"')]),t._v(" | "),e("code",[t._v('"max"')]),t._v("> & { "),e("code",[t._v("labels")]),t._v(": "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("string")]),t._v("[][] ; "),e("code",[t._v("max")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("min")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3251",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3251"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartcomponentlike"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartcomponentlike"}},[t._v("#")]),t._v(" ChartComponentLike")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartComponentLike")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v("[] | { "),e("code",[t._v("[key: string]")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v("; } | "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1125",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1125"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartdataset"}},[t._v("#")]),t._v(" ChartDataset")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartDataset")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v('<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }['),e("code",[t._v("TType")]),t._v("]> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetProperties.html"}},[e("code",[t._v("ChartDatasetProperties")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-5"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#defaultdatapoint"}},[e("code",[t._v("DefaultDataPoint")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3770",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3770"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartdatasetcustomtypesperdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartdatasetcustomtypesperdataset"}},[t._v("#")]),t._v(" ChartDatasetCustomTypesPerDataset")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartDatasetCustomTypesPerDataset")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v('<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }['),e("code",[t._v("TType")]),t._v("]> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html"}},[e("code",[t._v("ChartDatasetPropertiesCustomTypesPerDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-6"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#defaultdatapoint"}},[e("code",[t._v("DefaultDataPoint")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3777",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3777"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartitem"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartitem"}},[t._v("#")]),t._v(" ChartItem")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartItem")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("CanvasRenderingContext2D")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")]),t._v(" | { "),e("code",[t._v("canvas")]),t._v(": "),e("code",[t._v("HTMLCanvasElement")]),t._v(" } | "),e("code",[t._v("ArrayLike")]),t._v("<"),e("code",[t._v("CanvasRenderingContext2D")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L563",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:563"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartmeta"}},[t._v("#")]),t._v(" ChartMeta")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartMeta")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v('<{ [key in ChartType]: ChartTypeRegistry[key]["metaExtensions"] }['),e("code",[t._v("TType")]),t._v("]> & "),e("code",[t._v("ChartMetaCommon")]),t._v("<"),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-7"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TDatasetElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L467",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:467"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartoptions"}},[t._v("#")]),t._v(" ChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreChartOptions.html"}},[e("code",[t._v("CoreChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#elementchartoptions"}},[e("code",[t._v("ElementChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/PluginChartOptions.html"}},[e("code",[t._v("PluginChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#datasetchartoptions"}},[e("code",[t._v("DatasetChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#scalechartoptions"}},[e("code",[t._v("ScaleChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"chartOptions"')]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-8"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3747"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"charttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#charttype"}},[t._v("#")]),t._v(" ChartType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartType")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3726",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3726"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" Color")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Color")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("CanvasGradient")]),t._v(" | "),e("code",[t._v("CanvasPattern")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/color.d.ts#L1",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/color.d.ts:1"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datasetchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetchartoptions"}},[t._v("#")]),t._v(" DatasetChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DatasetChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: { [key in TType]: Object }")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-9"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3735",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3735"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"decimationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decimationoptions"}},[t._v("#")]),t._v(" DecimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DecimationOptions")]),t._v(": "),e("code",[t._v("LttbDecimationOptions")]),t._v(" | "),e("code",[t._v("MinMaxDecimationOptions")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2220",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2220"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaultdatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaultdatapoint"}},[t._v("#")]),t._v(" DefaultDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DefaultDataPoint")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-10"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3756",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3756"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"doughnutdatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#doughnutdatapoint"}},[t._v("#")]),t._v(" DoughnutDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DoughnutDataPoint")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L338",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:338"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"easingfunction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#easingfunction"}},[t._v("#")]),t._v(" EasingFunction")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("EasingFunction")]),t._v(": keyof typeof "),e("code",[t._v("effects")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/helpers/helpers.easing.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[t._v("helpers/helpers.easing.ts:122"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"elementchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#elementchartoptions"}},[t._v("#")]),t._v(" ElementChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ElementChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-11"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("elements")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ElementOptionsByType.html"}},[e("code",[t._v("ElementOptionsByType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2136",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2136"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"filltarget"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#filltarget"}},[t._v("#")]),t._v(" FillTarget")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("FillTarget")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v(" | { "),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("number")]),t._v(" } | "),e("code",[t._v('"start"')]),t._v(" | "),e("code",[t._v('"end"')]),t._v(" | "),e("code",[t._v('"origin"')]),t._v(" | "),e("code",[t._v('"stack"')]),t._v(" | "),e("code",[t._v('"shape"')]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2228",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2228"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interactionaxis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactionaxis"}},[t._v("#")]),t._v(" InteractionAxis")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("InteractionAxis")]),t._v(": "),e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')]),t._v(" | "),e("code",[t._v('"xy"')]),t._v(" | "),e("code",[t._v('"r"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1562",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1562"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interactionmode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactionmode"}},[t._v("#")]),t._v(" InteractionMode")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("InteractionMode")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[e("code",[t._v("InteractionModeMap")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L761",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:761"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interactionmodefunction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactionmodefunction"}},[t._v("#")]),t._v(" InteractionModeFunction")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("InteractionModeFunction")]),t._v(": ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(", "),e("code",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[e("code",[t._v("InteractionOptions")])]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v(": "),e("code",[t._v("boolean")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"type-declaration-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("e")]),t._v(", "),e("code",[t._v("options")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h5",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("e")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[e("code",[t._v("InteractionOptions")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h5",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L723",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:723"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"layoutposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#layoutposition"}},[t._v("#")]),t._v(" LayoutPosition")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LayoutPosition")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"right"')]),t._v(" | "),e("code",[t._v('"bottom"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"chartArea"')]),t._v(" | { "),e("code",[t._v("[scaleId: string]")]),t._v(": "),e("code",[t._v("number")]),t._v("; }")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L3",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:3"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linecontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linecontroller"}},[t._v("#")]),t._v(" LineController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LineController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L229",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:229"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L230",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:230"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linearscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linearscale"}},[t._v("#")]),t._v(" LinearScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LinearScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-12"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#linearscaleoptions"}},[e("code",[t._v("LinearScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#linearscaleoptions"}},[e("code",[t._v("LinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3306",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3306"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3307",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3307"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linearscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linearscaleoptions"}},[t._v("#")]),t._v(" LinearScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LinearScaleOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(" & { "),e("code",[t._v("beginAtZero")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("grace?")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMax?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("count")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("format")]),t._v(": "),e("code",[t._v("Intl.NumberFormatOptions")]),t._v(" ; "),e("code",[t._v("precision")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("stepSize")]),t._v(": "),e("code",[t._v("number")]),t._v(" } }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmicscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmicscale"}},[t._v("#")]),t._v(" LogarithmicScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LogarithmicScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-13"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#logarithmicscaleoptions"}},[e("code",[t._v("LogarithmicScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#logarithmicscaleoptions"}},[e("code",[t._v("LogarithmicScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3330",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3330"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3331",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3331"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmicscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmicscaleoptions"}},[t._v("#")]),t._v(" LogarithmicScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LogarithmicScaleOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(" & { "),e("code",[t._v("suggestedMax?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("format")]),t._v(": "),e("code",[t._v("Intl.NumberFormatOptions")]),t._v(" } }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3312",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3312"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Overrides")]),t._v(': { [key in ChartType]: CoreChartOptions & ElementChartOptions & PluginChartOptions & DatasetChartOptions & ScaleChartOptions & ChartTypeRegistry[key]["chartOptions"] }')]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L700",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:700"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseddatatype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseddatatype"}},[t._v("#")]),t._v(" ParsedDataType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ParsedDataType")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"parsedDataType"')]),t._v("]")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-14"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3758"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pieanimationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pieanimationoptions"}},[t._v("#")]),t._v(" PieAnimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieAnimationOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[e("code",[t._v("DoughnutAnimationOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontroller"}},[t._v("#")]),t._v(" PieController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:366"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontrollerchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontrollerchartoptions"}},[t._v("#")]),t._v(" PieControllerChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieControllerChartOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerChartOptions.html"}},[e("code",[t._v("DoughnutControllerChartOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontrollerdatasetoptions"}},[t._v("#")]),t._v(" PieControllerDatasetOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieControllerDatasetOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[e("code",[t._v("DoughnutControllerDatasetOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piedatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piedatapoint"}},[t._v("#")]),t._v(" PieDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieDataPoint")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#doughnutdatapoint"}},[e("code",[t._v("DoughnutDataPoint")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piemetaextensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piemetaextensions"}},[t._v("#")]),t._v(" PieMetaExtensions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieMetaExtensions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutMetaExtensions.html"}},[e("code",[t._v("DoughnutMetaExtensions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointprops"}},[t._v("#")]),t._v(" PointProps")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PointProps")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:18"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" PointStyle")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PointStyle")]),t._v(": "),e("code",[t._v('"circle"')]),t._v(" | "),e("code",[t._v('"cross"')]),t._v(" | "),e("code",[t._v('"crossRot"')]),t._v(" | "),e("code",[t._v('"dash"')]),t._v(" | "),e("code",[t._v('"line"')]),t._v(" | "),e("code",[t._v('"rect"')]),t._v(" | "),e("code",[t._v('"rectRounded"')]),t._v(" | "),e("code",[t._v('"rectRot"')]),t._v(" | "),e("code",[t._v('"star"')]),t._v(" | "),e("code",[t._v('"triangle"')]),t._v(" | "),e("code",[t._v("false")]),t._v(" | "),e("code",[t._v("HTMLImageElement")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1968",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1968"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"polarareaanimationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polarareaanimationoptions"}},[t._v("#")]),t._v(" PolarAreaAnimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PolarAreaAnimationOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[e("code",[t._v("DoughnutAnimationOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L380",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:380"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radarcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radarcontroller"}},[t._v("#")]),t._v(" RadarController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L427",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:427"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L428",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:428"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radarcontrollerchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radarcontrollerchartoptions"}},[t._v("#")]),t._v(" RadarControllerChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadarControllerChartOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerChartOptions.html"}},[e("code",[t._v("LineControllerChartOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L425",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:425"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radiallinearscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinearscaleoptions"}},[t._v("#")]),t._v(" RadialLinearScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadialLinearScaleOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(" & { "),e("code",[t._v("angleLines")]),t._v(": { "),e("code",[t._v("borderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> ; "),e("code",[t._v("borderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> ; "),e("code",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> ; "),e("code",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("lineWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> } ; "),e("code",[t._v("animate")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("beginAtZero")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("grid")]),t._v(": "),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/GridLineOptions.html"}},[e("code",[t._v("GridLineOptions")])]),t._v("> ; "),e("code",[t._v("max")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("min")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("pointLabels")]),t._v(": { "),e("code",[t._v("backdropColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("backdropPadding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("borderRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[t._v("BorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("callback")]),t._v(": ("),e("code",[t._v("label")]),t._v(": "),e("code",[t._v("string")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] ; "),e("code",[t._v("centerPointLabels")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v('"auto"')]),t._v(" ; "),e("code",[t._v("font")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("padding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> } ; "),e("code",[t._v("startAngle")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMax")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#radialtickoptions"}},[e("code",[t._v("RadialTickOptions")])]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3470",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3470"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radialtickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radialtickoptions"}},[t._v("#")]),t._v(" RadialTickOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadialTickOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TickOptions.html"}},[e("code",[t._v("TickOptions")])]),t._v(" & { "),e("code",[t._v("count")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("format")]),t._v(": "),e("code",[t._v("Intl.NumberFormatOptions")]),t._v(" ; "),e("code",[t._v("maxTicksLimit")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("precision")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("stepSize")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3442",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3442"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scalechartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scalechartoptions"}},[t._v("#")]),t._v(" ScaleChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-15"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scales")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("{ "),e("code",[t._v("[key: string]")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scaleoptionsbytype"}},[e("code",[t._v("ScaleOptionsByType")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"scales"')]),t._v("]>; }")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3741",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3741"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scaleoptions"}},[t._v("#")]),t._v(" ScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleOptions")]),t._v("<"),e("code",[t._v("TScale")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#scaleoptionsbytype"}},[e("code",[t._v("ScaleOptionsByType")])]),t._v("<"),e("code",[t._v("TScale")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-16"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TScale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3733",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3733"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scaleoptionsbytype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scaleoptionsbytype"}},[t._v("#")]),t._v(" ScaleOptionsByType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleOptionsByType")]),t._v("<"),e("code",[t._v("TScale")]),t._v('>: { [key in ScaleType]: Object & ScaleTypeRegistry[key]["options"] }['),e("code",[t._v("TScale")]),t._v("]")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-17"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TScale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3728",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3728"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scaletype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scaletype"}},[t._v("#")]),t._v(" ScaleType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleType")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ScaleTypeRegistry.html"}},[e("code",[t._v("ScaleTypeRegistry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3625",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3625"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontroller"}},[t._v("#")]),t._v(" ScatterController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#linecontroller-1"}},[e("code",[t._v("LineController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L241",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:241"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L242",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:242"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontrollerchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontrollerchartoptions"}},[t._v("#")]),t._v(" ScatterControllerChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterControllerChartOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerChartOptions.html"}},[e("code",[t._v("LineControllerChartOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L239",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:239"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontrollerdatasetoptions"}},[t._v("#")]),t._v(" ScatterControllerDatasetOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterControllerDatasetOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerDatasetOptions.html"}},[e("code",[t._v("LineControllerDatasetOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L235",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:235"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scatterdatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scatterdatapoint"}},[t._v("#")]),t._v(" ScatterDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterDataPoint")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L237",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:237"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptable"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptable"}},[t._v("#")]),t._v(" Scriptable")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Scriptable")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: "),e("code",[t._v("T")]),t._v(" | ("),e("code",[t._v("ctx")]),t._v(": "),e("code",[t._v("TContext")]),t._v(", "),e("code",[t._v("options")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("code",[t._v("T")]),t._v(" | "),e("code",[t._v("undefined")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-18"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:44"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableandarray"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableandarray"}},[t._v("#")]),t._v(" ScriptableAndArray")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableAndArray")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: readonly "),e("code",[t._v("T")]),t._v("[] | "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-19"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:47"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableandarrayoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableandarrayoptions"}},[t._v("#")]),t._v(" ScriptableAndArrayOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableAndArrayOptions")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: { [P in keyof T]: ScriptableAndArray }")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-20"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:48"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableandscriptableoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableandscriptableoptions"}},[t._v("#")]),t._v(" ScriptableAndScriptableOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableAndScriptableOptions")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v("> | "),e("RouterLink",{attrs:{to:"/api/#scriptableoptions"}},[e("code",[t._v("ScriptableOptions")])]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-21"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableoptions"}},[t._v("#")]),t._v(" ScriptableOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableOptions")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: { [P in keyof T]: Scriptable }")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-22"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:45"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textalign"}},[t._v("#")]),t._v(" TextAlign")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TextAlign")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"right"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1792",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1792"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescaleoptions"}},[t._v("#")]),t._v(" TimeScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeScaleOptions")]),t._v(": "),e("code",[t._v("Omit")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(", "),e("code",[t._v('"min"')]),t._v(" | "),e("code",[t._v('"max"')]),t._v("> & { "),e("code",[t._v("adapters")]),t._v(": { "),e("code",[t._v("date")]),t._v(": "),e("code",[t._v("unknown")]),t._v(" } ; "),e("code",[t._v("bounds")]),t._v(": "),e("code",[t._v('"ticks"')]),t._v(" | "),e("code",[t._v('"data"')]),t._v(" ; "),e("code",[t._v("max")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("min")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("offsetAfterAutoskip")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("suggestedMax")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#timescaletickoptions"}},[e("code",[t._v("TimeScaleTickOptions")])]),t._v(" ; "),e("code",[t._v("time")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#timescaletimeoptions"}},[e("code",[t._v("TimeScaleTimeOptions")])]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3391",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3391"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescaletickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescaletickoptions"}},[t._v("#")]),t._v(" TimeScaleTickOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeScaleTickOptions")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("source")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"labels"')]),t._v(" | "),e("code",[t._v('"auto"')]),t._v(" | "),e("code",[t._v('"data"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Ticks generation input values: - 'auto': generates \"optimal\" ticks based on scale size and time options. - 'data': generates ticks from data (including labels from data "),e("code",[t._v("{t\\|x\\|y}")]),t._v(" objects). - 'labels': generates ticks from user given "),e("code",[t._v("data.labels")]),t._v(" values ONLY. "),e("strong",[e("code",[t._v("See")])]),t._v(" https://github.com/chartjs/Chart.js/pull/4507 "),e("strong",[e("code",[t._v("Since")])]),t._v(" 2.7.0 "),e("strong",[e("code",[t._v("Default")])]),t._v(" 'auto'")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("stepSize")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The number of units between grid lines. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 1")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3373",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3373"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescaletimeoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescaletimeoptions"}},[t._v("#")]),t._v(" TimeScaleTimeOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeScaleTimeOptions")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("displayFormats")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("{ "),e("code",[t._v("[key: string]")]),t._v(": "),e("code",[t._v("string")]),t._v("; }")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Sets how different time units are displayed.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("isoWeekday")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If boolean and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If "),e("code",[t._v("number")]),t._v(", the index of the first day of the week (0 - Sunday, 6 - Saturday). "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TimeUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The minimum display format to be used for a time unit. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 'millisecond'")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parser")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | ("),e("code",[t._v("v")]),t._v(": "),e("code",[t._v("unknown")]),t._v(") => "),e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Custom parser for dates.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("round")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")]),t._v(" | "),e("code",[t._v("TimeUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If defined, dates will be rounded to the start of this unit. See Time Units below for the allowed units.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipFormat")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The format string to use for the tooltip.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")]),t._v(" | "),e("code",[t._v("TimeUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If defined, will force the unit to be a certain type. See Time Units section below for details. "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3336",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3336"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timeseriesscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timeseriesscale"}},[t._v("#")]),t._v(" TimeSeriesScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeSeriesScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/#timescale"}},[e("code",[t._v("TimeScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-23"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3436",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3436"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3437",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3437"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltippositioner"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltippositioner"}},[t._v("#")]),t._v(" TooltipPositioner")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipPositioner")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPositionerMap.html"}},[e("code",[t._v("TooltipPositionerMap")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2650",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2650"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltippositionerfunction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltippositionerfunction"}},[t._v("#")]),t._v(" TooltipPositionerFunction")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipPositionerFunction")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("items")]),t._v(": readonly "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[], "),e("code",[t._v("eventPosition")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[e("code",[t._v("TooltipPosition")])]),t._v(" | "),e("code",[t._v("false")])],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-24"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("items")]),t._v(", "),e("code",[t._v("eventPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[e("code",[t._v("TooltipPosition")])]),t._v(" | "),e("code",[t._v("false")])],1),t._v(" "),e("h5",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("readonly "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("eventPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[e("code",[t._v("TooltipPosition")])]),t._v(" | "),e("code",[t._v("false")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2639",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2639"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipxalignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipxalignment"}},[t._v("#")]),t._v(" TooltipXAlignment")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipXAlignment")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"right"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2550",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2550"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipyalignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipyalignment"}},[t._v("#")]),t._v(" TooltipYAlignment")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipYAlignment")]),t._v(": "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"bottom"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2551",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2551"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitionspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitionspec"}},[t._v("#")]),t._v(" TransitionSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TransitionSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-25"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-9"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animation")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1737",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1737"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitionsspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitionsspec"}},[t._v("#")]),t._v(" TransitionsSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TransitionsSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-26"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"index-signature-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature-2"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [mode: "),e("code",[t._v("string")]),t._v("]: "),e("RouterLink",{attrs:{to:"/api/#transitionspec"}},[e("code",[t._v("TransitionSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1742",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1742"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatemode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatemode"}},[t._v("#")]),t._v(" UpdateMode")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("UpdateMode")]),t._v(": keyof typeof "),e("RouterLink",{attrs:{to:"/api/enums/UpdateModeEnum.html"}},[e("code",[t._v("UpdateModeEnum")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L580",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:580"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"variables"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#variables"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),e("h3",{attrs:{id:"barcontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barcontroller-2"}},[t._v("#")]),t._v(" BarController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("BarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#barcontroller-1"}},[e("code",[t._v("BarController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:156"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barelement"}},[t._v("#")]),t._v(" BarElement")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("BarElement")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#barelement"}},[e("code",[t._v("BarElement")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[e("code",[t._v("BarProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2119",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2119"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2124",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2124"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bubblecontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bubblecontroller-2"}},[t._v("#")]),t._v(" BubbleController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("BubbleController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#bubblecontroller-1"}},[e("code",[t._v("BubbleController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:183"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categoryscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categoryscale-2"}},[t._v("#")]),t._v(" CategoryScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("CategoryScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#categoryscale-1"}},[e("code",[t._v("CategoryScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3257",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3257"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3258",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3258"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decimation"}},[t._v("#")]),t._v(" Decimation")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Decimation")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2200",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2200"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"doughnutcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#doughnutcontroller"}},[t._v("#")]),t._v(" DoughnutController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("DoughnutController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L340",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:340"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"filler"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#filler"}},[t._v("#")]),t._v(" Filler")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Filler")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2222",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2222"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interaction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interaction"}},[t._v("#")]),t._v(" Interaction")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Interaction")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-10"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("modes")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[e("code",[t._v("InteractionModeMap")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("evaluateInteractionItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("axis")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#interactionaxis"}},[e("code",[t._v("InteractionAxis")])]),t._v(", "),e("code",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(", "),e("code",[t._v("handler")]),t._v(": ("),e("code",[t._v("element")]),t._v(": "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[e("code",[t._v("VisualElement")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("void")]),t._v(", "),e("code",[t._v("intersect?")]),t._v(": "),e("code",[t._v("boolean")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L763",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:763"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"legend"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend"}},[t._v("#")]),t._v(" Legend")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Legend")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-82"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-82"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2252",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2252"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linecontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linecontroller-2"}},[t._v("#")]),t._v(" LineController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LineController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#linecontroller-1"}},[e("code",[t._v("LineController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-83"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-83"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L229",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:229"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L230",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:230"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"lineelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lineelement"}},[t._v("#")]),t._v(" LineElement")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LineElement")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#lineelement"}},[e("code",[t._v("LineElement")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/LineProps.html"}},[e("code",[t._v("LineProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/LineOptions.html"}},[e("code",[t._v("LineOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-84"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-84"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1950",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1950"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1963",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1963"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linearscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linearscale-2"}},[t._v("#")]),t._v(" LinearScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LinearScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#linearscale-1"}},[e("code",[t._v("LinearScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-85"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-85"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3306",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3306"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3307",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3307"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmicscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmicscale-2"}},[t._v("#")]),t._v(" LogarithmicScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LogarithmicScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#logarithmicscale-1"}},[e("code",[t._v("LogarithmicScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-86"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-86"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3330",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3330"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3331",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3331"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontroller-2"}},[t._v("#")]),t._v(" PieController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("PieController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-87"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-87"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:366"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"polarareacontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polarareacontroller"}},[t._v("#")]),t._v(" PolarAreaController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("PolarAreaController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#polarareacontroller"}},[e("code",[t._v("PolarAreaController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-88"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-88"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L392",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:392"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L395",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:395"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radarcontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radarcontroller-2"}},[t._v("#")]),t._v(" RadarController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("RadarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#radarcontroller-1"}},[e("code",[t._v("RadarController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-89"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-89"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L427",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:427"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L428",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:428"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radiallinearscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinearscale"}},[t._v("#")]),t._v(" RadialLinearScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("RadialLinearScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#radiallinearscale"}},[e("code",[t._v("RadialLinearScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-90"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-90"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3583",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3583"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontroller-2"}},[t._v("#")]),t._v(" ScatterController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ScatterController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#linecontroller-1"}},[e("code",[t._v("LineController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-91"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-91"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L241",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:241"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L242",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:242"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"subtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#subtitle"}},[t._v("#")]),t._v(" SubTitle")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("SubTitle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-92"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-92"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2508",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2508"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" Ticks")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Ticks")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-11"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("{ "),e("code",[t._v("logarithmic")]),t._v(": ("),e("code",[t._v("tickValue")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("number")]),t._v(" }[]) => "),e("code",[t._v("string")]),t._v(" ; "),e("code",[t._v("numeric")]),t._v(": ("),e("code",[t._v("tickValue")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("number")]),t._v(" }[]) => "),e("code",[t._v("string")]),t._v(" ; "),e("code",[t._v("values")]),t._v(": ("),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("unknown")]),t._v(") => "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] }")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters.logarithmic")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("[object Object]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters.numeric")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("[object Object]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters.values")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("[object Object]")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-93"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-93"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1496",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1496"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescale"}},[t._v("#")]),t._v(" TimeScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("TimeScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#timescale"}},[e("code",[t._v("TimeScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-94"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-94"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3424",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3424"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3431",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3431"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timeseriesscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timeseriesscale-2"}},[t._v("#")]),t._v(" TimeSeriesScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("TimeSeriesScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#timeseriesscale-1"}},[e("code",[t._v("TimeSeriesScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-95"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-95"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3436",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3436"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3437",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3437"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"title"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" Title")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Title")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-96"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-96"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2509",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2509"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" Tooltip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("Tooltip")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltip"}},[e("code",[t._v("Tooltip")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-97"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-97"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2652",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2652"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2656",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2656"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Defaults.html"}},[e("code",[t._v("Defaults")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-98"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-98"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L710",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:710"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"layouts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#layouts"}},[t._v("#")]),t._v(" layouts")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("layouts")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-12"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("addBox")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("item")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v(") => "),e("code",[t._v("void")])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("configure")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("item")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v(", "),e("code",[t._v("options")]),t._v(": { "),e("code",[t._v("fullSize?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("position?")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])]),t._v(" ; "),e("code",[t._v("weight?")]),t._v(": "),e("code",[t._v("number")]),t._v(" }) => "),e("code",[t._v("void")])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("removeBox")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("layoutItem")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v(") => "),e("code",[t._v("void")])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("update")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("width")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("height")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("void")])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-99"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-99"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L778",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:778"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"registerables"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registerables"}},[t._v("#")]),t._v(" registerables")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("registerables")]),t._v(": readonly "),e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-100"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-100"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L561",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:561"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"registry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registry"}},[t._v("#")]),t._v(" registry")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("registry")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Registry.html"}},[e("code",[t._v("Registry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-101"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-101"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1151",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1151"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{345:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"chart-js-v4-4-1"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart-js-v4-4-1"}},[t._v("#")]),t._v(" Chart.js - v4.4.1")]),t._v(" "),e("h2",{attrs:{id:"enumerations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enumerations"}},[t._v("#")]),t._v(" Enumerations")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/api/enums/DecimationAlgorithm.html"}},[t._v("DecimationAlgorithm")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/enums/UpdateModeEnum.html"}},[t._v("UpdateModeEnum")])],1)]),t._v(" "),e("h2",{attrs:{id:"classes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#classes"}},[t._v("#")]),t._v(" Classes")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[t._v("Animation")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Animations.html"}},[t._v("Animations")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Animator.html"}},[t._v("Animator")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/ArcElement.html"}},[t._v("ArcElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/BasicPlatform.html"}},[t._v("BasicPlatform")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[t._v("Chart")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[t._v("DatasetController")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/DomPlatform.html"}},[t._v("DomPlatform")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/PointElement.html"}},[t._v("PointElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")])],1)]),t._v(" "),e("h2",{attrs:{id:"interfaces"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interfaces"}},[t._v("#")]),t._v(" Interfaces")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[t._v("ActiveDataPoint")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[t._v("ActiveElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[t._v("AnimationEvent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcBorderRadius.html"}},[t._v("ArcBorderRadius")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcHoverOptions.html"}},[t._v("ArcHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcOptions.html"}},[t._v("ArcOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[t._v("ArcProps")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BackdropOptions.html"}},[t._v("BackdropOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarControllerChartOptions.html"}},[t._v("BarControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarControllerDatasetOptions.html"}},[t._v("BarControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarElement.html"}},[t._v("BarElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarHoverOptions.html"}},[t._v("BarHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[t._v("BarOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[t._v("BarProps")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BorderOptions.html"}},[t._v("BorderOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[t._v("BorderRadius")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BubbleControllerDatasetOptions.html"}},[t._v("BubbleControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/BubbleDataPoint.html"}},[t._v("BubbleDataPoint")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CanvasFontSpec.html"}},[t._v("CanvasFontSpec")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[t._v("CartesianParsedData")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[t._v("CartesianScaleOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleTypeRegistry.html"}},[t._v("CartesianScaleTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[t._v("ChartArea")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[t._v("ChartComponent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[t._v("ChartConfiguration")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[t._v("ChartConfigurationCustomTypesPerDataset")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[t._v("ChartData")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartDataCustomTypesPerDataset.html"}},[t._v("ChartDataCustomTypesPerDataset")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetProperties.html"}},[t._v("ChartDatasetProperties")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html"}},[t._v("ChartDatasetPropertiesCustomTypesPerDataset")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[t._v("ChartTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[t._v("CommonElementOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[t._v("CommonHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ComplexFillTarget.html"}},[t._v("ComplexFillTarget")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreChartOptions.html"}},[t._v("CoreChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[t._v("CoreScaleOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DatasetControllerChartComponent.html"}},[t._v("DatasetControllerChartComponent")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Defaults.html"}},[t._v("Defaults")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[t._v("DoughnutAnimationOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutController.html"}},[t._v("DoughnutController")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerChartOptions.html"}},[t._v("DoughnutControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[t._v("DoughnutControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutMetaExtensions.html"}},[t._v("DoughnutMetaExtensions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ElementOptionsByType.html"}},[t._v("ElementOptionsByType")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ExtendedPlugin.html"}},[t._v("ExtendedPlugin")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/FillerControllerDatasetOptions.html"}},[t._v("FillerControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/FillerOptions.html"}},[t._v("FillerOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[t._v("FontSpec")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/GridLineOptions.html"}},[t._v("GridLineOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[t._v("InteractionItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[t._v("InteractionModeMap")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[t._v("InteractionOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[t._v("LabelItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LegendElement.html"}},[t._v("LegendElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LegendItem.html"}},[t._v("LegendItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LegendOptions.html"}},[t._v("LegendOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerChartOptions.html"}},[t._v("LineControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerDatasetOptions.html"}},[t._v("LineControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineElement.html"}},[t._v("LineElement")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineHoverOptions.html"}},[t._v("LineHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineOptions.html"}},[t._v("LineOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/LineProps.html"}},[t._v("LineProps")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ParsingOptions.html"}},[t._v("ParsingOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PluginChartOptions.html"}},[t._v("PluginChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PluginOptionsByType.html"}},[t._v("PluginOptionsByType")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[t._v("PointHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[t._v("PointOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedHoverOptions.html"}},[t._v("PointPrefixedHoverOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PointPrefixedOptions.html"}},[t._v("PointPrefixedOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PolarAreaController.html"}},[t._v("PolarAreaController")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PolarAreaControllerChartOptions.html"}},[t._v("PolarAreaControllerChartOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/PolarAreaControllerDatasetOptions.html"}},[t._v("PolarAreaControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RadarControllerDatasetOptions.html"}},[t._v("RadarControllerDatasetOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialLinearScale.html"}},[t._v("RadialLinearScale")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RadialScaleTypeRegistry.html"}},[t._v("RadialScaleTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Registry.html"}},[t._v("Registry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/RenderTextOpts.html"}},[t._v("RenderTextOpts")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScaleTypeRegistry.html"}},[t._v("ScaleTypeRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableCartesianScaleContext.html"}},[t._v("ScriptableCartesianScaleContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableChartContext.html"}},[t._v("ScriptableChartContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[t._v("ScriptableContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableLineSegmentContext.html"}},[t._v("ScriptableLineSegmentContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[t._v("ScriptableScaleContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[t._v("ScriptableScalePointLabelContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[t._v("ScriptableTooltipContext")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Segment.html"}},[t._v("Segment")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[t._v("Tick")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TickOptions.html"}},[t._v("TickOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TimeScale.html"}},[t._v("TimeScale")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TitleOptions.html"}},[t._v("TitleOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/Tooltip.html"}},[t._v("Tooltip")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipCallbacks.html"}},[t._v("TooltipCallbacks")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[t._v("TooltipItem")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[t._v("TooltipLabelStyle")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[t._v("TooltipModel")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipOptions.html"}},[t._v("TooltipOptions")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[t._v("TooltipPosition")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPositionerMap.html"}},[t._v("TooltipPositionerMap")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/TypedRegistry.html"}},[t._v("TypedRegistry")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")])],1)]),t._v(" "),e("h2",{attrs:{id:"type-aliases"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-aliases"}},[t._v("#")]),t._v(" Type Aliases")]),t._v(" "),e("h3",{attrs:{id:"align"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" Align")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Align")]),t._v(": "),e("code",[t._v('"start"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"end"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1793",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1793"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animationoptions"}},[t._v("#")]),t._v(" AnimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("AnimationOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animation")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & { "),e("code",[t._v("onComplete?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" ; "),e("code",[t._v("onProgress?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" }")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("transitions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[e("code",[t._v("TransitionsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1746",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1746"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animationspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animationspec"}},[t._v("#")]),t._v(" AnimationSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("AnimationSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("delay?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Delay before starting the animations. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 0")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("duration?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The number of milliseconds an animation takes. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 1000")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("easing?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#easingfunction"}},[e("code",[t._v("EasingFunction")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Easing function to use "),e("strong",[e("code",[t._v("Default")])]),t._v(" 'easeOutQuart'")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("loop?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If set to true, the animations loop endlessly. "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1690",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1690"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animationsspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animationsspec"}},[t._v("#")]),t._v(" AnimationsSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("AnimationsSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"index-signature"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [name: "),e("code",[t._v("string")]),t._v("]: "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & { "),e("code",[t._v("fn")]),t._v(": ("),e("code",[t._v("from")]),t._v(": "),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("to")]),t._v(": "),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("factor")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("T")]),t._v(" ; "),e("code",[t._v("from")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">> ; "),e("code",[t._v("properties")]),t._v(": "),e("code",[t._v("string")]),t._v("[] ; "),e("code",[t._v("to")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(" | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">> ; "),e("code",[t._v("type")]),t._v(": "),e("code",[t._v('"color"')]),t._v(" | "),e("code",[t._v('"number"')]),t._v(" | "),e("code",[t._v('"boolean"')]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1715",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1715"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barcontroller"}},[t._v("#")]),t._v(" BarController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("BarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:156"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bubblecontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bubblecontroller"}},[t._v("#")]),t._v(" BubbleController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("BubbleController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:183"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"cartesiantickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cartesiantickoptions"}},[t._v("#")]),t._v(" CartesianTickOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("CartesianTickOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TickOptions.html"}},[e("code",[t._v("TickOptions")])]),t._v(" & { "),e("code",[t._v("align")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#align"}},[e("code",[t._v("Align")])]),t._v(" | "),e("code",[t._v('"inner"')]),t._v(" ; "),e("code",[t._v("autoSkip")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("autoSkipPadding")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("crossAlign")]),t._v(": "),e("code",[t._v('"near"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"far"')]),t._v(" ; "),e("code",[t._v("includeBounds")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("labelOffset")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("maxRotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("maxTicksLimit")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("minRotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("mirror")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("padding")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("sampleSize")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3090",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3090"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categoryscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categoryscale"}},[t._v("#")]),t._v(" CategoryScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("CategoryScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-4"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#categoryscaleoptions"}},[e("code",[t._v("CategoryScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#categoryscaleoptions"}},[e("code",[t._v("CategoryScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3257",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3257"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3258",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3258"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categoryscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categoryscaleoptions"}},[t._v("#")]),t._v(" CategoryScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("CategoryScaleOptions")]),t._v(": "),e("code",[t._v("Omit")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(", "),e("code",[t._v('"min"')]),t._v(" | "),e("code",[t._v('"max"')]),t._v("> & { "),e("code",[t._v("labels")]),t._v(": "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("string")]),t._v("[][] ; "),e("code",[t._v("max")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("min")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3251",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3251"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartcomponentlike"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartcomponentlike"}},[t._v("#")]),t._v(" ChartComponentLike")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartComponentLike")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v("[] | { "),e("code",[t._v("[key: string]")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v("; } | "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1125",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1125"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartdataset"}},[t._v("#")]),t._v(" ChartDataset")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartDataset")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v('<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }['),e("code",[t._v("TType")]),t._v("]> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetProperties.html"}},[e("code",[t._v("ChartDatasetProperties")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-5"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#defaultdatapoint"}},[e("code",[t._v("DefaultDataPoint")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3770",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3770"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartdatasetcustomtypesperdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartdatasetcustomtypesperdataset"}},[t._v("#")]),t._v(" ChartDatasetCustomTypesPerDataset")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartDatasetCustomTypesPerDataset")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v('<{ [key in ChartType]: Object & ChartTypeRegistry[key]["datasetOptions"] }['),e("code",[t._v("TType")]),t._v("]> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartDatasetPropertiesCustomTypesPerDataset.html"}},[e("code",[t._v("ChartDatasetPropertiesCustomTypesPerDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-6"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#defaultdatapoint"}},[e("code",[t._v("DefaultDataPoint")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3777",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3777"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartitem"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartitem"}},[t._v("#")]),t._v(" ChartItem")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartItem")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("CanvasRenderingContext2D")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")]),t._v(" | { "),e("code",[t._v("canvas")]),t._v(": "),e("code",[t._v("HTMLCanvasElement")]),t._v(" } | "),e("code",[t._v("ArrayLike")]),t._v("<"),e("code",[t._v("CanvasRenderingContext2D")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L563",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:563"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartmeta"}},[t._v("#")]),t._v(" ChartMeta")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartMeta")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v('<{ [key in ChartType]: ChartTypeRegistry[key]["metaExtensions"] }['),e("code",[t._v("TType")]),t._v("]> & "),e("code",[t._v("ChartMetaCommon")]),t._v("<"),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-7"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TDatasetElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L467",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:467"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartoptions"}},[t._v("#")]),t._v(" ChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreChartOptions.html"}},[e("code",[t._v("CoreChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#elementchartoptions"}},[e("code",[t._v("ElementChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/PluginChartOptions.html"}},[e("code",[t._v("PluginChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#datasetchartoptions"}},[e("code",[t._v("DatasetChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#scalechartoptions"}},[e("code",[t._v("ScaleChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"chartOptions"')]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-8"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3747"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"charttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#charttype"}},[t._v("#")]),t._v(" ChartType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ChartType")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3726",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3726"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" Color")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Color")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("CanvasGradient")]),t._v(" | "),e("code",[t._v("CanvasPattern")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/color.d.ts#L1",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/color.d.ts:1"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datasetchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetchartoptions"}},[t._v("#")]),t._v(" DatasetChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DatasetChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: { [key in TType]: Object }")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-9"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3735",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3735"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"decimationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decimationoptions"}},[t._v("#")]),t._v(" DecimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DecimationOptions")]),t._v(": "),e("code",[t._v("LttbDecimationOptions")]),t._v(" | "),e("code",[t._v("MinMaxDecimationOptions")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2220",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2220"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaultdatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaultdatapoint"}},[t._v("#")]),t._v(" DefaultDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DefaultDataPoint")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-10"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3756",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3756"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"doughnutdatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#doughnutdatapoint"}},[t._v("#")]),t._v(" DoughnutDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("DoughnutDataPoint")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L338",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:338"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"easingfunction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#easingfunction"}},[t._v("#")]),t._v(" EasingFunction")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("EasingFunction")]),t._v(": keyof typeof "),e("code",[t._v("effects")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/helpers/helpers.easing.ts#L122",target:"_blank",rel:"noopener noreferrer"}},[t._v("helpers/helpers.easing.ts:122"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"elementchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#elementchartoptions"}},[t._v("#")]),t._v(" ElementChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ElementChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-11"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("elements")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ElementOptionsByType.html"}},[e("code",[t._v("ElementOptionsByType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2136",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2136"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"filltarget"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#filltarget"}},[t._v("#")]),t._v(" FillTarget")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("FillTarget")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("string")]),t._v(" | { "),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("number")]),t._v(" } | "),e("code",[t._v('"start"')]),t._v(" | "),e("code",[t._v('"end"')]),t._v(" | "),e("code",[t._v('"origin"')]),t._v(" | "),e("code",[t._v('"stack"')]),t._v(" | "),e("code",[t._v('"shape"')]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2228",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2228"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interactionaxis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactionaxis"}},[t._v("#")]),t._v(" InteractionAxis")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("InteractionAxis")]),t._v(": "),e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')]),t._v(" | "),e("code",[t._v('"xy"')]),t._v(" | "),e("code",[t._v('"r"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1562",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1562"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interactionmode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactionmode"}},[t._v("#")]),t._v(" InteractionMode")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("InteractionMode")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[e("code",[t._v("InteractionModeMap")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L761",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:761"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interactionmodefunction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactionmodefunction"}},[t._v("#")]),t._v(" InteractionModeFunction")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("InteractionModeFunction")]),t._v(": ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(", "),e("code",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[e("code",[t._v("InteractionOptions")])]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v(": "),e("code",[t._v("boolean")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"type-declaration-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-4"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("e")]),t._v(", "),e("code",[t._v("options")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h5",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("e")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[e("code",[t._v("InteractionOptions")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h5",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L723",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:723"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"layoutposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#layoutposition"}},[t._v("#")]),t._v(" LayoutPosition")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LayoutPosition")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"right"')]),t._v(" | "),e("code",[t._v('"bottom"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"chartArea"')]),t._v(" | { "),e("code",[t._v("[scaleId: string]")]),t._v(": "),e("code",[t._v("number")]),t._v("; }")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L3",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:3"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linecontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linecontroller"}},[t._v("#")]),t._v(" LineController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LineController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L229",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:229"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L230",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:230"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linearscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linearscale"}},[t._v("#")]),t._v(" LinearScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LinearScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-12"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#linearscaleoptions"}},[e("code",[t._v("LinearScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#linearscaleoptions"}},[e("code",[t._v("LinearScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3306",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3306"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3307",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3307"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linearscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linearscaleoptions"}},[t._v("#")]),t._v(" LinearScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LinearScaleOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(" & { "),e("code",[t._v("beginAtZero")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("grace?")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMax?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("count")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("format")]),t._v(": "),e("code",[t._v("Intl.NumberFormatOptions")]),t._v(" ; "),e("code",[t._v("precision")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("stepSize")]),t._v(": "),e("code",[t._v("number")]),t._v(" } }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmicscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmicscale"}},[t._v("#")]),t._v(" LogarithmicScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LogarithmicScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-13"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#logarithmicscaleoptions"}},[e("code",[t._v("LogarithmicScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#logarithmicscaleoptions"}},[e("code",[t._v("LogarithmicScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3330",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3330"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3331",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3331"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmicscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmicscaleoptions"}},[t._v("#")]),t._v(" LogarithmicScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("LogarithmicScaleOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(" & { "),e("code",[t._v("suggestedMax?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("format")]),t._v(": "),e("code",[t._v("Intl.NumberFormatOptions")]),t._v(" } }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3312",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3312"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Overrides")]),t._v(': { [key in ChartType]: CoreChartOptions & ElementChartOptions & PluginChartOptions & DatasetChartOptions & ScaleChartOptions & ChartTypeRegistry[key]["chartOptions"] }')]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L700",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:700"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseddatatype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseddatatype"}},[t._v("#")]),t._v(" ParsedDataType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ParsedDataType")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"parsedDataType"')]),t._v("]")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-14"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3758"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pieanimationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pieanimationoptions"}},[t._v("#")]),t._v(" PieAnimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieAnimationOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[e("code",[t._v("DoughnutAnimationOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontroller"}},[t._v("#")]),t._v(" PieController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:366"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontrollerchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontrollerchartoptions"}},[t._v("#")]),t._v(" PieControllerChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieControllerChartOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerChartOptions.html"}},[e("code",[t._v("DoughnutControllerChartOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontrollerdatasetoptions"}},[t._v("#")]),t._v(" PieControllerDatasetOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieControllerDatasetOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutControllerDatasetOptions.html"}},[e("code",[t._v("DoughnutControllerDatasetOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piedatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piedatapoint"}},[t._v("#")]),t._v(" PieDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieDataPoint")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#doughnutdatapoint"}},[e("code",[t._v("DoughnutDataPoint")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piemetaextensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piemetaextensions"}},[t._v("#")]),t._v(" PieMetaExtensions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PieMetaExtensions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutMetaExtensions.html"}},[e("code",[t._v("DoughnutMetaExtensions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointprops"}},[t._v("#")]),t._v(" PointProps")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PointProps")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L18",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:18"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" PointStyle")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PointStyle")]),t._v(": "),e("code",[t._v('"circle"')]),t._v(" | "),e("code",[t._v('"cross"')]),t._v(" | "),e("code",[t._v('"crossRot"')]),t._v(" | "),e("code",[t._v('"dash"')]),t._v(" | "),e("code",[t._v('"line"')]),t._v(" | "),e("code",[t._v('"rect"')]),t._v(" | "),e("code",[t._v('"rectRounded"')]),t._v(" | "),e("code",[t._v('"rectRot"')]),t._v(" | "),e("code",[t._v('"star"')]),t._v(" | "),e("code",[t._v('"triangle"')]),t._v(" | "),e("code",[t._v("false")]),t._v(" | "),e("code",[t._v("HTMLImageElement")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1968",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1968"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"polarareaanimationoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polarareaanimationoptions"}},[t._v("#")]),t._v(" PolarAreaAnimationOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("PolarAreaAnimationOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutAnimationOptions.html"}},[e("code",[t._v("DoughnutAnimationOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L380",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:380"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radarcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radarcontroller"}},[t._v("#")]),t._v(" RadarController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/DatasetController.html"}},[e("code",[t._v("DatasetController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L427",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:427"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L428",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:428"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radarcontrollerchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radarcontrollerchartoptions"}},[t._v("#")]),t._v(" RadarControllerChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadarControllerChartOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerChartOptions.html"}},[e("code",[t._v("LineControllerChartOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L425",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:425"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radiallinearscaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinearscaleoptions"}},[t._v("#")]),t._v(" RadialLinearScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadialLinearScaleOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(" & { "),e("code",[t._v("angleLines")]),t._v(": { "),e("code",[t._v("borderDash")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v("[], "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> ; "),e("code",[t._v("borderDashOffset")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> ; "),e("code",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> ; "),e("code",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("lineWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v("> } ; "),e("code",[t._v("animate")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("beginAtZero")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("grid")]),t._v(": "),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/GridLineOptions.html"}},[e("code",[t._v("GridLineOptions")])]),t._v("> ; "),e("code",[t._v("max")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("min")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("pointLabels")]),t._v(": { "),e("code",[t._v("backdropColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("backdropPadding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("borderRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[t._v("BorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("callback")]),t._v(": ("),e("code",[t._v("label")]),t._v(": "),e("code",[t._v("string")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] | "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("number")]),t._v("[] ; "),e("code",[t._v("centerPointLabels")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v('"auto"')]),t._v(" ; "),e("code",[t._v("font")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> ; "),e("code",[t._v("padding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScalePointLabelContext.html"}},[e("code",[t._v("ScriptableScalePointLabelContext")])]),t._v("> } ; "),e("code",[t._v("startAngle")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMax")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#radialtickoptions"}},[e("code",[t._v("RadialTickOptions")])]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3470",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3470"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radialtickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radialtickoptions"}},[t._v("#")]),t._v(" RadialTickOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("RadialTickOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TickOptions.html"}},[e("code",[t._v("TickOptions")])]),t._v(" & { "),e("code",[t._v("count")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("format")]),t._v(": "),e("code",[t._v("Intl.NumberFormatOptions")]),t._v(" ; "),e("code",[t._v("maxTicksLimit")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("precision")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("stepSize")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3442",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3442"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scalechartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scalechartoptions"}},[t._v("#")]),t._v(" ScaleChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleChartOptions")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-15"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-5"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scales")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("{ "),e("code",[t._v("[key: string]")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scaleoptionsbytype"}},[e("code",[t._v("ScaleOptionsByType")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"scales"')]),t._v("]>; }")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3741",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3741"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scaleoptions"}},[t._v("#")]),t._v(" ScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleOptions")]),t._v("<"),e("code",[t._v("TScale")]),t._v(">: "),e("code",[t._v("DeepPartial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#scaleoptionsbytype"}},[e("code",[t._v("ScaleOptionsByType")])]),t._v("<"),e("code",[t._v("TScale")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-16"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TScale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3733",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3733"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scaleoptionsbytype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scaleoptionsbytype"}},[t._v("#")]),t._v(" ScaleOptionsByType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleOptionsByType")]),t._v("<"),e("code",[t._v("TScale")]),t._v('>: { [key in ScaleType]: Object & ScaleTypeRegistry[key]["options"] }['),e("code",[t._v("TScale")]),t._v("]")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-17"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TScale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#scaletype"}},[e("code",[t._v("ScaleType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3728",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3728"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scaletype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scaletype"}},[t._v("#")]),t._v(" ScaleType")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScaleType")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ScaleTypeRegistry.html"}},[e("code",[t._v("ScaleTypeRegistry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3625",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3625"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontroller"}},[t._v("#")]),t._v(" ScatterController")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#linecontroller-1"}},[e("code",[t._v("LineController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L241",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:241"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L242",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:242"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontrollerchartoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontrollerchartoptions"}},[t._v("#")]),t._v(" ScatterControllerChartOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterControllerChartOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerChartOptions.html"}},[e("code",[t._v("LineControllerChartOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L239",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:239"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontrollerdatasetoptions"}},[t._v("#")]),t._v(" ScatterControllerDatasetOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterControllerDatasetOptions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LineControllerDatasetOptions.html"}},[e("code",[t._v("LineControllerDatasetOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L235",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:235"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scatterdatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scatterdatapoint"}},[t._v("#")]),t._v(" ScatterDataPoint")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScatterDataPoint")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L237",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:237"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptable"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptable"}},[t._v("#")]),t._v(" Scriptable")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("Scriptable")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: "),e("code",[t._v("T")]),t._v(" | ("),e("code",[t._v("ctx")]),t._v(": "),e("code",[t._v("TContext")]),t._v(", "),e("code",[t._v("options")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("code",[t._v("T")]),t._v(" | "),e("code",[t._v("undefined")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-18"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:44"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableandarray"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableandarray"}},[t._v("#")]),t._v(" ScriptableAndArray")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableAndArray")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: readonly "),e("code",[t._v("T")]),t._v("[] | "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-19"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L47",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:47"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableandarrayoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableandarrayoptions"}},[t._v("#")]),t._v(" ScriptableAndArrayOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableAndArrayOptions")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: { [P in keyof T]: ScriptableAndArray }")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-20"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L48",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:48"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableandscriptableoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableandscriptableoptions"}},[t._v("#")]),t._v(" ScriptableAndScriptableOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableAndScriptableOptions")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v("> | "),e("RouterLink",{attrs:{to:"/api/#scriptableoptions"}},[e("code",[t._v("ScriptableOptions")])]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-21"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scriptableoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptableoptions"}},[t._v("#")]),t._v(" ScriptableOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("ScriptableOptions")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("TContext")]),t._v(">: { [P in keyof T]: Scriptable }")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-22"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TContext")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L45",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:45"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textalign"}},[t._v("#")]),t._v(" TextAlign")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TextAlign")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"right"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1792",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1792"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescaleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescaleoptions"}},[t._v("#")]),t._v(" TimeScaleOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeScaleOptions")]),t._v(": "),e("code",[t._v("Omit")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianScaleOptions.html"}},[e("code",[t._v("CartesianScaleOptions")])]),t._v(", "),e("code",[t._v('"min"')]),t._v(" | "),e("code",[t._v('"max"')]),t._v("> & { "),e("code",[t._v("adapters")]),t._v(": { "),e("code",[t._v("date")]),t._v(": "),e("code",[t._v("unknown")]),t._v(" } ; "),e("code",[t._v("bounds")]),t._v(": "),e("code",[t._v('"ticks"')]),t._v(" | "),e("code",[t._v('"data"')]),t._v(" ; "),e("code",[t._v("max")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("min")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("offsetAfterAutoskip")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" ; "),e("code",[t._v("suggestedMax")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("suggestedMin")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#timescaletickoptions"}},[e("code",[t._v("TimeScaleTickOptions")])]),t._v(" ; "),e("code",[t._v("time")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#timescaletimeoptions"}},[e("code",[t._v("TimeScaleTimeOptions")])]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3391",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3391"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescaletickoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescaletickoptions"}},[t._v("#")]),t._v(" TimeScaleTickOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeScaleTickOptions")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-6"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("source")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"labels"')]),t._v(" | "),e("code",[t._v('"auto"')]),t._v(" | "),e("code",[t._v('"data"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Ticks generation input values: - 'auto': generates \"optimal\" ticks based on scale size and time options. - 'data': generates ticks from data (including labels from data "),e("code",[t._v("{t\\|x\\|y}")]),t._v(" objects). - 'labels': generates ticks from user given "),e("code",[t._v("data.labels")]),t._v(" values ONLY. "),e("strong",[e("code",[t._v("See")])]),t._v(" https://github.com/chartjs/Chart.js/pull/4507 "),e("strong",[e("code",[t._v("Since")])]),t._v(" 2.7.0 "),e("strong",[e("code",[t._v("Default")])]),t._v(" 'auto'")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("stepSize")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The number of units between grid lines. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 1")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3373",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3373"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescaletimeoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescaletimeoptions"}},[t._v("#")]),t._v(" TimeScaleTimeOptions")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeScaleTimeOptions")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-7"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("displayFormats")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("{ "),e("code",[t._v("[key: string]")]),t._v(": "),e("code",[t._v("string")]),t._v("; }")]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Sets how different time units are displayed.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("isoWeekday")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If boolean and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If "),e("code",[t._v("number")]),t._v(", the index of the first day of the week (0 - Sunday, 6 - Saturday). "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TimeUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The minimum display format to be used for a time unit. "),e("strong",[e("code",[t._v("Default")])]),t._v(" 'millisecond'")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parser")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | ("),e("code",[t._v("v")]),t._v(": "),e("code",[t._v("unknown")]),t._v(") => "),e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Custom parser for dates.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("round")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")]),t._v(" | "),e("code",[t._v("TimeUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If defined, dates will be rounded to the start of this unit. See Time Units below for the allowed units.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipFormat")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The format string to use for the tooltip.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")]),t._v(" | "),e("code",[t._v("TimeUnit")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("If defined, will force the unit to be a certain type. See Time Units section below for details. "),e("strong",[e("code",[t._v("Default")])]),t._v(" false")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3336",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3336"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timeseriesscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timeseriesscale"}},[t._v("#")]),t._v(" TimeSeriesScale")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TimeSeriesScale")]),t._v("<"),e("code",[t._v("O")]),t._v(">: "),e("RouterLink",{attrs:{to:"/api/#timescale"}},[e("code",[t._v("TimeScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-23"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3436",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3436"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3437",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3437"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltippositioner"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltippositioner"}},[t._v("#")]),t._v(" TooltipPositioner")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipPositioner")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPositionerMap.html"}},[e("code",[t._v("TooltipPositionerMap")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2650",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2650"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltippositionerfunction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltippositionerfunction"}},[t._v("#")]),t._v(" TooltipPositionerFunction")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipPositionerFunction")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("items")]),t._v(": readonly "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[], "),e("code",[t._v("eventPosition")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[e("code",[t._v("TooltipPosition")])]),t._v(" | "),e("code",[t._v("false")])],1),t._v(" "),e("h4",{attrs:{id:"type-parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-24"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-8"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("items")]),t._v(", "),e("code",[t._v("eventPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[e("code",[t._v("TooltipPosition")])]),t._v(" | "),e("code",[t._v("false")])],1),t._v(" "),e("h5",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("readonly "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("eventPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPosition.html"}},[e("code",[t._v("TooltipPosition")])]),t._v(" | "),e("code",[t._v("false")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2639",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2639"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipxalignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipxalignment"}},[t._v("#")]),t._v(" TooltipXAlignment")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipXAlignment")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"right"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2550",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2550"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipyalignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipyalignment"}},[t._v("#")]),t._v(" TooltipYAlignment")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TooltipYAlignment")]),t._v(": "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"center"')]),t._v(" | "),e("code",[t._v('"bottom"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2551",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2551"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitionspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitionspec"}},[t._v("#")]),t._v(" TransitionSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TransitionSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-25"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-9"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animation")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1737",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1737"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitionsspec"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitionsspec"}},[t._v("#")]),t._v(" TransitionsSpec")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("TransitionsSpec")]),t._v("<"),e("code",[t._v("TType")]),t._v(">: "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-parameters-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-26"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"index-signature-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature-2"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [mode: "),e("code",[t._v("string")]),t._v("]: "),e("RouterLink",{attrs:{to:"/api/#transitionspec"}},[e("code",[t._v("TransitionSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1742",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1742"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatemode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatemode"}},[t._v("#")]),t._v(" UpdateMode")]),t._v(" "),e("p",[t._v("Ƭ "),e("strong",[t._v("UpdateMode")]),t._v(": keyof typeof "),e("RouterLink",{attrs:{to:"/api/enums/UpdateModeEnum.html"}},[e("code",[t._v("UpdateModeEnum")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L580",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:580"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"variables"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#variables"}},[t._v("#")]),t._v(" Variables")]),t._v(" "),e("h3",{attrs:{id:"barcontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barcontroller-2"}},[t._v("#")]),t._v(" BarController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("BarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#barcontroller-1"}},[e("code",[t._v("BarController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L156",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:156"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barelement"}},[t._v("#")]),t._v(" BarElement")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("BarElement")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#barelement"}},[e("code",[t._v("BarElement")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[e("code",[t._v("BarProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2119",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2119"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2124",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2124"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bubblecontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bubblecontroller-2"}},[t._v("#")]),t._v(" BubbleController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("BubbleController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#bubblecontroller-1"}},[e("code",[t._v("BubbleController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L183",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:183"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categoryscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categoryscale-2"}},[t._v("#")]),t._v(" CategoryScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("CategoryScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#categoryscale-1"}},[e("code",[t._v("CategoryScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3257",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3257"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3258",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3258"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decimation"}},[t._v("#")]),t._v(" Decimation")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Decimation")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2200",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2200"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"doughnutcontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#doughnutcontroller"}},[t._v("#")]),t._v(" DoughnutController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("DoughnutController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L340",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:340"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"filler"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#filler"}},[t._v("#")]),t._v(" Filler")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Filler")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2222",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2222"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"interaction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interaction"}},[t._v("#")]),t._v(" Interaction")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Interaction")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-10"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("modes")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[e("code",[t._v("InteractionModeMap")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("evaluateInteractionItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("axis")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#interactionaxis"}},[e("code",[t._v("InteractionAxis")])]),t._v(", "),e("code",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(", "),e("code",[t._v("handler")]),t._v(": ("),e("code",[t._v("element")]),t._v(": "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[e("code",[t._v("VisualElement")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("void")]),t._v(", "),e("code",[t._v("intersect?")]),t._v(": "),e("code",[t._v("boolean")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L763",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:763"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"legend"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend"}},[t._v("#")]),t._v(" Legend")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Legend")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-82"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-82"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2252",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2252"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linecontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linecontroller-2"}},[t._v("#")]),t._v(" LineController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LineController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#linecontroller-1"}},[e("code",[t._v("LineController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-83"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-83"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L229",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:229"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L230",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:230"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"lineelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lineelement"}},[t._v("#")]),t._v(" LineElement")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LineElement")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#lineelement"}},[e("code",[t._v("LineElement")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/LineProps.html"}},[e("code",[t._v("LineProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/LineOptions.html"}},[e("code",[t._v("LineOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-84"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-84"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1950",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1950"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1963",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1963"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linearscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linearscale-2"}},[t._v("#")]),t._v(" LinearScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LinearScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#linearscale-1"}},[e("code",[t._v("LinearScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-85"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-85"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3306",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3306"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3307",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3307"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"logarithmicscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmicscale-2"}},[t._v("#")]),t._v(" LogarithmicScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("LogarithmicScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#logarithmicscale-1"}},[e("code",[t._v("LogarithmicScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-86"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-86"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3330",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3330"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3331",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3331"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"piecontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#piecontroller-2"}},[t._v("#")]),t._v(" PieController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("PieController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#doughnutcontroller"}},[e("code",[t._v("DoughnutController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-87"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-87"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:366"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"polarareacontroller"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polarareacontroller"}},[t._v("#")]),t._v(" PolarAreaController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("PolarAreaController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#polarareacontroller"}},[e("code",[t._v("PolarAreaController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-88"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-88"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L392",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:392"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L395",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:395"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radarcontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radarcontroller-2"}},[t._v("#")]),t._v(" RadarController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("RadarController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#radarcontroller-1"}},[e("code",[t._v("RadarController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-89"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-89"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L427",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:427"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L428",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:428"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"radiallinearscale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#radiallinearscale"}},[t._v("#")]),t._v(" RadialLinearScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("RadialLinearScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#radiallinearscale"}},[e("code",[t._v("RadialLinearScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-90"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-90"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3583",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3583"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scattercontroller-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scattercontroller-2"}},[t._v("#")]),t._v(" ScatterController")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ScatterController")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#linecontroller-1"}},[e("code",[t._v("LineController")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-91"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-91"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L241",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:241"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L242",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:242"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"subtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#subtitle"}},[t._v("#")]),t._v(" SubTitle")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("SubTitle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-92"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-92"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2508",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2508"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" Ticks")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Ticks")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-11"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("{ "),e("code",[t._v("logarithmic")]),t._v(": ("),e("code",[t._v("tickValue")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("number")]),t._v(" }[]) => "),e("code",[t._v("string")]),t._v(" ; "),e("code",[t._v("numeric")]),t._v(": ("),e("code",[t._v("tickValue")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("ticks")]),t._v(": { "),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("number")]),t._v(" }[]) => "),e("code",[t._v("string")]),t._v(" ; "),e("code",[t._v("values")]),t._v(": ("),e("code",[t._v("value")]),t._v(": "),e("code",[t._v("unknown")]),t._v(") => "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[] }")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters.logarithmic")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("[object Object]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters.numeric")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("[object Object]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("formatters.values")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("[object Object]")])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-93"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-93"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1496",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1496"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timescale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timescale"}},[t._v("#")]),t._v(" TimeScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("TimeScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#timescale"}},[e("code",[t._v("TimeScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-94"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-94"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3424",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3424"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3431",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3431"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"timeseriesscale-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#timeseriesscale-2"}},[t._v("#")]),t._v(" TimeSeriesScale")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("TimeSeriesScale")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])]),t._v(" & ("),e("code",[t._v("cfg")]),t._v(": "),e("code",[t._v("AnyObject")]),t._v(") => "),e("RouterLink",{attrs:{to:"/api/#timeseriesscale-1"}},[e("code",[t._v("TimeSeriesScale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-95"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-95"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3436",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3436"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3437",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3437"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"title"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" Title")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("Title")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-96"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-96"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2509",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2509"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" Tooltip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("Tooltip")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltip"}},[e("code",[t._v("Tooltip")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-97"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-97"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2652",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2652"),e("OutboundLink")],1)]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2656",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2656"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Defaults.html"}},[e("code",[t._v("Defaults")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-98"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-98"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L710",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:710"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"layouts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#layouts"}},[t._v("#")]),t._v(" layouts")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("layouts")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-12"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("addBox")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("item")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v(") => "),e("code",[t._v("void")])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("configure")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("item")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v(", "),e("code",[t._v("options")]),t._v(": { "),e("code",[t._v("fullSize?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("position?")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])]),t._v(" ; "),e("code",[t._v("weight?")]),t._v(": "),e("code",[t._v("number")]),t._v(" }) => "),e("code",[t._v("void")])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("removeBox")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("layoutItem")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v(") => "),e("code",[t._v("void")])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("update")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("width")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("height")]),t._v(": "),e("code",[t._v("number")]),t._v(") => "),e("code",[t._v("void")])],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-99"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-99"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L778",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:778"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"registerables"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registerables"}},[t._v("#")]),t._v(" registerables")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("registerables")]),t._v(": readonly "),e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-100"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-100"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L561",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:561"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"registry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registry"}},[t._v("#")]),t._v(" registry")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Const")]),t._v(" "),e("strong",[t._v("registry")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Registry.html"}},[e("code",[t._v("Registry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-101"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-101"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1151",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1151"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/120.deb5c679.js b/docs/master/assets/js/120.36124b5b.js similarity index 94% rename from docs/master/assets/js/120.deb5c679.js rename to docs/master/assets/js/120.36124b5b.js index deb9d8b987..711297ecd9 100644 --- a/docs/master/assets/js/120.deb5c679.js +++ b/docs/master/assets/js/120.36124b5b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{451:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-timescale-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-timescale-o"}},[t._v("#")]),t._v(" Interface: TimeScale")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TimeScale")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("never")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#animations"}},[t._v("$animations")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#active"}},[t._v("active")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#axis"}},[t._v("axis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1276",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1276"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bottom"}},[t._v("#")]),t._v(" bottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Bottom edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#bottom"}},[t._v("bottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#chart"}},[t._v("chart")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1266",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1266"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ctx"}},[t._v("ctx")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1265",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1265"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, and the item is horizontal, then push vertical boxes down")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fullsize"}},[t._v("fullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#height"}},[t._v("height")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#id"}},[t._v("id")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelrotation"}},[t._v("#")]),t._v(" labelRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#labelrotation"}},[t._v("labelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1277",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1277"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#left"}},[t._v("left")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:29"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"max"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#max"}},[t._v("#")]),t._v(" max")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("max")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#max"}},[t._v("max")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1279",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1279"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxheight"}},[t._v("#")]),t._v(" maxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxHeight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxheight"}},[t._v("maxHeight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1269",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1269"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxwidth"}},[t._v("maxWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"min"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min"}},[t._v("#")]),t._v(" min")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("min")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#min"}},[t._v("min")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1278",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1278"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#options"}},[t._v("options")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingbottom"}},[t._v("#")]),t._v(" paddingBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingBottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingbottom"}},[t._v("paddingBottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1272",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1272"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingleft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingleft"}},[t._v("#")]),t._v(" paddingLeft")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingLeft")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingleft"}},[t._v("paddingLeft")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1273",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1273"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingright"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingright"}},[t._v("#")]),t._v(" paddingRight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingRight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingright"}},[t._v("paddingRight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1274"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingtop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingtop"}},[t._v("#")]),t._v(" paddingTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingTop")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingtop"}},[t._v("paddingTop")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1271",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1271"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])])],1),t._v(" "),e("p",[t._v("The position of the item in the chart layout. Possible values are")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#position"}},[t._v("position")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"right"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#right"}},[t._v("#")]),t._v(" right")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("right")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Right edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#right"}},[t._v("right")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" ticks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ticks"}},[t._v("ticks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1280",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1280"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#top"}},[t._v("top")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:33"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#type"}},[t._v("type")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1264",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1264"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The weight used to sort the item. Higher weights are further away from the chart area")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#width"}},[t._v("width")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#x"}},[t._v("x")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#y"}},[t._v("y")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterbuildticks"}},[t._v("afterBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftercalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftercalculatelabelrotation"}},[t._v("#")]),t._v(" afterCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftercalculatelabelrotation"}},[t._v("afterCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterdatalimits"}},[t._v("afterDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1358"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfit"}},[t._v("#")]),t._v(" afterFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterfit"}},[t._v("afterFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1370",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1370"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftersetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftersetdimensions"}},[t._v("#")]),t._v(" afterSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftersetdimensions"}},[t._v("afterSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1355",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterticktolabelconversion"}},[t._v("#")]),t._v(" afterTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterticktolabelconversion"}},[t._v("afterTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterupdate"}},[t._v("afterUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1352",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1352"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforebuildticks"}},[t._v("beforeBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforecalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforecalculatelabelrotation"}},[t._v("#")]),t._v(" beforeCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforecalculatelabelrotation"}},[t._v("beforeCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1365",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1365"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforedatalimits"}},[t._v("beforeDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1356",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1356"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefit"}},[t._v("#")]),t._v(" beforeFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforefit"}},[t._v("beforeFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1368",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1368"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the layout process starts")]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforesetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforesetdimensions"}},[t._v("#")]),t._v(" beforeSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforesetdimensions"}},[t._v("beforeSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1353",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1353"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeticktolabelconversion"}},[t._v("#")]),t._v(" beforeTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeticktolabelconversion"}},[t._v("beforeTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1362",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1362"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeupdate"}},[t._v("beforeUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildticks"}},[t._v("#")]),t._v(" buildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-45"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#buildticks"}},[t._v("buildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatelabelrotation"}},[t._v("#")]),t._v(" calculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-46"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#calculatelabelrotation"}},[t._v("calculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1366"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-47"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#configure"}},[t._v("configure")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1351",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1351"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"determinedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#determinedatalimits"}},[t._v("#")]),t._v(" determineDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("determineDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-48"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#determinedatalimits"}},[t._v("determineDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1357",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1357"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Draws the element")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-49"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:50"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawgrid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawgrid"}},[t._v("#")]),t._v(" drawGrid")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawGrid")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-50"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawgrid"}},[t._v("drawGrid")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1285",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawlabels"}},[t._v("#")]),t._v(" drawLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawLabels")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-51"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawlabels"}},[t._v("drawLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1284",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1284"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawtitle"}},[t._v("#")]),t._v(" drawTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawTitle")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-52"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawtitle"}},[t._v("drawTitle")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1283",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1283"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fit"}},[t._v("#")]),t._v(" fit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-53"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fit"}},[t._v("fit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1369",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1369"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#format"}},[t._v("#")]),t._v(" format")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("format")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("format?")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("format?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3425",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3425"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"generateticklabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#generateticklabels"}},[t._v("#")]),t._v(" generateTickLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("generateTickLabels")]),t._v("("),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-54"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#generateticklabels"}},[t._v("generateTickLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasepixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasepixel"}},[t._v("#")]),t._v(" getBasePixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePixel")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the pixel for the minimum chart value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-55"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasepixel"}},[t._v("getBasePixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasevalue"}},[t._v("#")]),t._v(" getBaseValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBaseValue")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-56"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasevalue"}},[t._v("getBaseValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1335",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1335"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdatatimestamps"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdatatimestamps"}},[t._v("#")]),t._v(" getDataTimestamps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataTimestamps")]),t._v("(): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3426",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3426"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdecimalforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdecimalforpixel"}},[t._v("#")]),t._v(" getDecimalForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDecimalForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-57"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getdecimalforpixel"}},[t._v("getDecimalForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1291",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelforvalue"}},[t._v("#")]),t._v(" getLabelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Used to get the label to display in the tooltip for the given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-58"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelforvalue"}},[t._v("getLabelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1311",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1311"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelitems"}},[t._v("#")]),t._v(" getLabelItems")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelItems")]),t._v("("),e("code",[t._v("chartArea?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-59"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelitems"}},[t._v("getLabelItems")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1349",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1349"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabeltimestamps"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabeltimestamps"}},[t._v("#")]),t._v(" getLabelTimestamps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelTimestamps")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3427",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3427"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabels"}},[t._v("#")]),t._v(" getLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabels")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-60"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabels"}},[t._v("getLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1348",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1348"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlinewidthforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlinewidthforvalue"}},[t._v("#")]),t._v(" getLineWidthForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLineWidthForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the grid line width at given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-61"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlinewidthforvalue"}},[t._v("getLineWidthForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1316",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1316"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmatchingvisiblemetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmatchingvisiblemetas"}},[t._v("#")]),t._v(" getMatchingVisibleMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMatchingVisibleMetas")]),t._v("("),e("code",[t._v("type?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-62"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getmatchingvisiblemetas"}},[t._v("getMatchingVisibleMetas")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("canStack")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-37"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-63"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getminmax"}},[t._v("getMinMax")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpadding"}},[t._v("#")]),t._v(" getPadding")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getPadding")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Returns an object with padding on the edges")]),t._v(" "),e("h4",{attrs:{id:"returns-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-38"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-64"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpadding"}},[t._v("getPadding")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfordecimal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfordecimal"}},[t._v("#")]),t._v(" getPixelForDecimal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForDecimal")]),t._v("("),e("code",[t._v("decimal")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Utility for getting the pixel location of a percentage of scale\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("decimal")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-39"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-65"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfordecimal"}},[t._v("getPixelForDecimal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1298",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1298"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfortick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfortick"}},[t._v("#")]),t._v(" getPixelForTick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForTick")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the tick at the given index\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-40"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-66"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfortick"}},[t._v("getPixelForTick")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1305",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1305"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelforvalue"}},[t._v("#")]),t._v(" getPixelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForValue")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the given data point. Value can either be an index or a numerical value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-41"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-67"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelforvalue"}},[t._v("getPixelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1325",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1325"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("never")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-42"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-68"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-43"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-69"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getticks"}},[t._v("#")]),t._v(" getTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-44"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-70"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getticks"}},[t._v("getTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getuserbounds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getuserbounds"}},[t._v("#")]),t._v(" getUserBounds")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getUserBounds")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-45"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("maxDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-71"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getuserbounds"}},[t._v("getUserBounds")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1345",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1345"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvalueforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvalueforpixel"}},[t._v("#")]),t._v(" getValueForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Used to get the data value from a given pixel. This is the inverse of getPixelForValue\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-46"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-72"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getvalueforpixel"}},[t._v("getValueForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1333",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-47"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-73"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#hasvalue"}},[t._v("hasValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"init"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#init"}},[t._v("#")]),t._v(" init")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("init")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-48"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-74"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#init"}},[t._v("init")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isfullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isfullsize"}},[t._v("#")]),t._v(" isFullSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isFullSize")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-49"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-75"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#isfullsize"}},[t._v("isFullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1372",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1372"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ishorizontal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ishorizontal"}},[t._v("#")]),t._v(" isHorizontal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isHorizontal")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("returns true if the layout item is horizontal (ie. top or bottom)")]),t._v(" "),e("h4",{attrs:{id:"returns-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-50"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-76"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ishorizontal"}},[t._v("isHorizontal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:58"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"normalize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#normalize"}},[t._v("#")]),t._v(" normalize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("normalize")]),t._v("("),e("code",[t._v("values")]),t._v("): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("values")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-51"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L3428",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3428"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("raw")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("raw")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-52"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-77"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#parse"}},[t._v("parse")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdimensions"}},[t._v("#")]),t._v(" setDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-53"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-78"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#setdimensions"}},[t._v("setDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-82"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-82"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1354",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1354"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-54"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-79"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#tooltipposition"}},[t._v("tooltipPosition")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-83"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-83"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("width")]),t._v(", "),e("code",[t._v("height")]),t._v(", "),e("code",[t._v("margins?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Takes two parameters: width and height.")]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("margins?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-55"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-80"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#update"}},[t._v("update")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-84"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-84"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:64"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{451:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-timescale-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-timescale-o"}},[t._v("#")]),t._v(" Interface: TimeScale")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#timescaleoptions"}},[e("code",[t._v("TimeScaleOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("code",[t._v("O")]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TimeScale")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("never")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#animations"}},[t._v("$animations")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#active"}},[t._v("active")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#axis"}},[t._v("axis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1276",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1276"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bottom"}},[t._v("#")]),t._v(" bottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Bottom edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#bottom"}},[t._v("bottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#chart"}},[t._v("chart")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1266",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1266"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ctx"}},[t._v("ctx")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1265",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1265"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, and the item is horizontal, then push vertical boxes down")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fullsize"}},[t._v("fullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#height"}},[t._v("height")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#id"}},[t._v("id")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelrotation"}},[t._v("#")]),t._v(" labelRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#labelrotation"}},[t._v("labelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1277",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1277"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#left"}},[t._v("left")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:29"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"max"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#max"}},[t._v("#")]),t._v(" max")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("max")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#max"}},[t._v("max")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1279",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1279"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxheight"}},[t._v("#")]),t._v(" maxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxHeight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxheight"}},[t._v("maxHeight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1269",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1269"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#maxwidth"}},[t._v("maxWidth")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"min"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min"}},[t._v("#")]),t._v(" min")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("min")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#min"}},[t._v("min")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1278",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1278"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#options"}},[t._v("options")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingbottom"}},[t._v("#")]),t._v(" paddingBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingBottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingbottom"}},[t._v("paddingBottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1272",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1272"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingleft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingleft"}},[t._v("#")]),t._v(" paddingLeft")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingLeft")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingleft"}},[t._v("paddingLeft")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1273",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1273"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingright"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingright"}},[t._v("#")]),t._v(" paddingRight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingRight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingright"}},[t._v("paddingRight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1274"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingtop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingtop"}},[t._v("#")]),t._v(" paddingTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingTop")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#paddingtop"}},[t._v("paddingTop")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1271",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1271"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])])],1),t._v(" "),e("p",[t._v("The position of the item in the chart layout. Possible values are")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#position"}},[t._v("position")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"right"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#right"}},[t._v("#")]),t._v(" right")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("right")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Right edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#right"}},[t._v("right")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" ticks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ticks"}},[t._v("ticks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1280",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1280"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#top"}},[t._v("top")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:33"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#type"}},[t._v("type")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1264",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1264"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The weight used to sort the item. Higher weights are further away from the chart area")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#width"}},[t._v("width")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#x"}},[t._v("x")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#y"}},[t._v("y")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterbuildticks"}},[t._v("afterBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftercalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftercalculatelabelrotation"}},[t._v("#")]),t._v(" afterCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftercalculatelabelrotation"}},[t._v("afterCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterdatalimits"}},[t._v("afterDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1358"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfit"}},[t._v("#")]),t._v(" afterFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterfit"}},[t._v("afterFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1370",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1370"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftersetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftersetdimensions"}},[t._v("#")]),t._v(" afterSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#aftersetdimensions"}},[t._v("afterSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1355",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterticktolabelconversion"}},[t._v("#")]),t._v(" afterTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterticktolabelconversion"}},[t._v("afterTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#afterupdate"}},[t._v("afterUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1352",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1352"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforebuildticks"}},[t._v("beforeBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforecalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforecalculatelabelrotation"}},[t._v("#")]),t._v(" beforeCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforecalculatelabelrotation"}},[t._v("beforeCalculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1365",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1365"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-39"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforedatalimits"}},[t._v("beforeDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1356",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1356"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefit"}},[t._v("#")]),t._v(" beforeFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-40"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforefit"}},[t._v("beforeFit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1368",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1368"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the layout process starts")]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-41"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforesetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforesetdimensions"}},[t._v("#")]),t._v(" beforeSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-42"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforesetdimensions"}},[t._v("beforeSetDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1353",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1353"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeticktolabelconversion"}},[t._v("#")]),t._v(" beforeTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-43"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeticktolabelconversion"}},[t._v("beforeTickToLabelConversion")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1362",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1362"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-44"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#beforeupdate"}},[t._v("beforeUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildticks"}},[t._v("#")]),t._v(" buildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-45"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#buildticks"}},[t._v("buildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatelabelrotation"}},[t._v("#")]),t._v(" calculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-46"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#calculatelabelrotation"}},[t._v("calculateLabelRotation")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1366"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-47"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#configure"}},[t._v("configure")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1351",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1351"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"determinedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#determinedatalimits"}},[t._v("#")]),t._v(" determineDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("determineDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-48"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#determinedatalimits"}},[t._v("determineDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1357",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1357"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Draws the element")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-49"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:50"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawgrid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawgrid"}},[t._v("#")]),t._v(" drawGrid")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawGrid")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-50"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawgrid"}},[t._v("drawGrid")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1285",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawlabels"}},[t._v("#")]),t._v(" drawLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawLabels")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-51"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawlabels"}},[t._v("drawLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1284",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1284"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawtitle"}},[t._v("#")]),t._v(" drawTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawTitle")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-52"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#drawtitle"}},[t._v("drawTitle")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1283",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1283"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fit"}},[t._v("#")]),t._v(" fit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-53"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#fit"}},[t._v("fit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1369",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1369"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#format"}},[t._v("#")]),t._v(" format")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("format")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("format?")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("format?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3425",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3425"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"generateticklabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#generateticklabels"}},[t._v("#")]),t._v(" generateTickLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("generateTickLabels")]),t._v("("),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-54"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#generateticklabels"}},[t._v("generateTickLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasepixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasepixel"}},[t._v("#")]),t._v(" getBasePixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePixel")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the pixel for the minimum chart value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-55"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasepixel"}},[t._v("getBasePixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasevalue"}},[t._v("#")]),t._v(" getBaseValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBaseValue")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-56"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getbasevalue"}},[t._v("getBaseValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1335",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1335"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdatatimestamps"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdatatimestamps"}},[t._v("#")]),t._v(" getDataTimestamps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataTimestamps")]),t._v("(): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3426",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3426"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdecimalforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdecimalforpixel"}},[t._v("#")]),t._v(" getDecimalForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDecimalForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-57"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getdecimalforpixel"}},[t._v("getDecimalForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1291",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelforvalue"}},[t._v("#")]),t._v(" getLabelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Used to get the label to display in the tooltip for the given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-58"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelforvalue"}},[t._v("getLabelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1311",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1311"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelitems"}},[t._v("#")]),t._v(" getLabelItems")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelItems")]),t._v("("),e("code",[t._v("chartArea?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-59"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelitems"}},[t._v("getLabelItems")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1349",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1349"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabeltimestamps"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabeltimestamps"}},[t._v("#")]),t._v(" getLabelTimestamps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelTimestamps")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3427",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3427"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabels"}},[t._v("#")]),t._v(" getLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabels")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-60"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabels"}},[t._v("getLabels")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1348",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1348"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlinewidthforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlinewidthforvalue"}},[t._v("#")]),t._v(" getLineWidthForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLineWidthForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the grid line width at given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-61"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlinewidthforvalue"}},[t._v("getLineWidthForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1316",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1316"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmatchingvisiblemetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmatchingvisiblemetas"}},[t._v("#")]),t._v(" getMatchingVisibleMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMatchingVisibleMetas")]),t._v("("),e("code",[t._v("type?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-62"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getmatchingvisiblemetas"}},[t._v("getMatchingVisibleMetas")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("canStack")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-37"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-63"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getminmax"}},[t._v("getMinMax")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpadding"}},[t._v("#")]),t._v(" getPadding")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getPadding")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Returns an object with padding on the edges")]),t._v(" "),e("h4",{attrs:{id:"returns-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-38"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-64"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpadding"}},[t._v("getPadding")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfordecimal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfordecimal"}},[t._v("#")]),t._v(" getPixelForDecimal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForDecimal")]),t._v("("),e("code",[t._v("decimal")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Utility for getting the pixel location of a percentage of scale\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("decimal")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-39"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-65"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfordecimal"}},[t._v("getPixelForDecimal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1298",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1298"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfortick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfortick"}},[t._v("#")]),t._v(" getPixelForTick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForTick")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the tick at the given index\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-40"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-66"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelfortick"}},[t._v("getPixelForTick")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1305",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1305"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelforvalue"}},[t._v("#")]),t._v(" getPixelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForValue")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the given data point. Value can either be an index or a numerical value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-41"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-67"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelforvalue"}},[t._v("getPixelForValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1325",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1325"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("never")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-42"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-68"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-43"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-69"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getprops"}},[t._v("getProps")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getticks"}},[t._v("#")]),t._v(" getTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-44"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-70"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getticks"}},[t._v("getTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getuserbounds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getuserbounds"}},[t._v("#")]),t._v(" getUserBounds")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getUserBounds")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-45"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("maxDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-71"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getuserbounds"}},[t._v("getUserBounds")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1345",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1345"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvalueforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvalueforpixel"}},[t._v("#")]),t._v(" getValueForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Used to get the data value from a given pixel. This is the inverse of getPixelForValue\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-46"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-72"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#getvalueforpixel"}},[t._v("getValueForPixel")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1333",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-47"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-73"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#hasvalue"}},[t._v("hasValue")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"init"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#init"}},[t._v("#")]),t._v(" init")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("init")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-48"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-74"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#init"}},[t._v("init")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isfullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isfullsize"}},[t._v("#")]),t._v(" isFullSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isFullSize")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-49"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-75"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#isfullsize"}},[t._v("isFullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1372",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1372"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ishorizontal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ishorizontal"}},[t._v("#")]),t._v(" isHorizontal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isHorizontal")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("returns true if the layout item is horizontal (ie. top or bottom)")]),t._v(" "),e("h4",{attrs:{id:"returns-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-50"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-76"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#ishorizontal"}},[t._v("isHorizontal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:58"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"normalize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#normalize"}},[t._v("#")]),t._v(" normalize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("normalize")]),t._v("("),e("code",[t._v("values")]),t._v("): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("values")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-51"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L3428",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:3428"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("raw")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("raw")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-52"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-77"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#parse"}},[t._v("parse")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdimensions"}},[t._v("#")]),t._v(" setDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-53"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-78"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#setdimensions"}},[t._v("setDimensions")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-82"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-82"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1354",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1354"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-54"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-79"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#tooltipposition"}},[t._v("tooltipPosition")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-83"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-83"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("width")]),t._v(", "),e("code",[t._v("height")]),t._v(", "),e("code",[t._v("margins?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Takes two parameters: width and height.")]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("margins?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-55"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-80"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/Scale.html#update"}},[t._v("update")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-84"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-84"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:64"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/121.3dd0f8f5.js b/docs/master/assets/js/121.0b460d77.js similarity index 91% rename from docs/master/assets/js/121.3dd0f8f5.js rename to docs/master/assets/js/121.0b460d77.js index 7527939335..9f6fa1c51b 100644 --- a/docs/master/assets/js/121.3dd0f8f5.js +++ b/docs/master/assets/js/121.0b460d77.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[121],{455:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-titleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-titleoptions"}},[t._v("#")]),t._v(" Interface: TitleOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"align"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" align")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("align")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#align"}},[e("code",[t._v("Align")])])],1),t._v(" "),e("p",[t._v("Alignment of the title.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'center'")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2516",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2516"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("Color of text")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("See")])])]),t._v(" "),e("p",[t._v("Defaults.color")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2531",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2531"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"display"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#display"}},[t._v("#")]),t._v(" display")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Is the title shown?")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2521",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2521"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"font"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#font"}},[t._v("#")]),t._v(" font")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("font")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableChartContext.html"}},[e("code",[t._v("ScriptableChartContext")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2532",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2532"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Marks that this box should take the full width/height of the canvas (moving other boxes). If set to "),e("code",[t._v("false")]),t._v(", places the box above/beside the\nchart area")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2539",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2539"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"padding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" padding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("padding")]),t._v(": "),e("code",[t._v("number")]),t._v(" | { "),e("code",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("top")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")]),t._v(" "),e("p",[t._v("Adds padding above and below the title text if a single number is specified. It is also possible to change top and bottom padding separately.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2543",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2543"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"bottom"')]),t._v(" | "),e("code",[t._v('"right"')])]),t._v(" "),e("p",[t._v("Position of title")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'top'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2526",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2526"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"text"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#text"}},[t._v("#")]),t._v(" text")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("text")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("p",[t._v("Title text to display. If specified as an array, text is rendered on multiple lines.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2547",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2547"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[121],{452:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-titleoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-titleoptions"}},[t._v("#")]),t._v(" Interface: TitleOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"align"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" align")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("align")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#align"}},[e("code",[t._v("Align")])])],1),t._v(" "),e("p",[t._v("Alignment of the title.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'center'")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2516",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2516"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("p",[t._v("Color of text")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("See")])])]),t._v(" "),e("p",[t._v("Defaults.color")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2531",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2531"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"display"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#display"}},[t._v("#")]),t._v(" display")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("display")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Is the title shown?")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2521",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2521"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"font"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#font"}},[t._v("#")]),t._v(" font")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("font")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableChartContext.html"}},[e("code",[t._v("ScriptableChartContext")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2532",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2532"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Marks that this box should take the full width/height of the canvas (moving other boxes). If set to "),e("code",[t._v("false")]),t._v(", places the box above/beside the\nchart area")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2539",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2539"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"padding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" padding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("padding")]),t._v(": "),e("code",[t._v("number")]),t._v(" | { "),e("code",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("top")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")]),t._v(" "),e("p",[t._v("Adds padding above and below the title text if a single number is specified. It is also possible to change top and bottom padding separately.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2543",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2543"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"bottom"')]),t._v(" | "),e("code",[t._v('"right"')])]),t._v(" "),e("p",[t._v("Position of title")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'top'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2526",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2526"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"text"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#text"}},[t._v("#")]),t._v(" text")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("text")]),t._v(": "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("p",[t._v("Title text to display. If specified as an array, text is rendered on multiple lines.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2547",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2547"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/122.99ad623d.js b/docs/master/assets/js/122.c2b42ad6.js similarity index 98% rename from docs/master/assets/js/122.99ad623d.js rename to docs/master/assets/js/122.c2b42ad6.js index 7e2f7a794c..1d2d51d25d 100644 --- a/docs/master/assets/js/122.99ad623d.js +++ b/docs/master/assets/js/122.c2b42ad6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{576:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltip"}},[t._v("#")]),t._v(" Interface: Tooltip")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("Tooltip")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("p",[t._v("Default options used in the plugin")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#defaults"}},[t._v("defaults")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1122",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1122"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"events"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[t._v("#")]),t._v(" events")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("events")]),t._v(": keyof "),e("code",[t._v("HTMLElementEventMap")]),t._v("[]")]),t._v(" "),e("p",[t._v("The events option defines the browser events that the plugin should listen.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#events"}},[t._v("events")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L823",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:823"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#id"}},[t._v("id")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L817",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:817"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"positioners"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#positioners"}},[t._v("#")]),t._v(" positioners")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("positioners")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPositionerMap.html"}},[e("code",[t._v("TooltipPositionerMap")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2653",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2653"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterBuildTicks")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after scale has build its ticks. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterbuildticks"}},[t._v("afterBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L982",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:982"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDataLimits")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after scale data limits are calculated. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatalimits"}},[t._v("afterDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L966",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:966"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetdraw"}},[t._v("#")]),t._v(" afterDatasetDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets at the given "),e("code",[t._v("args.index")]),t._v(" have been drawn\n(datasets are drawn in the reverse order). Note that this hook will not be called\nif the datasets drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetdraw"}},[t._v("afterDatasetDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1064",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1064"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetupdate"}},[t._v("#")]),t._v(" afterDatasetUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets at the given "),e("code",[t._v("args.index")]),t._v(" has been updated. Note\nthat this hook will not be called if the datasets update has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetupdate"}},[t._v("afterDatasetUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L941",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:941"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetsdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetsdraw"}},[t._v("#")]),t._v(" afterDatasetsDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetsDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v(", "),e("code",[t._v("cancelable")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets have been drawn. Note that this hook\nwill not be called if the datasets drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetsdraw"}},[t._v("afterDatasetsDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1041",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1041"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetsupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetsupdate"}},[t._v("#")]),t._v(" afterDatasetsUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetsUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets have been updated. Note that this hook\nwill not be called if the datasets update has been previously cancelled.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("version 2.1.5")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetsupdate"}},[t._v("afterDatasetsUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L918",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:918"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdestroy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdestroy"}},[t._v("#")]),t._v(" afterDestroy")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDestroy")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called after the chart has been destroyed.")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdestroy"}},[t._v("afterDestroy")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1109",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1109"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdraw"}},[t._v("#")]),t._v(" afterDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" has been drawn. Note that this hook will not be called\nif the drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdraw"}},[t._v("afterDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1024",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1024"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterevent"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterevent"}},[t._v("#")]),t._v(" afterEvent")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterEvent")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("event")]),t._v(" has been consumed. Note that this hook\nwill not be called if the "),e("code",[t._v("event")]),t._v(" has been previously discarded.")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.changed?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Set to true if the plugin needs a render. Should only be changed to true, because this args object is passed through all plugins.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.event")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event object.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.inChartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event position is inside chartArea")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.replay")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("True if this event is replayed from "),e("code",[t._v("Chart.update")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterevent"}},[t._v("afterEvent")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1087",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1087"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterinit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterinit"}},[t._v("#")]),t._v(" afterInit")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterInit")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after "),e("code",[t._v("chart")]),t._v(" has been initialized and before the first update.")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterinit"}},[t._v("afterInit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L862",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:862"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterlayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterlayout"}},[t._v("#")]),t._v(" afterLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterLayout")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" has been laid out. Note that this hook will not\nbe called if the layout update has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterlayout"}},[t._v("afterLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L990",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:990"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterrender"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterrender"}},[t._v("#")]),t._v(" afterRender")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterRender")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" has been fully rendered (and animation completed). Note\nthat this hook will not be called if the rendering has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterrender"}},[t._v("afterRender")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1007",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1007"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftertooltipdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftertooltipdraw"}},[t._v("#")]),t._v(" afterTooltipDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterTooltipDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after drawing the "),e("code",[t._v("tooltip")]),t._v(". Note that this hook will not\nbe called if the tooltip drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.tooltip")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The tooltip.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#aftertooltipdraw"}},[t._v("afterTooltipDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2705",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2705"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after "),e("code",[t._v("chart")]),t._v(" has been updated and before rendering. Note that this\nhook will not be called if the chart update has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterupdate"}},[t._v("afterUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L881",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:881"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeBuildTicks")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before scale builds its ticks. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforebuildticks"}},[t._v("beforeBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L974",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:974"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDataLimits")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before scale data limits are calculated. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatalimits"}},[t._v("beforeDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L958",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:958"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetdraw"}},[t._v("#")]),t._v(" beforeDatasetDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing the "),e("code",[t._v("chart")]),t._v(" dataset at the given "),e("code",[t._v("args.index")]),t._v(" (datasets\nare drawn in the reverse order). If any plugin returns "),e("code",[t._v("false")]),t._v(", the datasets drawing\nis cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart datasets drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetdraw"}},[t._v("beforeDatasetDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1053",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1053"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetupdate"}},[t._v("#")]),t._v(" beforeDatasetUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before updating the "),e("code",[t._v("chart")]),t._v(" dataset at the given "),e("code",[t._v("args.index")]),t._v(". If any plugin\nreturns "),e("code",[t._v("false")]),t._v(", the datasets update is cancelled until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart datasets drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetupdate"}},[t._v("beforeDatasetUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L930",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:930"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetsdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetsdraw"}},[t._v("#")]),t._v(" beforeDatasetsDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetsDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing the "),e("code",[t._v("chart")]),t._v(" datasets. If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe datasets drawing is cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart datasets drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetsdraw"}},[t._v("beforeDatasetsDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1033",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1033"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetsupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetsupdate"}},[t._v("#")]),t._v(" beforeDatasetsUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetsUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before updating the "),e("code",[t._v("chart")]),t._v(" datasets. If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe datasets update is cancelled until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("version 2.1.5")]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("false to cancel the datasets update.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetsupdate"}},[t._v("beforeDatasetsUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L908",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:908"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedestroy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedestroy"}},[t._v("#")]),t._v(" beforeDestroy")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDestroy")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the chart is being destroyed.")]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedestroy"}},[t._v("beforeDestroy")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1102",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1102"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedraw"}},[t._v("#")]),t._v(" beforeDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing "),e("code",[t._v("chart")]),t._v(" at every animation frame. If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe frame drawing is cancelled untilanother "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedraw"}},[t._v("beforeDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1016",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1016"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeelementsupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeelementsupdate"}},[t._v("#")]),t._v(" beforeElementsUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeElementsUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called during the update process, before any chart elements have been created.\nThis can be used for data decimation by changing the data array inside a dataset.")]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeelementsupdate"}},[t._v("beforeElementsUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L889",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:889"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeevent"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeevent"}},[t._v("#")]),t._v(" beforeEvent")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeEvent")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before processing the specified "),e("code",[t._v("event")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe event will be discarded.")]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.event")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event object.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.inChartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event position is inside chartArea")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.replay")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("True if this event is replayed from "),e("code",[t._v("Chart.update")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeevent"}},[t._v("beforeEvent")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1075",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1075"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeinit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeinit"}},[t._v("#")]),t._v(" beforeInit")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeInit")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before initializing "),e("code",[t._v("chart")]),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeinit"}},[t._v("beforeInit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L855",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:855"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before laying out "),e("code",[t._v("chart")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe layout update is cancelled until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-26"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart layout.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L950",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:950"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforerender"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforerender"}},[t._v("#")]),t._v(" beforeRender")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeRender")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before rendering "),e("code",[t._v("chart")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe rendering is cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-27"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart rendering.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforerender"}},[t._v("beforeRender")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L999",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:999"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforetooltipdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforetooltipdraw"}},[t._v("#")]),t._v(" beforeTooltipDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeTooltipDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing the "),e("code",[t._v("tooltip")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe tooltip drawing is cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-28"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.tooltip")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The tooltip.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart tooltip drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforetooltipdraw"}},[t._v("beforeTooltipDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2696",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2696"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before updating "),e("code",[t._v("chart")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(", the update\nis cancelled (and thus subsequent render(s)) until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-29"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart update.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeupdate"}},[t._v("beforeUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L872",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:872"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"install"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install"}},[t._v("#")]),t._v(" install")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("install")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-30"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#install"}},[t._v("install")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L832",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:832"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("reset")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called during chart reset")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("version 3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-31"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#reset"}},[t._v("reset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L897",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:897"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resize"}},[t._v("#")]),t._v(" resize")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("resize")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the chart as been resized.")]),t._v(" "),e("h4",{attrs:{id:"parameters-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-32"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.size")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The new canvas display size (eq. canvas.style width & height).")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.size.height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.size.width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#resize"}},[t._v("resize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1095",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1095"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"start"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start"}},[t._v("#")]),t._v(" start")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("start")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called when a plugin is starting. This happens when chart is created or plugin is enabled.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-33"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#start"}},[t._v("start")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L840",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:840"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("stop")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-34"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#stop"}},[t._v("stop")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L848",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:848"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"uninstall"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#uninstall"}},[t._v("#")]),t._v(" uninstall")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("uninstall")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-35"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#uninstall"}},[t._v("uninstall")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1117",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1117"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{453:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltip"}},[t._v("#")]),t._v(" Interface: Tooltip")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[e("code",[t._v("Plugin")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("Tooltip")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("p",[t._v("Default options used in the plugin")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#defaults"}},[t._v("defaults")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1122",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1122"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"events"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[t._v("#")]),t._v(" events")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("events")]),t._v(": keyof "),e("code",[t._v("HTMLElementEventMap")]),t._v("[]")]),t._v(" "),e("p",[t._v("The events option defines the browser events that the plugin should listen.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#events"}},[t._v("events")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L823",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:823"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#id"}},[t._v("id")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L817",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:817"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"positioners"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#positioners"}},[t._v("#")]),t._v(" positioners")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("positioners")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipPositionerMap.html"}},[e("code",[t._v("TooltipPositionerMap")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2653",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2653"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterBuildTicks")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after scale has build its ticks. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterbuildticks"}},[t._v("afterBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L982",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:982"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDataLimits")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after scale data limits are calculated. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatalimits"}},[t._v("afterDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L966",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:966"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetdraw"}},[t._v("#")]),t._v(" afterDatasetDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets at the given "),e("code",[t._v("args.index")]),t._v(" have been drawn\n(datasets are drawn in the reverse order). Note that this hook will not be called\nif the datasets drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetdraw"}},[t._v("afterDatasetDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1064",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1064"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetupdate"}},[t._v("#")]),t._v(" afterDatasetUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets at the given "),e("code",[t._v("args.index")]),t._v(" has been updated. Note\nthat this hook will not be called if the datasets update has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetupdate"}},[t._v("afterDatasetUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L941",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:941"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetsdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetsdraw"}},[t._v("#")]),t._v(" afterDatasetsDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetsDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v(", "),e("code",[t._v("cancelable")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets have been drawn. Note that this hook\nwill not be called if the datasets drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetsdraw"}},[t._v("afterDatasetsDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1041",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1041"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatasetsupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatasetsupdate"}},[t._v("#")]),t._v(" afterDatasetsUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDatasetsUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" datasets have been updated. Note that this hook\nwill not be called if the datasets update has been previously cancelled.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("version 2.1.5")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdatasetsupdate"}},[t._v("afterDatasetsUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L918",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:918"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdestroy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdestroy"}},[t._v("#")]),t._v(" afterDestroy")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDestroy")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called after the chart has been destroyed.")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdestroy"}},[t._v("afterDestroy")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1109",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1109"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdraw"}},[t._v("#")]),t._v(" afterDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" has been drawn. Note that this hook will not be called\nif the drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterdraw"}},[t._v("afterDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1024",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1024"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterevent"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterevent"}},[t._v("#")]),t._v(" afterEvent")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterEvent")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("event")]),t._v(" has been consumed. Note that this hook\nwill not be called if the "),e("code",[t._v("event")]),t._v(" has been previously discarded.")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.changed?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Set to true if the plugin needs a render. Should only be changed to true, because this args object is passed through all plugins.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.event")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event object.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.inChartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event position is inside chartArea")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.replay")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("True if this event is replayed from "),e("code",[t._v("Chart.update")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterevent"}},[t._v("afterEvent")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1087",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1087"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterinit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterinit"}},[t._v("#")]),t._v(" afterInit")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterInit")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after "),e("code",[t._v("chart")]),t._v(" has been initialized and before the first update.")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterinit"}},[t._v("afterInit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L862",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:862"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterlayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterlayout"}},[t._v("#")]),t._v(" afterLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterLayout")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" has been laid out. Note that this hook will not\nbe called if the layout update has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterlayout"}},[t._v("afterLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L990",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:990"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterrender"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterrender"}},[t._v("#")]),t._v(" afterRender")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterRender")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the "),e("code",[t._v("chart")]),t._v(" has been fully rendered (and animation completed). Note\nthat this hook will not be called if the rendering has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterrender"}},[t._v("afterRender")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1007",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1007"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftertooltipdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftertooltipdraw"}},[t._v("#")]),t._v(" afterTooltipDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterTooltipDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after drawing the "),e("code",[t._v("tooltip")]),t._v(". Note that this hook will not\nbe called if the tooltip drawing has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.tooltip")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The tooltip.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#aftertooltipdraw"}},[t._v("afterTooltipDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2705",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2705"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("afterUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after "),e("code",[t._v("chart")]),t._v(" has been updated and before rendering. Note that this\nhook will not be called if the chart update has been previously cancelled.")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#afterupdate"}},[t._v("afterUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L881",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:881"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeBuildTicks")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before scale builds its ticks. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforebuildticks"}},[t._v("beforeBuildTicks")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L974",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:974"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDataLimits")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before scale data limits are calculated. This hook is called separately for each scale in the chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The scale.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatalimits"}},[t._v("beforeDataLimits")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L958",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:958"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetdraw"}},[t._v("#")]),t._v(" beforeDatasetDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing the "),e("code",[t._v("chart")]),t._v(" dataset at the given "),e("code",[t._v("args.index")]),t._v(" (datasets\nare drawn in the reverse order). If any plugin returns "),e("code",[t._v("false")]),t._v(", the datasets drawing\nis cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart datasets drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetdraw"}},[t._v("beforeDatasetDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1053",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1053"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetupdate"}},[t._v("#")]),t._v(" beforeDatasetUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before updating the "),e("code",[t._v("chart")]),t._v(" dataset at the given "),e("code",[t._v("args.index")]),t._v(". If any plugin\nreturns "),e("code",[t._v("false")]),t._v(", the datasets update is cancelled until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset index.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The dataset metadata.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart datasets drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetupdate"}},[t._v("beforeDatasetUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L930",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:930"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetsdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetsdraw"}},[t._v("#")]),t._v(" beforeDatasetsDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetsDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing the "),e("code",[t._v("chart")]),t._v(" datasets. If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe datasets drawing is cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart datasets drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetsdraw"}},[t._v("beforeDatasetsDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1033",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1033"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatasetsupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatasetsupdate"}},[t._v("#")]),t._v(" beforeDatasetsUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDatasetsUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before updating the "),e("code",[t._v("chart")]),t._v(" datasets. If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe datasets update is cancelled until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("version 2.1.5")]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("false to cancel the datasets update.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedatasetsupdate"}},[t._v("beforeDatasetsUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L908",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:908"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedestroy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedestroy"}},[t._v("#")]),t._v(" beforeDestroy")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDestroy")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the chart is being destroyed.")]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedestroy"}},[t._v("beforeDestroy")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1102",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1102"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedraw"}},[t._v("#")]),t._v(" beforeDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing "),e("code",[t._v("chart")]),t._v(" at every animation frame. If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe frame drawing is cancelled untilanother "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-25"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforedraw"}},[t._v("beforeDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1016",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1016"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeelementsupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeelementsupdate"}},[t._v("#")]),t._v(" beforeElementsUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeElementsUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called during the update process, before any chart elements have been created.\nThis can be used for data decimation by changing the data array inside a dataset.")]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-26"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeelementsupdate"}},[t._v("beforeElementsUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L889",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:889"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeevent"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeevent"}},[t._v("#")]),t._v(" beforeEvent")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeEvent")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before processing the specified "),e("code",[t._v("event")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe event will be discarded.")]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.event")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event object.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.inChartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The event position is inside chartArea")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.replay")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("True if this event is replayed from "),e("code",[t._v("Chart.update")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-27"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeevent"}},[t._v("beforeEvent")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1075",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1075"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeinit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeinit"}},[t._v("#")]),t._v(" beforeInit")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeInit")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before initializing "),e("code",[t._v("chart")]),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-28"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeinit"}},[t._v("beforeInit")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L855",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:855"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before laying out "),e("code",[t._v("chart")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe layout update is cancelled until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-26"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart layout.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-29"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L950",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:950"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforerender"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforerender"}},[t._v("#")]),t._v(" beforeRender")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeRender")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before rendering "),e("code",[t._v("chart")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe rendering is cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-27"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart rendering.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-30"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforerender"}},[t._v("beforeRender")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L999",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:999"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforetooltipdraw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforetooltipdraw"}},[t._v("#")]),t._v(" beforeTooltipDraw")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeTooltipDraw")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before drawing the "),e("code",[t._v("tooltip")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(",\nthe tooltip drawing is cancelled until another "),e("code",[t._v("render")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-28"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.tooltip")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The tooltip.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart tooltip drawing.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-31"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforetooltipdraw"}},[t._v("beforeTooltipDraw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2696",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2696"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeUpdate")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called before updating "),e("code",[t._v("chart")]),t._v(". If any plugin returns "),e("code",[t._v("false")]),t._v(", the update\nis cancelled (and thus subsequent render(s)) until another "),e("code",[t._v("update")]),t._v(" is triggered.")]),t._v(" "),e("h4",{attrs:{id:"parameters-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-29"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.cancelable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The update mode")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("code",[t._v("false")]),t._v(" to cancel the chart update.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-32"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#beforeupdate"}},[t._v("beforeUpdate")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L872",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:872"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"install"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#install"}},[t._v("#")]),t._v(" install")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("install")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called when plugin is installed for this chart instance. This hook is also invoked for disabled plugins (options === false).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-30"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-33"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#install"}},[t._v("install")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L832",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:832"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("reset")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called during chart reset")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("version 3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-31"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-34"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#reset"}},[t._v("reset")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L897",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:897"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resize"}},[t._v("#")]),t._v(" resize")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("resize")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called after the chart as been resized.")]),t._v(" "),e("h4",{attrs:{id:"parameters-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-32"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.size")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The new canvas display size (eq. canvas.style width & height).")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.size.height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.size.width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("-")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-35"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#resize"}},[t._v("resize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1095",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1095"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"start"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start"}},[t._v("#")]),t._v(" start")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("start")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called when a plugin is starting. This happens when chart is created or plugin is enabled.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-33"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-36"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#start"}},[t._v("start")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L840",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:840"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("stop")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Desc")])])]),t._v(" "),e("p",[t._v("Called when a plugin stopping. This happens when chart is destroyed or plugin is disabled.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-34"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-37"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#stop"}},[t._v("stop")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L848",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:848"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"uninstall"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#uninstall"}},[t._v("#")]),t._v(" uninstall")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("uninstall")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("args")]),t._v(", "),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called after chart is destroyed on all plugins that were installed for that chart. This hook is also invoked for disabled plugins (options === false).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Since")])])]),t._v(" "),e("p",[t._v("3.0.0")]),t._v(" "),e("h4",{attrs:{id:"parameters-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-35"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart instance.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("EmptyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The call arguments.")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The plugin options.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-38"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html"}},[t._v("Plugin")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Plugin.html#uninstall"}},[t._v("uninstall")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1117",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1117"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/123.fc18ae2a.js b/docs/master/assets/js/123.d5ad1d92.js similarity index 96% rename from docs/master/assets/js/123.fc18ae2a.js rename to docs/master/assets/js/123.d5ad1d92.js index 7d841ab455..7daa94153e 100644 --- a/docs/master/assets/js/123.fc18ae2a.js +++ b/docs/master/assets/js/123.d5ad1d92.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{454:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipcallbacks-ttype-model-item"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipcallbacks-ttype-model-item"}},[t._v("#")]),t._v(" Interface: TooltipCallbacks")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbody"}},[t._v("#")]),t._v(" afterBody")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBody")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2668",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2668"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfooter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfooter"}},[t._v("#")]),t._v(" afterFooter")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFooter")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2680",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2680"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterlabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterlabel"}},[t._v("#")]),t._v(" afterLabel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterLabel")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2672",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2672"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftertitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftertitle"}},[t._v("#")]),t._v(" afterTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTitle")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2665",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2665"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebody"}},[t._v("#")]),t._v(" beforeBody")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBody")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2667",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2667"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefooter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefooter"}},[t._v("#")]),t._v(" beforeFooter")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFooter")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2678",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2678"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelabel"}},[t._v("#")]),t._v(" beforeLabel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeLabel")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2670",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2670"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforetitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforetitle"}},[t._v("#")]),t._v(" beforeTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTitle")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2663",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2663"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footer"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footer"}},[t._v("#")]),t._v(" footer")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("footer")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2679",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2679"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("label")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2671",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2671"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelcolor"}},[t._v("#")]),t._v(" labelColor")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("labelColor")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[e("code",[t._v("TooltipLabelStyle")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[e("code",[t._v("TooltipLabelStyle")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2674",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2674"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelpointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelpointstyle"}},[t._v("#")]),t._v(" labelPointStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("labelPointStyle")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("void")]),t._v(" | { "),e("code",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])]),t._v(" ; "),e("code",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")]),t._v(" | { "),e("code",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])]),t._v(" ; "),e("code",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2676",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2676"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labeltextcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labeltextcolor"}},[t._v("#")]),t._v(" labelTextColor")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("labelTextColor")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2675",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2675"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"title"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" title")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("title")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2664",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2664"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{454:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipcallbacks-ttype-model-item"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipcallbacks-ttype-model-item"}},[t._v("#")]),t._v(" Interface: TooltipCallbacks")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbody"}},[t._v("#")]),t._v(" afterBody")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBody")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2668",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2668"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfooter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfooter"}},[t._v("#")]),t._v(" afterFooter")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFooter")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2680",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2680"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterlabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterlabel"}},[t._v("#")]),t._v(" afterLabel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterLabel")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2672",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2672"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftertitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftertitle"}},[t._v("#")]),t._v(" afterTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTitle")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2665",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2665"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebody"}},[t._v("#")]),t._v(" beforeBody")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBody")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2667",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2667"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefooter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefooter"}},[t._v("#")]),t._v(" beforeFooter")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFooter")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2678",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2678"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelabel"}},[t._v("#")]),t._v(" beforeLabel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeLabel")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2670",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2670"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforetitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforetitle"}},[t._v("#")]),t._v(" beforeTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTitle")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2663",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2663"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footer"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footer"}},[t._v("#")]),t._v(" footer")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("footer")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2679",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2679"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("label")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2671",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2671"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelcolor"}},[t._v("#")]),t._v(" labelColor")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("labelColor")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[e("code",[t._v("TooltipLabelStyle")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[e("code",[t._v("TooltipLabelStyle")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2674",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2674"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelpointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelpointstyle"}},[t._v("#")]),t._v(" labelPointStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("labelPointStyle")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("void")]),t._v(" | { "),e("code",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])]),t._v(" ; "),e("code",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")]),t._v(" | { "),e("code",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])]),t._v(" ; "),e("code",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2676",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2676"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labeltextcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labeltextcolor"}},[t._v("#")]),t._v(" labelTextColor")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("labelTextColor")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItem")]),t._v("): "),e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItem")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2675",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2675"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"title"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" title")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("title")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("tooltipItems")]),t._v("): "),e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Model")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("tooltipItems")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Item")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("void")]),t._v(" | "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2664",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2664"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/124.fc4310bf.js b/docs/master/assets/js/124.78a1753d.js similarity index 91% rename from docs/master/assets/js/124.fc4310bf.js rename to docs/master/assets/js/124.78a1753d.js index 810cc95db6..a3ee0ceff9 100644 --- a/docs/master/assets/js/124.fc4310bf.js +++ b/docs/master/assets/js/124.78a1753d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[124],{456:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipitem-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipitem-ttype"}},[t._v("#")]),t._v(" Interface: TooltipItem")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("p",[t._v("The chart the tooltip is being shown on")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2897",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2897"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataindex"}},[t._v("#")]),t._v(" dataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Index of this data item in the dataset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2932",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2932"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataset")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>>>")],1),t._v(" "),e("p",[t._v("The dataset the item comes from")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2922",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2922"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Index of the dataset the item comes from")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2927",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2927"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"element"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#element"}},[t._v("#")]),t._v(" element")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("element")]),t._v(": "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("p",[t._v("The chart element (point, arc, bar, etc.) for this tooltip item")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2937",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2937"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"formattedvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#formattedvalue"}},[t._v("#")]),t._v(" formattedValue")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("formattedValue")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Formatted value for the tooltip")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2917",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2917"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Label for the tooltip")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2902",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2902"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsed"}},[t._v("#")]),t._v(" parsed")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsed")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Parsed data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2907",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2907"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"raw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#raw"}},[t._v("#")]),t._v(" raw")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("raw")]),t._v(": "),e("code",[t._v("unknown")])]),t._v(" "),e("p",[t._v("Raw data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2912",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2912"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[124],{455:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipitem-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipitem-ttype"}},[t._v("#")]),t._v(" Interface: TooltipItem")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("p",[t._v("The chart the tooltip is being shown on")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2897",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2897"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataindex"}},[t._v("#")]),t._v(" dataIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Index of this data item in the dataset")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2932",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2932"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"dataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataset")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>>>")],1),t._v(" "),e("p",[t._v("The dataset the item comes from")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2922",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2922"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Index of the dataset the item comes from")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2927",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2927"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"element"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#element"}},[t._v("#")]),t._v(" element")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("element")]),t._v(": "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("p",[t._v("The chart element (point, arc, bar, etc.) for this tooltip item")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2937",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2937"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"formattedvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#formattedvalue"}},[t._v("#")]),t._v(" formattedValue")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("formattedValue")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Formatted value for the tooltip")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2917",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2917"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Label for the tooltip")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2902",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2902"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsed"}},[t._v("#")]),t._v(" parsed")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsed")]),t._v(": "),e("code",[t._v("UnionToIntersection")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Parsed data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2907",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2907"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"raw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#raw"}},[t._v("#")]),t._v(" raw")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("raw")]),t._v(": "),e("code",[t._v("unknown")])]),t._v(" "),e("p",[t._v("Raw data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2912",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2912"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/125.d54228d1.js b/docs/master/assets/js/125.b57d36fc.js similarity index 90% rename from docs/master/assets/js/125.d54228d1.js rename to docs/master/assets/js/125.b57d36fc.js index 5b174108e6..655f6d2732 100644 --- a/docs/master/assets/js/125.d54228d1.js +++ b/docs/master/assets/js/125.b57d36fc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[125],{460:function(r,e,t){"use strict";t.r(e);var a=t(3),s=Object(a.a)({},(function(){var r=this,e=r._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltiplabelstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltiplabelstyle"}},[r._v("#")]),r._v(" Interface: TooltipLabelStyle")]),r._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[r._v("#")]),r._v(" backgroundColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("backgroundColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2554",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2554"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[r._v("#")]),r._v(" borderColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2553",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2553"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[r._v("#")]),r._v(" borderDash")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderDash")]),r._v(": ["),e("code",[r._v("number")]),r._v(", "),e("code",[r._v("number")]),r._v("]")]),r._v(" "),e("p",[r._v("Border dash")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2566",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2566"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[r._v("#")]),r._v(" borderDashOffset")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderDashOffset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("p",[r._v("Border dash offset")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2572",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2572"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[r._v("#")]),r._v(" borderRadius")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderRadius")]),r._v(": "),e("code",[r._v("number")]),r._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[r._v("BorderRadius")])])],1),r._v(" "),e("p",[r._v("borderRadius")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2578",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2578"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[r._v("#")]),r._v(" borderWidth")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderWidth")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("p",[r._v("Width of border line")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2560",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2560"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[125],{457:function(r,e,t){"use strict";t.r(e);var a=t(3),s=Object(a.a)({},(function(){var r=this,e=r._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltiplabelstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltiplabelstyle"}},[r._v("#")]),r._v(" Interface: TooltipLabelStyle")]),r._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[r._v("#")]),r._v(" backgroundColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("backgroundColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2554",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2554"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[r._v("#")]),r._v(" borderColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2553",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2553"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[r._v("#")]),r._v(" borderDash")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderDash")]),r._v(": ["),e("code",[r._v("number")]),r._v(", "),e("code",[r._v("number")]),r._v("]")]),r._v(" "),e("p",[r._v("Border dash")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2566",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2566"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[r._v("#")]),r._v(" borderDashOffset")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderDashOffset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("p",[r._v("Border dash offset")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2572",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2572"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[r._v("#")]),r._v(" borderRadius")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderRadius")]),r._v(": "),e("code",[r._v("number")]),r._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[r._v("BorderRadius")])])],1),r._v(" "),e("p",[r._v("borderRadius")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2578",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2578"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[r._v("#")]),r._v(" borderWidth")]),r._v(" "),e("p",[r._v("• "),e("code",[r._v("Optional")]),r._v(" "),e("strong",[r._v("borderWidth")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("p",[r._v("Width of border line")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Since")])])]),r._v(" "),e("p",[r._v("3.1.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2560",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2560"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/126.80f7d121.js b/docs/master/assets/js/126.335cb8d1.js similarity index 93% rename from docs/master/assets/js/126.80f7d121.js rename to docs/master/assets/js/126.335cb8d1.js index 15e3f64faf..8aad522abd 100644 --- a/docs/master/assets/js/126.80f7d121.js +++ b/docs/master/assets/js/126.335cb8d1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[126],{458:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipmodel-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipmodel-ttype"}},[t._v("#")]),t._v(" Interface: TooltipModel")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipOptions.html"}},[e("code",[t._v("TooltipOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TooltipModel")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("string")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterbody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbody"}},[t._v("#")]),t._v(" afterBody")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("afterBody")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2609",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2609"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebody"}},[t._v("#")]),t._v(" beforeBody")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("beforeBody")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2607",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2607"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"body"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#body"}},[t._v("#")]),t._v(" body")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("body")]),t._v(": { "),e("code",[t._v("after")]),t._v(": "),e("code",[t._v("string")]),t._v("[] ; "),e("code",[t._v("before")]),t._v(": "),e("code",[t._v("string")]),t._v("[] ; "),e("code",[t._v("lines")]),t._v(": "),e("code",[t._v("string")]),t._v("[] }[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"caretx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#caretx"}},[t._v("#")]),t._v(" caretX")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretX")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2596",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2596"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"carety"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#carety"}},[t._v("#")]),t._v(" caretY")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretY")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2597",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2597"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>, "),e("code",[t._v("unknown")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2581",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2581"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datapoints"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datapoints"}},[t._v("#")]),t._v(" dataPoints")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataPoints")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2584",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2584"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footer"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footer"}},[t._v("#")]),t._v(" footer")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footer")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2594",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2594"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelcolors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelcolors"}},[t._v("#")]),t._v(" labelColors")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelColors")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[e("code",[t._v("TooltipLabelStyle")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2620",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2620"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelpointstyles"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelpointstyles"}},[t._v("#")]),t._v(" labelPointStyles")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelPointStyles")]),t._v(": { "),e("code",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])]),t._v(" ; "),e("code",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" }[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2622",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2622"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labeltextcolors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labeltextcolors"}},[t._v("#")]),t._v(" labelTextColors")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelTextColors")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2621",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2621"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"opacity"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#opacity"}},[t._v("#")]),t._v(" opacity")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("opacity")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2625",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2625"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipOptions.html"}},[e("code",[t._v("TooltipOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2628",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2628"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"title"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" title")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("title")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2613",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2613"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"overrides-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-2"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xalign"}},[t._v("#")]),t._v(" xAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("xAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipxalignment"}},[e("code",[t._v("TooltipXAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2587",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2587"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"overrides-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-3"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2592",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2592"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yalign"}},[t._v("#")]),t._v(" yAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("yAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipyalignment"}},[e("code",[t._v("TooltipYAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2588",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2588"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"getactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getactiveelements"}},[t._v("#")]),t._v(" getActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getActiveElements")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2630",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2630"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setactiveelements"}},[t._v("#")]),t._v(" setActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setActiveElements")]),t._v("("),e("code",[t._v("active")]),t._v(", "),e("code",[t._v("eventPosition")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[e("code",[t._v("ActiveDataPoint")])]),t._v("[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("eventPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2631",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2631"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[126],{459:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipmodel-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipmodel-ttype"}},[t._v("#")]),t._v(" Interface: TooltipModel")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipOptions.html"}},[e("code",[t._v("TooltipOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TooltipModel")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("string")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterbody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbody"}},[t._v("#")]),t._v(" afterBody")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("afterBody")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2609",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2609"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebody"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebody"}},[t._v("#")]),t._v(" beforeBody")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("beforeBody")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2607",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2607"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"body"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#body"}},[t._v("#")]),t._v(" body")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("body")]),t._v(": { "),e("code",[t._v("after")]),t._v(": "),e("code",[t._v("string")]),t._v("[] ; "),e("code",[t._v("before")]),t._v(": "),e("code",[t._v("string")]),t._v("[] ; "),e("code",[t._v("lines")]),t._v(": "),e("code",[t._v("string")]),t._v("[] }[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"caretx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#caretx"}},[t._v("#")]),t._v(" caretX")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretX")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2596",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2596"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"carety"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#carety"}},[t._v("#")]),t._v(" caretY")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretY")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2597",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2597"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>, "),e("code",[t._v("unknown")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2581",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2581"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"datapoints"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datapoints"}},[t._v("#")]),t._v(" dataPoints")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("dataPoints")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2584",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2584"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footer"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footer"}},[t._v("#")]),t._v(" footer")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footer")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2594",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2594"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelcolors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelcolors"}},[t._v("#")]),t._v(" labelColors")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelColors")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipLabelStyle.html"}},[e("code",[t._v("TooltipLabelStyle")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2620",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2620"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelpointstyles"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelpointstyles"}},[t._v("#")]),t._v(" labelPointStyles")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelPointStyles")]),t._v(": { "),e("code",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])]),t._v(" ; "),e("code",[t._v("rotation")]),t._v(": "),e("code",[t._v("number")]),t._v(" }[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2622",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2622"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labeltextcolors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labeltextcolors"}},[t._v("#")]),t._v(" labelTextColors")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelTextColors")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2621",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2621"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"opacity"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#opacity"}},[t._v("#")]),t._v(" opacity")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("opacity")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2625",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2625"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipOptions.html"}},[e("code",[t._v("TooltipOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2628",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2628"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"title"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" title")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("title")]),t._v(": "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2613",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2613"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"overrides-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-2"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xalign"}},[t._v("#")]),t._v(" xAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("xAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipxalignment"}},[e("code",[t._v("TooltipXAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2587",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2587"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"overrides-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-3"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2592",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2592"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yalign"}},[t._v("#")]),t._v(" yAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("yAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipyalignment"}},[e("code",[t._v("TooltipYAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2588",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2588"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"getactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getactiveelements"}},[t._v("#")]),t._v(" getActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getActiveElements")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2630",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2630"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setactiveelements"}},[t._v("#")]),t._v(" setActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setActiveElements")]),t._v("("),e("code",[t._v("active")]),t._v(", "),e("code",[t._v("eventPosition")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[e("code",[t._v("ActiveDataPoint")])]),t._v("[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("eventPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2631",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2631"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/127.984321dd.js b/docs/master/assets/js/127.ce962e77.js similarity index 94% rename from docs/master/assets/js/127.984321dd.js rename to docs/master/assets/js/127.ce962e77.js index dcbb8da76a..115dd976a5 100644 --- a/docs/master/assets/js/127.984321dd.js +++ b/docs/master/assets/js/127.ce962e77.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{457:function(t,e,r){"use strict";r.r(e);var a=r(3),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipoptions-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipoptions-ttype"}},[t._v("#")]),t._v(" Interface: TooltipOptions")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[e("code",[t._v("CoreInteractionOptions")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TooltipOptions")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2888",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2888"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animations")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2889",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2889"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#interactionaxis"}},[e("code",[t._v("InteractionAxis")])])],1),t._v(" "),e("p",[t._v("Defines which directions are used in calculating distances. Defaults to 'x' for 'index' mode and 'xy' in dataset and 'nearest' modes.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#axis"}},[t._v("axis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1579",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1579"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Background color of the tooltip.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'rgba(0, 0, 0, 0.8)'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2746",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2746"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodyalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodyalign"}},[t._v("#")]),t._v(" bodyAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodyAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#textalign"}},[e("code",[t._v("TextAlign")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Horizontal alignment of the body text lines.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'left'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2796",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2796"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodycolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodycolor"}},[t._v("#")]),t._v(" bodyColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodyColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of body")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2786",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2786"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodyfont"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodyfont"}},[t._v("#")]),t._v(" bodyFont")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodyFont")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("See Fonts.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2791",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2791"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodyspacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodyspacing"}},[t._v("#")]),t._v(" bodySpacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodySpacing")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Spacing to add to top and bottom of each tooltip item.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2781",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2781"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of the border.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'rgba(0, 0, 0, 0)'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2871",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2871"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Size of the border.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2876",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2876"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxheight"}},[t._v("#")]),t._v(" boxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("boxHeight")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Height of the color box if displayColors is true.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("bodyFont.size")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2861",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2861"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxpadding"}},[t._v("#")]),t._v(" boxPadding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("boxPadding")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Padding between the color box and the text.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("1")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2751",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2751"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxwidth"}},[t._v("#")]),t._v(" boxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("boxWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Width of the color box if displayColors is true.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("bodyFont.size")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2856",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2856"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"callbacks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#callbacks"}},[t._v("#")]),t._v(" callbacks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("callbacks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipCallbacks.html"}},[e("code",[t._v("TooltipCallbacks")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2890",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2890"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"caretpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#caretpadding"}},[t._v("#")]),t._v(" caretPadding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretPadding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Extra distance to move the end of the tooltip arrow away from the tooltip point.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2831",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2831"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"caretsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#caretsize"}},[t._v("#")]),t._v(" caretSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretSize")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Size, in px, of the tooltip arrow.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("5")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2836",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2836"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"cornerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cornerradius"}},[t._v("#")]),t._v(" cornerRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("cornerRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[t._v("BorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Radius of tooltip corner curves.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2841",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2841"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"displaycolors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#displaycolors"}},[t._v("#")]),t._v(" displayColors")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("displayColors")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("If true, color boxes are shown in the tooltip.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2851",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2851"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"enabled"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enabled"}},[t._v("#")]),t._v(" enabled")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("enabled")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Are on-canvas tooltips enabled?")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2719",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2719"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"filter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#filter"}},[t._v("#")]),t._v(" filter")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("filter")]),t._v(": ("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("array")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[], "),e("code",[t._v("data")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v(") => "),e("code",[t._v("boolean")])],1),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("e")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("array")]),t._v(", "),e("code",[t._v("data")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h5",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("e")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("array")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v("")],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2740",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2740"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footeralign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footeralign"}},[t._v("#")]),t._v(" footerAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#textalign"}},[e("code",[t._v("TextAlign")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Horizontal alignment of the footer text lines.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'left'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2821",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2821"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footercolor"}},[t._v("#")]),t._v(" footerColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of footer")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2811"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footerfont"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footerfont"}},[t._v("#")]),t._v(" footerFont")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerFont")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("See Fonts")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2816",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2816"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footermargintop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footermargintop"}},[t._v("#")]),t._v(" footerMarginTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerMarginTop")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Margin to add before drawing the footer.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2806"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footerspacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footerspacing"}},[t._v("#")]),t._v(" footerSpacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerSpacing")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Spacing to add to top and bottom of each footer line.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2801",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2801"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"includeinvisible"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#includeinvisible"}},[t._v("#")]),t._v(" includeInvisible")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("includeInvisible")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#includeinvisible"}},[t._v("includeInvisible")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1585",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1585"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"intersect"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#intersect"}},[t._v("#")]),t._v(" intersect")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("intersect")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, the hover mode only applies when the mouse position intersects an item on the chart.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#intersect"}},[t._v("intersect")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1574",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1574"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"itemsort"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#itemsort"}},[t._v("#")]),t._v(" itemSort")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("itemSort")]),t._v(": ("),e("code",[t._v("a")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("b")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("data")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v(") => "),e("code",[t._v("number")])],1),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("a")]),t._v(", "),e("code",[t._v("b")]),t._v(", "),e("code",[t._v("data")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Sort tooltip items.")]),t._v(" "),e("h5",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("a")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("b")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v("")],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2738",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2738"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"mode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mode"}},[t._v("#")]),t._v(" mode")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("mode")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[e("code",[t._v("InteractionModeMap")])])],1),t._v(" "),e("p",[t._v("Sets which elements appear in the tooltip. See Interaction Modes for details.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'nearest'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#mode"}},[t._v("mode")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1569",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1569"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"multikeybackground"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#multikeybackground"}},[t._v("#")]),t._v(" multiKeyBackground")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("multiKeyBackground")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color to draw behind the colored boxes when multiple items are in the tooltip.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2846",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2846"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"padding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" padding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("padding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("Padding")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Padding to add to the tooltip")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2826",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2826"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v(">")],1),t._v(" "),e("p",[t._v("The mode for positioning the tooltip")]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2727",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2727"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"rtl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rtl"}},[t._v("#")]),t._v(" rtl")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("rtl")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("true for rendering the legends from right to left.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2880",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2880"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textdirection"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textdirection"}},[t._v("#")]),t._v(" textDirection")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("textDirection")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("string")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("This will force the text direction 'rtl' or 'ltr on the canvas for rendering the tooltips, regardless of the css specified on the canvas")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("canvas's default")]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2886",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2886"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlealign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlealign"}},[t._v("#")]),t._v(" titleAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#textalign"}},[e("code",[t._v("TextAlign")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Horizontal alignment of the title text lines.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'left'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2776",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2776"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlecolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlecolor"}},[t._v("#")]),t._v(" titleColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of title")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2756",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2756"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlefont"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlefont"}},[t._v("#")]),t._v(" titleFont")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleFont")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("See Fonts")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2761",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2761"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlemarginbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlemarginbottom"}},[t._v("#")]),t._v(" titleMarginBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleMarginBottom")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Margin to add on bottom of title section.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2771",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2771"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlespacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlespacing"}},[t._v("#")]),t._v(" titleSpacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleSpacing")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Spacing to add to top and bottom of each title line.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2766",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2766"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"usepointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#usepointstyle"}},[t._v("#")]),t._v(" usePointStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("usePointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Use the corresponding point style (from dataset options) instead of color boxes, ex: star, triangle etc. (size is based on the minimum value between boxWidth and boxHeight)")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2866",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2866"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xalign"}},[t._v("#")]),t._v(" xAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("xAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#tooltipxalignment"}},[e("code",[t._v("TooltipXAlignment")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Override the tooltip alignment calculations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2732",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2732"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yalign"}},[t._v("#")]),t._v(" yAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("yAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#tooltipyalignment"}},[e("code",[t._v("TooltipYAlignment")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2733",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2733"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"external"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#external"}},[t._v("#")]),t._v(" external")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("external")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("See external tooltip section.")]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.tooltip")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2723",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2723"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{458:function(t,e,r){"use strict";r.r(e);var a=r(3),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipoptions-ttype"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipoptions-ttype"}},[t._v("#")]),t._v(" Interface: TooltipOptions")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[e("code",[t._v("CoreInteractionOptions")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TooltipOptions")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2888",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2888"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animations")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2889",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2889"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#interactionaxis"}},[e("code",[t._v("InteractionAxis")])])],1),t._v(" "),e("p",[t._v("Defines which directions are used in calculating distances. Defaults to 'x' for 'index' mode and 'xy' in dataset and 'nearest' modes.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#axis"}},[t._v("axis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1579",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1579"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Background color of the tooltip.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'rgba(0, 0, 0, 0.8)'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2746",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2746"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodyalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodyalign"}},[t._v("#")]),t._v(" bodyAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodyAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#textalign"}},[e("code",[t._v("TextAlign")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Horizontal alignment of the body text lines.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'left'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2796",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2796"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodycolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodycolor"}},[t._v("#")]),t._v(" bodyColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodyColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of body")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2786",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2786"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodyfont"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodyfont"}},[t._v("#")]),t._v(" bodyFont")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodyFont")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("See Fonts.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2791",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2791"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bodyspacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bodyspacing"}},[t._v("#")]),t._v(" bodySpacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bodySpacing")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Spacing to add to top and bottom of each tooltip item.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2781",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2781"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of the border.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'rgba(0, 0, 0, 0)'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2871",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2871"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Size of the border.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2876",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2876"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxheight"}},[t._v("#")]),t._v(" boxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("boxHeight")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Height of the color box if displayColors is true.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("bodyFont.size")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2861",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2861"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxpadding"}},[t._v("#")]),t._v(" boxPadding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("boxPadding")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Padding between the color box and the text.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("1")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2751",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2751"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxwidth"}},[t._v("#")]),t._v(" boxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("boxWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Width of the color box if displayColors is true.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("bodyFont.size")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2856",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2856"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"callbacks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#callbacks"}},[t._v("#")]),t._v(" callbacks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("callbacks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipCallbacks.html"}},[e("code",[t._v("TooltipCallbacks")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2890",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2890"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"caretpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#caretpadding"}},[t._v("#")]),t._v(" caretPadding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretPadding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Extra distance to move the end of the tooltip arrow away from the tooltip point.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2831",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2831"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"caretsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#caretsize"}},[t._v("#")]),t._v(" caretSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("caretSize")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Size, in px, of the tooltip arrow.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("5")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2836",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2836"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"cornerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cornerradius"}},[t._v("#")]),t._v(" cornerRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("cornerRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[t._v("BorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Radius of tooltip corner curves.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2841",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2841"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"displaycolors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#displaycolors"}},[t._v("#")]),t._v(" displayColors")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("displayColors")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("If true, color boxes are shown in the tooltip.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2851",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2851"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"enabled"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enabled"}},[t._v("#")]),t._v(" enabled")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("enabled")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Are on-canvas tooltips enabled?")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2719",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2719"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"filter"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#filter"}},[t._v("#")]),t._v(" filter")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("filter")]),t._v(": ("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("index")]),t._v(": "),e("code",[t._v("number")]),t._v(", "),e("code",[t._v("array")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[], "),e("code",[t._v("data")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v(") => "),e("code",[t._v("boolean")])],1),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("e")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("array")]),t._v(", "),e("code",[t._v("data")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h5",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("e")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("array")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v("")],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2740",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2740"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footeralign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footeralign"}},[t._v("#")]),t._v(" footerAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#textalign"}},[e("code",[t._v("TextAlign")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Horizontal alignment of the footer text lines.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'left'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2821",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2821"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footercolor"}},[t._v("#")]),t._v(" footerColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of footer")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2811"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footerfont"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footerfont"}},[t._v("#")]),t._v(" footerFont")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerFont")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("See Fonts")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2816",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2816"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footermargintop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footermargintop"}},[t._v("#")]),t._v(" footerMarginTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerMarginTop")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Margin to add before drawing the footer.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2806"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"footerspacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#footerspacing"}},[t._v("#")]),t._v(" footerSpacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("footerSpacing")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Spacing to add to top and bottom of each footer line.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2801",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2801"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"includeinvisible"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#includeinvisible"}},[t._v("#")]),t._v(" includeInvisible")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("includeInvisible")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#includeinvisible"}},[t._v("includeInvisible")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1585",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1585"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"intersect"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#intersect"}},[t._v("#")]),t._v(" intersect")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("intersect")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, the hover mode only applies when the mouse position intersects an item on the chart.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#intersect"}},[t._v("intersect")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1574",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1574"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"itemsort"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#itemsort"}},[t._v("#")]),t._v(" itemSort")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("itemSort")]),t._v(": ("),e("code",[t._v("a")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("b")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">, "),e("code",[t._v("data")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v(") => "),e("code",[t._v("number")])],1),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("p",[t._v("▸ ("),e("code",[t._v("a")]),t._v(", "),e("code",[t._v("b")]),t._v(", "),e("code",[t._v("data")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Sort tooltip items.")]),t._v(" "),e("h5",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("a")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("b")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipItem.html"}},[e("code",[t._v("TooltipItem")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v("")],1)])])]),t._v(" "),e("h5",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2738",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2738"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"mode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#mode"}},[t._v("#")]),t._v(" mode")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("mode")]),t._v(": keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionModeMap.html"}},[e("code",[t._v("InteractionModeMap")])])],1),t._v(" "),e("p",[t._v("Sets which elements appear in the tooltip. See Interaction Modes for details.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'nearest'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html"}},[t._v("CoreInteractionOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CoreInteractionOptions.html#mode"}},[t._v("mode")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1569",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1569"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"multikeybackground"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#multikeybackground"}},[t._v("#")]),t._v(" multiKeyBackground")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("multiKeyBackground")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color to draw behind the colored boxes when multiple items are in the tooltip.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2846",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2846"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"padding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" padding")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("padding")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("Padding")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Padding to add to the tooltip")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2826",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2826"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v(">")],1),t._v(" "),e("p",[t._v("The mode for positioning the tooltip")]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2727",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2727"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"rtl"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rtl"}},[t._v("#")]),t._v(" rtl")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("rtl")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("true for rendering the legends from right to left.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2880",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2880"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"textdirection"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#textdirection"}},[t._v("#")]),t._v(" textDirection")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("textDirection")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("string")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("This will force the text direction 'rtl' or 'ltr on the canvas for rendering the tooltips, regardless of the css specified on the canvas")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("canvas's default")]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2886",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2886"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlealign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlealign"}},[t._v("#")]),t._v(" titleAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#textalign"}},[e("code",[t._v("TextAlign")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Horizontal alignment of the title text lines.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'left'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2776",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2776"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlecolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlecolor"}},[t._v("#")]),t._v(" titleColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Color of title")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'#fff'")]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2756",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2756"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlefont"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlefont"}},[t._v("#")]),t._v(" titleFont")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleFont")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandscriptableoptions"}},[e("code",[t._v("ScriptableAndScriptableOptions")])]),t._v("<"),e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/FontSpec.html"}},[e("code",[t._v("FontSpec")])]),t._v(">, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("See Fonts")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2761",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2761"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlemarginbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlemarginbottom"}},[t._v("#")]),t._v(" titleMarginBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleMarginBottom")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Margin to add on bottom of title section.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("6")]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2771",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2771"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"titlespacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#titlespacing"}},[t._v("#")]),t._v(" titleSpacing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("titleSpacing")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Spacing to add to top and bottom of each title line.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("2")]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2766",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2766"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"usepointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#usepointstyle"}},[t._v("#")]),t._v(" usePointStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("usePointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Use the corresponding point style (from dataset options) instead of color boxes, ex: star, triangle etc. (size is based on the minimum value between boxWidth and boxHeight)")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2866",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2866"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xalign"}},[t._v("#")]),t._v(" xAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("xAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#tooltipxalignment"}},[e("code",[t._v("TooltipXAlignment")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("p",[t._v("Override the tooltip alignment calculations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2732",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2732"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yalign"}},[t._v("#")]),t._v(" yAlign")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("yAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#tooltipyalignment"}},[e("code",[t._v("TooltipYAlignment")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableTooltipContext.html"}},[e("code",[t._v("ScriptableTooltipContext")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2733",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2733"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"external"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#external"}},[t._v("#")]),t._v(" external")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("external")]),t._v("("),e("code",[t._v("this")]),t._v(", "),e("code",[t._v("args")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("See external tooltip section.")]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("this")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args.tooltip")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2723",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2723"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/128.7469921c.js b/docs/master/assets/js/128.ed573cd1.js similarity index 92% rename from docs/master/assets/js/128.7469921c.js rename to docs/master/assets/js/128.ed573cd1.js index 8e0bf8bc84..2e9841a0f4 100644 --- a/docs/master/assets/js/128.7469921c.js +++ b/docs/master/assets/js/128.ed573cd1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[128],{476:function(t,e,r){"use strict";r.r(e);var a=r(3),i=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipposition"}},[t._v("#")]),t._v(" Interface: TooltipPosition")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TooltipPosition")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html#x"}},[t._v("x")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/geometric.d.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xalign"}},[t._v("#")]),t._v(" xAlign")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("xAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipxalignment"}},[e("code",[t._v("TooltipXAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2635",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2635"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html#y"}},[t._v("y")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/geometric.d.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yalign"}},[t._v("#")]),t._v(" yAlign")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("yAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipyalignment"}},[e("code",[t._v("TooltipYAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2636",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2636"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[128],{456:function(t,e,r){"use strict";r.r(e);var a=r(3),i=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltipposition"}},[t._v("#")]),t._v(" Interface: TooltipPosition")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("TooltipPosition")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html#x"}},[t._v("x")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/geometric.d.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xalign"}},[t._v("#")]),t._v(" xAlign")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("xAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipxalignment"}},[e("code",[t._v("TooltipXAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2635",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2635"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html#y"}},[t._v("y")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/geometric.d.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yalign"}},[t._v("#")]),t._v(" yAlign")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("yAlign")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltipyalignment"}},[e("code",[t._v("TooltipYAlignment")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2636",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2636"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/129.0a6b69dc.js b/docs/master/assets/js/129.68c181ad.js similarity index 91% rename from docs/master/assets/js/129.0a6b69dc.js rename to docs/master/assets/js/129.68c181ad.js index 92f4497593..9f3e09e291 100644 --- a/docs/master/assets/js/129.0a6b69dc.js +++ b/docs/master/assets/js/129.68c181ad.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{461:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltippositionermap"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltippositionermap"}},[t._v("#")]),t._v(" Interface: TooltipPositionerMap")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"average"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#average"}},[t._v("#")]),t._v(" average")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("average")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltippositionerfunction"}},[e("code",[t._v("TooltipPositionerFunction")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2646",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2646"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"nearest"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#nearest"}},[t._v("#")]),t._v(" nearest")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("nearest")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltippositionerfunction"}},[e("code",[t._v("TooltipPositionerFunction")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2647",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2647"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{460:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-tooltippositionermap"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-tooltippositionermap"}},[t._v("#")]),t._v(" Interface: TooltipPositionerMap")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"average"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#average"}},[t._v("#")]),t._v(" average")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("average")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltippositionerfunction"}},[e("code",[t._v("TooltipPositionerFunction")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2646",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2646"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"nearest"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#nearest"}},[t._v("#")]),t._v(" nearest")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("nearest")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#tooltippositionerfunction"}},[e("code",[t._v("TooltipPositionerFunction")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2647",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2647"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/13.fda49ea4.js b/docs/master/assets/js/13.30e78acc.js similarity index 92% rename from docs/master/assets/js/13.fda49ea4.js rename to docs/master/assets/js/13.30e78acc.js index 9da3822329..2c38ceaee0 100644 --- a/docs/master/assets/js/13.fda49ea4.js +++ b/docs/master/assets/js/13.30e78acc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{345:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-animation"}},[t._v("#")]),t._v(" Class: Animation")]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Animation")]),t._v("("),e("code",[t._v("cfg")]),t._v(", "),e("code",[t._v("target")]),t._v(", "),e("code",[t._v("prop")]),t._v(", "),e("code",[t._v("to?")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("target")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("prop")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("to?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:5"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"to"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#to"}},[t._v("#")]),t._v(" _to")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("_to")]),t._v(": "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:10"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("active")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:6"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"cancel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cancel"}},[t._v("#")]),t._v(" cancel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("cancel")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:8"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick"}},[t._v("#")]),t._v(" tick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tick")]),t._v("("),e("code",[t._v("date")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("date")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("cfg")]),t._v(", "),e("code",[t._v("to")]),t._v(", "),e("code",[t._v("date")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("to")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("date")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:7"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{346:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-animation"}},[t._v("#")]),t._v(" Class: Animation")]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Animation")]),t._v("("),e("code",[t._v("cfg")]),t._v(", "),e("code",[t._v("target")]),t._v(", "),e("code",[t._v("prop")]),t._v(", "),e("code",[t._v("to?")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("target")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("prop")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("to?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L5",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:5"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"to"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#to"}},[t._v("#")]),t._v(" _to")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("_to")]),t._v(": "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L10",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:10"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("active")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L6",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:6"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"cancel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cancel"}},[t._v("#")]),t._v(" cancel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("cancel")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L8",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:8"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick"}},[t._v("#")]),t._v(" tick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tick")]),t._v("("),e("code",[t._v("date")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("date")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("cfg")]),t._v(", "),e("code",[t._v("to")]),t._v(", "),e("code",[t._v("date")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("to")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("date")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L7",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:7"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/130.a9547202.js b/docs/master/assets/js/130.e3b853a0.js similarity index 95% rename from docs/master/assets/js/130.a9547202.js rename to docs/master/assets/js/130.e3b853a0.js index 00d5c02a7b..80138dcfb6 100644 --- a/docs/master/assets/js/130.a9547202.js +++ b/docs/master/assets/js/130.e3b853a0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{459:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-typedregistry-t"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-typedregistry-t"}},[t._v("#")]),t._v(" Interface: TypedRegistry")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])])])]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get"}},[t._v("#")]),t._v(" get")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("get")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("code",[t._v("T")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("T")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1529",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1529"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"register"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#register"}},[t._v("#")]),t._v(" register")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("register")]),t._v("("),e("code",[t._v("item")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The scope where items defaults were registered to.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1528",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1528"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"unregister"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unregister"}},[t._v("#")]),t._v(" unregister")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("unregister")]),t._v("("),e("code",[t._v("item")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1530",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1530"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{462:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-typedregistry-t"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-typedregistry-t"}},[t._v("#")]),t._v(" Interface: TypedRegistry")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])])])])]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"get"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#get"}},[t._v("#")]),t._v(" get")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("get")]),t._v("("),e("code",[t._v("id")]),t._v("): "),e("code",[t._v("T")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("T")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1529",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1529"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"register"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#register"}},[t._v("#")]),t._v(" register")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("register")]),t._v("("),e("code",[t._v("item")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The scope where items defaults were registered to.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1528",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1528"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"unregister"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unregister"}},[t._v("#")]),t._v(" unregister")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("unregister")]),t._v("("),e("code",[t._v("item")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartComponent.html"}},[e("code",[t._v("ChartComponent")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1530",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1530"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/131.933e7e9d.js b/docs/master/assets/js/131.7f6f2cc0.js similarity index 95% rename from docs/master/assets/js/131.933e7e9d.js rename to docs/master/assets/js/131.7f6f2cc0.js index 25feaf91e0..54ef55d361 100644 --- a/docs/master/assets/js/131.933e7e9d.js +++ b/docs/master/assets/js/131.7f6f2cc0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{463:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-visualelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-visualelement"}},[t._v("#")]),t._v(" Interface: VisualElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("VisualElement")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/LineElement.html"}},[e("code",[t._v("LineElement")])])],1),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/BarElement.html"}},[e("code",[t._v("BarElement")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v(", "),e("code",[t._v("area?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("area?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1796",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1796"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1800",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1800"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getrange"}},[t._v("#")]),t._v(" getRange")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getRange")]),t._v("("),e("code",[t._v("axis")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("axis")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1801",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1801"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1797",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1797"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inxrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inxrange"}},[t._v("#")]),t._v(" inXRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inXRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1798",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1798"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inyrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inyrange"}},[t._v("#")]),t._v(" inYRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inYRange")]),t._v("("),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1799",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1799"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{461:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-visualelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-visualelement"}},[t._v("#")]),t._v(" Interface: VisualElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("VisualElement")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/LineElement.html"}},[e("code",[t._v("LineElement")])])],1),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/BarElement.html"}},[e("code",[t._v("BarElement")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v(", "),e("code",[t._v("area?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("area?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1796",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1796"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1800",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1800"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getrange"}},[t._v("#")]),t._v(" getRange")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getRange")]),t._v("("),e("code",[t._v("axis")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("axis")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1801",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1801"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1797",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1797"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inxrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inxrange"}},[t._v("#")]),t._v(" inXRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inXRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1798",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1798"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inyrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inyrange"}},[t._v("#")]),t._v(" inYRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inYRange")]),t._v("("),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1799",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1799"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/132.73734ebc.js b/docs/master/assets/js/132.3613ccba.js similarity index 98% rename from docs/master/assets/js/132.73734ebc.js rename to docs/master/assets/js/132.3613ccba.js index 5c30a3a6f9..ec03fc1a56 100644 --- a/docs/master/assets/js/132.73734ebc.js +++ b/docs/master/assets/js/132.3613ccba.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{462:function(t,e,o){"use strict";o.r(e);var v=o(3),d=Object(v.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])])])}),[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{465:function(t,e,o){"use strict";o.r(e);var v=o(3),d=Object(v.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])])])}),[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/134.f6ed2900.js b/docs/master/assets/js/134.731b48e4.js similarity index 98% rename from docs/master/assets/js/134.f6ed2900.js rename to docs/master/assets/js/134.731b48e4.js index f397e1983c..55193374a8 100644 --- a/docs/master/assets/js/134.f6ed2900.js +++ b/docs/master/assets/js/134.731b48e4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{465:function(t,e,o){"use strict";o.r(e);var a=o(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{467:function(t,e,o){"use strict";o.r(e);var a=o(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/136.1ec86061.js b/docs/master/assets/js/136.2edd49ed.js similarity index 99% rename from docs/master/assets/js/136.1ec86061.js rename to docs/master/assets/js/136.2edd49ed.js index eb9bf72c22..b0a91d0cfc 100644 --- a/docs/master/assets/js/136.1ec86061.js +++ b/docs/master/assets/js/136.2edd49ed.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{467:function(t,e,a){"use strict";a.r(e);var s=a(3),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"category-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category-axis"}},[t._v("#")]),t._v(" Category Axis")]),t._v(" "),e("p",[t._v("If the global configuration is used, labels are drawn from one of the label arrays included in the chart data. If only "),e("code",[t._v("data.labels")]),t._v(" is defined, this will be used. If "),e("code",[t._v("data.xLabels")]),t._v(" is defined and the axis is horizontal, this will be used. Similarly, if "),e("code",[t._v("data.yLabels")]),t._v(" is defined and the axis is vertical, this property will be used. Using both "),e("code",[t._v("xLabels")]),t._v(" and "),e("code",[t._v("yLabels")]),t._v(" together can create a chart that uses strings for both the X and Y axes.")]),t._v(" "),e("p",[t._v("Specifying any of the settings above defines the x-axis as "),e("code",[t._v("type: 'category'")]),t._v(" if not defined otherwise. For more fine-grained control of category labels, it is also possible to add "),e("code",[t._v("labels")]),t._v(" as part of the category axis definition. Doing so does not apply the global defaults.")]),t._v(" "),e("h2",{attrs:{id:"category-axis-definition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category-axis-definition"}},[t._v("#")]),t._v(" Category Axis Definition")]),t._v(" "),e("p",[t._v("Globally:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("As part of axis definition:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'category'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"category-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category-axis-specific-options"}},[t._v("#")]),t._v(" Category Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v("|"),e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("The minimum item to display. "),e("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v("|"),e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("The maximum item to display. "),e("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labels")])]),t._v(" "),e("td",[e("code",[t._v("string[]")]),t._v("|"),e("code",[t._v("string[][]")])]),t._v(" "),e("td",[t._v("An array of labels to display. When an individual label is an array of strings, each item is rendered on a new line.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common tick options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("The tick alignment along the axis. Can be "),e("code",[t._v("'start'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", "),e("code",[t._v("'end'")]),t._v(", or "),e("code",[t._v("'inner'")]),t._v(". "),e("code",[t._v("inner")]),t._v(" alignment means align "),e("code",[t._v("start")]),t._v(" for first tick and "),e("code",[t._v("end")]),t._v(" for the last tick of horizontal axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("crossAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'near'")])]),t._v(" "),e("td",[t._v("The tick alignment perpendicular to the axis. Can be "),e("code",[t._v("'near'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", or "),e("code",[t._v("'far'")]),t._v(". See "),e("RouterLink",{attrs:{to:"/axes/cartesian/#tick-alignment"}},[t._v("Tick Alignment")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sampleSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("ticks.length")])]),t._v(" "),e("td",[t._v("The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to "),e("code",[t._v("maxRotation")]),t._v(" before skipping any. Turn "),e("code",[t._v("autoSkip")]),t._v(" off to show all labels no matter what.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkipPadding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Padding between the ticks on the horizontal axis when "),e("code",[t._v("autoSkip")]),t._v(" is enabled.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("includeBounds")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Should the defined "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(' values be presented as ticks even if they are not "nice".')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labelOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). "),e("em",[t._v("Note: this can cause labels at the edges to be cropped by the edge of the canvas")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("50")])]),t._v(" "),e("td",[t._v("Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Minimum rotation for tick labels. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("mirror")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Flips tick labels around axis, displaying the labels inside the chart instead of outside. "),e("em",[t._v("Note: Only applicable to vertical scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("h2",{attrs:{id:"min-max-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min-max-configuration"}},[t._v("#")]),t._v(" Min Max Configuration")]),t._v(" "),e("p",[t._v("For both the "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(" properties, the value must be "),e("code",[t._v("string")]),t._v(" in the "),e("code",[t._v("labels")]),t._v(" array or "),e("code",[t._v("numeric")]),t._v(' value as an index of a label in that array. In the example below, the x axis would only display "March" through "June".')]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("40")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally category scale uses label indices")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{469:function(t,e,a){"use strict";a.r(e);var s=a(3),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"category-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category-axis"}},[t._v("#")]),t._v(" Category Axis")]),t._v(" "),e("p",[t._v("If the global configuration is used, labels are drawn from one of the label arrays included in the chart data. If only "),e("code",[t._v("data.labels")]),t._v(" is defined, this will be used. If "),e("code",[t._v("data.xLabels")]),t._v(" is defined and the axis is horizontal, this will be used. Similarly, if "),e("code",[t._v("data.yLabels")]),t._v(" is defined and the axis is vertical, this property will be used. Using both "),e("code",[t._v("xLabels")]),t._v(" and "),e("code",[t._v("yLabels")]),t._v(" together can create a chart that uses strings for both the X and Y axes.")]),t._v(" "),e("p",[t._v("Specifying any of the settings above defines the x-axis as "),e("code",[t._v("type: 'category'")]),t._v(" if not defined otherwise. For more fine-grained control of category labels, it is also possible to add "),e("code",[t._v("labels")]),t._v(" as part of the category axis definition. Doing so does not apply the global defaults.")]),t._v(" "),e("h2",{attrs:{id:"category-axis-definition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category-axis-definition"}},[t._v("#")]),t._v(" Category Axis Definition")]),t._v(" "),e("p",[t._v("Globally:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("As part of axis definition:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'category'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"category-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#category-axis-specific-options"}},[t._v("#")]),t._v(" Category Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v("|"),e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("The minimum item to display. "),e("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v("|"),e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("The maximum item to display. "),e("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labels")])]),t._v(" "),e("td",[e("code",[t._v("string[]")]),t._v("|"),e("code",[t._v("string[][]")])]),t._v(" "),e("td",[t._v("An array of labels to display. When an individual label is an array of strings, each item is rendered on a new line.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common tick options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("The tick alignment along the axis. Can be "),e("code",[t._v("'start'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", "),e("code",[t._v("'end'")]),t._v(", or "),e("code",[t._v("'inner'")]),t._v(". "),e("code",[t._v("inner")]),t._v(" alignment means align "),e("code",[t._v("start")]),t._v(" for first tick and "),e("code",[t._v("end")]),t._v(" for the last tick of horizontal axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("crossAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'near'")])]),t._v(" "),e("td",[t._v("The tick alignment perpendicular to the axis. Can be "),e("code",[t._v("'near'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", or "),e("code",[t._v("'far'")]),t._v(". See "),e("RouterLink",{attrs:{to:"/axes/cartesian/#tick-alignment"}},[t._v("Tick Alignment")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sampleSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("ticks.length")])]),t._v(" "),e("td",[t._v("The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to "),e("code",[t._v("maxRotation")]),t._v(" before skipping any. Turn "),e("code",[t._v("autoSkip")]),t._v(" off to show all labels no matter what.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkipPadding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Padding between the ticks on the horizontal axis when "),e("code",[t._v("autoSkip")]),t._v(" is enabled.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("includeBounds")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Should the defined "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(' values be presented as ticks even if they are not "nice".')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labelOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). "),e("em",[t._v("Note: this can cause labels at the edges to be cropped by the edge of the canvas")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("50")])]),t._v(" "),e("td",[t._v("Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Minimum rotation for tick labels. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("mirror")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Flips tick labels around axis, displaying the labels inside the chart instead of outside. "),e("em",[t._v("Note: Only applicable to vertical scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("h2",{attrs:{id:"min-max-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min-max-configuration"}},[t._v("#")]),t._v(" Min Max Configuration")]),t._v(" "),e("p",[t._v("For both the "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(" properties, the value must be "),e("code",[t._v("string")]),t._v(" in the "),e("code",[t._v("labels")]),t._v(" array or "),e("code",[t._v("numeric")]),t._v(' value as an index of a label in that array. In the example below, the x axis would only display "March" through "June".')]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("40")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally category scale uses label indices")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/138.7729face.js b/docs/master/assets/js/138.698eb6a9.js similarity index 99% rename from docs/master/assets/js/138.7729face.js rename to docs/master/assets/js/138.698eb6a9.js index 9c027e903f..1cf3b3288e 100644 --- a/docs/master/assets/js/138.7729face.js +++ b/docs/master/assets/js/138.698eb6a9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{469:function(t,e,a){"use strict";a.r(e);var o=a(3),v=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"linear-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-axis"}},[t._v("#")]),t._v(" Linear Axis")]),t._v(" "),e("p",[t._v("The linear scale is used to chart numerical data. It can be placed on either the x or y-axis. The scatter chart type automatically configures a line chart to use one of these scales for the x-axis. As the name suggests, linear interpolation is used to determine where a value lies on the axis.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"linear-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-axis-specific-options"}},[t._v("#")]),t._v(" Linear Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("beginAtZero")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[t._v("if true, scale will include 0 if it is not already included.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grace")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("Percentage (string ending with "),e("code",[t._v("%")]),t._v(") or amount (number) for added room in the scale range above and below data. "),e("a",{attrs:{href:"#grace"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"linear-axis-specific-tick-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-axis-specific-tick-options"}},[t._v("#")]),t._v(" Linear Axis specific tick options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("count")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("The number of ticks to generate. If specified, this overrides the automatic generation.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("format")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("Intl.NumberFormat")]),e("OutboundLink")],1),t._v(" options used by the default label formatter")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("precision")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("if defined and "),e("code",[t._v("stepSize")]),t._v(" is not specified, the step size will be rounded to this many decimal places.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stepSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User-defined fixed step size for the scale. "),e("a",{attrs:{href:"#step-size"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common tick options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("The tick alignment along the axis. Can be "),e("code",[t._v("'start'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", "),e("code",[t._v("'end'")]),t._v(", or "),e("code",[t._v("'inner'")]),t._v(". "),e("code",[t._v("inner")]),t._v(" alignment means align "),e("code",[t._v("start")]),t._v(" for first tick and "),e("code",[t._v("end")]),t._v(" for the last tick of horizontal axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("crossAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'near'")])]),t._v(" "),e("td",[t._v("The tick alignment perpendicular to the axis. Can be "),e("code",[t._v("'near'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", or "),e("code",[t._v("'far'")]),t._v(". See "),e("RouterLink",{attrs:{to:"/axes/cartesian/#tick-alignment"}},[t._v("Tick Alignment")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sampleSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("ticks.length")])]),t._v(" "),e("td",[t._v("The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to "),e("code",[t._v("maxRotation")]),t._v(" before skipping any. Turn "),e("code",[t._v("autoSkip")]),t._v(" off to show all labels no matter what.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkipPadding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Padding between the ticks on the horizontal axis when "),e("code",[t._v("autoSkip")]),t._v(" is enabled.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("includeBounds")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Should the defined "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(' values be presented as ticks even if they are not "nice".')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labelOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). "),e("em",[t._v("Note: this can cause labels at the edges to be cropped by the edge of the canvas")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("50")])]),t._v(" "),e("td",[t._v("Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Minimum rotation for tick labels. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("mirror")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Flips tick labels around axis, displaying the labels inside the chart instead of outside. "),e("em",[t._v("Note: Only applicable to vertical scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("h2",{attrs:{id:"step-size"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-size"}},[t._v("#")]),t._v(" Step Size")]),t._v(" "),e("p",[t._v("If set, the scale ticks will be enumerated by multiple of "),e("code",[t._v("stepSize")]),t._v(", having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.")]),t._v(" "),e("p",[t._v("This example sets up a chart with a y-axis that creates ticks at "),e("code",[t._v("0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5")]),t._v(".")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stepSize")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"grace"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grace"}},[t._v("#")]),t._v(" Grace")]),t._v(" "),e("p",[t._v("If the value is a string ending with "),e("code",[t._v("%")]),t._v(", it's treated as a percentage. If a number, it's treated as a value.\nThe value is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: ['Positive', 'Negative'],\n datasets: [{\n data: [100, -50],\n backgroundColor: 'rgb(255, 99, 132)'\n }],\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data,\n options: {\n scales: {\n y: {\n type: 'linear',\n grace: '5%'\n }\n },\n plugins: {\n legend: false\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally, the linear scale uses numeric data")])],1)}),[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{470:function(t,e,a){"use strict";a.r(e);var o=a(3),v=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"linear-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-axis"}},[t._v("#")]),t._v(" Linear Axis")]),t._v(" "),e("p",[t._v("The linear scale is used to chart numerical data. It can be placed on either the x or y-axis. The scatter chart type automatically configures a line chart to use one of these scales for the x-axis. As the name suggests, linear interpolation is used to determine where a value lies on the axis.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"linear-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-axis-specific-options"}},[t._v("#")]),t._v(" Linear Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("beginAtZero")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[t._v("if true, scale will include 0 if it is not already included.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grace")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("Percentage (string ending with "),e("code",[t._v("%")]),t._v(") or amount (number) for added room in the scale range above and below data. "),e("a",{attrs:{href:"#grace"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"linear-axis-specific-tick-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-axis-specific-tick-options"}},[t._v("#")]),t._v(" Linear Axis specific tick options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("count")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("The number of ticks to generate. If specified, this overrides the automatic generation.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("format")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("Intl.NumberFormat")]),e("OutboundLink")],1),t._v(" options used by the default label formatter")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("precision")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("if defined and "),e("code",[t._v("stepSize")]),t._v(" is not specified, the step size will be rounded to this many decimal places.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stepSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User-defined fixed step size for the scale. "),e("a",{attrs:{href:"#step-size"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common tick options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("The tick alignment along the axis. Can be "),e("code",[t._v("'start'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", "),e("code",[t._v("'end'")]),t._v(", or "),e("code",[t._v("'inner'")]),t._v(". "),e("code",[t._v("inner")]),t._v(" alignment means align "),e("code",[t._v("start")]),t._v(" for first tick and "),e("code",[t._v("end")]),t._v(" for the last tick of horizontal axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("crossAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'near'")])]),t._v(" "),e("td",[t._v("The tick alignment perpendicular to the axis. Can be "),e("code",[t._v("'near'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", or "),e("code",[t._v("'far'")]),t._v(". See "),e("RouterLink",{attrs:{to:"/axes/cartesian/#tick-alignment"}},[t._v("Tick Alignment")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sampleSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("ticks.length")])]),t._v(" "),e("td",[t._v("The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to "),e("code",[t._v("maxRotation")]),t._v(" before skipping any. Turn "),e("code",[t._v("autoSkip")]),t._v(" off to show all labels no matter what.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkipPadding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Padding between the ticks on the horizontal axis when "),e("code",[t._v("autoSkip")]),t._v(" is enabled.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("includeBounds")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Should the defined "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(' values be presented as ticks even if they are not "nice".')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labelOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). "),e("em",[t._v("Note: this can cause labels at the edges to be cropped by the edge of the canvas")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("50")])]),t._v(" "),e("td",[t._v("Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Minimum rotation for tick labels. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("mirror")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Flips tick labels around axis, displaying the labels inside the chart instead of outside. "),e("em",[t._v("Note: Only applicable to vertical scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("h2",{attrs:{id:"step-size"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-size"}},[t._v("#")]),t._v(" Step Size")]),t._v(" "),e("p",[t._v("If set, the scale ticks will be enumerated by multiple of "),e("code",[t._v("stepSize")]),t._v(", having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.")]),t._v(" "),e("p",[t._v("This example sets up a chart with a y-axis that creates ticks at "),e("code",[t._v("0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5")]),t._v(".")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stepSize")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"grace"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grace"}},[t._v("#")]),t._v(" Grace")]),t._v(" "),e("p",[t._v("If the value is a string ending with "),e("code",[t._v("%")]),t._v(", it's treated as a percentage. If a number, it's treated as a value.\nThe value is added to the maximum data value and subtracted from the minimum data. This extends the scale range as if the data values were that much greater.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: ['Positive', 'Negative'],\n datasets: [{\n data: [100, -50],\n backgroundColor: 'rgb(255, 99, 132)'\n }],\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data,\n options: {\n scales: {\n y: {\n type: 'linear',\n grace: '5%'\n }\n },\n plugins: {\n legend: false\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally, the linear scale uses numeric data")])],1)}),[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/139.429d9663.js b/docs/master/assets/js/139.409483fb.js similarity index 99% rename from docs/master/assets/js/139.429d9663.js rename to docs/master/assets/js/139.409483fb.js index ddc182a1d6..674eeed07e 100644 --- a/docs/master/assets/js/139.429d9663.js +++ b/docs/master/assets/js/139.409483fb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{601:function(t,e,o){"use strict";o.r(e);var a=o(3),v=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"logarithmic-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmic-axis"}},[t._v("#")]),t._v(" Logarithmic Axis")]),t._v(" "),e("p",[t._v("The logarithmic scale is used to chart numerical data. It can be placed on either the x or y-axis. As the name suggests, logarithmic interpolation is used to determine where a value lies on the axis.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"logarithmic-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmic-axis-specific-options"}},[t._v("#")]),t._v(" Logarithmic Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("format")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("Intl.NumberFormat")]),e("OutboundLink")],1),t._v(" options used by the default label formatter")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common tick options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("The tick alignment along the axis. Can be "),e("code",[t._v("'start'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", "),e("code",[t._v("'end'")]),t._v(", or "),e("code",[t._v("'inner'")]),t._v(". "),e("code",[t._v("inner")]),t._v(" alignment means align "),e("code",[t._v("start")]),t._v(" for first tick and "),e("code",[t._v("end")]),t._v(" for the last tick of horizontal axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("crossAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'near'")])]),t._v(" "),e("td",[t._v("The tick alignment perpendicular to the axis. Can be "),e("code",[t._v("'near'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", or "),e("code",[t._v("'far'")]),t._v(". See "),e("RouterLink",{attrs:{to:"/axes/cartesian/#tick-alignment"}},[t._v("Tick Alignment")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sampleSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("ticks.length")])]),t._v(" "),e("td",[t._v("The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to "),e("code",[t._v("maxRotation")]),t._v(" before skipping any. Turn "),e("code",[t._v("autoSkip")]),t._v(" off to show all labels no matter what.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkipPadding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Padding between the ticks on the horizontal axis when "),e("code",[t._v("autoSkip")]),t._v(" is enabled.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("includeBounds")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Should the defined "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(' values be presented as ticks even if they are not "nice".')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labelOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). "),e("em",[t._v("Note: this can cause labels at the edges to be cropped by the edge of the canvas")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("50")])]),t._v(" "),e("td",[t._v("Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Minimum rotation for tick labels. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("mirror")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Flips tick labels around axis, displaying the labels inside the chart instead of outside. "),e("em",[t._v("Note: Only applicable to vertical scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally, the logarithmic scale uses numeric data.")])])}),[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{471:function(t,e,o){"use strict";o.r(e);var a=o(3),v=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"logarithmic-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmic-axis"}},[t._v("#")]),t._v(" Logarithmic Axis")]),t._v(" "),e("p",[t._v("The logarithmic scale is used to chart numerical data. It can be placed on either the x or y-axis. As the name suggests, logarithmic interpolation is used to determine where a value lies on the axis.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("bounds")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'ticks'")])]),t._v(" "),e("td",[t._v("Determines the scale bounds. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Position of the axis. "),e("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Stack group. Axes at the same "),e("code",[t._v("position")]),t._v(" with same "),e("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stackWeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("1")]),t._v(" "),e("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("axis")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Which type of axis this is. Possible values are: "),e("code",[t._v("'x'")]),t._v(", "),e("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),e("code",[t._v("'x'")]),t._v(" or "),e("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Scale title configuration. "),e("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"common-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("border")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Border configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"logarithmic-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#logarithmic-axis-specific-options"}},[t._v("#")]),t._v(" Logarithmic Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("format")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("Intl.NumberFormat")]),e("OutboundLink")],1),t._v(" options used by the default label formatter")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-cartesian-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common tick options to all cartesian axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("The tick alignment along the axis. Can be "),e("code",[t._v("'start'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", "),e("code",[t._v("'end'")]),t._v(", or "),e("code",[t._v("'inner'")]),t._v(". "),e("code",[t._v("inner")]),t._v(" alignment means align "),e("code",[t._v("start")]),t._v(" for first tick and "),e("code",[t._v("end")]),t._v(" for the last tick of horizontal axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("crossAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'near'")])]),t._v(" "),e("td",[t._v("The tick alignment perpendicular to the axis. Can be "),e("code",[t._v("'near'")]),t._v(", "),e("code",[t._v("'center'")]),t._v(", or "),e("code",[t._v("'far'")]),t._v(". See "),e("RouterLink",{attrs:{to:"/axes/cartesian/#tick-alignment"}},[t._v("Tick Alignment")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sampleSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("ticks.length")])]),t._v(" "),e("td",[t._v("The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkip")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to "),e("code",[t._v("maxRotation")]),t._v(" before skipping any. Turn "),e("code",[t._v("autoSkip")]),t._v(" off to show all labels no matter what.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("autoSkipPadding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Padding between the ticks on the horizontal axis when "),e("code",[t._v("autoSkip")]),t._v(" is enabled.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("includeBounds")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Should the defined "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(' values be presented as ticks even if they are not "nice".')])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labelOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). "),e("em",[t._v("Note: this can cause labels at the edges to be cropped by the edge of the canvas")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("50")])]),t._v(" "),e("td",[t._v("Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minRotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Minimum rotation for tick labels. "),e("em",[t._v("Note: Only applicable to horizontal scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("mirror")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Flips tick labels around axis, displaying the labels inside the chart instead of outside. "),e("em",[t._v("Note: Only applicable to vertical scales.")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally, the logarithmic scale uses numeric data.")])])}),[],!1,null,null,null);e.default=v.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/14.b98fea97.js b/docs/master/assets/js/14.c564b266.js similarity index 96% rename from docs/master/assets/js/14.b98fea97.js rename to docs/master/assets/js/14.c564b266.js index 97d86e650f..bc1a83d95b 100644 --- a/docs/master/assets/js/14.b98fea97.js +++ b/docs/master/assets/js/14.c564b266.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{347:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-animations"}},[t._v("#")]),t._v(" Class: Animations")]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Animations")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("animations")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("("),e("code",[t._v("animations")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("target")]),t._v(", "),e("code",[t._v("values")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("target")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("values")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:33"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{347:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-animations"}},[t._v("#")]),t._v(" Class: Animations")]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Animations")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("animations")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("("),e("code",[t._v("animations")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("animations")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("target")]),t._v(", "),e("code",[t._v("values")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("target")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("values")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:33"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/140.d4adcd65.js b/docs/master/assets/js/140.d6a5488c.js similarity index 99% rename from docs/master/assets/js/140.d4adcd65.js rename to docs/master/assets/js/140.d6a5488c.js index 5aea0fa733..cb64fce291 100644 --- a/docs/master/assets/js/140.d4adcd65.js +++ b/docs/master/assets/js/140.d6a5488c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{470:function(t,a,e){"use strict";e.r(a);var s=e(3),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"time-cartesian-axis"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#time-cartesian-axis"}},[t._v("#")]),t._v(" Time Cartesian Axis")]),t._v(" "),a("p",[t._v("The time scale is used to display times and dates. Data are spread according to the amount of time between data points. When building its ticks, it will automatically calculate the most comfortable unit base on the size of the scale.")]),t._v(" "),a("h2",{attrs:{id:"date-adapters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#date-adapters"}},[t._v("#")]),t._v(" Date Adapters")]),t._v(" "),a("p",[t._v("The time scale "),a("strong",[t._v("requires")]),t._v(" both a date library and a corresponding adapter to be present. Please choose from the "),a("a",{attrs:{href:"https://github.com/chartjs/awesome#adapters",target:"_blank",rel:"noopener noreferrer"}},[t._v("available adapters"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"data-sets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-sets"}},[t._v("#")]),t._v(" Data Sets")]),t._v(" "),a("h3",{attrs:{id:"input-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#input-data"}},[t._v("#")]),t._v(" Input Data")]),t._v(" "),a("p",[t._v("See "),a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("data structures")]),t._v(".")],1),t._v(" "),a("h3",{attrs:{id:"date-formats"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#date-formats"}},[t._v("#")]),t._v(" Date Formats")]),t._v(" "),a("p",[t._v("When providing data for the time scale, Chart.js uses timestamps defined as milliseconds since the epoch (midnight January 1, 1970, UTC) internally. However, Chart.js also supports all of the formats that your chosen date adapter accepts. You should use timestamps if you'd like to set "),a("code",[t._v("parsing: false")]),t._v(" for better performance.")]),t._v(" "),a("h2",{attrs:{id:"configuration-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),a("h3",{attrs:{id:"time-axis-specific-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#time-axis-specific-options"}},[t._v("#")]),t._v(" Time Axis specific options")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("min")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The minimum item to display. "),a("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("max")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The maximum item to display. "),a("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMin")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The minimum item to display if there is no datapoint before it. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMax")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The maximum item to display if there is no datapoint behind it. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("adapters.date")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("code",[t._v("{}")])]),t._v(" "),a("td",[t._v("Options for adapter for external date library if that adapter needs or supports options")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("bounds")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'data'")])]),t._v(" "),a("td",[t._v("Determines the scale bounds. "),a("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("offsetAfterAutoskip")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If true, bar chart offsets are computed with auto skipped ticks.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("ticks.source")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'auto'")])]),t._v(" "),a("td",[t._v("How ticks are generated. "),a("a",{attrs:{href:"#ticks-source"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.displayFormats")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Sets how different time units are displayed. "),a("a",{attrs:{href:"#display-formats"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.isoWeekday")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If "),a("code",[t._v("boolean")]),t._v(" and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If "),a("code",[t._v("number")]),t._v(", the index of the first day of the week (0 - Sunday, 6 - Saturday)")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.parser")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v("|"),a("code",[t._v("function")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Custom parser for dates. "),a("a",{attrs:{href:"#parser"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.round")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If defined, dates will be rounded to the start of this unit. See "),a("a",{attrs:{href:"#time-units"}},[t._v("Time Units")]),t._v(" below for the allowed units.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.tooltipFormat")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The format string to use for the tooltip.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.unit")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If defined, will force the unit to be a certain type. See "),a("a",{attrs:{href:"#time-units"}},[t._v("Time Units")]),t._v(" section below for details.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.minUnit")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'millisecond'")])]),t._v(" "),a("td",[t._v("The minimum display format to be used for a time unit.")])])])]),t._v(" "),a("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("bounds")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'ticks'")])]),t._v(" "),a("td",[t._v("Determines the scale bounds. "),a("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("clip")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("position")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Position of the axis. "),a("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stack")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Stack group. Axes at the same "),a("code",[t._v("position")]),t._v(" with same "),a("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stackWeight")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("1")]),t._v(" "),a("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("axis")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Which type of axis this is. Possible values are: "),a("code",[t._v("'x'")]),t._v(", "),a("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),a("code",[t._v("'x'")]),t._v(" or "),a("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("offset")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),a("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("title")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Scale title configuration. "),a("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),a("h3",{attrs:{id:"common-options-to-all-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("alignToPixels")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("backgroundColor")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/colors.html"}},[a("code",[t._v("Color")])])],1),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Background color of the scale area.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("border")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Border configuration. "),a("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("display")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("Controls the axis global visibility (visible when "),a("code",[t._v("true")]),t._v(", hidden when "),a("code",[t._v("false")]),t._v("). When "),a("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("grid")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Grid line configuration. "),a("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("min")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("max")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("reverse")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("Reverse the scale.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stacked")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("Should the data be stacked. "),a("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMax")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Adjustment used when calculating the maximum data value. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMin")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Adjustment used when calculating the minimum data value. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("ticks")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Tick configuration. "),a("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("weight")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("0")])]),t._v(" "),a("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),a("h4",{attrs:{id:"time-units"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#time-units"}},[t._v("#")]),t._v(" Time Units")]),t._v(" "),a("p",[t._v("The following time measurements are supported. The names can be passed as strings to the "),a("code",[t._v("time.unit")]),t._v(" config option to force a certain unit.")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'millisecond'")])]),t._v(" "),a("li",[a("code",[t._v("'second'")])]),t._v(" "),a("li",[a("code",[t._v("'minute'")])]),t._v(" "),a("li",[a("code",[t._v("'hour'")])]),t._v(" "),a("li",[a("code",[t._v("'day'")])]),t._v(" "),a("li",[a("code",[t._v("'week'")])]),t._v(" "),a("li",[a("code",[t._v("'month'")])]),t._v(" "),a("li",[a("code",[t._v("'quarter'")])]),t._v(" "),a("li",[a("code",[t._v("'year'")])])]),t._v(" "),a("p",[t._v("For example, to create a chart with a time scale that always displayed units per month, the following config could be used.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("time")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("unit")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'month'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h4",{attrs:{id:"display-formats"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#display-formats"}},[t._v("#")]),t._v(" Display Formats")]),t._v(" "),a("p",[t._v("You may specify a map of display formats with a key for each unit:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("millisecond")])]),t._v(" "),a("li",[a("code",[t._v("second")])]),t._v(" "),a("li",[a("code",[t._v("minute")])]),t._v(" "),a("li",[a("code",[t._v("hour")])]),t._v(" "),a("li",[a("code",[t._v("day")])]),t._v(" "),a("li",[a("code",[t._v("week")])]),t._v(" "),a("li",[a("code",[t._v("month")])]),t._v(" "),a("li",[a("code",[t._v("quarter")])]),t._v(" "),a("li",[a("code",[t._v("year")])])]),t._v(" "),a("p",[t._v("The format string used as a value depends on the date adapter you chose to use.")]),t._v(" "),a("p",[t._v("For example, to set the display format for the "),a("code",[t._v("quarter")]),t._v(" unit to show the month and year, the following config might be passed to the chart constructor.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("time")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("displayFormats")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("quarter")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MMM YYYY'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h4",{attrs:{id:"ticks-source"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ticks-source"}},[t._v("#")]),t._v(" Ticks Source")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("ticks.source")]),t._v(" property controls the ticks generation.")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'auto'")]),t._v(': generates "optimal" ticks based on scale size and time options')]),t._v(" "),a("li",[a("code",[t._v("'data'")]),t._v(": generates ticks from data (including labels from data "),a("code",[t._v("{x|y}")]),t._v(" objects)")]),t._v(" "),a("li",[a("code",[t._v("'labels'")]),t._v(": generates ticks from user given "),a("code",[t._v("labels")]),t._v(" ONLY")])]),t._v(" "),a("h4",{attrs:{id:"parser"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parser"}},[t._v("#")]),t._v(" Parser")]),t._v(" "),a("p",[t._v("If this property is defined as a string, it is interpreted as a custom format to be used by the date adapter to parse the date.")]),t._v(" "),a("p",[t._v("If this is a function, it must return a type that can be handled by your date adapter's "),a("code",[t._v("parse")]),t._v(" method.")]),t._v(" "),a("h2",{attrs:{id:"min-max-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#min-max-configuration"}},[t._v("#")]),t._v(" Min Max Configuration")]),t._v(" "),a("p",[t._v("For both the "),a("code",[t._v("min")]),t._v(" and "),a("code",[t._v("max")]),t._v(" properties, the value must be "),a("code",[t._v("string")]),t._v(" that is parsable by your date adapter or a number with the amount of milliseconds that have elapsed since UNIX epoch.\nIn the example below the x axis will start at 7 November 2021.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-06 23:39:30'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-07 01:00:28'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-07 09:00:28'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-07 00:00:00'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"changing-the-scale-type-from-time-scale-to-logarithmic-linear-scale"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#changing-the-scale-type-from-time-scale-to-logarithmic-linear-scale"}},[t._v("#")]),t._v(" Changing the scale type from Time scale to Logarithmic/Linear scale.")]),t._v(" "),a("p",[t._v("When changing the scale type from Time scale to Logarithmic/Linear scale, you need to add "),a("code",[t._v("bounds: 'ticks'")]),t._v(" to the scale options. Changing the "),a("code",[t._v("bounds")]),t._v(" parameter is necessary because its default value is the "),a("code",[t._v("'data'")]),t._v(" for the Time scale.")]),t._v(" "),a("p",[t._v("Initial config:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Scale update:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'logarithmic'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bounds")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ticks'")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"internal-data-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),a("p",[t._v("Internally time scale uses milliseconds since epoch")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{472:function(t,a,e){"use strict";e.r(a);var s=e(3),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"time-cartesian-axis"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#time-cartesian-axis"}},[t._v("#")]),t._v(" Time Cartesian Axis")]),t._v(" "),a("p",[t._v("The time scale is used to display times and dates. Data are spread according to the amount of time between data points. When building its ticks, it will automatically calculate the most comfortable unit base on the size of the scale.")]),t._v(" "),a("h2",{attrs:{id:"date-adapters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#date-adapters"}},[t._v("#")]),t._v(" Date Adapters")]),t._v(" "),a("p",[t._v("The time scale "),a("strong",[t._v("requires")]),t._v(" both a date library and a corresponding adapter to be present. Please choose from the "),a("a",{attrs:{href:"https://github.com/chartjs/awesome#adapters",target:"_blank",rel:"noopener noreferrer"}},[t._v("available adapters"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"data-sets"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-sets"}},[t._v("#")]),t._v(" Data Sets")]),t._v(" "),a("h3",{attrs:{id:"input-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#input-data"}},[t._v("#")]),t._v(" Input Data")]),t._v(" "),a("p",[t._v("See "),a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("data structures")]),t._v(".")],1),t._v(" "),a("h3",{attrs:{id:"date-formats"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#date-formats"}},[t._v("#")]),t._v(" Date Formats")]),t._v(" "),a("p",[t._v("When providing data for the time scale, Chart.js uses timestamps defined as milliseconds since the epoch (midnight January 1, 1970, UTC) internally. However, Chart.js also supports all of the formats that your chosen date adapter accepts. You should use timestamps if you'd like to set "),a("code",[t._v("parsing: false")]),t._v(" for better performance.")]),t._v(" "),a("h2",{attrs:{id:"configuration-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),a("h3",{attrs:{id:"time-axis-specific-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#time-axis-specific-options"}},[t._v("#")]),t._v(" Time Axis specific options")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("min")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The minimum item to display. "),a("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("max")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The maximum item to display. "),a("a",{attrs:{href:"#min-max-configuration"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMin")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The minimum item to display if there is no datapoint before it. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMax")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The maximum item to display if there is no datapoint behind it. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("adapters.date")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("code",[t._v("{}")])]),t._v(" "),a("td",[t._v("Options for adapter for external date library if that adapter needs or supports options")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("bounds")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'data'")])]),t._v(" "),a("td",[t._v("Determines the scale bounds. "),a("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("offsetAfterAutoskip")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If true, bar chart offsets are computed with auto skipped ticks.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("ticks.source")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'auto'")])]),t._v(" "),a("td",[t._v("How ticks are generated. "),a("a",{attrs:{href:"#ticks-source"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.displayFormats")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Sets how different time units are displayed. "),a("a",{attrs:{href:"#display-formats"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.isoWeekday")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If "),a("code",[t._v("boolean")]),t._v(" and true and the unit is set to 'week', then the first day of the week will be Monday. Otherwise, it will be Sunday. If "),a("code",[t._v("number")]),t._v(", the index of the first day of the week (0 - Sunday, 6 - Saturday)")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.parser")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v("|"),a("code",[t._v("function")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Custom parser for dates. "),a("a",{attrs:{href:"#parser"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.round")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If defined, dates will be rounded to the start of this unit. See "),a("a",{attrs:{href:"#time-units"}},[t._v("Time Units")]),t._v(" below for the allowed units.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.tooltipFormat")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("The format string to use for the tooltip.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.unit")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If defined, will force the unit to be a certain type. See "),a("a",{attrs:{href:"#time-units"}},[t._v("Time Units")]),t._v(" section below for details.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("time.minUnit")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'millisecond'")])]),t._v(" "),a("td",[t._v("The minimum display format to be used for a time unit.")])])])]),t._v(" "),a("h3",{attrs:{id:"common-options-to-all-cartesian-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-cartesian-axes"}},[t._v("#")]),t._v(" Common options to all cartesian axes")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("bounds")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'ticks'")])]),t._v(" "),a("td",[t._v("Determines the scale bounds. "),a("RouterLink",{attrs:{to:"/axes/cartesian/#scale-bounds"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("clip")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("If true, clip the dataset drawing against the size of the scale instead of chart area")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("position")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v(" | "),a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Position of the axis. "),a("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stack")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Stack group. Axes at the same "),a("code",[t._v("position")]),t._v(" with same "),a("code",[t._v("stack")]),t._v(" are stacked.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stackWeight")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("1")]),t._v(" "),a("td",[t._v("Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("axis")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Which type of axis this is. Possible values are: "),a("code",[t._v("'x'")]),t._v(", "),a("code",[t._v("'y'")]),t._v(". If not set, this is inferred from the first character of the ID which should be "),a("code",[t._v("'x'")]),t._v(" or "),a("code",[t._v("'y'")]),t._v(".")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("offset")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to "),a("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("title")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Scale title configuration. "),a("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("more...")])],1)])])]),t._v(" "),a("h3",{attrs:{id:"common-options-to-all-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#common-options-to-all-axes"}},[t._v("#")]),t._v(" Common options to all axes")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("alignToPixels")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("backgroundColor")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/colors.html"}},[a("code",[t._v("Color")])])],1),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Background color of the scale area.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("border")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Border configuration. "),a("RouterLink",{attrs:{to:"/axes/styling.html#border-configuration"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("display")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("Controls the axis global visibility (visible when "),a("code",[t._v("true")]),t._v(", hidden when "),a("code",[t._v("false")]),t._v("). When "),a("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("grid")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Grid line configuration. "),a("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("min")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("max")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("reverse")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("Reverse the scale.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stacked")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("Should the data be stacked. "),a("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMax")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Adjustment used when calculating the maximum data value. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("suggestedMin")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Adjustment used when calculating the minimum data value. "),a("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("ticks")])]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td"),t._v(" "),a("td",[t._v("Tick configuration. "),a("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("weight")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("0")])]),t._v(" "),a("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),a("h4",{attrs:{id:"time-units"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#time-units"}},[t._v("#")]),t._v(" Time Units")]),t._v(" "),a("p",[t._v("The following time measurements are supported. The names can be passed as strings to the "),a("code",[t._v("time.unit")]),t._v(" config option to force a certain unit.")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'millisecond'")])]),t._v(" "),a("li",[a("code",[t._v("'second'")])]),t._v(" "),a("li",[a("code",[t._v("'minute'")])]),t._v(" "),a("li",[a("code",[t._v("'hour'")])]),t._v(" "),a("li",[a("code",[t._v("'day'")])]),t._v(" "),a("li",[a("code",[t._v("'week'")])]),t._v(" "),a("li",[a("code",[t._v("'month'")])]),t._v(" "),a("li",[a("code",[t._v("'quarter'")])]),t._v(" "),a("li",[a("code",[t._v("'year'")])])]),t._v(" "),a("p",[t._v("For example, to create a chart with a time scale that always displayed units per month, the following config could be used.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("time")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("unit")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'month'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h4",{attrs:{id:"display-formats"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#display-formats"}},[t._v("#")]),t._v(" Display Formats")]),t._v(" "),a("p",[t._v("You may specify a map of display formats with a key for each unit:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("millisecond")])]),t._v(" "),a("li",[a("code",[t._v("second")])]),t._v(" "),a("li",[a("code",[t._v("minute")])]),t._v(" "),a("li",[a("code",[t._v("hour")])]),t._v(" "),a("li",[a("code",[t._v("day")])]),t._v(" "),a("li",[a("code",[t._v("week")])]),t._v(" "),a("li",[a("code",[t._v("month")])]),t._v(" "),a("li",[a("code",[t._v("quarter")])]),t._v(" "),a("li",[a("code",[t._v("year")])])]),t._v(" "),a("p",[t._v("The format string used as a value depends on the date adapter you chose to use.")]),t._v(" "),a("p",[t._v("For example, to set the display format for the "),a("code",[t._v("quarter")]),t._v(" unit to show the month and year, the following config might be passed to the chart constructor.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("time")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("displayFormats")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("quarter")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MMM YYYY'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h4",{attrs:{id:"ticks-source"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ticks-source"}},[t._v("#")]),t._v(" Ticks Source")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("ticks.source")]),t._v(" property controls the ticks generation.")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'auto'")]),t._v(': generates "optimal" ticks based on scale size and time options')]),t._v(" "),a("li",[a("code",[t._v("'data'")]),t._v(": generates ticks from data (including labels from data "),a("code",[t._v("{x|y}")]),t._v(" objects)")]),t._v(" "),a("li",[a("code",[t._v("'labels'")]),t._v(": generates ticks from user given "),a("code",[t._v("labels")]),t._v(" ONLY")])]),t._v(" "),a("h4",{attrs:{id:"parser"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parser"}},[t._v("#")]),t._v(" Parser")]),t._v(" "),a("p",[t._v("If this property is defined as a string, it is interpreted as a custom format to be used by the date adapter to parse the date.")]),t._v(" "),a("p",[t._v("If this is a function, it must return a type that can be handled by your date adapter's "),a("code",[t._v("parse")]),t._v(" method.")]),t._v(" "),a("h2",{attrs:{id:"min-max-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#min-max-configuration"}},[t._v("#")]),t._v(" Min Max Configuration")]),t._v(" "),a("p",[t._v("For both the "),a("code",[t._v("min")]),t._v(" and "),a("code",[t._v("max")]),t._v(" properties, the value must be "),a("code",[t._v("string")]),t._v(" that is parsable by your date adapter or a number with the amount of milliseconds that have elapsed since UNIX epoch.\nIn the example below the x axis will start at 7 November 2021.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-06 23:39:30'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-07 01:00:28'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-07 09:00:28'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2021-11-07 00:00:00'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"changing-the-scale-type-from-time-scale-to-logarithmic-linear-scale"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#changing-the-scale-type-from-time-scale-to-logarithmic-linear-scale"}},[t._v("#")]),t._v(" Changing the scale type from Time scale to Logarithmic/Linear scale.")]),t._v(" "),a("p",[t._v("When changing the scale type from Time scale to Logarithmic/Linear scale, you need to add "),a("code",[t._v("bounds: 'ticks'")]),t._v(" to the scale options. Changing the "),a("code",[t._v("bounds")]),t._v(" parameter is necessary because its default value is the "),a("code",[t._v("'data'")]),t._v(" for the Time scale.")]),t._v(" "),a("p",[t._v("Initial config:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Scale update:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'logarithmic'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bounds")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'ticks'")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"internal-data-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),a("p",[t._v("Internally time scale uses milliseconds since epoch")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/141.7286da74.js b/docs/master/assets/js/141.809e6040.js similarity index 98% rename from docs/master/assets/js/141.7286da74.js rename to docs/master/assets/js/141.809e6040.js index 9072c9d641..d35a60516b 100644 --- a/docs/master/assets/js/141.7286da74.js +++ b/docs/master/assets/js/141.809e6040.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{471:function(t,s,a){"use strict";a.r(s);var e=a(3),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"time-series-axis"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#time-series-axis"}},[t._v("#")]),t._v(" Time Series Axis")]),t._v(" "),s("p",[t._v("The time series scale extends from the time scale and supports all the same options. However, for the time series scale, each data point is spread equidistant.")]),t._v(" "),s("h2",{attrs:{id:"example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[t._v("#")]),t._v(" Example")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'timeseries'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"more-details"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#more-details"}},[t._v("#")]),t._v(" More details")]),t._v(" "),s("p",[t._v("Please see "),s("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[t._v("the time scale documentation")]),t._v(" for all other details.")],1)])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{473:function(t,s,a){"use strict";a.r(s);var e=a(3),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"time-series-axis"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#time-series-axis"}},[t._v("#")]),t._v(" Time Series Axis")]),t._v(" "),s("p",[t._v("The time series scale extends from the time scale and supports all the same options. However, for the time series scale, each data point is spread equidistant.")]),t._v(" "),s("h2",{attrs:{id:"example"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[t._v("#")]),t._v(" Example")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'timeseries'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"more-details"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#more-details"}},[t._v("#")]),t._v(" More details")]),t._v(" "),s("p",[t._v("Please see "),s("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[t._v("the time scale documentation")]),t._v(" for all other details.")],1)])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/143.3afbcbf7.js b/docs/master/assets/js/143.21ca424a.js similarity index 99% rename from docs/master/assets/js/143.3afbcbf7.js rename to docs/master/assets/js/143.21ca424a.js index b3bff4949b..9f4eb3480c 100644 --- a/docs/master/assets/js/143.3afbcbf7.js +++ b/docs/master/assets/js/143.21ca424a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{473:function(t,a,e){"use strict";e.r(a);var s=e(3),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"labeling-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#labeling-axes"}},[t._v("#")]),t._v(" Labeling Axes")]),t._v(" "),a("p",[t._v("When creating a chart, you want to tell the viewer what data they are viewing. To do this, you need to label the axis.")]),t._v(" "),a("h2",{attrs:{id:"scale-title-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scale-title-configuration"}},[t._v("#")]),t._v(" Scale Title Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId].title")]),t._v(", it defines options for the scale title. Note that this only applies to cartesian axes.")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("display")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If true, display the axis title.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("align")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'center'")])]),t._v(" "),a("td",[t._v("Alignment of the axis title. Possible options are "),a("code",[t._v("'start'")]),t._v(", "),a("code",[t._v("'center'")]),t._v(" and "),a("code",[t._v("'end'")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("text")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v("|"),a("code",[t._v("string[]")])]),t._v(" "),a("td",[a("code",[t._v("''")])]),t._v(" "),a("td",[t._v('The text for the title. (i.e. "# of People" or "Response Choices").')])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("color")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/colors.html"}},[a("code",[t._v("Color")])])],1),t._v(" "),a("td",[a("code",[t._v("Chart.defaults.color")])]),t._v(" "),a("td",[t._v("Color of label.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("font")])]),t._v(" "),a("td",[a("code",[t._v("Font")])]),t._v(" "),a("td",[a("code",[t._v("Chart.defaults.font")])]),t._v(" "),a("td",[t._v("See "),a("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("padding")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/padding.html"}},[a("code",[t._v("Padding")])])],1),t._v(" "),a("td",[a("code",[t._v("4")])]),t._v(" "),a("td",[t._v("Padding to apply around scale labels. Only "),a("code",[t._v("top")]),t._v(", "),a("code",[t._v("bottom")]),t._v(" and "),a("code",[t._v("y")]),t._v(" are implemented.")])])])]),t._v(" "),a("h2",{attrs:{id:"creating-custom-tick-formats"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#creating-custom-tick-formats"}},[t._v("#")]),t._v(" Creating Custom Tick Formats")]),t._v(" "),a("p",[t._v("It is also common to want to change the tick marks to include information about the data type. For example, adding a dollar sign ('$').\nTo do this, you need to override the "),a("code",[t._v("ticks.callback")]),t._v(" method in the axis configuration.")]),t._v(" "),a("p",[t._v("The method receives 3 arguments:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("value")]),t._v(" - the tick value in the "),a("strong",[t._v("internal data format")]),t._v(" of the associated scale. For time scale, it is a timestamp.")]),t._v(" "),a("li",[a("code",[t._v("index")]),t._v(" - the tick index in the ticks array.")]),t._v(" "),a("li",[a("code",[t._v("ticks")]),t._v(" - the array containing all of the "),a("a",{attrs:{href:"../api/interfaces/Tick"}},[t._v("tick objects")]),t._v(".")])]),t._v(" "),a("p",[t._v("The call to the method is scoped to the scale. "),a("code",[t._v("this")]),t._v(" inside the method is the scale object.")]),t._v(" "),a("p",[t._v("If the callback returns "),a("code",[t._v("null")]),t._v(" or "),a("code",[t._v("undefined")]),t._v(" the associated grid line will be hidden.")]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),a("p",[t._v("The "),a("a",{attrs:{href:"../axes/cartesian/category"}},[t._v("category axis")]),t._v(", which is the default x-axis for line and bar charts, uses the "),a("code",[t._v("index")]),t._v(" as internal data format. For accessing the label, use "),a("code",[t._v("this.getLabelForValue(value)")]),t._v(". "),a("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelforvalue"}},[t._v("API: getLabelForValue")])],1)]),t._v(" "),a("p",[t._v("In the following example, every label of the Y-axis would be displayed with a dollar sign at the front.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Include a dollar sign in the ticks")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("callback")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ticks")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'$'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Keep in mind that overriding "),a("code",[t._v("ticks.callback")]),t._v(" means that you are responsible for all formatting of the label. Depending on your use case, you may want to call the default formatter and then modify its output. In the example above, that would look like:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// call the default formatter, forwarding `this`")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'$'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Ticks"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("formatters"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("numeric")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("apply")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ticks"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Related samples:")]),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"../samples/scale-options/ticks"}},[t._v("Tick configuration sample")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{475:function(t,a,e){"use strict";e.r(a);var s=e(3),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"labeling-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#labeling-axes"}},[t._v("#")]),t._v(" Labeling Axes")]),t._v(" "),a("p",[t._v("When creating a chart, you want to tell the viewer what data they are viewing. To do this, you need to label the axis.")]),t._v(" "),a("h2",{attrs:{id:"scale-title-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scale-title-configuration"}},[t._v("#")]),t._v(" Scale Title Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.scales[scaleId].title")]),t._v(", it defines options for the scale title. Note that this only applies to cartesian axes.")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("display")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",[t._v("If true, display the axis title.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("align")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'center'")])]),t._v(" "),a("td",[t._v("Alignment of the axis title. Possible options are "),a("code",[t._v("'start'")]),t._v(", "),a("code",[t._v("'center'")]),t._v(" and "),a("code",[t._v("'end'")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("text")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v("|"),a("code",[t._v("string[]")])]),t._v(" "),a("td",[a("code",[t._v("''")])]),t._v(" "),a("td",[t._v('The text for the title. (i.e. "# of People" or "Response Choices").')])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("color")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/colors.html"}},[a("code",[t._v("Color")])])],1),t._v(" "),a("td",[a("code",[t._v("Chart.defaults.color")])]),t._v(" "),a("td",[t._v("Color of label.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("font")])]),t._v(" "),a("td",[a("code",[t._v("Font")])]),t._v(" "),a("td",[a("code",[t._v("Chart.defaults.font")])]),t._v(" "),a("td",[t._v("See "),a("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("padding")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/padding.html"}},[a("code",[t._v("Padding")])])],1),t._v(" "),a("td",[a("code",[t._v("4")])]),t._v(" "),a("td",[t._v("Padding to apply around scale labels. Only "),a("code",[t._v("top")]),t._v(", "),a("code",[t._v("bottom")]),t._v(" and "),a("code",[t._v("y")]),t._v(" are implemented.")])])])]),t._v(" "),a("h2",{attrs:{id:"creating-custom-tick-formats"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#creating-custom-tick-formats"}},[t._v("#")]),t._v(" Creating Custom Tick Formats")]),t._v(" "),a("p",[t._v("It is also common to want to change the tick marks to include information about the data type. For example, adding a dollar sign ('$').\nTo do this, you need to override the "),a("code",[t._v("ticks.callback")]),t._v(" method in the axis configuration.")]),t._v(" "),a("p",[t._v("The method receives 3 arguments:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("value")]),t._v(" - the tick value in the "),a("strong",[t._v("internal data format")]),t._v(" of the associated scale. For time scale, it is a timestamp.")]),t._v(" "),a("li",[a("code",[t._v("index")]),t._v(" - the tick index in the ticks array.")]),t._v(" "),a("li",[a("code",[t._v("ticks")]),t._v(" - the array containing all of the "),a("a",{attrs:{href:"../api/interfaces/Tick"}},[t._v("tick objects")]),t._v(".")])]),t._v(" "),a("p",[t._v("The call to the method is scoped to the scale. "),a("code",[t._v("this")]),t._v(" inside the method is the scale object.")]),t._v(" "),a("p",[t._v("If the callback returns "),a("code",[t._v("null")]),t._v(" or "),a("code",[t._v("undefined")]),t._v(" the associated grid line will be hidden.")]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),a("p",[t._v("The "),a("a",{attrs:{href:"../axes/cartesian/category"}},[t._v("category axis")]),t._v(", which is the default x-axis for line and bar charts, uses the "),a("code",[t._v("index")]),t._v(" as internal data format. For accessing the label, use "),a("code",[t._v("this.getLabelForValue(value)")]),t._v(". "),a("RouterLink",{attrs:{to:"/api/classes/Scale.html#getlabelforvalue"}},[t._v("API: getLabelForValue")])],1)]),t._v(" "),a("p",[t._v("In the following example, every label of the Y-axis would be displayed with a dollar sign at the front.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Include a dollar sign in the ticks")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("callback")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ticks")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'$'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Keep in mind that overriding "),a("code",[t._v("ticks.callback")]),t._v(" means that you are responsible for all formatting of the label. Depending on your use case, you may want to call the default formatter and then modify its output. In the example above, that would look like:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// call the default formatter, forwarding `this`")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'$'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Ticks"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("formatters"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("numeric")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("apply")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" ticks"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Related samples:")]),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"../samples/scale-options/ticks"}},[t._v("Tick configuration sample")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/144.c34e46a5.js b/docs/master/assets/js/144.2cd7b7d4.js similarity index 98% rename from docs/master/assets/js/144.c34e46a5.js rename to docs/master/assets/js/144.2cd7b7d4.js index 955ed87ccf..322bdd11d3 100644 --- a/docs/master/assets/js/144.c34e46a5.js +++ b/docs/master/assets/js/144.2cd7b7d4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{480:function(n,a,e){"use strict";e.r(a);var t=e(3),s=Object(t.a)({},(function(){var n=this,a=n._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[a("h1",{attrs:{id:"radial-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#radial-axes"}},[n._v("#")]),n._v(" Radial Axes")]),n._v(" "),a("p",[n._v("Radial axes are used specifically for the radar and polar area chart types. These axes overlay the chart area, rather than being positioned on one of the edges. One radial axis is included by default in Chart.js.")]),n._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[n._v("radialLinear")])],1)]),n._v(" "),a("h2",{attrs:{id:"visual-components"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#visual-components"}},[n._v("#")]),n._v(" Visual Components")]),n._v(" "),a("p",[n._v("A radial axis is composed of visual components that can be individually configured. These components are:")]),n._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"#angle-lines"}},[n._v("angle lines")])]),n._v(" "),a("li",[a("a",{attrs:{href:"#grid-lines"}},[n._v("grid lines")])]),n._v(" "),a("li",[a("a",{attrs:{href:"#point-labels"}},[n._v("point labels")])]),n._v(" "),a("li",[a("a",{attrs:{href:"#ticks"}},[n._v("ticks")])])]),n._v(" "),a("h3",{attrs:{id:"angle-lines"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#angle-lines"}},[n._v("#")]),n._v(" Angle Lines")]),n._v(" "),a("p",[n._v("The grid lines for an axis are drawn on the chart area. They stretch out from the center towards the edge of the canvas. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n angleLines: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),a("h3",{attrs:{id:"grid-lines"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#grid-lines"}},[n._v("#")]),n._v(" Grid Lines")]),n._v(" "),a("p",[n._v("The grid lines for an axis are drawn on the chart area. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n grid: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),a("h3",{attrs:{id:"point-labels"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#point-labels"}},[n._v("#")]),n._v(" Point Labels")]),n._v(" "),a("p",[n._v("The point labels indicate the value for each angle line. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n pointLabels: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),a("h3",{attrs:{id:"ticks"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[n._v("#")]),n._v(" Ticks")]),n._v(" "),a("p",[n._v("The ticks are used to label values based on how far they are from the center of the axis. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n ticks: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{476:function(n,a,e){"use strict";e.r(a);var t=e(3),s=Object(t.a)({},(function(){var n=this,a=n._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[a("h1",{attrs:{id:"radial-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#radial-axes"}},[n._v("#")]),n._v(" Radial Axes")]),n._v(" "),a("p",[n._v("Radial axes are used specifically for the radar and polar area chart types. These axes overlay the chart area, rather than being positioned on one of the edges. One radial axis is included by default in Chart.js.")]),n._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[n._v("radialLinear")])],1)]),n._v(" "),a("h2",{attrs:{id:"visual-components"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#visual-components"}},[n._v("#")]),n._v(" Visual Components")]),n._v(" "),a("p",[n._v("A radial axis is composed of visual components that can be individually configured. These components are:")]),n._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"#angle-lines"}},[n._v("angle lines")])]),n._v(" "),a("li",[a("a",{attrs:{href:"#grid-lines"}},[n._v("grid lines")])]),n._v(" "),a("li",[a("a",{attrs:{href:"#point-labels"}},[n._v("point labels")])]),n._v(" "),a("li",[a("a",{attrs:{href:"#ticks"}},[n._v("ticks")])])]),n._v(" "),a("h3",{attrs:{id:"angle-lines"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#angle-lines"}},[n._v("#")]),n._v(" Angle Lines")]),n._v(" "),a("p",[n._v("The grid lines for an axis are drawn on the chart area. They stretch out from the center towards the edge of the canvas. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n angleLines: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),a("h3",{attrs:{id:"grid-lines"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#grid-lines"}},[n._v("#")]),n._v(" Grid Lines")]),n._v(" "),a("p",[n._v("The grid lines for an axis are drawn on the chart area. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n grid: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),a("h3",{attrs:{id:"point-labels"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#point-labels"}},[n._v("#")]),n._v(" Point Labels")]),n._v(" "),a("p",[n._v("The point labels indicate the value for each angle line. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n pointLabels: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),a("h3",{attrs:{id:"ticks"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[n._v("#")]),n._v(" Ticks")]),n._v(" "),a("p",[n._v("The ticks are used to label values based on how far they are from the center of the axis. In the example below, they are red.")]),n._v(" "),a("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First dataset',\n backgroundColor: 'rgba(54, 162, 235, 0.5)',\n borderColor: 'rgb(54, 162, 235)',\n borderWidth: 1,\n data: [10, 20, 30, 40, 50, 0, 5],\n }]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data,\n options: {\n scales: {\n r: {\n ticks: {\n color: 'red'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/145.1f735a34.js b/docs/master/assets/js/145.f62ab293.js similarity index 99% rename from docs/master/assets/js/145.1f735a34.js rename to docs/master/assets/js/145.f62ab293.js index 8bad4f9ffe..63bee6fac4 100644 --- a/docs/master/assets/js/145.1f735a34.js +++ b/docs/master/assets/js/145.f62ab293.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[145],{472:function(t,e,a){"use strict";a.r(e);var s=a(3),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"linear-radial-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-radial-axis"}},[t._v("#")]),t._v(" Linear Radial Axis")]),t._v(" "),e("p",[t._v("The linear radial scale is used to chart numerical data. As the name suggests, linear interpolation is used to determine where a value lies in relation to the center of the axis.")]),t._v(" "),e("p",[t._v("The following additional configuration options are provided by the radial linear scale.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"linear-radial-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-radial-axis-specific-options"}},[t._v("#")]),t._v(" Linear Radial Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("animate")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Whether to animate scaling the chart from the centre")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("angleLines")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Angle line configuration. "),e("a",{attrs:{href:"#angle-line-options"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("beginAtZero")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, scale will include 0 if it is not already included.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointLabels")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Point label configuration. "),e("a",{attrs:{href:"#point-label-options"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("startAngle")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Starting angle of the scale. In degrees, 0 is at top.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-options-for-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-for-all-axes"}},[t._v("#")]),t._v(" Common options for all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("a",{attrs:{href:"#grid-line-configuration"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"linear-radial-axis-specific-tick-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-radial-axis-specific-tick-options"}},[t._v("#")]),t._v(" Linear Radial Axis specific tick options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("count")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("The number of ticks to generate. If specified, this overrides the automatic generation.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("format")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("Intl.NumberFormat")]),e("OutboundLink")],1),t._v(" options used by the default label formatter")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("precision")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("If defined and "),e("code",[t._v("stepSize")]),t._v(" is not specified, the step size will be rounded to this many decimal places.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stepSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined fixed step size for the scale. "),e("a",{attrs:{href:"#step-size"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"grid-line-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grid-line-configuration"}},[t._v("#")]),t._v(" Grid Line Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].grid")]),t._v(", it defines options for the grid lines of the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Indexable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of dashes on grid lines. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0.0")])]),t._v(" "),e("td",[t._v("Offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("circular")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, gridlines are circular (on radar and polar area charts only).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If false, do not display grid lines for this axis.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("Stroke width of grid lines.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/axes/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"axis-range-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis-range-settings"}},[t._v("#")]),t._v(" Axis Range Settings")]),t._v(" "),e("p",[t._v("Given the number of axis range settings, it is important to understand how they all interact with each other.")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("suggestedMax")]),t._v(" and "),e("code",[t._v("suggestedMin")]),t._v(" settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaining the auto-fit behaviour.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" minDataValue "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mostNegativeValue"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ticks"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("suggestedMin"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" maxDataValue "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("max")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mostPositiveValue"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ticks"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("suggestedMax"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("In this example, the largest positive value is 50, but the data maximum is expanded out to 100. However, because the lowest data value is below the "),e("code",[t._v("suggestedMin")]),t._v(" setting, it is ignored.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'radar'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'First dataset'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("40")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("suggestedMin")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("suggestedMax")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("In contrast to the "),e("code",[t._v("suggested*")]),t._v(" settings, the "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(" settings set explicit ends to the axes. When these are set, some data points may not be visible.")]),t._v(" "),e("h2",{attrs:{id:"step-size"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-size"}},[t._v("#")]),t._v(" Step Size")]),t._v(" "),e("p",[t._v("If set, the scale ticks will be enumerated by multiple of "),e("code",[t._v("stepSize")]),t._v(", having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.")]),t._v(" "),e("p",[t._v("This example sets up a chart with a y axis that creates ticks at "),e("code",[t._v("0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5")]),t._v(".")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stepSize")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"angle-line-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#angle-line-options"}},[t._v("#")]),t._v(" Angle Line Options")]),t._v(" "),e("p",[t._v("The following options are used to configure angled lines that radiate from the center of the chart to the point labels.\nNamespace: "),e("code",[t._v("options.scales[scaleId].angleLines")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, angle lines are shown.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("Color of angled lines.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("Width of angled lines.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",[t._v("Yes"),e("sup",[t._v("1")])]),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of dashes on angled lines. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0.0")])]),t._v(" "),e("td",[t._v("Offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])])])]),t._v(" "),e("ol",[e("li",[t._v("the "),e("code",[t._v("borderDash")]),t._v(" setting only accepts a static value or a function. Passing an array of arrays is not supported.")])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#pointLabel"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"point-label-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#point-label-options"}},[t._v("#")]),t._v(" Point Label Options")]),t._v(" "),e("p",[t._v("The following options are used to configure the point labels that are shown on the perimeter of the scale.\nNamespace: "),e("code",[t._v("options.scales[scaleId].pointLabels")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("Background color of the point label.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderRadius")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Border radius of the point label")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, point labels are shown. When "),e("code",[t._v("display: 'auto'")]),t._v(", the label is hidden if it overlaps with another label.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Callback function to transform data labels to point labels. The default implementation simply returns the current string.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of label.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[t._v("5")]),t._v(" "),e("td",[t._v("Padding between chart and point labels.")])]),t._v(" "),e("tr",[e("td",[e("RouterLink",{attrs:{to:"/samples/other-charts/polar-area-center-labels.html"}},[e("code",[t._v("centerPointLabels")])])],1),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, point labels are centered.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#pointLabel"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally, the linear radial scale uses numeric data")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[145],{477:function(t,e,a){"use strict";a.r(e);var s=a(3),r=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"linear-radial-axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-radial-axis"}},[t._v("#")]),t._v(" Linear Radial Axis")]),t._v(" "),e("p",[t._v("The linear radial scale is used to chart numerical data. As the name suggests, linear interpolation is used to determine where a value lies in relation to the center of the axis.")]),t._v(" "),e("p",[t._v("The following additional configuration options are provided by the radial linear scale.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("h3",{attrs:{id:"linear-radial-axis-specific-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-radial-axis-specific-options"}},[t._v("#")]),t._v(" Linear Radial Axis specific options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("animate")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Whether to animate scaling the chart from the centre")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("angleLines")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Angle line configuration. "),e("a",{attrs:{href:"#angle-line-options"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("beginAtZero")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, scale will include 0 if it is not already included.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointLabels")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Point label configuration. "),e("a",{attrs:{href:"#point-label-options"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("startAngle")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Starting angle of the scale. In degrees, 0 is at top.")])])])]),t._v(" "),e("h3",{attrs:{id:"common-options-for-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-options-for-all-axes"}},[t._v("#")]),t._v(" Common options for all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId]")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("type")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("alignToPixels")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Align pixel values to device pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Background color of the scale area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Controls the axis global visibility (visible when "),e("code",[t._v("true")]),t._v(", hidden when "),e("code",[t._v("false")]),t._v("). When "),e("code",[t._v("display: 'auto'")]),t._v(", the axis is visible only if at least one associated dataset is visible.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Grid line configuration. "),e("a",{attrs:{href:"#grid-line-configuration"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("min")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined minimum number for the scale, overrides minimum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("max")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined maximum number for the scale, overrides maximum value from data. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Reverse the scale.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stacked")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Should the data be stacked. "),e("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMax")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the maximum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("suggestedMin")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Adjustment used when calculating the minimum data value. "),e("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("ticks")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Tick configuration. "),e("RouterLink",{attrs:{to:"/axes/#tick-configuration"}},[t._v("more...")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("The weight used to sort the axis. Higher weights are further away from the chart area.")])])])]),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"linear-radial-axis-specific-tick-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linear-radial-axis-specific-tick-options"}},[t._v("#")]),t._v(" Linear Radial Axis specific tick options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("count")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("The number of ticks to generate. If specified, this overrides the automatic generation.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("format")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e("code",[t._v("Intl.NumberFormat")]),e("OutboundLink")],1),t._v(" options used by the default label formatter")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxTicksLimit")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("11")])]),t._v(" "),e("td",[t._v("Maximum number of ticks and gridlines to show.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("precision")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("If defined and "),e("code",[t._v("stepSize")]),t._v(" is not specified, the step size will be rounded to this many decimal places.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stepSize")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("User defined fixed step size for the scale. "),e("a",{attrs:{href:"#step-size"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"grid-line-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grid-line-configuration"}},[t._v("#")]),t._v(" Grid Line Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].grid")]),t._v(", it defines options for the grid lines of the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Indexable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of dashes on grid lines. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0.0")])]),t._v(" "),e("td",[t._v("Offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("circular")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, gridlines are circular (on radar and polar area charts only).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If false, do not display grid lines for this axis.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("Stroke width of grid lines.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/axes/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"axis-range-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis-range-settings"}},[t._v("#")]),t._v(" Axis Range Settings")]),t._v(" "),e("p",[t._v("Given the number of axis range settings, it is important to understand how they all interact with each other.")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("suggestedMax")]),t._v(" and "),e("code",[t._v("suggestedMin")]),t._v(" settings only change the data values that are used to scale the axis. These are useful for extending the range of the axis while maintaining the auto-fit behaviour.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" minDataValue "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mostNegativeValue"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ticks"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("suggestedMin"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" maxDataValue "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("max")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("mostPositiveValue"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ticks"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("suggestedMax"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("In this example, the largest positive value is 50, but the data maximum is expanded out to 100. However, because the lowest data value is below the "),e("code",[t._v("suggestedMin")]),t._v(" setting, it is ignored.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'radar'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'First dataset'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("40")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("suggestedMin")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("suggestedMax")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("In contrast to the "),e("code",[t._v("suggested*")]),t._v(" settings, the "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(" settings set explicit ends to the axes. When these are set, some data points may not be visible.")]),t._v(" "),e("h2",{attrs:{id:"step-size"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-size"}},[t._v("#")]),t._v(" Step Size")]),t._v(" "),e("p",[t._v("If set, the scale ticks will be enumerated by multiple of "),e("code",[t._v("stepSize")]),t._v(", having one tick per increment. If not set, the ticks are labeled automatically using the nice numbers algorithm.")]),t._v(" "),e("p",[t._v("This example sets up a chart with a y axis that creates ticks at "),e("code",[t._v("0, 0.5, 1, 1.5, 2, 2.5, 3, 3.5, 4, 4.5, 5")]),t._v(".")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stepSize")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"angle-line-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#angle-line-options"}},[t._v("#")]),t._v(" Angle Line Options")]),t._v(" "),e("p",[t._v("The following options are used to configure angled lines that radiate from the center of the chart to the point labels.\nNamespace: "),e("code",[t._v("options.scales[scaleId].angleLines")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, angle lines are shown.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("Color of angled lines.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("Width of angled lines.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",[t._v("Yes"),e("sup",[t._v("1")])]),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of dashes on angled lines. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0.0")])]),t._v(" "),e("td",[t._v("Offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])])])]),t._v(" "),e("ol",[e("li",[t._v("the "),e("code",[t._v("borderDash")]),t._v(" setting only accepts a static value or a function. Passing an array of arrays is not supported.")])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#pointLabel"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"point-label-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#point-label-options"}},[t._v("#")]),t._v(" Point Label Options")]),t._v(" "),e("p",[t._v("The following options are used to configure the point labels that are shown on the perimeter of the scale.\nNamespace: "),e("code",[t._v("options.scales[scaleId].pointLabels")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("Background color of the point label.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderRadius")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Border radius of the point label")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, point labels are shown. When "),e("code",[t._v("display: 'auto'")]),t._v(", the label is hidden if it overlaps with another label.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Callback function to transform data labels to point labels. The default implementation simply returns the current string.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of label.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("Yes")]),t._v(" "),e("td",[t._v("5")]),t._v(" "),e("td",[t._v("Padding between chart and point labels.")])]),t._v(" "),e("tr",[e("td",[e("RouterLink",{attrs:{to:"/samples/other-charts/polar-area-center-labels.html"}},[e("code",[t._v("centerPointLabels")])])],1),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, point labels are centered.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#pointLabel"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[t._v("Internally, the linear radial scale uses numeric data")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/146.6cb7b21a.js b/docs/master/assets/js/146.840207c7.js similarity index 99% rename from docs/master/assets/js/146.6cb7b21a.js rename to docs/master/assets/js/146.840207c7.js index 08ebd7cfd2..491161e6de 100644 --- a/docs/master/assets/js/146.6cb7b21a.js +++ b/docs/master/assets/js/146.840207c7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{475:function(t,e,a){"use strict";a.r(e);var d=a(3),r=Object(d.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("There are a number of options to allow styling an axis. There are settings to control "),e("a",{attrs:{href:"#grid-line-configuration"}},[t._v("grid lines")]),t._v(" and "),e("a",{attrs:{href:"#tick-configuration"}},[t._v("ticks")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"grid-line-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grid-line-configuration"}},[t._v("#")]),t._v(" Grid Line Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].grid")]),t._v(", it defines options for the grid lines that run perpendicular to the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Indexable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("circular")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, gridlines are circular (on radar and polar area charts only).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If false, do not display grid lines for this axis.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("drawOnChartArea")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("drawTicks")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, draw lines beside the ticks in the axis area beside the chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("Stroke width of grid lines.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, grid lines will be shifted to be between labels. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickBorderDash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of the tick mark line. If not set, defaults to the grid line "),e("code",[t._v("borderDash")]),t._v(" value.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickBorderDashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Offset for the line dash of the tick mark. If unset, defaults to the grid line "),e("code",[t._v("borderDashOffset")]),t._v(" value")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Color of the tick line. If unset, defaults to the grid line color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickLength")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("8")])]),t._v(" "),e("td",[t._v("Length in pixels that the grid lines will draw into the axis area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Width of the tick mark in pixels. If unset, defaults to the grid line width.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("-1")])]),t._v(" "),e("td",[t._v("z-index of the gridline layer. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"major-tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#major-tick-configuration"}},[t._v("#")]),t._v(" Major Tick Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks.major")]),t._v(", it defines options for the major tick marks that are generated by the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("enabled")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, major ticks are generated. A major tick will affect autoskipping and "),e("code",[t._v("major")]),t._v(" will be defined on ticks in the scriptable options context.")])])])]),t._v(" "),e("h2",{attrs:{id:"border-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-configuration"}},[t._v("#")]),t._v(" Border Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].border")]),t._v(", it defines options for the border that run perpendicular to the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Indexable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, draw a border at the edge between the axis and the chart area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("The color of the border line.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("width")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("The width of the border line.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("dash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of dashes on grid lines. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("dashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0.0")])]),t._v(" "),e("td",[t._v("Offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of the border layer. Values <= 0 are drawn under datasets, > 0 on top.")])])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[146],{478:function(t,e,a){"use strict";a.r(e);var d=a(3),r=Object(d.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("There are a number of options to allow styling an axis. There are settings to control "),e("a",{attrs:{href:"#grid-line-configuration"}},[t._v("grid lines")]),t._v(" and "),e("a",{attrs:{href:"#tick-configuration"}},[t._v("ticks")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"grid-line-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grid-line-configuration"}},[t._v("#")]),t._v(" Grid Line Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].grid")]),t._v(", it defines options for the grid lines that run perpendicular to the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Indexable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("circular")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, gridlines are circular (on radar and polar area charts only).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If false, do not display grid lines for this axis.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("drawOnChartArea")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("drawTicks")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, draw lines beside the ticks in the axis area beside the chart.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("Stroke width of grid lines.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, grid lines will be shifted to be between labels. This is set to "),e("code",[t._v("true")]),t._v(" for a bar chart by default.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickBorderDash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of the tick mark line. If not set, defaults to the grid line "),e("code",[t._v("borderDash")]),t._v(" value.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickBorderDashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Offset for the line dash of the tick mark. If unset, defaults to the grid line "),e("code",[t._v("borderDashOffset")]),t._v(" value")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Color of the tick line. If unset, defaults to the grid line color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickLength")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("8")])]),t._v(" "),e("td",[t._v("Length in pixels that the grid lines will draw into the axis area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("tickWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Width of the tick mark in pixels. If unset, defaults to the grid line width.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("-1")])]),t._v(" "),e("td",[t._v("z-index of the gridline layer. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[t._v("#")]),t._v(" Tick Configuration")]),t._v(" "),e("h3",{attrs:{id:"common-tick-options-to-all-axes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#common-tick-options-to-all-axes"}},[t._v("#")]),t._v(" Common tick options to all axes")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backdropColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(255, 255, 255, 0.75)'")])]),t._v(" "),e("td",[t._v("Color of label backdrops.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("backdropPadding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("2")])]),t._v(" "),e("td",[t._v("Padding of label backdrop.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("callback")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Returns the string representation of the tick value as it should be displayed on the chart. See "),e("RouterLink",{attrs:{to:"/axes/labelling.html#creating-custom-tick-formats"}},[t._v("callback")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, show tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of ticks.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("major")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("{}")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/axes/styling.html#major-tick-configuration"}},[t._v("Major ticks configuration")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("3")])]),t._v(" "),e("td",[t._v("Sets the offset of the tick labels from the axis")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("showLabelBackdrop")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for radial scale, "),e("code",[t._v("false")]),t._v(" otherwise")]),t._v(" "),e("td",[t._v("If true, draw a background behind the tick labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeColor")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("``")]),t._v(" "),e("td",[t._v("The color of the stroke around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textStrokeWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Stroke width around the text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.")])])])]),t._v(" "),e("p",[t._v("The scriptable context is described in "),e("RouterLink",{attrs:{to:"/general/options.html#tick"}},[t._v("Options")]),t._v(" section.")],1),t._v(" "),e("h2",{attrs:{id:"major-tick-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#major-tick-configuration"}},[t._v("#")]),t._v(" Major Tick Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].ticks.major")]),t._v(", it defines options for the major tick marks that are generated by the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("enabled")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, major ticks are generated. A major tick will affect autoskipping and "),e("code",[t._v("major")]),t._v(" will be defined on ticks in the scriptable options context.")])])])]),t._v(" "),e("h2",{attrs:{id:"border-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-configuration"}},[t._v("#")]),t._v(" Border Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.scales[scaleId].border")]),t._v(", it defines options for the border that run perpendicular to the axis.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Scriptable")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[t._v("Indexable")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, draw a border at the edge between the axis and the chart area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.borderColor")])]),t._v(" "),e("td",[t._v("The color of the border line.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("width")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("1")])]),t._v(" "),e("td",[t._v("The width of the border line.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("dash")])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("[]")])]),t._v(" "),e("td",[t._v("Length and spacing of dashes on grid lines. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("dashOffset")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0.0")])]),t._v(" "),e("td",[t._v("Offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("z")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",{staticStyle:{"text-align":"center"}}),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("z-index of the border layer. Values <= 0 are drawn under datasets, > 0 on top.")])])])])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/147.d725d898.js b/docs/master/assets/js/147.f9403dc8.js similarity index 99% rename from docs/master/assets/js/147.d725d898.js rename to docs/master/assets/js/147.f9403dc8.js index 7000f324a4..8875f38c97 100644 --- a/docs/master/assets/js/147.d725d898.js +++ b/docs/master/assets/js/147.f9403dc8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[147],{478:function(t,a,e){"use strict";e.r(a);var s=e(3),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"area-chart"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#area-chart"}},[t._v("#")]),t._v(" Area Chart")]),t._v(" "),a("p",[t._v("Both "),a("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("line")]),t._v(" and "),a("RouterLink",{attrs:{to:"/charts/radar.html"}},[t._v("radar")]),t._v(" charts support a "),a("code",[t._v("fill")]),t._v(" option on the dataset object which can be used to create space between two datasets or a dataset and a boundary, i.e. the scale "),a("code",[t._v("origin")]),t._v(", "),a("code",[t._v("start,")]),t._v(" or "),a("code",[t._v("end")]),t._v(" (see "),a("a",{attrs:{href:"#filling-modes"}},[t._v("filling modes")]),t._v(").")],1),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("This feature is implemented by the "),a("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/src/plugins/plugin.filler/index.js",target:"_blank",rel:"noopener noreferrer"}},[a("code",[t._v("filler")]),t._v(" plugin"),a("OutboundLink")],1),t._v(".")])]),t._v(" "),a("h2",{attrs:{id:"filling-modes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#filling-modes"}},[t._v("#")]),t._v(" Filling modes")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",{staticStyle:{"text-align":"left"}},[t._v("Mode")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Values")])])]),t._v(" "),a("tbody",[a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Absolute dataset index")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("number")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("1")]),t._v(", "),a("code",[t._v("2")]),t._v(", "),a("code",[t._v("3")]),t._v(", ...")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Relative dataset index")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'-1'")]),t._v(", "),a("code",[t._v("'-2'")]),t._v(", "),a("code",[t._v("'+1'")]),t._v(", ...")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Boundary")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'start'")]),t._v(", "),a("code",[t._v("'end'")]),t._v(", "),a("code",[t._v("'origin'")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Disabled "),a("sup",[t._v("1")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("boolean")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("false")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Stacked value below")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'stack'")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Axis value")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("object")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("{ value: number; }")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Shape (fill inside line)")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'shape'")])])])])]),t._v(" "),a("blockquote",[a("p",[a("sup",[t._v("1")]),t._v(" for backward compatibility, "),a("code",[t._v("fill: true")]),t._v(" is equivalent to "),a("code",[t._v("fill: 'origin'")]),a("br")])]),t._v(" "),a("h3",{attrs:{id:"example"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[t._v("#")]),t._v(" Example")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'origin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0: fill to 'origin'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'+2'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 1: fill to dataset 3")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 2: fill to dataset 1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 3: no fill")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'-2'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 4: fill to dataset 2")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("25")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 5: fill to axis value 25")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("If you need to support multiple colors when filling from one dataset to another, you may specify an object with the following option :")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",{staticStyle:{"text-align":"left"}},[t._v("Param")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("target")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("number")]),t._v(", "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("boolean")]),t._v(", "),a("code",[t._v("object")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("The accepted values are the same as the filling mode values, so you may use absolute and relative dataset indexes and/or boundaries.")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("above")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("Color")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("If no color is set, the default color will be the background color of the chart.")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("below")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("Color")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("Same as the above.")])])])]),t._v(" "),a("h3",{attrs:{id:"example-with-multiple-colors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-with-multiple-colors"}},[t._v("#")]),t._v(" Example with multiple colors")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("target")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'origin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("above")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 0, 0)'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Area will be red above the origin")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("below")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(0, 0, 255)'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// And blue below the origin")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration"}},[t._v("#")]),t._v(" Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.plugins.filler")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",{staticStyle:{"text-align":"left"}},[t._v("Option")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Default")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("drawTime")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("beforeDatasetDraw")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("Filler draw time. Supported values: "),a("code",[t._v("'beforeDraw'")]),t._v(", "),a("code",[t._v("'beforeDatasetDraw'")]),t._v(", "),a("code",[t._v("'beforeDatasetsDraw'")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("a",{attrs:{href:"#propagate"}},[a("code",[t._v("propagate")])])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("boolean")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("true")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("Fill propagation when target is hidden.")])])])]),t._v(" "),a("h3",{attrs:{id:"propagate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#propagate"}},[t._v("#")]),t._v(" propagate")]),t._v(" "),a("p",[a("code",[t._v("propagate")]),t._v(" takes a "),a("code",[t._v("boolean")]),t._v(" value (default: "),a("code",[t._v("true")]),t._v(").")]),t._v(" "),a("p",[t._v("If "),a("code",[t._v("true")]),t._v(", the fill area will be recursively extended to the visible target defined by the "),a("code",[t._v("fill")]),t._v(" value of hidden dataset targets:")]),t._v(" "),a("h4",{attrs:{id:"example-using-propagate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-using-propagate"}},[t._v("#")]),t._v(" Example using propagate")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'origin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0: fill to 'origin'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'-1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 1: fill to dataset 0")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 2: fill to dataset 1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 3: no fill")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'-2'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 4: fill to dataset 2")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("filler")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("propagate")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[a("code",[t._v("propagate: true")]),t._v(":\n-if dataset 2 is hidden, dataset 4 will fill to dataset 1\n-if dataset 2 and 1 are hidden, dataset 4 will fill to "),a("code",[t._v("'origin'")])]),t._v(" "),a("p",[a("code",[t._v("propagate: false")]),t._v(":\n-if dataset 2 and/or 4 are hidden, dataset 4 will not be filled")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[147],{479:function(t,a,e){"use strict";e.r(a);var s=e(3),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"area-chart"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#area-chart"}},[t._v("#")]),t._v(" Area Chart")]),t._v(" "),a("p",[t._v("Both "),a("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("line")]),t._v(" and "),a("RouterLink",{attrs:{to:"/charts/radar.html"}},[t._v("radar")]),t._v(" charts support a "),a("code",[t._v("fill")]),t._v(" option on the dataset object which can be used to create space between two datasets or a dataset and a boundary, i.e. the scale "),a("code",[t._v("origin")]),t._v(", "),a("code",[t._v("start,")]),t._v(" or "),a("code",[t._v("end")]),t._v(" (see "),a("a",{attrs:{href:"#filling-modes"}},[t._v("filling modes")]),t._v(").")],1),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("This feature is implemented by the "),a("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/src/plugins/plugin.filler/index.js",target:"_blank",rel:"noopener noreferrer"}},[a("code",[t._v("filler")]),t._v(" plugin"),a("OutboundLink")],1),t._v(".")])]),t._v(" "),a("h2",{attrs:{id:"filling-modes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#filling-modes"}},[t._v("#")]),t._v(" Filling modes")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",{staticStyle:{"text-align":"left"}},[t._v("Mode")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Values")])])]),t._v(" "),a("tbody",[a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Absolute dataset index")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("number")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("1")]),t._v(", "),a("code",[t._v("2")]),t._v(", "),a("code",[t._v("3")]),t._v(", ...")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Relative dataset index")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'-1'")]),t._v(", "),a("code",[t._v("'-2'")]),t._v(", "),a("code",[t._v("'+1'")]),t._v(", ...")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Boundary")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'start'")]),t._v(", "),a("code",[t._v("'end'")]),t._v(", "),a("code",[t._v("'origin'")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Disabled "),a("sup",[t._v("1")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("boolean")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("false")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Stacked value below")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'stack'")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Axis value")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("object")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("{ value: number; }")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[t._v("Shape (fill inside line)")]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("'shape'")])])])])]),t._v(" "),a("blockquote",[a("p",[a("sup",[t._v("1")]),t._v(" for backward compatibility, "),a("code",[t._v("fill: true")]),t._v(" is equivalent to "),a("code",[t._v("fill: 'origin'")]),a("br")])]),t._v(" "),a("h3",{attrs:{id:"example"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[t._v("#")]),t._v(" Example")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'origin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0: fill to 'origin'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'+2'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 1: fill to dataset 3")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 2: fill to dataset 1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 3: no fill")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'-2'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 4: fill to dataset 2")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("25")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 5: fill to axis value 25")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("If you need to support multiple colors when filling from one dataset to another, you may specify an object with the following option :")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",{staticStyle:{"text-align":"left"}},[t._v("Param")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("target")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("number")]),t._v(", "),a("code",[t._v("string")]),t._v(", "),a("code",[t._v("boolean")]),t._v(", "),a("code",[t._v("object")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("The accepted values are the same as the filling mode values, so you may use absolute and relative dataset indexes and/or boundaries.")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("above")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("Color")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("If no color is set, the default color will be the background color of the chart.")])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("below")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("Color")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("Same as the above.")])])])]),t._v(" "),a("h3",{attrs:{id:"example-with-multiple-colors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-with-multiple-colors"}},[t._v("#")]),t._v(" Example with multiple colors")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("target")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'origin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("above")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 0, 0)'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Area will be red above the origin")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("below")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(0, 0, 255)'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// And blue below the origin")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration"}},[t._v("#")]),t._v(" Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.plugins.filler")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",{staticStyle:{"text-align":"left"}},[t._v("Option")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Default")]),t._v(" "),a("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("drawTime")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("string")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("beforeDatasetDraw")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("Filler draw time. Supported values: "),a("code",[t._v("'beforeDraw'")]),t._v(", "),a("code",[t._v("'beforeDatasetDraw'")]),t._v(", "),a("code",[t._v("'beforeDatasetsDraw'")])])]),t._v(" "),a("tr",[a("td",{staticStyle:{"text-align":"left"}},[a("a",{attrs:{href:"#propagate"}},[a("code",[t._v("propagate")])])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("boolean")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[a("code",[t._v("true")])]),t._v(" "),a("td",{staticStyle:{"text-align":"left"}},[t._v("Fill propagation when target is hidden.")])])])]),t._v(" "),a("h3",{attrs:{id:"propagate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#propagate"}},[t._v("#")]),t._v(" propagate")]),t._v(" "),a("p",[a("code",[t._v("propagate")]),t._v(" takes a "),a("code",[t._v("boolean")]),t._v(" value (default: "),a("code",[t._v("true")]),t._v(").")]),t._v(" "),a("p",[t._v("If "),a("code",[t._v("true")]),t._v(", the fill area will be recursively extended to the visible target defined by the "),a("code",[t._v("fill")]),t._v(" value of hidden dataset targets:")]),t._v(" "),a("h4",{attrs:{id:"example-using-propagate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-using-propagate"}},[t._v("#")]),t._v(" Example using propagate")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'origin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0: fill to 'origin'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'-1'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 1: fill to dataset 0")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 2: fill to dataset 1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 3: no fill")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fill")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'-2'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 4: fill to dataset 2")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("filler")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("propagate")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[a("code",[t._v("propagate: true")]),t._v(":\n-if dataset 2 is hidden, dataset 4 will fill to dataset 1\n-if dataset 2 and 1 are hidden, dataset 4 will fill to "),a("code",[t._v("'origin'")])]),t._v(" "),a("p",[a("code",[t._v("propagate: false")]),t._v(":\n-if dataset 2 and/or 4 are hidden, dataset 4 will not be filled")])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/148.9a562c57.js b/docs/master/assets/js/148.0d730d6b.js similarity index 99% rename from docs/master/assets/js/148.9a562c57.js rename to docs/master/assets/js/148.0d730d6b.js index 97c6b7189c..6ea5845dbc 100644 --- a/docs/master/assets/js/148.9a562c57.js +++ b/docs/master/assets/js/148.0d730d6b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[148],{479:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"bar-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bar-chart"}},[t._v("#")]),t._v(" Bar Chart")]),t._v(" "),e("p",[t._v("A bar chart provides a way of showing data values represented as vertical bars. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First Dataset',\n data: [65, 59, 80, 81, 56, 55, 40],\n backgroundColor: [\n 'rgba(255, 99, 132, 0.2)',\n 'rgba(255, 159, 64, 0.2)',\n 'rgba(255, 205, 86, 0.2)',\n 'rgba(75, 192, 192, 0.2)',\n 'rgba(54, 162, 235, 0.2)',\n 'rgba(153, 102, 255, 0.2)',\n 'rgba(201, 203, 207, 0.2)'\n ],\n borderColor: [\n 'rgb(255, 99, 132)',\n 'rgb(255, 159, 64)',\n 'rgb(255, 205, 86)',\n 'rgb(75, 192, 192)',\n 'rgb(54, 162, 235)',\n 'rgb(153, 102, 255)',\n 'rgb(201, 203, 207)'\n ],\n borderWidth: 1\n }]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n scales: {\n y: {\n beginAtZero: true\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.bar")]),t._v(" - options for all bar datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.bar")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#bar-configuration"}},[t._v("bar elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The bar chart allows a number of properties to be specified for each dataset.\nThese are used to set display properties for a specific dataset. For example,\nthe color of the bars is generally set this way.\nOnly the "),e("code",[t._v("data")]),t._v(" option needs to be specified in the dataset namespace.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("base")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#barpercentage"}},[e("code",[t._v("barPercentage")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.9")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#barthickness"}},[e("code",[t._v("barThickness")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v("|"),e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'start'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderwidth"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderradius"}},[e("code",[t._v("borderRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#categorypercentage"}},[e("code",[t._v("categoryPercentage")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.8")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("object")]),t._v("|"),e("code",[t._v("object[]")]),t._v("| "),e("code",[t._v("number[]")]),t._v("|"),e("code",[t._v("string[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("grouped")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("true")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("indexAxis")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("'x'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#inflateamount"}},[e("code",[t._v("inflateAmount")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("'auto'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'auto'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#maxbarthickness"}},[e("code",[t._v("maxBarThickness")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("minBarLength")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("label")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("''")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("order")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#types"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("'circle'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("skipNull")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("stack")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("'bar'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("xAxisID")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[t._v("first x axis")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("yAxisID")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[t._v("first y axis")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"example-dataset-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-dataset-configuration"}},[t._v("#")]),t._v(" Example dataset configuration")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("barPercentage")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("barThickness")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("6")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxBarThickness")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("minBarLength")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("40")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("70")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("base")])]),t._v(" "),e("td",[t._v("Base value for the bar in data units along the value axis. If not set, defaults to the value axis base value.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grouped")])]),t._v(" "),e("td",[t._v("Should the bars be grouped on index axis. When "),e("code",[t._v("true")]),t._v(", all the datasets at same index value will be placed next to each other centering on that index value. When "),e("code",[t._v("false")]),t._v(", each bar is placed on its actual index-axis value.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("indexAxis")])]),t._v(" "),e("td",[t._v("The base axis of the dataset. "),e("code",[t._v("'x'")]),t._v(" for vertical bars and "),e("code",[t._v("'y'")]),t._v(" for horizontal bars.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("label")])]),t._v(" "),e("td",[t._v("The label for the dataset which appears in the legend and tooltips.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("order")])]),t._v(" "),e("td",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend. "),e("RouterLink",{attrs:{to:"/charts/mixed.html#drawing-order"}},[t._v("more")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("skipNull")])]),t._v(" "),e("td",[t._v("If "),e("code",[t._v("true")]),t._v(", null or undefined values will not be used for spacing calculations when determining bar size.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). "),e("a",{attrs:{href:"#stacked-bar-chart"}},[t._v("more")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("xAxisID")])]),t._v(" "),e("td",[t._v("The ID of the x-axis to plot this dataset on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("yAxisID")])]),t._v(" "),e("td",[t._v("The ID of the y-axis to plot this dataset on.")])])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each bar can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("The bar background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("The bar border color.")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])])]),t._v(" "),e("td",[t._v("The edge to skip when drawing bar.")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderwidth"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[t._v("The bar border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderradius"}},[e("code",[t._v("borderRadius")])])]),t._v(" "),e("td",[t._v("The bar border radius (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minBarLength")])]),t._v(" "),e("td",[t._v("Set this to ensure that bars have a minimum length in pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointStyle")])]),t._v(" "),e("td",[t._v("Style of the point for legend. "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("more...")])],1)])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#bar-configuration"}},[e("code",[t._v("elements.bar.*")])]),t._v(" options.")],1),t._v(" "),e("h4",{attrs:{id:"borderskipped"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderskipped"}},[t._v("#")]),t._v(" borderSkipped")]),t._v(" "),e("p",[t._v("This setting is used to avoid drawing the bar stroke at the base of the fill, or disable the border radius.\nIn general, this does not need to be changed except when creating chart types\nthat derive from a bar chart.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("For negative bars in a vertical chart, "),e("code",[t._v("top")]),t._v(" and "),e("code",[t._v("bottom")]),t._v(" are flipped. Same goes for "),e("code",[t._v("left")]),t._v(" and "),e("code",[t._v("right")]),t._v(" in a horizontal chart.")])]),t._v(" "),e("p",[t._v("Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'start'")])]),t._v(" "),e("li",[e("code",[t._v("'end'")])]),t._v(" "),e("li",[e("code",[t._v("'middle'")]),t._v(" (only valid on stacked bars: the borders between bars are skipped)")]),t._v(" "),e("li",[e("code",[t._v("'bottom'")])]),t._v(" "),e("li",[e("code",[t._v("'left'")])]),t._v(" "),e("li",[e("code",[t._v("'top'")])]),t._v(" "),e("li",[e("code",[t._v("'right'")])]),t._v(" "),e("li",[e("code",[t._v("false")]),t._v(" (don't skip any borders)")]),t._v(" "),e("li",[e("code",[t._v("true")]),t._v(" (skip all borders)")])]),t._v(" "),e("h4",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to all sides of the rectangle (left, top, right, bottom), except "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(". If this value is an object, the "),e("code",[t._v("left")]),t._v(" property defines the left border width. Similarly, the "),e("code",[t._v("right")]),t._v(", "),e("code",[t._v("top")]),t._v(", and "),e("code",[t._v("bottom")]),t._v(" properties can also be specified. Omitted borders and "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(" are skipped.")]),t._v(" "),e("h4",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[t._v("#")]),t._v(" borderRadius")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to all corners of the rectangle (topLeft, topRight, bottomLeft, bottomRight), except corners touching the "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(". If this value is an object, the "),e("code",[t._v("topLeft")]),t._v(" property defines the top-left corners border radius. Similarly, the "),e("code",[t._v("topRight")]),t._v(", "),e("code",[t._v("bottomLeft")]),t._v(", and "),e("code",[t._v("bottomRight")]),t._v(" properties can also be specified. Omitted corners and those touching the "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(" are skipped. For example if the "),e("code",[t._v("top")]),t._v(" border is skipped, the border radius for the corners "),e("code",[t._v("topLeft")]),t._v(" and "),e("code",[t._v("topRight")]),t._v(" will be skipped as well.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Stacked Charts")]),t._v(" "),e("p",[t._v("When the border radius is supplied as a number and the chart is stacked, the radius will only be applied to the bars that are at the edges of the stack or where the bar is floating. The object syntax can be used to override this behavior.")])]),t._v(" "),e("h4",{attrs:{id:"inflateamount"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inflateamount"}},[t._v("#")]),t._v(" inflateAmount")]),t._v(" "),e("p",[t._v("This option can be used to inflate the rects that are used to draw the bars. This can be used to hide artifacts between bars when "),e("a",{attrs:{href:"#barpercentage"}},[e("code",[t._v("barPercentage")])]),t._v(" * "),e("a",{attrs:{href:"#categorypercentage"}},[e("code",[t._v("categoryPercentage")])]),t._v(" is 1. The default value "),e("code",[t._v("'auto'")]),t._v(" should work in most cases.")]),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each bar can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("The bar background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("The bar border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("The bar border width when hovered (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderRadius")])]),t._v(" "),e("td",[t._v("The bar border radius when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#bar-configuration"}},[e("code",[t._v("elements.bar.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"barpercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barpercentage"}},[t._v("#")]),t._v(" barPercentage")]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. "),e("a",{attrs:{href:"#barpercentage-vs-categorypercentage"}},[t._v("more...")])]),t._v(" "),e("h3",{attrs:{id:"categorypercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categorypercentage"}},[t._v("#")]),t._v(" categoryPercentage")]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each category should be within the sample width. "),e("a",{attrs:{href:"#barpercentage-vs-categorypercentage"}},[t._v("more...")])]),t._v(" "),e("h3",{attrs:{id:"barthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barthickness"}},[t._v("#")]),t._v(" barThickness")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to the width of each bar, in pixels. When this is enforced, "),e("code",[t._v("barPercentage")]),t._v(" and "),e("code",[t._v("categoryPercentage")]),t._v(" are ignored.")]),t._v(" "),e("p",[t._v("If set to "),e("code",[t._v("'flex'")]),t._v(", the base sample widths are calculated automatically based on the previous and following samples so that they take the full available widths without overlap. Then, bars are sized using "),e("code",[t._v("barPercentage")]),t._v(" and "),e("code",[t._v("categoryPercentage")]),t._v(". There is no gap when the percentage options are 1. This mode generates bars with different widths when data are not evenly spaced.")]),t._v(" "),e("p",[t._v("If not set (default), the base sample widths are calculated using the smallest interval that prevents bar overlapping, and bars are sized using "),e("code",[t._v("barPercentage")]),t._v(" and "),e("code",[t._v("categoryPercentage")]),t._v(". This mode always generates bars equally sized.")]),t._v(" "),e("h3",{attrs:{id:"maxbarthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxbarthickness"}},[t._v("#")]),t._v(" maxBarThickness")]),t._v(" "),e("p",[t._v("Set this to ensure that bars are not sized thicker than this.")]),t._v(" "),e("h2",{attrs:{id:"scale-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale-configuration"}},[t._v("#")]),t._v(" Scale Configuration")]),t._v(" "),e("p",[t._v("The bar chart sets unique default values for the following configuration from the associated "),e("code",[t._v("scale")]),t._v(" options:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, extra space is added to both edges and the axis is scaled to fit into the chart area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid.offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval. If false, the grid line will go right down the middle of the bars. "),e("a",{attrs:{href:"#offsetgridlines"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"example-scale-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-scale-configuration"}},[t._v("#")]),t._v(" Example scale configuration")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("grid")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("offset")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h3",{attrs:{id:"offset-grid-lines"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offset-grid-lines"}},[t._v("#")]),t._v(" Offset Grid Lines")]),t._v(" "),e("p",[t._v("If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval, which is the space between the grid lines. If false, the grid line will go right down the middle of the bars. This is set to true for a category scale in a bar chart while false for other scales or chart types by default.")]),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("It is common to want to apply a configuration setting to all created bar charts. The global bar chart settings are stored in "),e("code",[t._v("Chart.overrides.bar")]),t._v(". Changing the global options only affects charts created after the change. Existing charts are not changed.")]),t._v(" "),e("h2",{attrs:{id:"barpercentage-vs-categorypercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barpercentage-vs-categorypercentage"}},[t._v("#")]),t._v(" barPercentage vs categoryPercentage")]),t._v(" "),e("p",[t._v("The following shows the relationship between the bar percentage option and the category percentage option.")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("// categoryPercentage: 1.0\n// barPercentage: 1.0\nBar: | 1.0 | 1.0 |\nCategory: | 1.0 |\nSample: |===========|\n\n// categoryPercentage: 1.0\n// barPercentage: 0.5\nBar: |.5| |.5|\nCategory: | 1.0 |\nSample: |==============|\n\n// categoryPercentage: 0.5\n// barPercentage: 1.0\nBar: |1.0||1.0|\nCategory: | .5 |\nSample: |==================|\n")])])]),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("All the supported "),e("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("data structures")]),t._v(" can be used with bar charts.")],1),t._v(" "),e("h2",{attrs:{id:"stacked-bar-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stacked-bar-chart"}},[t._v("#")]),t._v(" Stacked Bar Chart")]),t._v(" "),e("p",[t._v("Bar charts can be configured into stacked bar charts by changing the settings on the X and Y axes to enable stacking. Stacked bar charts can be used to show how one data series is made up of a number of smaller pieces.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" stackedBar "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stacked")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stacked")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"horizontal-bar-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#horizontal-bar-chart"}},[t._v("#")]),t._v(" Horizontal Bar Chart")]),t._v(" "),e("p",[t._v("A horizontal bar chart is a variation on a vertical bar chart. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.\nTo achieve this, you will have to set the "),e("code",[t._v("indexAxis")]),t._v(" property in the options object to "),e("code",[t._v("'y'")]),t._v(".\nThe default for this property is "),e("code",[t._v("'x'")]),t._v(" and thus will show vertical bars.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n axis: 'y',\n label: 'My First Dataset',\n data: [65, 59, 80, 81, 56, 55, 40],\n fill: false,\n backgroundColor: [\n 'rgba(255, 99, 132, 0.2)',\n 'rgba(255, 159, 64, 0.2)',\n 'rgba(255, 205, 86, 0.2)',\n 'rgba(75, 192, 192, 0.2)',\n 'rgba(54, 162, 235, 0.2)',\n 'rgba(153, 102, 255, 0.2)',\n 'rgba(201, 203, 207, 0.2)'\n ],\n borderColor: [\n 'rgb(255, 99, 132)',\n 'rgb(255, 159, 64)',\n 'rgb(255, 205, 86)',\n 'rgb(75, 192, 192)',\n 'rgb(54, 162, 235)',\n 'rgb(153, 102, 255)',\n 'rgb(201, 203, 207)'\n ],\n borderWidth: 1\n }]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data,\n options: {\n indexAxis: 'y',\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h3",{attrs:{id:"horizontal-bar-chart-config-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#horizontal-bar-chart-config-options"}},[t._v("#")]),t._v(" Horizontal Bar Chart config Options")]),t._v(" "),e("p",[t._v("The configuration options for the horizontal bar chart are the same as for the "),e("a",{attrs:{href:"#scale-configuration"}},[t._v("bar chart")]),t._v(". However, any options specified on the x-axis in a bar chart, are applied to the y-axis in a horizontal bar chart.")]),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[e("code",[t._v("{x, y, _custom}")]),t._v(" where "),e("code",[t._v("_custom")]),t._v(" is an optional object defining stacked bar properties: "),e("code",[t._v("{start, end, barStart, barEnd, min, max}")]),t._v(". "),e("code",[t._v("start")]),t._v(" and "),e("code",[t._v("end")]),t._v(" are the input values. Those two are repeated in "),e("code",[t._v("barStart")]),t._v(" (closer to origin), "),e("code",[t._v("barEnd")]),t._v(" (further from origin), "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(".")])],1)}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[148],{481:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"bar-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bar-chart"}},[t._v("#")]),t._v(" Bar Chart")]),t._v(" "),e("p",[t._v("A bar chart provides a way of showing data values represented as vertical bars. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n label: 'My First Dataset',\n data: [65, 59, 80, 81, 56, 55, 40],\n backgroundColor: [\n 'rgba(255, 99, 132, 0.2)',\n 'rgba(255, 159, 64, 0.2)',\n 'rgba(255, 205, 86, 0.2)',\n 'rgba(75, 192, 192, 0.2)',\n 'rgba(54, 162, 235, 0.2)',\n 'rgba(153, 102, 255, 0.2)',\n 'rgba(201, 203, 207, 0.2)'\n ],\n borderColor: [\n 'rgb(255, 99, 132)',\n 'rgb(255, 159, 64)',\n 'rgb(255, 205, 86)',\n 'rgb(75, 192, 192)',\n 'rgb(54, 162, 235)',\n 'rgb(153, 102, 255)',\n 'rgb(201, 203, 207)'\n ],\n borderWidth: 1\n }]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n scales: {\n y: {\n beginAtZero: true\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.bar")]),t._v(" - options for all bar datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.bar")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#bar-configuration"}},[t._v("bar elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The bar chart allows a number of properties to be specified for each dataset.\nThese are used to set display properties for a specific dataset. For example,\nthe color of the bars is generally set this way.\nOnly the "),e("code",[t._v("data")]),t._v(" option needs to be specified in the dataset namespace.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("base")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#barpercentage"}},[e("code",[t._v("barPercentage")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.9")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#barthickness"}},[e("code",[t._v("barThickness")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])])]),t._v(" "),e("td",[e("code",[t._v("string")]),t._v("|"),e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'start'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderwidth"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderradius"}},[e("code",[t._v("borderRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#categorypercentage"}},[e("code",[t._v("categoryPercentage")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.8")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("object")]),t._v("|"),e("code",[t._v("object[]")]),t._v("| "),e("code",[t._v("number[]")]),t._v("|"),e("code",[t._v("string[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("grouped")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("true")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("indexAxis")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("'x'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#inflateamount"}},[e("code",[t._v("inflateAmount")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("'auto'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'auto'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#maxbarthickness"}},[e("code",[t._v("maxBarThickness")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("minBarLength")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("label")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("''")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("order")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#types"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("'circle'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("skipNull")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td")]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("stack")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("'bar'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("xAxisID")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[t._v("first x axis")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("yAxisID")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[t._v("first y axis")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"example-dataset-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-dataset-configuration"}},[t._v("#")]),t._v(" Example dataset configuration")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("barPercentage")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("barThickness")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("6")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("maxBarThickness")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("minBarLength")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("40")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("60")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("70")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("base")])]),t._v(" "),e("td",[t._v("Base value for the bar in data units along the value axis. If not set, defaults to the value axis base value.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grouped")])]),t._v(" "),e("td",[t._v("Should the bars be grouped on index axis. When "),e("code",[t._v("true")]),t._v(", all the datasets at same index value will be placed next to each other centering on that index value. When "),e("code",[t._v("false")]),t._v(", each bar is placed on its actual index-axis value.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("indexAxis")])]),t._v(" "),e("td",[t._v("The base axis of the dataset. "),e("code",[t._v("'x'")]),t._v(" for vertical bars and "),e("code",[t._v("'y'")]),t._v(" for horizontal bars.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("label")])]),t._v(" "),e("td",[t._v("The label for the dataset which appears in the legend and tooltips.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("order")])]),t._v(" "),e("td",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend. "),e("RouterLink",{attrs:{to:"/charts/mixed.html#drawing-order"}},[t._v("more")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("skipNull")])]),t._v(" "),e("td",[t._v("If "),e("code",[t._v("true")]),t._v(", null or undefined values will not be used for spacing calculations when determining bar size.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("stack")])]),t._v(" "),e("td",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). "),e("a",{attrs:{href:"#stacked-bar-chart"}},[t._v("more")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("xAxisID")])]),t._v(" "),e("td",[t._v("The ID of the x-axis to plot this dataset on.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("yAxisID")])]),t._v(" "),e("td",[t._v("The ID of the y-axis to plot this dataset on.")])])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each bar can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("The bar background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("The bar border color.")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])])]),t._v(" "),e("td",[t._v("The edge to skip when drawing bar.")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderwidth"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[t._v("The bar border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#borderradius"}},[e("code",[t._v("borderRadius")])])]),t._v(" "),e("td",[t._v("The bar border radius (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("minBarLength")])]),t._v(" "),e("td",[t._v("Set this to ensure that bars have a minimum length in pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointStyle")])]),t._v(" "),e("td",[t._v("Style of the point for legend. "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("more...")])],1)])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#bar-configuration"}},[e("code",[t._v("elements.bar.*")])]),t._v(" options.")],1),t._v(" "),e("h4",{attrs:{id:"borderskipped"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderskipped"}},[t._v("#")]),t._v(" borderSkipped")]),t._v(" "),e("p",[t._v("This setting is used to avoid drawing the bar stroke at the base of the fill, or disable the border radius.\nIn general, this does not need to be changed except when creating chart types\nthat derive from a bar chart.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("For negative bars in a vertical chart, "),e("code",[t._v("top")]),t._v(" and "),e("code",[t._v("bottom")]),t._v(" are flipped. Same goes for "),e("code",[t._v("left")]),t._v(" and "),e("code",[t._v("right")]),t._v(" in a horizontal chart.")])]),t._v(" "),e("p",[t._v("Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'start'")])]),t._v(" "),e("li",[e("code",[t._v("'end'")])]),t._v(" "),e("li",[e("code",[t._v("'middle'")]),t._v(" (only valid on stacked bars: the borders between bars are skipped)")]),t._v(" "),e("li",[e("code",[t._v("'bottom'")])]),t._v(" "),e("li",[e("code",[t._v("'left'")])]),t._v(" "),e("li",[e("code",[t._v("'top'")])]),t._v(" "),e("li",[e("code",[t._v("'right'")])]),t._v(" "),e("li",[e("code",[t._v("false")]),t._v(" (don't skip any borders)")]),t._v(" "),e("li",[e("code",[t._v("true")]),t._v(" (skip all borders)")])]),t._v(" "),e("h4",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to all sides of the rectangle (left, top, right, bottom), except "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(". If this value is an object, the "),e("code",[t._v("left")]),t._v(" property defines the left border width. Similarly, the "),e("code",[t._v("right")]),t._v(", "),e("code",[t._v("top")]),t._v(", and "),e("code",[t._v("bottom")]),t._v(" properties can also be specified. Omitted borders and "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(" are skipped.")]),t._v(" "),e("h4",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[t._v("#")]),t._v(" borderRadius")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to all corners of the rectangle (topLeft, topRight, bottomLeft, bottomRight), except corners touching the "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(". If this value is an object, the "),e("code",[t._v("topLeft")]),t._v(" property defines the top-left corners border radius. Similarly, the "),e("code",[t._v("topRight")]),t._v(", "),e("code",[t._v("bottomLeft")]),t._v(", and "),e("code",[t._v("bottomRight")]),t._v(" properties can also be specified. Omitted corners and those touching the "),e("a",{attrs:{href:"#borderskipped"}},[e("code",[t._v("borderSkipped")])]),t._v(" are skipped. For example if the "),e("code",[t._v("top")]),t._v(" border is skipped, the border radius for the corners "),e("code",[t._v("topLeft")]),t._v(" and "),e("code",[t._v("topRight")]),t._v(" will be skipped as well.")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Stacked Charts")]),t._v(" "),e("p",[t._v("When the border radius is supplied as a number and the chart is stacked, the radius will only be applied to the bars that are at the edges of the stack or where the bar is floating. The object syntax can be used to override this behavior.")])]),t._v(" "),e("h4",{attrs:{id:"inflateamount"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inflateamount"}},[t._v("#")]),t._v(" inflateAmount")]),t._v(" "),e("p",[t._v("This option can be used to inflate the rects that are used to draw the bars. This can be used to hide artifacts between bars when "),e("a",{attrs:{href:"#barpercentage"}},[e("code",[t._v("barPercentage")])]),t._v(" * "),e("a",{attrs:{href:"#categorypercentage"}},[e("code",[t._v("categoryPercentage")])]),t._v(" is 1. The default value "),e("code",[t._v("'auto'")]),t._v(" should work in most cases.")]),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each bar can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("The bar background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("The bar border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("The bar border width when hovered (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderRadius")])]),t._v(" "),e("td",[t._v("The bar border radius when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#bar-configuration"}},[e("code",[t._v("elements.bar.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"barpercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barpercentage"}},[t._v("#")]),t._v(" barPercentage")]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. "),e("a",{attrs:{href:"#barpercentage-vs-categorypercentage"}},[t._v("more...")])]),t._v(" "),e("h3",{attrs:{id:"categorypercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categorypercentage"}},[t._v("#")]),t._v(" categoryPercentage")]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each category should be within the sample width. "),e("a",{attrs:{href:"#barpercentage-vs-categorypercentage"}},[t._v("more...")])]),t._v(" "),e("h3",{attrs:{id:"barthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barthickness"}},[t._v("#")]),t._v(" barThickness")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to the width of each bar, in pixels. When this is enforced, "),e("code",[t._v("barPercentage")]),t._v(" and "),e("code",[t._v("categoryPercentage")]),t._v(" are ignored.")]),t._v(" "),e("p",[t._v("If set to "),e("code",[t._v("'flex'")]),t._v(", the base sample widths are calculated automatically based on the previous and following samples so that they take the full available widths without overlap. Then, bars are sized using "),e("code",[t._v("barPercentage")]),t._v(" and "),e("code",[t._v("categoryPercentage")]),t._v(". There is no gap when the percentage options are 1. This mode generates bars with different widths when data are not evenly spaced.")]),t._v(" "),e("p",[t._v("If not set (default), the base sample widths are calculated using the smallest interval that prevents bar overlapping, and bars are sized using "),e("code",[t._v("barPercentage")]),t._v(" and "),e("code",[t._v("categoryPercentage")]),t._v(". This mode always generates bars equally sized.")]),t._v(" "),e("h3",{attrs:{id:"maxbarthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxbarthickness"}},[t._v("#")]),t._v(" maxBarThickness")]),t._v(" "),e("p",[t._v("Set this to ensure that bars are not sized thicker than this.")]),t._v(" "),e("h2",{attrs:{id:"scale-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale-configuration"}},[t._v("#")]),t._v(" Scale Configuration")]),t._v(" "),e("p",[t._v("The bar chart sets unique default values for the following configuration from the associated "),e("code",[t._v("scale")]),t._v(" options:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, extra space is added to both edges and the axis is scaled to fit into the chart area.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("grid.offset")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval. If false, the grid line will go right down the middle of the bars. "),e("a",{attrs:{href:"#offsetgridlines"}},[t._v("more...")])])])])]),t._v(" "),e("h3",{attrs:{id:"example-scale-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example-scale-configuration"}},[t._v("#")]),t._v(" Example scale configuration")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("options "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("grid")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("offset")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h3",{attrs:{id:"offset-grid-lines"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offset-grid-lines"}},[t._v("#")]),t._v(" Offset Grid Lines")]),t._v(" "),e("p",[t._v("If true, the bars for a particular data point fall between the grid lines. The grid line will move to the left by one half of the tick interval, which is the space between the grid lines. If false, the grid line will go right down the middle of the bars. This is set to true for a category scale in a bar chart while false for other scales or chart types by default.")]),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("It is common to want to apply a configuration setting to all created bar charts. The global bar chart settings are stored in "),e("code",[t._v("Chart.overrides.bar")]),t._v(". Changing the global options only affects charts created after the change. Existing charts are not changed.")]),t._v(" "),e("h2",{attrs:{id:"barpercentage-vs-categorypercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barpercentage-vs-categorypercentage"}},[t._v("#")]),t._v(" barPercentage vs categoryPercentage")]),t._v(" "),e("p",[t._v("The following shows the relationship between the bar percentage option and the category percentage option.")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("// categoryPercentage: 1.0\n// barPercentage: 1.0\nBar: | 1.0 | 1.0 |\nCategory: | 1.0 |\nSample: |===========|\n\n// categoryPercentage: 1.0\n// barPercentage: 0.5\nBar: |.5| |.5|\nCategory: | 1.0 |\nSample: |==============|\n\n// categoryPercentage: 0.5\n// barPercentage: 1.0\nBar: |1.0||1.0|\nCategory: | .5 |\nSample: |==================|\n")])])]),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("All the supported "),e("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("data structures")]),t._v(" can be used with bar charts.")],1),t._v(" "),e("h2",{attrs:{id:"stacked-bar-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stacked-bar-chart"}},[t._v("#")]),t._v(" Stacked Bar Chart")]),t._v(" "),e("p",[t._v("Bar charts can be configured into stacked bar charts by changing the settings on the X and Y axes to enable stacking. Stacked bar charts can be used to show how one data series is made up of a number of smaller pieces.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" stackedBar "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stacked")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("stacked")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"horizontal-bar-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#horizontal-bar-chart"}},[t._v("#")]),t._v(" Horizontal Bar Chart")]),t._v(" "),e("p",[t._v("A horizontal bar chart is a variation on a vertical bar chart. It is sometimes used to show trend data, and the comparison of multiple data sets side by side.\nTo achieve this, you will have to set the "),e("code",[t._v("indexAxis")]),t._v(" property in the options object to "),e("code",[t._v("'y'")]),t._v(".\nThe default for this property is "),e("code",[t._v("'x'")]),t._v(" and thus will show vertical bars.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [{\n axis: 'y',\n label: 'My First Dataset',\n data: [65, 59, 80, 81, 56, 55, 40],\n fill: false,\n backgroundColor: [\n 'rgba(255, 99, 132, 0.2)',\n 'rgba(255, 159, 64, 0.2)',\n 'rgba(255, 205, 86, 0.2)',\n 'rgba(75, 192, 192, 0.2)',\n 'rgba(54, 162, 235, 0.2)',\n 'rgba(153, 102, 255, 0.2)',\n 'rgba(201, 203, 207, 0.2)'\n ],\n borderColor: [\n 'rgb(255, 99, 132)',\n 'rgb(255, 159, 64)',\n 'rgb(255, 205, 86)',\n 'rgb(75, 192, 192)',\n 'rgb(54, 162, 235)',\n 'rgb(153, 102, 255)',\n 'rgb(201, 203, 207)'\n ],\n borderWidth: 1\n }]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data,\n options: {\n indexAxis: 'y',\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h3",{attrs:{id:"horizontal-bar-chart-config-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#horizontal-bar-chart-config-options"}},[t._v("#")]),t._v(" Horizontal Bar Chart config Options")]),t._v(" "),e("p",[t._v("The configuration options for the horizontal bar chart are the same as for the "),e("a",{attrs:{href:"#scale-configuration"}},[t._v("bar chart")]),t._v(". However, any options specified on the x-axis in a bar chart, are applied to the y-axis in a horizontal bar chart.")]),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[e("code",[t._v("{x, y, _custom}")]),t._v(" where "),e("code",[t._v("_custom")]),t._v(" is an optional object defining stacked bar properties: "),e("code",[t._v("{start, end, barStart, barEnd, min, max}")]),t._v(". "),e("code",[t._v("start")]),t._v(" and "),e("code",[t._v("end")]),t._v(" are the input values. Those two are repeated in "),e("code",[t._v("barStart")]),t._v(" (closer to origin), "),e("code",[t._v("barEnd")]),t._v(" (further from origin), "),e("code",[t._v("min")]),t._v(" and "),e("code",[t._v("max")]),t._v(".")])],1)}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/149.af966653.js b/docs/master/assets/js/149.7c8a1c07.js similarity index 99% rename from docs/master/assets/js/149.af966653.js rename to docs/master/assets/js/149.7c8a1c07.js index 2bdcd30e9e..f406e94de8 100644 --- a/docs/master/assets/js/149.af966653.js +++ b/docs/master/assets/js/149.7c8a1c07.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[149],{477:function(t,e,a){"use strict";a.r(e);var r=a(3),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"bubble-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bubble-chart"}},[t._v("#")]),t._v(" Bubble Chart")]),t._v(" "),e("p",[t._v("A bubble chart is used to display three dimensions of data at the same time. The location of the bubble is determined by the first two dimensions and the corresponding horizontal and vertical axes. The third dimension is represented by the size of the individual bubbles.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst data = {\n datasets: [{\n label: 'First Dataset',\n data: [{\n x: 20,\n y: 30,\n r: 15\n }, {\n x: 40,\n y: 10,\n r: 10\n }],\n backgroundColor: 'rgb(255, 99, 132)'\n }]\n};\n// \n\n// \nconst config = {\n type: 'bubble',\n data: data,\n options: {}\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.bubble")]),t._v(" - options for all bubble datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.point")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[t._v("point elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The bubble chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset. For example, the colour of the bubbles is generally set this way.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("3")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("object[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("drawActiveElementsOnTop")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("4")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hitRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("label")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("order")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("pointStyle")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#types"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'circle'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("rotation")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("radius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("3")])])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("drawActiveElementsOnTop")])]),t._v(" "),e("td",[t._v("Draw the active bubbles of a dataset over the other bubbles of the dataset")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("label")])]),t._v(" "),e("td",[t._v("The label for the dataset which appears in the legend and tooltips.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("order")])]),t._v(" "),e("td",[t._v("The drawing order of dataset. Also affects order for tooltip and legend. "),e("RouterLink",{attrs:{to:"/charts/mixed.html#drawing-order"}},[t._v("more")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each bubble can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("bubble background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("bubble border color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",[t._v("bubble border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointStyle")])]),t._v(" "),e("td",[t._v("bubble "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("shape style")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rotation")])]),t._v(" "),e("td",[t._v("bubble rotation (in degrees).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("radius")])]),t._v(" "),e("td",[t._v("bubble radius (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[e("code",[t._v("elements.point.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each bubble can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hitRadius")])]),t._v(" "),e("td",[t._v("bubble "),e("strong",[t._v("additional")]),t._v(" radius for hit detection (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("bubble background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("bubble border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("bubble border width when hovered (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverRadius")])]),t._v(" "),e("td",[t._v("bubble "),e("strong",[t._v("additional")]),t._v(" radius when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[e("code",[t._v("elements.point.*")])]),t._v(" options.")],1),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("We can also change the default values for the Bubble chart type. Doing so will give all bubble charts created after this point the new defaults. The default configuration for the bubble chart can be accessed at "),e("code",[t._v("Chart.overrides.bubble")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("Bubble chart datasets need to contain a "),e("code",[t._v("data")]),t._v(" array of points, each point represented by an object containing the following properties:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// X Value")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Y Value")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Bubble radius in pixels (not scaled).")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("p",[e("strong",[t._v("Important:")]),t._v(" the radius property, "),e("code",[t._v("r")]),t._v(" is "),e("strong",[t._v("not")]),t._v(" scaled by the chart, it is the raw radius in pixels of the bubble that is drawn on the canvas.")]),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[e("code",[t._v("{x, y, _custom}")]),t._v(" where "),e("code",[t._v("_custom")]),t._v(" is the radius.")])],1)}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[149],{480:function(t,e,a){"use strict";a.r(e);var r=a(3),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"bubble-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bubble-chart"}},[t._v("#")]),t._v(" Bubble Chart")]),t._v(" "),e("p",[t._v("A bubble chart is used to display three dimensions of data at the same time. The location of the bubble is determined by the first two dimensions and the corresponding horizontal and vertical axes. The third dimension is represented by the size of the individual bubbles.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst data = {\n datasets: [{\n label: 'First Dataset',\n data: [{\n x: 20,\n y: 30,\n r: 15\n }, {\n x: 40,\n y: 10,\n r: 10\n }],\n backgroundColor: 'rgb(255, 99, 132)'\n }]\n};\n// \n\n// \nconst config = {\n type: 'bubble',\n data: data,\n options: {}\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.bubble")]),t._v(" - options for all bubble datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.point")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[t._v("point elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The bubble chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset. For example, the colour of the bubbles is generally set this way.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("3")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("object[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("drawActiveElementsOnTop")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("4")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hitRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("1")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("label")])])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("order")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("pointStyle")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#types"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'circle'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("rotation")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("radius")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("3")])])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("drawActiveElementsOnTop")])]),t._v(" "),e("td",[t._v("Draw the active bubbles of a dataset over the other bubbles of the dataset")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("label")])]),t._v(" "),e("td",[t._v("The label for the dataset which appears in the legend and tooltips.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("order")])]),t._v(" "),e("td",[t._v("The drawing order of dataset. Also affects order for tooltip and legend. "),e("RouterLink",{attrs:{to:"/charts/mixed.html#drawing-order"}},[t._v("more")])],1)])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each bubble can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("bubble background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("bubble border color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",[t._v("bubble border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointStyle")])]),t._v(" "),e("td",[t._v("bubble "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("shape style")]),t._v(".")],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rotation")])]),t._v(" "),e("td",[t._v("bubble rotation (in degrees).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("radius")])]),t._v(" "),e("td",[t._v("bubble radius (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[e("code",[t._v("elements.point.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each bubble can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hitRadius")])]),t._v(" "),e("td",[t._v("bubble "),e("strong",[t._v("additional")]),t._v(" radius for hit detection (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("bubble background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("bubble border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("bubble border width when hovered (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverRadius")])]),t._v(" "),e("td",[t._v("bubble "),e("strong",[t._v("additional")]),t._v(" radius when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[e("code",[t._v("elements.point.*")])]),t._v(" options.")],1),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("We can also change the default values for the Bubble chart type. Doing so will give all bubble charts created after this point the new defaults. The default configuration for the bubble chart can be accessed at "),e("code",[t._v("Chart.overrides.bubble")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("Bubble chart datasets need to contain a "),e("code",[t._v("data")]),t._v(" array of points, each point represented by an object containing the following properties:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// X Value")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Y Value")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Bubble radius in pixels (not scaled).")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("p",[e("strong",[t._v("Important:")]),t._v(" the radius property, "),e("code",[t._v("r")]),t._v(" is "),e("strong",[t._v("not")]),t._v(" scaled by the chart, it is the raw radius in pixels of the bubble that is drawn on the canvas.")]),t._v(" "),e("h2",{attrs:{id:"internal-data-format"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#internal-data-format"}},[t._v("#")]),t._v(" Internal data format")]),t._v(" "),e("p",[e("code",[t._v("{x, y, _custom}")]),t._v(" where "),e("code",[t._v("_custom")]),t._v(" is the radius.")])],1)}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/15.c29886c9.js b/docs/master/assets/js/15.59b78b0e.js similarity index 96% rename from docs/master/assets/js/15.c29886c9.js rename to docs/master/assets/js/15.59b78b0e.js index 2113bb6579..a499888601 100644 --- a/docs/master/assets/js/15.c29886c9.js +++ b/docs/master/assets/js/15.59b78b0e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{348:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-animator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-animator"}},[t._v("#")]),t._v(" Class: Animator")]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Animator")]),t._v("()")]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add"}},[t._v("#")]),t._v(" add")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("add")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("items")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("readonly "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"has"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#has"}},[t._v("#")]),t._v(" has")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("has")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:23"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"listen"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#listen"}},[t._v("#")]),t._v(" listen")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("listen")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("event")]),t._v(", "),e("code",[t._v("cb")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("event")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"progress"')]),t._v(" | "),e("code",[t._v('"complete"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cb")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove"}},[t._v("#")]),t._v(" remove")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("remove")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:27"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"running"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#running"}},[t._v("#")]),t._v(" running")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("running")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"start"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start"}},[t._v("#")]),t._v(" start")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("start")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:24"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("stop")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:26"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{352:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-animator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-animator"}},[t._v("#")]),t._v(" Class: Animator")]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Animator")]),t._v("()")]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"add"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#add"}},[t._v("#")]),t._v(" add")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("add")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("items")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("readonly "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"has"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#has"}},[t._v("#")]),t._v(" has")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("has")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L23",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:23"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"listen"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#listen"}},[t._v("#")]),t._v(" listen")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("listen")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("event")]),t._v(", "),e("code",[t._v("cb")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("event")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"progress"')]),t._v(" | "),e("code",[t._v('"complete"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cb")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"remove"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#remove"}},[t._v("#")]),t._v(" remove")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("remove")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L27",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:27"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"running"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#running"}},[t._v("#")]),t._v(" running")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("running")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"start"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start"}},[t._v("#")]),t._v(" start")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("start")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:24"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("stop")]),t._v("("),e("code",[t._v("chart")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:26"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/150.207bb291.js b/docs/master/assets/js/150.0add7d43.js similarity index 99% rename from docs/master/assets/js/150.207bb291.js rename to docs/master/assets/js/150.0add7d43.js index 76c4834f4a..a3dfa4e6fc 100644 --- a/docs/master/assets/js/150.207bb291.js +++ b/docs/master/assets/js/150.0add7d43.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[150],{481:function(t,e,r){"use strict";r.r(e);var a=r(3),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"doughnut-and-pie-charts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#doughnut-and-pie-charts"}},[t._v("#")]),t._v(" Doughnut and Pie Charts")]),t._v(" "),e("p",[t._v("Pie and doughnut charts are probably the most commonly used charts. They are divided into segments, the arc of each segment shows the proportional value of each piece of data.")]),t._v(" "),e("p",[t._v("They are excellent at showing the relational proportions between data.")]),t._v(" "),e("p",[t._v("Pie and doughnut charts are effectively the same class in Chart.js, but have one different default value - their "),e("code",[t._v("cutout")]),t._v(". This equates to what portion of the inner should be cut out. This defaults to "),e("code",[t._v("0")]),t._v(" for pie charts, and "),e("code",[t._v("'50%'")]),t._v(" for doughnuts.")]),t._v(" "),e("p",[t._v("They are also registered under two aliases in the "),e("code",[t._v("Chart")]),t._v(" core. Other than their different default value, and different alias, they are exactly the same.")]),t._v(" "),e("tabs",[e("tab",{attrs:{name:"Doughnut"}},[e("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1),t._v(" "),e("tab",{attrs:{name:"Pie"}},[e("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)],1),t._v(" "),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.doughnut")]),t._v(" - options for all doughnut datasets")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.pie")]),t._v(" - options for all pie datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.arc")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[t._v("arc elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The doughnut/pie chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset. For example, the colours of the dataset's arcs are generally set this way.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#border-alignment"}},[e("code",[t._v("borderAlign")])])]),t._v(" "),e("td",[e("code",[t._v("'center'")]),t._v("|"),e("code",[t._v("'inner'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'center'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'#fff'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("[]")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#border-radius"}},[e("code",[t._v("borderRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("2")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("circumference")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("offset")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("rotation")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("spacing")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("weight")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("1")])])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("circumference")])]),t._v(" "),e("td",[t._v("Per-dataset override for the sweep that the arcs cover")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rotation")])]),t._v(" "),e("td",[t._v("Per-dataset override for the starting angle to draw arcs from")])])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("arc background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("arc border color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",[t._v("arc border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[t._v("arc offset (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("spacing")])]),t._v(" "),e("td",[t._v("Fixed arc offset (in pixels). Similar to "),e("code",[t._v("offset")]),t._v(" but applies to all arcs.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[t._v("The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"border-alignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-alignment"}},[t._v("#")]),t._v(" Border Alignment")]),t._v(" "),e("p",[t._v("The following values are supported for "),e("code",[t._v("borderAlign")]),t._v(".")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'center'")]),t._v(" (default)")]),t._v(" "),e("li",[e("code",[t._v("'inner'")])])]),t._v(" "),e("p",[t._v("When "),e("code",[t._v("'center'")]),t._v(" is set, the borders of arcs next to each other will overlap. When "),e("code",[t._v("'inner'")]),t._v(" is set, it is guaranteed that all borders will not overlap.")]),t._v(" "),e("h3",{attrs:{id:"border-radius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-radius"}},[t._v("#")]),t._v(" Border Radius")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to all corners of the arc (outerStart, outerEnd, innerStart, innerRight). If this value is an object, the "),e("code",[t._v("outerStart")]),t._v(" property defines the outer-start corner's border radius. Similarly, the "),e("code",[t._v("outerEnd")]),t._v(", "),e("code",[t._v("innerStart")]),t._v(", and "),e("code",[t._v("innerEnd")]),t._v(" properties can also be specified.")]),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("arc background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("arc border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("arc border width when hovered (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverOffset")])]),t._v(" "),e("td",[t._v("arc offset when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h2",{attrs:{id:"config-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#config-options"}},[t._v("#")]),t._v(" Config Options")]),t._v(" "),e("p",[t._v("These are the customisation options specific to Pie & Doughnut charts. These options are looked up on access, and form together with the global chart configuration the options of the chart.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("cutout")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("50%")]),t._v(" - for doughnut, "),e("code",[t._v("0")]),t._v(" - for pie")]),t._v(" "),e("td",[t._v("The portion of the chart that is cut out of the middle. If "),e("code",[t._v("string")]),t._v(" and ending with '%', percentage of the chart radius. "),e("code",[t._v("number")]),t._v(" is considered to be pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("radius")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("100%")])]),t._v(" "),e("td",[t._v("The outer radius of the chart. If "),e("code",[t._v("string")]),t._v(" and ending with '%', percentage of the maximum radius. "),e("code",[t._v("number")]),t._v(" is considered to be pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("0")]),t._v(" "),e("td",[t._v("Starting angle to draw arcs from.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("circumference")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("360")]),t._v(" "),e("td",[t._v("Sweep to allow arcs to cover.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("animation.animateRotate")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, the chart will animate in with a rotation animation. This property is in the "),e("code",[t._v("options.animation")]),t._v(" object.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("animation.animateScale")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, will animate scaling the chart from the center outwards.")])])])]),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("We can also change these default values for each Doughnut type that is created, this object is available at "),e("code",[t._v("Chart.overrides.doughnut")]),t._v(". Pie charts also have a clone of these defaults available to change at "),e("code",[t._v("Chart.overrides.pie")]),t._v(", with the only difference being "),e("code",[t._v("cutout")]),t._v(" being set to 0.")]),t._v(" "),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("For a pie chart, datasets need to contain an array of data points. The data points should be a number, Chart.js will total all the numbers and calculate the relative proportion of each.")]),t._v(" "),e("p",[t._v("You also need to specify an array of labels so that tooltips appear correctly.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// These labels appear in the legend and in the tooltips when hovering different arcs")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])],1)}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[150],{483:function(t,e,r){"use strict";r.r(e);var a=r(3),o=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"doughnut-and-pie-charts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#doughnut-and-pie-charts"}},[t._v("#")]),t._v(" Doughnut and Pie Charts")]),t._v(" "),e("p",[t._v("Pie and doughnut charts are probably the most commonly used charts. They are divided into segments, the arc of each segment shows the proportional value of each piece of data.")]),t._v(" "),e("p",[t._v("They are excellent at showing the relational proportions between data.")]),t._v(" "),e("p",[t._v("Pie and doughnut charts are effectively the same class in Chart.js, but have one different default value - their "),e("code",[t._v("cutout")]),t._v(". This equates to what portion of the inner should be cut out. This defaults to "),e("code",[t._v("0")]),t._v(" for pie charts, and "),e("code",[t._v("'50%'")]),t._v(" for doughnuts.")]),t._v(" "),e("p",[t._v("They are also registered under two aliases in the "),e("code",[t._v("Chart")]),t._v(" core. Other than their different default value, and different alias, they are exactly the same.")]),t._v(" "),e("tabs",[e("tab",{attrs:{name:"Doughnut"}},[e("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1),t._v(" "),e("tab",{attrs:{name:"Pie"}},[e("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)],1),t._v(" "),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.doughnut")]),t._v(" - options for all doughnut datasets")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.pie")]),t._v(" - options for all pie datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.arc")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[t._v("arc elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The doughnut/pie chart allows a number of properties to be specified for each dataset. These are used to set display properties for a specific dataset. For example, the colours of the dataset's arcs are generally set this way.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#border-alignment"}},[e("code",[t._v("borderAlign")])])]),t._v(" "),e("td",[e("code",[t._v("'center'")]),t._v("|"),e("code",[t._v("'inner'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'center'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'#fff'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("[]")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#border-radius"}},[e("code",[t._v("borderRadius")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("2")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("circumference")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("offset")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("rotation")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("spacing")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("weight")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("1")])])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("circumference")])]),t._v(" "),e("td",[t._v("Per-dataset override for the sweep that the arcs cover")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rotation")])]),t._v(" "),e("td",[t._v("Per-dataset override for the starting angle to draw arcs from")])])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("arc background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("arc border color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",[t._v("arc border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("offset")])]),t._v(" "),e("td",[t._v("arc offset (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("spacing")])]),t._v(" "),e("td",[t._v("Fixed arc offset (in pixels). Similar to "),e("code",[t._v("offset")]),t._v(" but applies to all arcs.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[t._v("The relative thickness of the dataset. Providing a value for weight will cause the pie or doughnut dataset to be drawn with a thickness relative to the sum of all the dataset weight values.")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"border-alignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-alignment"}},[t._v("#")]),t._v(" Border Alignment")]),t._v(" "),e("p",[t._v("The following values are supported for "),e("code",[t._v("borderAlign")]),t._v(".")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'center'")]),t._v(" (default)")]),t._v(" "),e("li",[e("code",[t._v("'inner'")])])]),t._v(" "),e("p",[t._v("When "),e("code",[t._v("'center'")]),t._v(" is set, the borders of arcs next to each other will overlap. When "),e("code",[t._v("'inner'")]),t._v(" is set, it is guaranteed that all borders will not overlap.")]),t._v(" "),e("h3",{attrs:{id:"border-radius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-radius"}},[t._v("#")]),t._v(" Border Radius")]),t._v(" "),e("p",[t._v("If this value is a number, it is applied to all corners of the arc (outerStart, outerEnd, innerStart, innerRight). If this value is an object, the "),e("code",[t._v("outerStart")]),t._v(" property defines the outer-start corner's border radius. Similarly, the "),e("code",[t._v("outerEnd")]),t._v(", "),e("code",[t._v("innerStart")]),t._v(", and "),e("code",[t._v("innerEnd")]),t._v(" properties can also be specified.")]),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("arc background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("arc border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("arc border width when hovered (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverOffset")])]),t._v(" "),e("td",[t._v("arc offset when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h2",{attrs:{id:"config-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#config-options"}},[t._v("#")]),t._v(" Config Options")]),t._v(" "),e("p",[t._v("These are the customisation options specific to Pie & Doughnut charts. These options are looked up on access, and form together with the global chart configuration the options of the chart.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("cutout")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("50%")]),t._v(" - for doughnut, "),e("code",[t._v("0")]),t._v(" - for pie")]),t._v(" "),e("td",[t._v("The portion of the chart that is cut out of the middle. If "),e("code",[t._v("string")]),t._v(" and ending with '%', percentage of the chart radius. "),e("code",[t._v("number")]),t._v(" is considered to be pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("radius")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("100%")])]),t._v(" "),e("td",[t._v("The outer radius of the chart. If "),e("code",[t._v("string")]),t._v(" and ending with '%', percentage of the maximum radius. "),e("code",[t._v("number")]),t._v(" is considered to be pixels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rotation")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("0")]),t._v(" "),e("td",[t._v("Starting angle to draw arcs from.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("circumference")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[t._v("360")]),t._v(" "),e("td",[t._v("Sweep to allow arcs to cover.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("animation.animateRotate")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, the chart will animate in with a rotation animation. This property is in the "),e("code",[t._v("options.animation")]),t._v(" object.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("animation.animateScale")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("If true, will animate scaling the chart from the center outwards.")])])])]),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("We can also change these default values for each Doughnut type that is created, this object is available at "),e("code",[t._v("Chart.overrides.doughnut")]),t._v(". Pie charts also have a clone of these defaults available to change at "),e("code",[t._v("Chart.overrides.pie")]),t._v(", with the only difference being "),e("code",[t._v("cutout")]),t._v(" being set to 0.")]),t._v(" "),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("For a pie chart, datasets need to contain an array of data points. The data points should be a number, Chart.js will total all the numbers and calculate the relative proportion of each.")]),t._v(" "),e("p",[t._v("You also need to specify an array of labels so that tooltips appear correctly.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// These labels appear in the legend and in the tooltips when hovering different arcs")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])],1)}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/153.60baa682.js b/docs/master/assets/js/153.f8e696a8.js similarity index 99% rename from docs/master/assets/js/153.60baa682.js rename to docs/master/assets/js/153.f8e696a8.js index 0ebadd6590..1b876e22d3 100644 --- a/docs/master/assets/js/153.60baa682.js +++ b/docs/master/assets/js/153.f8e696a8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[153],{483:function(t,e,a){"use strict";a.r(e);var r=a(3),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polar-area-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polar-area-chart"}},[t._v("#")]),t._v(" Polar Area Chart")]),t._v(" "),e("p",[t._v("Polar area charts are similar to pie charts, but each segment has the same angle - the radius of the segment differs depending on the value.")]),t._v(" "),e("p",[t._v("This type of chart is often useful when we want to show a comparison data similar to a pie chart, but also show a scale of values for context.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Green',\n 'Yellow',\n 'Grey',\n 'Blue'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [11, 16, 7, 3, 14],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(75, 192, 192)',\n 'rgb(255, 205, 86)',\n 'rgb(201, 203, 207)',\n 'rgb(54, 162, 235)'\n ]\n }]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {}\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.polarArea")]),t._v(" - options for all polarArea datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.arc")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[t._v("arc elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The following options can be included in a polar area chart dataset to configure options for that specific dataset.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#border-alignment"}},[e("code",[t._v("borderAlign")])])]),t._v(" "),e("td",[e("code",[t._v("'center'")]),t._v("|"),e("code",[t._v("'inner'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'center'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'#fff'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("[]")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("2")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("circular")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")])])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("arc background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("arc border color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",[t._v("arc border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("circular")])]),t._v(" "),e("td",[t._v("By default the Arc is curved. If "),e("code",[t._v("circular: false")]),t._v(" the Arc will be flat.")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"border-alignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-alignment"}},[t._v("#")]),t._v(" Border Alignment")]),t._v(" "),e("p",[t._v("The following values are supported for "),e("code",[t._v("borderAlign")]),t._v(".")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'center'")]),t._v(" (default)")]),t._v(" "),e("li",[e("code",[t._v("'inner'")])])]),t._v(" "),e("p",[t._v("When "),e("code",[t._v("'center'")]),t._v(" is set, the borders of arcs next to each other will overlap. When "),e("code",[t._v("'inner'")]),t._v(" is set, it is guaranteed that all the borders do not overlap.")]),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("arc background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("arc border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("arc border width when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h2",{attrs:{id:"config-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#config-options"}},[t._v("#")]),t._v(" Config Options")]),t._v(" "),e("p",[t._v("These are the customisation options specific to Polar Area charts. These options are looked up on access, and form together with the "),e("a",{attrs:{href:"#default-options"}},[t._v("global chart default options")]),t._v(" the options of the chart.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("animation.animateRotate")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, the chart will animate in with a rotation animation. This property is in the "),e("code",[t._v("options.animation")]),t._v(" object.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("animation.animateScale")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, will animate scaling the chart from the center outwards.")])])])]),t._v(" "),e("p",[t._v("The polar area chart uses the "),e("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[t._v("radialLinear")]),t._v(" scale. Additional configuration is provided via the scale.")],1),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("We can also change these default values for each PolarArea type that is created, this object is available at "),e("code",[t._v("Chart.overrides.polarArea")]),t._v(". Changing the global options only affects charts created after the change. Existing charts are not changed.")]),t._v(" "),e("p",[t._v("For example, to configure all new polar area charts with "),e("code",[t._v("animateScale = false")]),t._v(" you would do:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("overrides"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("polarArea"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animation"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animateScale "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("For a polar area chart, datasets need to contain an array of data points. The data points should be a number, Chart.js will total all of the numbers and calculate the relative proportion of each.")]),t._v(" "),e("p",[t._v("You also need to specify an array of labels so that tooltips appear correctly for each slice.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// These labels appear in the legend and in the tooltips when hovering different arcs")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])],1)}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[153],{486:function(t,e,a){"use strict";a.r(e);var r=a(3),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"polar-area-chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#polar-area-chart"}},[t._v("#")]),t._v(" Polar Area Chart")]),t._v(" "),e("p",[t._v("Polar area charts are similar to pie charts, but each segment has the same angle - the radius of the segment differs depending on the value.")]),t._v(" "),e("p",[t._v("This type of chart is often useful when we want to show a comparison data similar to a pie chart, but also show a scale of values for context.")]),t._v(" "),e("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Green',\n 'Yellow',\n 'Grey',\n 'Blue'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [11, 16, 7, 3, 14],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(75, 192, 192)',\n 'rgb(255, 205, 86)',\n 'rgb(201, 203, 207)',\n 'rgb(54, 162, 235)'\n ]\n }]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {}\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),e("h2",{attrs:{id:"dataset-properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-properties"}},[t._v("#")]),t._v(" Dataset Properties")]),t._v(" "),e("p",[t._v("Namespaces:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data.datasets[index]")]),t._v(" - options for this dataset only")]),t._v(" "),e("li",[e("code",[t._v("options.datasets.polarArea")]),t._v(" - options for all polarArea datasets")]),t._v(" "),e("li",[e("code",[t._v("options.elements.arc")]),t._v(" - options for all "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[t._v("arc elements")])],1),t._v(" "),e("li",[e("code",[t._v("options")]),t._v(" - options for the whole chart")])]),t._v(" "),e("p",[t._v("The following options can be included in a polar area chart dataset to configure options for that specific dataset.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#indexable-options"}},[t._v("Indexable")])],1),t._v(" "),e("th",[t._v("Default")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("backgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'rgba(0, 0, 0, 0.1)'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#border-alignment"}},[e("code",[t._v("borderAlign")])])]),t._v(" "),e("td",[e("code",[t._v("'center'")]),t._v("|"),e("code",[t._v("'inner'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'center'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("'#fff'")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("[]")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("0.0")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("borderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("2")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#general"}},[e("code",[t._v("clip")])])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("object")]),t._v("|"),e("code",[t._v("false")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#data-structure"}},[e("code",[t._v("data")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("strong",[t._v("required")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBackgroundColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderColor")])])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDash")])])]),t._v(" "),e("td",[e("code",[t._v("number[]")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderDashOffset")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("-")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderJoinStyle")])])]),t._v(" "),e("td",[e("code",[t._v("'round'")]),t._v("|"),e("code",[t._v("'bevel'")]),t._v("|"),e("code",[t._v("'miter'")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#interactions"}},[e("code",[t._v("hoverBorderWidth")])])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("undefined")])])]),t._v(" "),e("tr",[e("td",[e("a",{attrs:{href:"#styling"}},[e("code",[t._v("circular")])])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[e("code",[t._v("true")])])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the scopes described in "),e("a",{attrs:{href:"../general/options"}},[t._v("option resolution")])]),t._v(" "),e("h3",{attrs:{id:"general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general"}},[t._v("#")]),t._v(" General")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("clip")])]),t._v(" "),e("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. "),e("code",[t._v("0")]),t._v(" = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])])])])]),t._v(" "),e("h3",{attrs:{id:"styling"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#styling"}},[t._v("#")]),t._v(" Styling")]),t._v(" "),e("p",[t._v("The style of each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",[t._v("arc background color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderColor")])]),t._v(" "),e("td",[t._v("arc border color.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",[t._v("arc border width (in pixels).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("circular")])]),t._v(" "),e("td",[t._v("By default the Arc is curved. If "),e("code",[t._v("circular: false")]),t._v(" the Arc will be flat.")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h3",{attrs:{id:"border-alignment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#border-alignment"}},[t._v("#")]),t._v(" Border Alignment")]),t._v(" "),e("p",[t._v("The following values are supported for "),e("code",[t._v("borderAlign")]),t._v(".")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'center'")]),t._v(" (default)")]),t._v(" "),e("li",[e("code",[t._v("'inner'")])])]),t._v(" "),e("p",[t._v("When "),e("code",[t._v("'center'")]),t._v(" is set, the borders of arcs next to each other will overlap. When "),e("code",[t._v("'inner'")]),t._v(" is set, it is guaranteed that all the borders do not overlap.")]),t._v(" "),e("h3",{attrs:{id:"interactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),e("p",[t._v("The interaction with each arc can be controlled with the following properties:")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("hoverBackgroundColor")])]),t._v(" "),e("td",[t._v("arc background color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderColor")])]),t._v(" "),e("td",[t._v("arc border color when hovered.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDash")])]),t._v(" "),e("td",[t._v("arc border length and spacing of dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderDashOffset")])]),t._v(" "),e("td",[t._v("arc border offset for line dashes when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderJoinStyle")])]),t._v(" "),e("td",[t._v("arc border join style when hovered. See "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",[t._v("arc border width when hovered (in pixels).")])])])]),t._v(" "),e("p",[t._v("All these values, if "),e("code",[t._v("undefined")]),t._v(", fallback to the associated "),e("RouterLink",{attrs:{to:"/configuration/elements.html#arc-configuration"}},[e("code",[t._v("elements.arc.*")])]),t._v(" options.")],1),t._v(" "),e("h2",{attrs:{id:"config-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#config-options"}},[t._v("#")]),t._v(" Config Options")]),t._v(" "),e("p",[t._v("These are the customisation options specific to Polar Area charts. These options are looked up on access, and form together with the "),e("a",{attrs:{href:"#default-options"}},[t._v("global chart default options")]),t._v(" the options of the chart.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("animation.animateRotate")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, the chart will animate in with a rotation animation. This property is in the "),e("code",[t._v("options.animation")]),t._v(" object.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("animation.animateScale")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("If true, will animate scaling the chart from the center outwards.")])])])]),t._v(" "),e("p",[t._v("The polar area chart uses the "),e("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[t._v("radialLinear")]),t._v(" scale. Additional configuration is provided via the scale.")],1),t._v(" "),e("h2",{attrs:{id:"default-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#default-options"}},[t._v("#")]),t._v(" Default Options")]),t._v(" "),e("p",[t._v("We can also change these default values for each PolarArea type that is created, this object is available at "),e("code",[t._v("Chart.overrides.polarArea")]),t._v(". Changing the global options only affects charts created after the change. Existing charts are not changed.")]),t._v(" "),e("p",[t._v("For example, to configure all new polar area charts with "),e("code",[t._v("animateScale = false")]),t._v(" you would do:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("overrides"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("polarArea"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animation"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animateScale "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"data-structure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-structure"}},[t._v("#")]),t._v(" Data Structure")]),t._v(" "),e("p",[t._v("For a polar area chart, datasets need to contain an array of data points. The data points should be a number, Chart.js will total all of the numbers and calculate the relative proportion of each.")]),t._v(" "),e("p",[t._v("You also need to specify an array of labels so that tooltips appear correctly for each slice.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("data "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// These labels appear in the legend and in the tooltips when hovering different arcs")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Red'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Yellow'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Blue'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])],1)}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/156.e8d8d1f4.js b/docs/master/assets/js/156.5babd4fa.js similarity index 99% rename from docs/master/assets/js/156.e8d8d1f4.js rename to docs/master/assets/js/156.5babd4fa.js index 279af0942f..f118114dd3 100644 --- a/docs/master/assets/js/156.e8d8d1f4.js +++ b/docs/master/assets/js/156.5babd4fa.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[156],{486:function(t,a,e){"use strict";e.r(a);var n=e(3),o=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" Animations")]),t._v(" "),a("p",[t._v("Chart.js animates charts out of the box. A number of options are provided to configure how the animation looks and how long it takes.")]),t._v(" "),a("tabs",[a("tab",{attrs:{name:"Looping tension [property]"}},[a("chart-editor",{attrs:{code:"// \nconst data = {\n labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'],\n datasets: [{\n label: 'Looping tension',\n data: [65, 59, 80, 81, 26, 55, 40],\n fill: false,\n borderColor: 'rgb(75, 192, 192)',\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animations: {\n tension: {\n duration: 1000,\n easing: 'linear',\n from: 1,\n to: 0,\n loop: true\n }\n },\n scales: {\n y: { // defining min and max so hiding the dataset does not change scale range\n min: 0,\n max: 100\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1),t._v(" "),a("tab",{attrs:{name:"Hide and show [mode]"}},[a("chart-editor",{attrs:{code:"// \nconst data = {\n labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'],\n datasets: [{\n label: 'Try hiding me',\n data: [65, 59, 80, 81, 26, 55, 40],\n fill: false,\n borderColor: 'rgb(75, 192, 192)',\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n transitions: {\n show: {\n animations: {\n x: {\n from: 0\n },\n y: {\n from: 0\n }\n }\n },\n hide: {\n animations: {\n x: {\n to: 0\n },\n y: {\n to: 0\n }\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)],1),t._v(" "),a("h2",{attrs:{id:"animation-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animation-configuration"}},[t._v("#")]),t._v(" Animation configuration")]),t._v(" "),a("p",[t._v("Animation configuration consists of 3 keys.")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Details")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("animation")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("a",{attrs:{href:"#animation"}},[t._v("animation")])])]),t._v(" "),a("tr",[a("td",[t._v("animations")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("a",{attrs:{href:"#animations"}},[t._v("animations")])])]),t._v(" "),a("tr",[a("td",[t._v("transitions")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("a",{attrs:{href:"#transitions"}},[t._v("transitions")])])])])]),t._v(" "),a("p",[t._v("These keys can be configured in following paths:")]),t._v(" "),a("ul",[a("li",[t._v("`` - chart options")]),t._v(" "),a("li",[a("code",[t._v("datasets[type]")]),t._v(" - dataset type options")]),t._v(" "),a("li",[a("code",[t._v("overrides[type]")]),t._v(" - chart type options")])]),t._v(" "),a("p",[t._v("These paths are valid under "),a("code",[t._v("defaults")]),t._v(" for global configuration and "),a("code",[t._v("options")]),t._v(" for instance configuration.")]),t._v(" "),a("h2",{attrs:{id:"animation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),a("p",[t._v("The default configuration is defined here: "),a("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/src/core/core.animations.js",target:"_blank"}},[t._v("core.animations.js")])]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.animation")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("duration")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("1000")])]),t._v(" "),a("td",[t._v("The number of milliseconds an animation takes.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("easing")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'easeOutQuart'")])]),t._v(" "),a("td",[t._v("Easing function to use. "),a("a",{attrs:{href:"#easing"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("delay")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("Delay before starting the animations.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("loop")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("If set to "),a("code",[t._v("true")]),t._v(", the animations loop endlessly.")])])])]),t._v(" "),a("p",[t._v("These defaults can be overridden in "),a("code",[t._v("options.animation")]),t._v(" or "),a("code",[t._v("dataset.animation")]),t._v(" and "),a("code",[t._v("tooltip.animation")]),t._v(". These keys are also "),a("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")]),t._v(".")],1),t._v(" "),a("h2",{attrs:{id:"animations-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animations-2"}},[t._v("#")]),t._v(" animations")]),t._v(" "),a("p",[t._v("Animations options configures which element properties are animated and how.\nIn addition to the main "),a("a",{attrs:{href:"#animation-configuration"}},[t._v("animation configuration")]),t._v(", the following options are available:")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.animations[animation]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("properties")])]),t._v(" "),a("td",[a("code",[t._v("string[]")])]),t._v(" "),a("td",[a("code",[t._v("key")])]),t._v(" "),a("td",[t._v("The property names this configuration applies to. Defaults to the key name of this object.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("typeof property")])]),t._v(" "),a("td",[t._v("Type of property, determines the interpolator used. Possible values: "),a("code",[t._v("'number'")]),t._v(", "),a("code",[t._v("'color'")]),t._v(" and "),a("code",[t._v("'boolean'")]),t._v(". Only really needed for "),a("code",[t._v("'color'")]),t._v(", because "),a("code",[t._v("typeof")]),t._v(" does not get that right.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("from")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("Color")]),t._v("|"),a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("Start value for the animation. Current value is used when "),a("code",[t._v("undefined")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("to")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("Color")]),t._v("|"),a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("End value for the animation. Updated value is used when "),a("code",[t._v("undefined")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("fn")])]),t._v(" "),a("td",[a("code",[t._v("(from: T, to: T, factor: number) => T;")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("Optional custom interpolator, instead of using a predefined interpolator from "),a("code",[t._v("type")])])])])]),t._v(" "),a("h3",{attrs:{id:"default-animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#default-animations"}},[t._v("#")]),t._v(" Default animations")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Option")]),t._v(" "),a("th",[t._v("Value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("numbers")])]),t._v(" "),a("td",[a("code",[t._v("properties")])]),t._v(" "),a("td",[a("code",[t._v("['x', 'y', 'borderWidth', 'radius', 'tension']")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("numbers")])]),t._v(" "),a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("'number'")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("colors")])]),t._v(" "),a("td",[a("code",[t._v("properties")])]),t._v(" "),a("td",[a("code",[t._v("['color', 'borderColor', 'backgroundColor']")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("colors")])]),t._v(" "),a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("'color'")])])])])]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("These default animations are overridden by most of the dataset controllers.")])]),t._v(" "),a("h2",{attrs:{id:"transitions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),a("p",[t._v("The core transitions are "),a("code",[t._v("'active'")]),t._v(", "),a("code",[t._v("'hide'")]),t._v(", "),a("code",[t._v("'reset'")]),t._v(", "),a("code",[t._v("'resize'")]),t._v(", "),a("code",[t._v("'show'")]),t._v(".\nA custom transition can be used by passing a custom "),a("code",[t._v("mode")]),t._v(" to "),a("RouterLink",{attrs:{to:"/developers/api.html#updatemode"}},[t._v("update")]),t._v(".\nTransition extends the main "),a("a",{attrs:{href:"#animation-configuration"}},[t._v("animation configuration")]),t._v(" and "),a("a",{attrs:{href:"#animations-configuration"}},[t._v("animations configuration")]),t._v(".")],1),t._v(" "),a("h3",{attrs:{id:"default-transitions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#default-transitions"}},[t._v("#")]),t._v(" Default transitions")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.transitions[mode]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Mode")]),t._v(" "),a("th",[t._v("Option")]),t._v(" "),a("th",[t._v("Value")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("'active'")])]),t._v(" "),a("td",[t._v("animation.duration")]),t._v(" "),a("td",[t._v("400")]),t._v(" "),a("td",[t._v("Override default duration to 400ms for hover animations")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'resize'")])]),t._v(" "),a("td",[t._v("animation.duration")]),t._v(" "),a("td",[t._v("0")]),t._v(" "),a("td",[t._v("Override default duration to 0ms (= no animation) for resize")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'show'")])]),t._v(" "),a("td",[t._v("animations.colors")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'color', properties: ['borderColor', 'backgroundColor'], from: 'transparent' }")])]),t._v(" "),a("td",[t._v("Colors are faded in from transparent when dataset is shown using legend / "),a("RouterLink",{attrs:{to:"/developers/api.html#showdatasetIndex"}},[t._v("api")]),t._v(".")],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'show'")])]),t._v(" "),a("td",[t._v("animations.visible")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'boolean', duration: 0 }")])]),t._v(" "),a("td",[t._v("Dataset visibility is immediately changed to true so the color transition from transparent is visible.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'hide'")])]),t._v(" "),a("td",[t._v("animations.colors")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'color', properties: ['borderColor', 'backgroundColor'], to: 'transparent' }")])]),t._v(" "),a("td",[t._v("Colors are faded to transparent when dataset id hidden using legend / "),a("RouterLink",{attrs:{to:"/developers/api.html#hidedatasetIndex"}},[t._v("api")]),t._v(".")],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'hide'")])]),t._v(" "),a("td",[t._v("animations.visible")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'boolean', easing: 'easeInExpo' }")])]),t._v(" "),a("td",[t._v("Visibility is changed to false at a very late phase of animation")])])])]),t._v(" "),a("h2",{attrs:{id:"disabling-animation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disabling-animation"}},[t._v("#")]),t._v(" Disabling animation")]),t._v(" "),a("p",[t._v("To disable an animation configuration, the animation node must be set to "),a("code",[t._v("false")]),t._v(", with the exception for animation modes which can be disabled by setting the "),a("code",[t._v("duration")]),t._v(" to "),a("code",[t._v("0")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animation "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables all animations")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animations"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("colors "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables animation defined by the collection of 'colors' properties")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animations"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables animation defined by the 'x' property")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("transitions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("active"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animation"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("duration "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables the animation for 'active' mode")]),t._v("\n")])])]),a("h2",{attrs:{id:"easing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#easing"}},[t._v("#")]),t._v(" Easing")]),t._v(" "),a("p",[t._v("Available options are:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'linear'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInQuad'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutQuad'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutQuad'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInCubic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutCubic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutCubic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInQuart'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutQuart'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutQuart'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInQuint'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutQuint'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutQuint'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInSine'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutSine'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutSine'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInExpo'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutExpo'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutExpo'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInCirc'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutCirc'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutCirc'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInElastic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutElastic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutElastic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInBack'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutBack'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutBack'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInBounce'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutBounce'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutBounce'")])])]),t._v(" "),a("p",[t._v("See "),a("a",{attrs:{href:"http://robertpenner.com/easing/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Robert Penner's easing equations"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"animation-callbacks"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animation-callbacks"}},[t._v("#")]),t._v(" Animation Callbacks")]),t._v(" "),a("p",[t._v("The animation configuration provides callbacks which are useful for synchronizing an external draw to the chart animation.\nThe callbacks can be set only at main "),a("a",{attrs:{href:"#animation-configuration"}},[t._v("animation configuration")]),t._v(".")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.animation")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("onProgress")])]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("Callback called on each step of an animation.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("onComplete")])]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("Callback called when all animations are completed.")])])])]),t._v(" "),a("p",[t._v("The callback is passed the following object:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chart object")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Number of animations still in progress")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("currentStep")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// `true` for the initial animation of the chart")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("initial")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" boolean"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Total number of animations at the start of current animation")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("numSteps")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("The following example fills a progress bar during the chart animation.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("animation")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onProgress")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("animation")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n progress"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("value "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" animation"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("currentStep "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" animation"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("numSteps"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Another example usage of these callbacks can be found "),a("RouterLink",{attrs:{to:"/samples/advanced/progress-bar.html"}},[t._v("in this progress bar sample,")]),t._v(" which displays a progress bar showing how far along the animation is.")],1)],1)}),[],!1,null,null,null);a.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[156],{488:function(t,a,e){"use strict";e.r(a);var n=e(3),o=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" Animations")]),t._v(" "),a("p",[t._v("Chart.js animates charts out of the box. A number of options are provided to configure how the animation looks and how long it takes.")]),t._v(" "),a("tabs",[a("tab",{attrs:{name:"Looping tension [property]"}},[a("chart-editor",{attrs:{code:"// \nconst data = {\n labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'],\n datasets: [{\n label: 'Looping tension',\n data: [65, 59, 80, 81, 26, 55, 40],\n fill: false,\n borderColor: 'rgb(75, 192, 192)',\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animations: {\n tension: {\n duration: 1000,\n easing: 'linear',\n from: 1,\n to: 0,\n loop: true\n }\n },\n scales: {\n y: { // defining min and max so hiding the dataset does not change scale range\n min: 0,\n max: 100\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1),t._v(" "),a("tab",{attrs:{name:"Hide and show [mode]"}},[a("chart-editor",{attrs:{code:"// \nconst data = {\n labels: ['January', 'February', 'March', 'April', 'May', 'June', 'July'],\n datasets: [{\n label: 'Try hiding me',\n data: [65, 59, 80, 81, 26, 55, 40],\n fill: false,\n borderColor: 'rgb(75, 192, 192)',\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n transitions: {\n show: {\n animations: {\n x: {\n from: 0\n },\n y: {\n from: 0\n }\n }\n },\n hide: {\n animations: {\n x: {\n to: 0\n },\n y: {\n to: 0\n }\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)],1),t._v(" "),a("h2",{attrs:{id:"animation-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animation-configuration"}},[t._v("#")]),t._v(" Animation configuration")]),t._v(" "),a("p",[t._v("Animation configuration consists of 3 keys.")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Details")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("animation")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("a",{attrs:{href:"#animation"}},[t._v("animation")])])]),t._v(" "),a("tr",[a("td",[t._v("animations")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("a",{attrs:{href:"#animations"}},[t._v("animations")])])]),t._v(" "),a("tr",[a("td",[t._v("transitions")]),t._v(" "),a("td",[a("code",[t._v("object")])]),t._v(" "),a("td",[a("a",{attrs:{href:"#transitions"}},[t._v("transitions")])])])])]),t._v(" "),a("p",[t._v("These keys can be configured in following paths:")]),t._v(" "),a("ul",[a("li",[t._v("`` - chart options")]),t._v(" "),a("li",[a("code",[t._v("datasets[type]")]),t._v(" - dataset type options")]),t._v(" "),a("li",[a("code",[t._v("overrides[type]")]),t._v(" - chart type options")])]),t._v(" "),a("p",[t._v("These paths are valid under "),a("code",[t._v("defaults")]),t._v(" for global configuration and "),a("code",[t._v("options")]),t._v(" for instance configuration.")]),t._v(" "),a("h2",{attrs:{id:"animation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),a("p",[t._v("The default configuration is defined here: "),a("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/src/core/core.animations.js",target:"_blank"}},[t._v("core.animations.js")])]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.animation")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("duration")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("1000")])]),t._v(" "),a("td",[t._v("The number of milliseconds an animation takes.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("easing")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'easeOutQuart'")])]),t._v(" "),a("td",[t._v("Easing function to use. "),a("a",{attrs:{href:"#easing"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("delay")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("Delay before starting the animations.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("loop")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("If set to "),a("code",[t._v("true")]),t._v(", the animations loop endlessly.")])])])]),t._v(" "),a("p",[t._v("These defaults can be overridden in "),a("code",[t._v("options.animation")]),t._v(" or "),a("code",[t._v("dataset.animation")]),t._v(" and "),a("code",[t._v("tooltip.animation")]),t._v(". These keys are also "),a("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")]),t._v(".")],1),t._v(" "),a("h2",{attrs:{id:"animations-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animations-2"}},[t._v("#")]),t._v(" animations")]),t._v(" "),a("p",[t._v("Animations options configures which element properties are animated and how.\nIn addition to the main "),a("a",{attrs:{href:"#animation-configuration"}},[t._v("animation configuration")]),t._v(", the following options are available:")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.animations[animation]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("properties")])]),t._v(" "),a("td",[a("code",[t._v("string[]")])]),t._v(" "),a("td",[a("code",[t._v("key")])]),t._v(" "),a("td",[t._v("The property names this configuration applies to. Defaults to the key name of this object.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("typeof property")])]),t._v(" "),a("td",[t._v("Type of property, determines the interpolator used. Possible values: "),a("code",[t._v("'number'")]),t._v(", "),a("code",[t._v("'color'")]),t._v(" and "),a("code",[t._v("'boolean'")]),t._v(". Only really needed for "),a("code",[t._v("'color'")]),t._v(", because "),a("code",[t._v("typeof")]),t._v(" does not get that right.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("from")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("Color")]),t._v("|"),a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("Start value for the animation. Current value is used when "),a("code",[t._v("undefined")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("to")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("Color")]),t._v("|"),a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("End value for the animation. Updated value is used when "),a("code",[t._v("undefined")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("fn")])]),t._v(" "),a("td",[a("code",[t._v("(from: T, to: T, factor: number) => T;")])]),t._v(" "),a("td",[a("code",[t._v("undefined")])]),t._v(" "),a("td",[t._v("Optional custom interpolator, instead of using a predefined interpolator from "),a("code",[t._v("type")])])])])]),t._v(" "),a("h3",{attrs:{id:"default-animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#default-animations"}},[t._v("#")]),t._v(" Default animations")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Option")]),t._v(" "),a("th",[t._v("Value")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("numbers")])]),t._v(" "),a("td",[a("code",[t._v("properties")])]),t._v(" "),a("td",[a("code",[t._v("['x', 'y', 'borderWidth', 'radius', 'tension']")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("numbers")])]),t._v(" "),a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("'number'")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("colors")])]),t._v(" "),a("td",[a("code",[t._v("properties")])]),t._v(" "),a("td",[a("code",[t._v("['color', 'borderColor', 'backgroundColor']")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("colors")])]),t._v(" "),a("td",[a("code",[t._v("type")])]),t._v(" "),a("td",[a("code",[t._v("'color'")])])])])]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("These default animations are overridden by most of the dataset controllers.")])]),t._v(" "),a("h2",{attrs:{id:"transitions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),a("p",[t._v("The core transitions are "),a("code",[t._v("'active'")]),t._v(", "),a("code",[t._v("'hide'")]),t._v(", "),a("code",[t._v("'reset'")]),t._v(", "),a("code",[t._v("'resize'")]),t._v(", "),a("code",[t._v("'show'")]),t._v(".\nA custom transition can be used by passing a custom "),a("code",[t._v("mode")]),t._v(" to "),a("RouterLink",{attrs:{to:"/developers/api.html#updatemode"}},[t._v("update")]),t._v(".\nTransition extends the main "),a("a",{attrs:{href:"#animation-configuration"}},[t._v("animation configuration")]),t._v(" and "),a("a",{attrs:{href:"#animations-configuration"}},[t._v("animations configuration")]),t._v(".")],1),t._v(" "),a("h3",{attrs:{id:"default-transitions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#default-transitions"}},[t._v("#")]),t._v(" Default transitions")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.transitions[mode]")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Mode")]),t._v(" "),a("th",[t._v("Option")]),t._v(" "),a("th",[t._v("Value")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("'active'")])]),t._v(" "),a("td",[t._v("animation.duration")]),t._v(" "),a("td",[t._v("400")]),t._v(" "),a("td",[t._v("Override default duration to 400ms for hover animations")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'resize'")])]),t._v(" "),a("td",[t._v("animation.duration")]),t._v(" "),a("td",[t._v("0")]),t._v(" "),a("td",[t._v("Override default duration to 0ms (= no animation) for resize")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'show'")])]),t._v(" "),a("td",[t._v("animations.colors")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'color', properties: ['borderColor', 'backgroundColor'], from: 'transparent' }")])]),t._v(" "),a("td",[t._v("Colors are faded in from transparent when dataset is shown using legend / "),a("RouterLink",{attrs:{to:"/developers/api.html#showdatasetIndex"}},[t._v("api")]),t._v(".")],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'show'")])]),t._v(" "),a("td",[t._v("animations.visible")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'boolean', duration: 0 }")])]),t._v(" "),a("td",[t._v("Dataset visibility is immediately changed to true so the color transition from transparent is visible.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'hide'")])]),t._v(" "),a("td",[t._v("animations.colors")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'color', properties: ['borderColor', 'backgroundColor'], to: 'transparent' }")])]),t._v(" "),a("td",[t._v("Colors are faded to transparent when dataset id hidden using legend / "),a("RouterLink",{attrs:{to:"/developers/api.html#hidedatasetIndex"}},[t._v("api")]),t._v(".")],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("'hide'")])]),t._v(" "),a("td",[t._v("animations.visible")]),t._v(" "),a("td",[a("code",[t._v("{ type: 'boolean', easing: 'easeInExpo' }")])]),t._v(" "),a("td",[t._v("Visibility is changed to false at a very late phase of animation")])])])]),t._v(" "),a("h2",{attrs:{id:"disabling-animation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disabling-animation"}},[t._v("#")]),t._v(" Disabling animation")]),t._v(" "),a("p",[t._v("To disable an animation configuration, the animation node must be set to "),a("code",[t._v("false")]),t._v(", with the exception for animation modes which can be disabled by setting the "),a("code",[t._v("duration")]),t._v(" to "),a("code",[t._v("0")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animation "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables all animations")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animations"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("colors "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables animation defined by the collection of 'colors' properties")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animations"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables animation defined by the 'x' property")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("transitions"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("active"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("animation"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("duration "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disables the animation for 'active' mode")]),t._v("\n")])])]),a("h2",{attrs:{id:"easing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#easing"}},[t._v("#")]),t._v(" Easing")]),t._v(" "),a("p",[t._v("Available options are:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'linear'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInQuad'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutQuad'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutQuad'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInCubic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutCubic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutCubic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInQuart'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutQuart'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutQuart'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInQuint'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutQuint'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutQuint'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInSine'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutSine'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutSine'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInExpo'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutExpo'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutExpo'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInCirc'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutCirc'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutCirc'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInElastic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutElastic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutElastic'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInBack'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutBack'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutBack'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInBounce'")])]),t._v(" "),a("li",[a("code",[t._v("'easeOutBounce'")])]),t._v(" "),a("li",[a("code",[t._v("'easeInOutBounce'")])])]),t._v(" "),a("p",[t._v("See "),a("a",{attrs:{href:"http://robertpenner.com/easing/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Robert Penner's easing equations"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"animation-callbacks"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#animation-callbacks"}},[t._v("#")]),t._v(" Animation Callbacks")]),t._v(" "),a("p",[t._v("The animation configuration provides callbacks which are useful for synchronizing an external draw to the chart animation.\nThe callbacks can be set only at main "),a("a",{attrs:{href:"#animation-configuration"}},[t._v("animation configuration")]),t._v(".")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.animation")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("onProgress")])]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("Callback called on each step of an animation.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("onComplete")])]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("Callback called when all animations are completed.")])])])]),t._v(" "),a("p",[t._v("The callback is passed the following object:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chart object")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Number of animations still in progress")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("currentStep")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// `true` for the initial animation of the chart")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("initial")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" boolean"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Total number of animations at the start of current animation")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("numSteps")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("The following example fills a progress bar during the chart animation.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("animation")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onProgress")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("animation")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n progress"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("value "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" animation"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("currentStep "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" animation"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("numSteps"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Another example usage of these callbacks can be found "),a("RouterLink",{attrs:{to:"/samples/advanced/progress-bar.html"}},[t._v("in this progress bar sample,")]),t._v(" which displays a progress bar showing how far along the animation is.")],1)],1)}),[],!1,null,null,null);a.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/157.542f9168.js b/docs/master/assets/js/157.f46468b8.js similarity index 98% rename from docs/master/assets/js/157.542f9168.js rename to docs/master/assets/js/157.f46468b8.js index faa9cb8041..d43560e864 100644 --- a/docs/master/assets/js/157.542f9168.js +++ b/docs/master/assets/js/157.f46468b8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[157],{490:function(n,t,o){"use strict";o.r(t);var a=o(3),e=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"canvas-background"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#canvas-background"}},[n._v("#")]),n._v(" Canvas background")]),n._v(" "),t("p",[n._v("In some use cases you would want a background image or color over the whole canvas. There is no built-in support for this, the way you can achieve this is by writing a custom plugin.")]),n._v(" "),t("p",[n._v("In the two example plugins underneath here you can see how you can draw a color or image to the canvas as background. This way of giving the chart a background is only necessary if you want to export the chart with that specific background.\nFor normal use you can set the background more easily with "),t("a",{attrs:{href:"https://www.w3schools.com/cssref/css3_pr_background.asp",target:"_blank",rel:"noopener noreferrer"}},[n._v("CSS"),t("OutboundLink")],1),n._v(".")]),n._v(" "),t("tabs",[t("tab",{attrs:{name:"Color"}},[t("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \n// Note: changes to the plugin code is not reflected to the chart, because the plugin is loaded at chart construction time and editor changes only trigger an chart.update().\nconst plugin = {\n id: 'customCanvasBackgroundColor',\n beforeDraw: (chart, args, options) => {\n const {ctx} = chart;\n ctx.save();\n ctx.globalCompositeOperation = 'destination-over';\n ctx.fillStyle = options.color || '#99ffff';\n ctx.fillRect(0, 0, chart.width, chart.height);\n ctx.restore();\n }\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n options: {\n plugins: {\n customCanvasBackgroundColor: {\n color: 'lightGreen',\n }\n }\n },\n plugins: [plugin],\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1),n._v(" "),t("tab",{attrs:{name:"Image"}},[t("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \n// Note: changes to the plugin code is not reflected to the chart, because the plugin is loaded at chart construction time and editor changes only trigger an chart.update().\nconst image = new Image();\nimage.src = 'https://www.chartjs.org/img/chartjs-logo.svg';\n\nconst plugin = {\n id: 'customCanvasBackgroundImage',\n beforeDraw: (chart) => {\n if (image.complete) {\n const ctx = chart.ctx;\n const {top, left, width, height} = chart.chartArea;\n const x = left + width / 2 - image.width / 2;\n const y = top + height / 2 - image.height / 2;\n ctx.drawImage(image, x, y);\n } else {\n image.onload = () => chart.draw();\n }\n }\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n plugins: [plugin],\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)],1)],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[157],{489:function(n,t,o){"use strict";o.r(t);var a=o(3),e=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"canvas-background"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#canvas-background"}},[n._v("#")]),n._v(" Canvas background")]),n._v(" "),t("p",[n._v("In some use cases you would want a background image or color over the whole canvas. There is no built-in support for this, the way you can achieve this is by writing a custom plugin.")]),n._v(" "),t("p",[n._v("In the two example plugins underneath here you can see how you can draw a color or image to the canvas as background. This way of giving the chart a background is only necessary if you want to export the chart with that specific background.\nFor normal use you can set the background more easily with "),t("a",{attrs:{href:"https://www.w3schools.com/cssref/css3_pr_background.asp",target:"_blank",rel:"noopener noreferrer"}},[n._v("CSS"),t("OutboundLink")],1),n._v(".")]),n._v(" "),t("tabs",[t("tab",{attrs:{name:"Color"}},[t("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \n// Note: changes to the plugin code is not reflected to the chart, because the plugin is loaded at chart construction time and editor changes only trigger an chart.update().\nconst plugin = {\n id: 'customCanvasBackgroundColor',\n beforeDraw: (chart, args, options) => {\n const {ctx} = chart;\n ctx.save();\n ctx.globalCompositeOperation = 'destination-over';\n ctx.fillStyle = options.color || '#99ffff';\n ctx.fillRect(0, 0, chart.width, chart.height);\n ctx.restore();\n }\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n options: {\n plugins: {\n customCanvasBackgroundColor: {\n color: 'lightGreen',\n }\n }\n },\n plugins: [plugin],\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1),n._v(" "),t("tab",{attrs:{name:"Image"}},[t("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [\n 'Red',\n 'Blue',\n 'Yellow'\n ],\n datasets: [{\n label: 'My First Dataset',\n data: [300, 50, 100],\n backgroundColor: [\n 'rgb(255, 99, 132)',\n 'rgb(54, 162, 235)',\n 'rgb(255, 205, 86)'\n ],\n hoverOffset: 4\n }]\n};\n// \n\n// \n// Note: changes to the plugin code is not reflected to the chart, because the plugin is loaded at chart construction time and editor changes only trigger an chart.update().\nconst image = new Image();\nimage.src = 'https://www.chartjs.org/img/chartjs-logo.svg';\n\nconst plugin = {\n id: 'customCanvasBackgroundImage',\n beforeDraw: (chart) => {\n if (image.complete) {\n const ctx = chart.ctx;\n const {top, left, width, height} = chart.chartArea;\n const x = left + width / 2 - image.width / 2;\n const y = top + height / 2 - image.height / 2;\n ctx.drawImage(image, x, y);\n } else {\n image.onload = () => chart.draw();\n }\n }\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n plugins: [plugin],\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}})],1)],1)],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/158.140156f4.js b/docs/master/assets/js/158.37e9f214.js similarity index 98% rename from docs/master/assets/js/158.140156f4.js rename to docs/master/assets/js/158.37e9f214.js index f200c510ea..4618de0e89 100644 --- a/docs/master/assets/js/158.140156f4.js +++ b/docs/master/assets/js/158.37e9f214.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[158],{488:function(t,e,a){"use strict";a.r(e);var i=a(3),o=Object(i.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"data-decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-decimation"}},[t._v("#")]),t._v(" Data Decimation")]),t._v(" "),e("p",[t._v("The decimation plugin can be used with line charts to automatically decimate data at the start of the chart lifecycle. Before enabling this plugin, review the "),e("a",{attrs:{href:"#requirements"}},[t._v("requirements")]),t._v(" to ensure that it will work with the chart you want to create.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.decimation")]),t._v(", the global options for the plugin are defined in "),e("code",[t._v("Chart.defaults.plugins.decimation")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("enabled")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Is decimation enabled?")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("algorithm")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'min-max'")])]),t._v(" "),e("td",[t._v("Decimation algorithm to use. See the "),e("a",{attrs:{href:"#decimation-algorithms"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("samples")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("If the "),e("code",[t._v("'lttb'")]),t._v(" algorithm is used, this is the number of samples in the output dataset. Defaults to the canvas width to pick 1 sample per pixel.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("threshold")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("If the number of samples in the current axis range is above this value, the decimation will be triggered. Defaults to 4 times the canvas width."),e("br"),t._v("The number of point after decimation can be higher than the "),e("code",[t._v("threshold")]),t._v(" value.")])])])]),t._v(" "),e("h2",{attrs:{id:"decimation-algorithms"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decimation-algorithms"}},[t._v("#")]),t._v(" Decimation Algorithms")]),t._v(" "),e("p",[t._v("Decimation algorithm to use for data. Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'lttb'")])]),t._v(" "),e("li",[e("code",[t._v("'min-max'")])])]),t._v(" "),e("h3",{attrs:{id:"largest-triangle-three-bucket-lttb-decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#largest-triangle-three-bucket-lttb-decimation"}},[t._v("#")]),t._v(" Largest Triangle Three Bucket (LTTB) Decimation")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/sveinn-steinarsson/flot-downsample",target:"_blank",rel:"noopener noreferrer"}},[t._v("LTTB"),e("OutboundLink")],1),t._v(" decimation reduces the number of data points significantly. This is most useful for showing trends in data using only a few data points.")]),t._v(" "),e("h3",{attrs:{id:"min-max-decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min-max-decimation"}},[t._v("#")]),t._v(" Min/Max Decimation")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://digital.ni.com/public.nsf/allkb/F694FFEEA0ACF282862576020075F784",target:"_blank",rel:"noopener noreferrer"}},[t._v("Min/max"),e("OutboundLink")],1),t._v(" decimation will preserve peaks in your data but could require up to 4 points for each pixel. This type of decimation would work well for a very noisy signal where you need to see data peaks.")]),t._v(" "),e("h2",{attrs:{id:"requirements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#requirements"}},[t._v("#")]),t._v(" Requirements")]),t._v(" "),e("p",[t._v("To use the decimation plugin, the following requirements must be met:")]),t._v(" "),e("ol",[e("li",[t._v("The dataset must have an "),e("RouterLink",{attrs:{to:"/charts/line.html#general"}},[e("code",[t._v("indexAxis")])]),t._v(" of "),e("code",[t._v("'x'")])],1),t._v(" "),e("li",[t._v("The dataset must be a line")]),t._v(" "),e("li",[t._v("The X axis for the dataset must be either a "),e("RouterLink",{attrs:{to:"/axes/cartesian/linear.html"}},[e("code",[t._v("'linear'")])]),t._v(" or "),e("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[e("code",[t._v("'time'")])]),t._v(" type axis")],1),t._v(" "),e("li",[t._v("Data must not need parsing, i.e. "),e("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[e("code",[t._v("parsing")])]),t._v(" must be "),e("code",[t._v("false")])],1),t._v(" "),e("li",[t._v("The dataset object must be mutable. The plugin stores the original data as "),e("code",[t._v("dataset._data")]),t._v(" and then defines a new "),e("code",[t._v("data")]),t._v(" property on the dataset.")]),t._v(" "),e("li",[t._v("There must be more points on the chart than the threshold value. Take a look at the Configuration Options for more information.")])]),t._v(" "),e("h2",{attrs:{id:"related-samples"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#related-samples"}},[t._v("#")]),t._v(" Related Samples")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"../samples/advanced/data-decimation"}},[t._v("Data Decimation Sample")])])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[158],{491:function(t,e,a){"use strict";a.r(e);var i=a(3),o=Object(i.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"data-decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data-decimation"}},[t._v("#")]),t._v(" Data Decimation")]),t._v(" "),e("p",[t._v("The decimation plugin can be used with line charts to automatically decimate data at the start of the chart lifecycle. Before enabling this plugin, review the "),e("a",{attrs:{href:"#requirements"}},[t._v("requirements")]),t._v(" to ensure that it will work with the chart you want to create.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.decimation")]),t._v(", the global options for the plugin are defined in "),e("code",[t._v("Chart.defaults.plugins.decimation")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("enabled")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Is decimation enabled?")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("algorithm")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'min-max'")])]),t._v(" "),e("td",[t._v("Decimation algorithm to use. See the "),e("a",{attrs:{href:"#decimation-algorithms"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("samples")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("If the "),e("code",[t._v("'lttb'")]),t._v(" algorithm is used, this is the number of samples in the output dataset. Defaults to the canvas width to pick 1 sample per pixel.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("threshold")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("If the number of samples in the current axis range is above this value, the decimation will be triggered. Defaults to 4 times the canvas width."),e("br"),t._v("The number of point after decimation can be higher than the "),e("code",[t._v("threshold")]),t._v(" value.")])])])]),t._v(" "),e("h2",{attrs:{id:"decimation-algorithms"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#decimation-algorithms"}},[t._v("#")]),t._v(" Decimation Algorithms")]),t._v(" "),e("p",[t._v("Decimation algorithm to use for data. Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'lttb'")])]),t._v(" "),e("li",[e("code",[t._v("'min-max'")])])]),t._v(" "),e("h3",{attrs:{id:"largest-triangle-three-bucket-lttb-decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#largest-triangle-three-bucket-lttb-decimation"}},[t._v("#")]),t._v(" Largest Triangle Three Bucket (LTTB) Decimation")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/sveinn-steinarsson/flot-downsample",target:"_blank",rel:"noopener noreferrer"}},[t._v("LTTB"),e("OutboundLink")],1),t._v(" decimation reduces the number of data points significantly. This is most useful for showing trends in data using only a few data points.")]),t._v(" "),e("h3",{attrs:{id:"min-max-decimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min-max-decimation"}},[t._v("#")]),t._v(" Min/Max Decimation")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://digital.ni.com/public.nsf/allkb/F694FFEEA0ACF282862576020075F784",target:"_blank",rel:"noopener noreferrer"}},[t._v("Min/max"),e("OutboundLink")],1),t._v(" decimation will preserve peaks in your data but could require up to 4 points for each pixel. This type of decimation would work well for a very noisy signal where you need to see data peaks.")]),t._v(" "),e("h2",{attrs:{id:"requirements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#requirements"}},[t._v("#")]),t._v(" Requirements")]),t._v(" "),e("p",[t._v("To use the decimation plugin, the following requirements must be met:")]),t._v(" "),e("ol",[e("li",[t._v("The dataset must have an "),e("RouterLink",{attrs:{to:"/charts/line.html#general"}},[e("code",[t._v("indexAxis")])]),t._v(" of "),e("code",[t._v("'x'")])],1),t._v(" "),e("li",[t._v("The dataset must be a line")]),t._v(" "),e("li",[t._v("The X axis for the dataset must be either a "),e("RouterLink",{attrs:{to:"/axes/cartesian/linear.html"}},[e("code",[t._v("'linear'")])]),t._v(" or "),e("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[e("code",[t._v("'time'")])]),t._v(" type axis")],1),t._v(" "),e("li",[t._v("Data must not need parsing, i.e. "),e("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[e("code",[t._v("parsing")])]),t._v(" must be "),e("code",[t._v("false")])],1),t._v(" "),e("li",[t._v("The dataset object must be mutable. The plugin stores the original data as "),e("code",[t._v("dataset._data")]),t._v(" and then defines a new "),e("code",[t._v("data")]),t._v(" property on the dataset.")]),t._v(" "),e("li",[t._v("There must be more points on the chart than the threshold value. Take a look at the Configuration Options for more information.")])]),t._v(" "),e("h2",{attrs:{id:"related-samples"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#related-samples"}},[t._v("#")]),t._v(" Related Samples")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"../samples/advanced/data-decimation"}},[t._v("Data Decimation Sample")])])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/159.cc3492e9.js b/docs/master/assets/js/159.c3c9e5b3.js similarity index 96% rename from docs/master/assets/js/159.cc3492e9.js rename to docs/master/assets/js/159.c3c9e5b3.js index 752c452f1e..b4f5ebc84d 100644 --- a/docs/master/assets/js/159.cc3492e9.js +++ b/docs/master/assets/js/159.c3c9e5b3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[159],{489:function(e,t,i){"use strict";i.r(t);var a=i(3),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"device-pixel-ratio"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#device-pixel-ratio"}},[e._v("#")]),e._v(" Device Pixel Ratio")]),e._v(" "),t("p",[e._v("By default, the chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g. Retina displays).")]),e._v(" "),t("p",[e._v("For applications where a chart will be converted to a bitmap, or printed to a higher DPI medium, it can be desirable to render the chart at a higher resolution than the default.")]),e._v(" "),t("p",[e._v("Setting "),t("code",[e._v("devicePixelRatio")]),e._v(" to a value other than 1 will force the canvas size to be scaled by that amount, relative to the container size. There should be no visible difference on screen; the difference will only be visible when the image is zoomed or printed.")]),e._v(" "),t("h2",{attrs:{id:"configuration-options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[e._v("#")]),e._v(" Configuration Options")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("devicePixelRatio")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("window.devicePixelRatio")])]),e._v(" "),t("td",[e._v("Override the window's default devicePixelRatio.")])])])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[159],{490:function(e,t,i){"use strict";i.r(t);var a=i(3),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"device-pixel-ratio"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#device-pixel-ratio"}},[e._v("#")]),e._v(" Device Pixel Ratio")]),e._v(" "),t("p",[e._v("By default, the chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g. Retina displays).")]),e._v(" "),t("p",[e._v("For applications where a chart will be converted to a bitmap, or printed to a higher DPI medium, it can be desirable to render the chart at a higher resolution than the default.")]),e._v(" "),t("p",[e._v("Setting "),t("code",[e._v("devicePixelRatio")]),e._v(" to a value other than 1 will force the canvas size to be scaled by that amount, relative to the container size. There should be no visible difference on screen; the difference will only be visible when the image is zoomed or printed.")]),e._v(" "),t("h2",{attrs:{id:"configuration-options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[e._v("#")]),e._v(" Configuration Options")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("devicePixelRatio")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("window.devicePixelRatio")])]),e._v(" "),t("td",[e._v("Override the window's default devicePixelRatio.")])])])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/16.a5b1b645.js b/docs/master/assets/js/16.1f4b8a5e.js similarity index 94% rename from docs/master/assets/js/16.a5b1b645.js rename to docs/master/assets/js/16.1f4b8a5e.js index 798c3559d7..f56a262058 100644 --- a/docs/master/assets/js/16.a5b1b645.js +++ b/docs/master/assets/js/16.1f4b8a5e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{349:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-arcelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-arcelement"}},[t._v("#")]),t._v(" Class: ArcElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcOptions.html"}},[e("code",[t._v("ArcOptions")])]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("ArcElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new ArcElement")]),t._v("("),e("code",[t._v("cfg")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"circumference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#circumference"}},[t._v("#")]),t._v(" circumference")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("circumference")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L290",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:290"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"endangle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#endangle"}},[t._v("#")]),t._v(" endAngle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("endAngle")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L291",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullcircles"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullcircles"}},[t._v("#")]),t._v(" fullCircles")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullCircles")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L292",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:292"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"innerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#innerradius"}},[t._v("#")]),t._v(" innerRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("innerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L293",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:293"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcOptions.html"}},[e("code",[t._v("ArcOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"outerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#outerradius"}},[t._v("#")]),t._v(" outerRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("outerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L294",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:294"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pixelmargin"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pixelmargin"}},[t._v("#")]),t._v(" pixelMargin")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pixelMargin")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L295",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:295"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"startangle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#startangle"}},[t._v("#")]),t._v(" startAngle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("startAngle")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L296",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:296"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaultroutes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaultroutes"}},[t._v("#")]),t._v(" defaultRoutes")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaultRoutes")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-2"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaultRoutes")]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L281",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderAlign")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderDash")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderJoinStyle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderRadius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("circular")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("offset")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("spacing")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-3"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaults")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L267",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:267"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"descriptors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#descriptors"}},[t._v("#")]),t._v(" descriptors")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("descriptors")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("_indexable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("name")]),t._v(": "),e("code",[t._v("any")]),t._v(") => "),e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("_scriptable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L285",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")]),t._v(" = "),e("code",[t._v("'arc'")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L265",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:265"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L355",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L333",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("chartX")]),t._v(", "),e("code",[t._v("chartY")]),t._v(", "),e("code",[t._v("useFinalPosition")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L315",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:315"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-4"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L351",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:351"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[16],{599:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-arcelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-arcelement"}},[t._v("#")]),t._v(" Class: ArcElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcOptions.html"}},[e("code",[t._v("ArcOptions")])]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("ArcElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new ArcElement")]),t._v("("),e("code",[t._v("cfg")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"circumference"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#circumference"}},[t._v("#")]),t._v(" circumference")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("circumference")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L290",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:290"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"endangle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#endangle"}},[t._v("#")]),t._v(" endAngle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("endAngle")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L291",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullcircles"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullcircles"}},[t._v("#")]),t._v(" fullCircles")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullCircles")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L292",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:292"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"innerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#innerradius"}},[t._v("#")]),t._v(" innerRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("innerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L293",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:293"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcOptions.html"}},[e("code",[t._v("ArcOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"outerradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#outerradius"}},[t._v("#")]),t._v(" outerRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("outerRadius")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L294",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:294"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pixelmargin"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pixelmargin"}},[t._v("#")]),t._v(" pixelMargin")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pixelMargin")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L295",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:295"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"startangle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#startangle"}},[t._v("#")]),t._v(" startAngle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("startAngle")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L296",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:296"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaultroutes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaultroutes"}},[t._v("#")]),t._v(" defaultRoutes")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaultRoutes")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-2"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaultRoutes")]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L281",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("angle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderAlign")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderDash")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderDashOffset")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderJoinStyle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderRadius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("circular")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("offset")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("spacing")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-3"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaults")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L267",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:267"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"descriptors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#descriptors"}},[t._v("#")]),t._v(" descriptors")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("descriptors")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-3"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("_indexable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("name")]),t._v(": "),e("code",[t._v("any")]),t._v(") => "),e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("_scriptable")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L285",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")]),t._v(" = "),e("code",[t._v("'arc'")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L265",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:265"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L355",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L333",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ArcProps.html"}},[e("code",[t._v("ArcProps")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("chartX")]),t._v(", "),e("code",[t._v("chartY")]),t._v(", "),e("code",[t._v("useFinalPosition")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L315",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:315"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-4"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L351",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.arc.ts:351"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/160.9e1ae630.js b/docs/master/assets/js/160.f2c5cca8.js similarity index 99% rename from docs/master/assets/js/160.9e1ae630.js rename to docs/master/assets/js/160.f2c5cca8.js index 318df20257..cf13a83e61 100644 --- a/docs/master/assets/js/160.9e1ae630.js +++ b/docs/master/assets/js/160.f2c5cca8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[160],{491:function(e,t,o){"use strict";o.r(t);var r=o(3),v=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"elements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#elements"}},[e._v("#")]),e._v(" Elements")]),e._v(" "),t("p",[e._v("While chart types provide settings to configure the styling of each dataset, you sometimes want to style "),t("strong",[e._v("all datasets the same way")]),e._v(". A common example would be to stroke all the bars in a bar chart with the same colour but change the fill per dataset. Options can be configured for four different types of elements: "),t("strong",[t("a",{attrs:{href:"#arc-configuration"}},[e._v("arc")])]),e._v(", "),t("strong",[t("a",{attrs:{href:"#line-configuration"}},[e._v("lines")])]),e._v(", "),t("strong",[t("a",{attrs:{href:"#point-configuration"}},[e._v("points")])]),e._v(", and "),t("strong",[t("a",{attrs:{href:"#bar-configuration"}},[e._v("bars")])]),e._v(". When set, these options apply to all objects of that type unless specifically overridden by the configuration attached to a dataset.")]),e._v(" "),t("h2",{attrs:{id:"global-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#global-configuration"}},[e._v("#")]),e._v(" Global Configuration")]),e._v(" "),t("p",[e._v("The element options can be specified per chart or globally. The global options for elements are defined in "),t("code",[e._v("Chart.defaults.elements")]),e._v(". For example, to set the border width of all bar charts globally, you would do:")]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[e._v("Chart"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("defaults"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("elements"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("bar"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("borderWidth "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h2",{attrs:{id:"point-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#point-configuration"}},[e._v("#")]),e._v(" Point Configuration")]),e._v(" "),t("p",[e._v("Point elements are used to represent the points in a line, radar or bubble chart.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.point")]),e._v(", global point options: "),t("code",[e._v("Chart.defaults.elements.point")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("radius")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("3")])]),e._v(" "),t("td",[e._v("Point radius.")])]),e._v(" "),t("tr",[t("td",[t("a",{attrs:{href:"#point-styles"}},[t("code",[e._v("pointStyle")])])]),e._v(" "),t("td",[t("a",{attrs:{href:"#types"}},[t("code",[e._v("pointStyle")])])]),e._v(" "),t("td",[t("code",[e._v("'circle'")])]),e._v(" "),t("td",[e._v("Point style.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("rotation")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("Point rotation (in degrees).")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Point fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("1")])]),e._v(" "),t("td",[e._v("Point stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("'Chart.defaults.borderColor")])]),e._v(" "),t("td",[e._v("Point stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hitRadius")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("1")])]),e._v(" "),t("td",[e._v("Extra radius added to point radius for hit detection.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hoverRadius")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("4")])]),e._v(" "),t("td",[e._v("Point radius when hovered.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hoverBorderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("1")])]),e._v(" "),t("td",[e._v("Stroke width when hovered.")])])])]),e._v(" "),t("h3",{attrs:{id:"point-styles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#point-styles"}},[e._v("#")]),e._v(" Point Styles")]),e._v(" "),t("h4",{attrs:{id:"types"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#types"}},[e._v("#")]),e._v(" Types")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("pointStyle")]),e._v(" argument accepts the following type of inputs: "),t("code",[e._v("string")]),e._v(", "),t("code",[e._v("Image")]),e._v(" and "),t("code",[e._v("HTMLCanvasElement")])]),e._v(" "),t("h4",{attrs:{id:"info"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#info"}},[e._v("#")]),e._v(" Info")]),e._v(" "),t("p",[e._v("When a string is provided, the following values are supported:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("'circle'")])]),e._v(" "),t("li",[t("code",[e._v("'cross'")])]),e._v(" "),t("li",[t("code",[e._v("'crossRot'")])]),e._v(" "),t("li",[t("code",[e._v("'dash'")])]),e._v(" "),t("li",[t("code",[e._v("'line'")])]),e._v(" "),t("li",[t("code",[e._v("'rect'")])]),e._v(" "),t("li",[t("code",[e._v("'rectRounded'")])]),e._v(" "),t("li",[t("code",[e._v("'rectRot'")])]),e._v(" "),t("li",[t("code",[e._v("'star'")])]),e._v(" "),t("li",[t("code",[e._v("'triangle'")])]),e._v(" "),t("li",[t("code",[e._v("false")])])]),e._v(" "),t("p",[e._v("If the value is an image or a canvas element, that image or canvas element is drawn on the canvas using "),t("a",{attrs:{href:"https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/drawImage",target:"_blank",rel:"noopener noreferrer"}},[e._v("drawImage"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"line-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-configuration"}},[e._v("#")]),e._v(" Line Configuration")]),e._v(" "),t("p",[e._v("Line elements are used to represent the line in a line chart.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.line")]),e._v(", global line options: "),t("code",[e._v("Chart.defaults.elements.line")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("tension")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("Bézier curve tension ("),t("code",[e._v("0")]),e._v(" for no Bézier curves).")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Line fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("3")])]),e._v(" "),t("td",[e._v("Line stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.borderColor")])]),e._v(" "),t("td",[e._v("Line stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderCapStyle")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("'butt'")])]),e._v(" "),t("td",[e._v("Line cap style. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDash")])]),e._v(" "),t("td",[t("code",[e._v("number[]")])]),e._v(" "),t("td",[t("code",[e._v("[]")])]),e._v(" "),t("td",[e._v("Line dash. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDashOffset")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0.0")])]),e._v(" "),t("td",[e._v("Line dash offset. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderJoinStyle")])]),e._v(" "),t("td",[t("code",[e._v("'round'")]),e._v("|"),t("code",[e._v("'bevel'")]),e._v("|"),t("code",[e._v("'miter'")])]),e._v(" "),t("td",[t("code",[e._v("'miter'")])]),e._v(" "),t("td",[e._v("Line join style. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("capBezierPoints")])]),e._v(" "),t("td",[t("code",[e._v("boolean")])]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[t("code",[e._v("true")]),e._v(" to keep Bézier control inside the chart, "),t("code",[e._v("false")]),e._v(" for no restriction.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("cubicInterpolationMode")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("'default'")])]),e._v(" "),t("td",[e._v("Interpolation mode to apply. "),t("RouterLink",{attrs:{to:"/charts/line.html#cubicinterpolationmode"}},[e._v("See more...")])],1)]),e._v(" "),t("tr",[t("td",[t("code",[e._v("fill")])]),e._v(" "),t("td",[t("code",[e._v("boolean")]),e._v("|"),t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("false")])]),e._v(" "),t("td",[e._v("How to fill the area under the line. See "),t("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[e._v("area charts")]),e._v(".")],1)]),e._v(" "),t("tr",[t("td",[t("code",[e._v("stepped")])]),e._v(" "),t("td",[t("code",[e._v("boolean")])]),e._v(" "),t("td",[t("code",[e._v("false")])]),e._v(" "),t("td",[t("code",[e._v("true")]),e._v(" to show the line as a stepped line ("),t("code",[e._v("tension")]),e._v(" will be ignored).")])])])]),e._v(" "),t("h2",{attrs:{id:"bar-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bar-configuration"}},[e._v("#")]),e._v(" Bar Configuration")]),e._v(" "),t("p",[e._v("Bar elements are used to represent the bars in a bar chart.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.bar")]),e._v(", global bar options: "),t("code",[e._v("Chart.defaults.elements.bar")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Bar fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("Bar stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.borderColor")])]),e._v(" "),t("td",[e._v("Bar stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderSkipped")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("'start'")])]),e._v(" "),t("td",[e._v("Skipped (excluded) border: "),t("code",[e._v("'start'")]),e._v(", "),t("code",[e._v("'end'")]),e._v(", "),t("code",[e._v("'middle'")]),e._v(", "),t("code",[e._v("'bottom'")]),e._v(", "),t("code",[e._v("'left'")]),e._v(", "),t("code",[e._v("'top'")]),e._v(", "),t("code",[e._v("'right'")]),e._v(" or "),t("code",[e._v("false")]),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderRadius")])]),e._v(" "),t("td",[t("code",[e._v("number")]),e._v("|"),t("code",[e._v("object")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("The bar border radius (in pixels).")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("inflateAmount")])]),e._v(" "),t("td",[t("code",[e._v("number")]),e._v("|"),t("code",[e._v("'auto'")])]),e._v(" "),t("td",[t("code",[e._v("'auto'")])]),e._v(" "),t("td",[e._v("The amount of pixels to inflate the bar rectangle(s) when drawing.")])]),e._v(" "),t("tr",[t("td",[t("a",{attrs:{href:"#point-styles"}},[t("code",[e._v("pointStyle")])])]),e._v(" "),t("td",[t("code",[e._v("string")]),e._v("|"),t("code",[e._v("Image")]),e._v("|"),t("code",[e._v("HTMLCanvasElement")])]),e._v(" "),t("td",[t("code",[e._v("'circle'")])]),e._v(" "),t("td",[e._v("Style of the point for legend.")])])])]),e._v(" "),t("h2",{attrs:{id:"arc-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arc-configuration"}},[e._v("#")]),e._v(" Arc Configuration")]),e._v(" "),t("p",[e._v("Arcs are used in the polar area, doughnut and pie charts.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.arc")]),e._v(", global arc options: "),t("code",[e._v("Chart.defaults.elements.arc")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("angle")]),e._v(" - for polar only")]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("circumference / (arc count)")])]),e._v(" "),t("td",[e._v("Arc angle to cover.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Arc fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderAlign")])]),e._v(" "),t("td",[t("code",[e._v("'center'")]),e._v("|"),t("code",[e._v("'inner'")])]),e._v(" "),t("td",[t("code",[e._v("'center'")])]),e._v(" "),t("td",[e._v("Arc stroke alignment.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("'#fff'")])]),e._v(" "),t("td",[e._v("Arc stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDash")])]),e._v(" "),t("td",[t("code",[e._v("number[]")])]),e._v(" "),t("td",[t("code",[e._v("[]")])]),e._v(" "),t("td",[e._v("Arc line dash. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDashOffset")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0.0")])]),e._v(" "),t("td",[e._v("Arc line dash offset. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderJoinStyle")])]),e._v(" "),t("td",[t("code",[e._v("'round'")]),e._v("|"),t("code",[e._v("'bevel'")]),e._v("|"),t("code",[e._v("'miter'")])]),e._v(" "),t("td",[t("code",[e._v("'bevel'")]),e._v("|"),t("code",[e._v("'round'")])]),e._v(" "),t("td",[e._v("Line join style. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(". The default is "),t("code",[e._v("'round'")]),e._v(" when "),t("code",[e._v("borderAlign")]),e._v(" is "),t("code",[e._v("'inner'")])])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("2")])]),e._v(" "),t("td",[e._v("Arc stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("circular")])]),e._v(" "),t("td",[t("code",[e._v("boolean")])]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("By default the Arc is curved. If "),t("code",[e._v("circular: false")]),e._v(" the Arc will be flat")])])])])])}),[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[160],{493:function(e,t,o){"use strict";o.r(t);var r=o(3),v=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"elements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#elements"}},[e._v("#")]),e._v(" Elements")]),e._v(" "),t("p",[e._v("While chart types provide settings to configure the styling of each dataset, you sometimes want to style "),t("strong",[e._v("all datasets the same way")]),e._v(". A common example would be to stroke all the bars in a bar chart with the same colour but change the fill per dataset. Options can be configured for four different types of elements: "),t("strong",[t("a",{attrs:{href:"#arc-configuration"}},[e._v("arc")])]),e._v(", "),t("strong",[t("a",{attrs:{href:"#line-configuration"}},[e._v("lines")])]),e._v(", "),t("strong",[t("a",{attrs:{href:"#point-configuration"}},[e._v("points")])]),e._v(", and "),t("strong",[t("a",{attrs:{href:"#bar-configuration"}},[e._v("bars")])]),e._v(". When set, these options apply to all objects of that type unless specifically overridden by the configuration attached to a dataset.")]),e._v(" "),t("h2",{attrs:{id:"global-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#global-configuration"}},[e._v("#")]),e._v(" Global Configuration")]),e._v(" "),t("p",[e._v("The element options can be specified per chart or globally. The global options for elements are defined in "),t("code",[e._v("Chart.defaults.elements")]),e._v(". For example, to set the border width of all bar charts globally, you would do:")]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[e._v("Chart"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("defaults"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("elements"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("bar"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("borderWidth "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n")])])]),t("h2",{attrs:{id:"point-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#point-configuration"}},[e._v("#")]),e._v(" Point Configuration")]),e._v(" "),t("p",[e._v("Point elements are used to represent the points in a line, radar or bubble chart.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.point")]),e._v(", global point options: "),t("code",[e._v("Chart.defaults.elements.point")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("radius")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("3")])]),e._v(" "),t("td",[e._v("Point radius.")])]),e._v(" "),t("tr",[t("td",[t("a",{attrs:{href:"#point-styles"}},[t("code",[e._v("pointStyle")])])]),e._v(" "),t("td",[t("a",{attrs:{href:"#types"}},[t("code",[e._v("pointStyle")])])]),e._v(" "),t("td",[t("code",[e._v("'circle'")])]),e._v(" "),t("td",[e._v("Point style.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("rotation")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("Point rotation (in degrees).")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Point fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("1")])]),e._v(" "),t("td",[e._v("Point stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("'Chart.defaults.borderColor")])]),e._v(" "),t("td",[e._v("Point stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hitRadius")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("1")])]),e._v(" "),t("td",[e._v("Extra radius added to point radius for hit detection.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hoverRadius")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("4")])]),e._v(" "),t("td",[e._v("Point radius when hovered.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("hoverBorderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("1")])]),e._v(" "),t("td",[e._v("Stroke width when hovered.")])])])]),e._v(" "),t("h3",{attrs:{id:"point-styles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#point-styles"}},[e._v("#")]),e._v(" Point Styles")]),e._v(" "),t("h4",{attrs:{id:"types"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#types"}},[e._v("#")]),e._v(" Types")]),e._v(" "),t("p",[e._v("The "),t("code",[e._v("pointStyle")]),e._v(" argument accepts the following type of inputs: "),t("code",[e._v("string")]),e._v(", "),t("code",[e._v("Image")]),e._v(" and "),t("code",[e._v("HTMLCanvasElement")])]),e._v(" "),t("h4",{attrs:{id:"info"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#info"}},[e._v("#")]),e._v(" Info")]),e._v(" "),t("p",[e._v("When a string is provided, the following values are supported:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("'circle'")])]),e._v(" "),t("li",[t("code",[e._v("'cross'")])]),e._v(" "),t("li",[t("code",[e._v("'crossRot'")])]),e._v(" "),t("li",[t("code",[e._v("'dash'")])]),e._v(" "),t("li",[t("code",[e._v("'line'")])]),e._v(" "),t("li",[t("code",[e._v("'rect'")])]),e._v(" "),t("li",[t("code",[e._v("'rectRounded'")])]),e._v(" "),t("li",[t("code",[e._v("'rectRot'")])]),e._v(" "),t("li",[t("code",[e._v("'star'")])]),e._v(" "),t("li",[t("code",[e._v("'triangle'")])]),e._v(" "),t("li",[t("code",[e._v("false")])])]),e._v(" "),t("p",[e._v("If the value is an image or a canvas element, that image or canvas element is drawn on the canvas using "),t("a",{attrs:{href:"https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/drawImage",target:"_blank",rel:"noopener noreferrer"}},[e._v("drawImage"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"line-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-configuration"}},[e._v("#")]),e._v(" Line Configuration")]),e._v(" "),t("p",[e._v("Line elements are used to represent the line in a line chart.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.line")]),e._v(", global line options: "),t("code",[e._v("Chart.defaults.elements.line")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("tension")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("Bézier curve tension ("),t("code",[e._v("0")]),e._v(" for no Bézier curves).")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Line fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("3")])]),e._v(" "),t("td",[e._v("Line stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.borderColor")])]),e._v(" "),t("td",[e._v("Line stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderCapStyle")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("'butt'")])]),e._v(" "),t("td",[e._v("Line cap style. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDash")])]),e._v(" "),t("td",[t("code",[e._v("number[]")])]),e._v(" "),t("td",[t("code",[e._v("[]")])]),e._v(" "),t("td",[e._v("Line dash. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDashOffset")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0.0")])]),e._v(" "),t("td",[e._v("Line dash offset. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderJoinStyle")])]),e._v(" "),t("td",[t("code",[e._v("'round'")]),e._v("|"),t("code",[e._v("'bevel'")]),e._v("|"),t("code",[e._v("'miter'")])]),e._v(" "),t("td",[t("code",[e._v("'miter'")])]),e._v(" "),t("td",[e._v("Line join style. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("capBezierPoints")])]),e._v(" "),t("td",[t("code",[e._v("boolean")])]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[t("code",[e._v("true")]),e._v(" to keep Bézier control inside the chart, "),t("code",[e._v("false")]),e._v(" for no restriction.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("cubicInterpolationMode")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("'default'")])]),e._v(" "),t("td",[e._v("Interpolation mode to apply. "),t("RouterLink",{attrs:{to:"/charts/line.html#cubicinterpolationmode"}},[e._v("See more...")])],1)]),e._v(" "),t("tr",[t("td",[t("code",[e._v("fill")])]),e._v(" "),t("td",[t("code",[e._v("boolean")]),e._v("|"),t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("false")])]),e._v(" "),t("td",[e._v("How to fill the area under the line. See "),t("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[e._v("area charts")]),e._v(".")],1)]),e._v(" "),t("tr",[t("td",[t("code",[e._v("stepped")])]),e._v(" "),t("td",[t("code",[e._v("boolean")])]),e._v(" "),t("td",[t("code",[e._v("false")])]),e._v(" "),t("td",[t("code",[e._v("true")]),e._v(" to show the line as a stepped line ("),t("code",[e._v("tension")]),e._v(" will be ignored).")])])])]),e._v(" "),t("h2",{attrs:{id:"bar-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bar-configuration"}},[e._v("#")]),e._v(" Bar Configuration")]),e._v(" "),t("p",[e._v("Bar elements are used to represent the bars in a bar chart.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.bar")]),e._v(", global bar options: "),t("code",[e._v("Chart.defaults.elements.bar")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Bar fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("Bar stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.borderColor")])]),e._v(" "),t("td",[e._v("Bar stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderSkipped")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("'start'")])]),e._v(" "),t("td",[e._v("Skipped (excluded) border: "),t("code",[e._v("'start'")]),e._v(", "),t("code",[e._v("'end'")]),e._v(", "),t("code",[e._v("'middle'")]),e._v(", "),t("code",[e._v("'bottom'")]),e._v(", "),t("code",[e._v("'left'")]),e._v(", "),t("code",[e._v("'top'")]),e._v(", "),t("code",[e._v("'right'")]),e._v(" or "),t("code",[e._v("false")]),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderRadius")])]),e._v(" "),t("td",[t("code",[e._v("number")]),e._v("|"),t("code",[e._v("object")])]),e._v(" "),t("td",[t("code",[e._v("0")])]),e._v(" "),t("td",[e._v("The bar border radius (in pixels).")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("inflateAmount")])]),e._v(" "),t("td",[t("code",[e._v("number")]),e._v("|"),t("code",[e._v("'auto'")])]),e._v(" "),t("td",[t("code",[e._v("'auto'")])]),e._v(" "),t("td",[e._v("The amount of pixels to inflate the bar rectangle(s) when drawing.")])]),e._v(" "),t("tr",[t("td",[t("a",{attrs:{href:"#point-styles"}},[t("code",[e._v("pointStyle")])])]),e._v(" "),t("td",[t("code",[e._v("string")]),e._v("|"),t("code",[e._v("Image")]),e._v("|"),t("code",[e._v("HTMLCanvasElement")])]),e._v(" "),t("td",[t("code",[e._v("'circle'")])]),e._v(" "),t("td",[e._v("Style of the point for legend.")])])])]),e._v(" "),t("h2",{attrs:{id:"arc-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#arc-configuration"}},[e._v("#")]),e._v(" Arc Configuration")]),e._v(" "),t("p",[e._v("Arcs are used in the polar area, doughnut and pie charts.")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options.elements.arc")]),e._v(", global arc options: "),t("code",[e._v("Chart.defaults.elements.arc")]),e._v(".")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("angle")]),e._v(" - for polar only")]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("circumference / (arc count)")])]),e._v(" "),t("td",[e._v("Arc angle to cover.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("backgroundColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("Chart.defaults.backgroundColor")])]),e._v(" "),t("td",[e._v("Arc fill color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderAlign")])]),e._v(" "),t("td",[t("code",[e._v("'center'")]),e._v("|"),t("code",[e._v("'inner'")])]),e._v(" "),t("td",[t("code",[e._v("'center'")])]),e._v(" "),t("td",[e._v("Arc stroke alignment.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderColor")])]),e._v(" "),t("td",[t("RouterLink",{attrs:{to:"/general/colors.html"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("td",[t("code",[e._v("'#fff'")])]),e._v(" "),t("td",[e._v("Arc stroke color.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDash")])]),e._v(" "),t("td",[t("code",[e._v("number[]")])]),e._v(" "),t("td",[t("code",[e._v("[]")])]),e._v(" "),t("td",[e._v("Arc line dash. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderDashOffset")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("0.0")])]),e._v(" "),t("td",[e._v("Arc line dash offset. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderJoinStyle")])]),e._v(" "),t("td",[t("code",[e._v("'round'")]),e._v("|"),t("code",[e._v("'bevel'")]),e._v("|"),t("code",[e._v("'miter'")])]),e._v(" "),t("td",[t("code",[e._v("'bevel'")]),e._v("|"),t("code",[e._v("'round'")])]),e._v(" "),t("td",[e._v("Line join style. See "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("MDN"),t("OutboundLink")],1),e._v(". The default is "),t("code",[e._v("'round'")]),e._v(" when "),t("code",[e._v("borderAlign")]),e._v(" is "),t("code",[e._v("'inner'")])])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("borderWidth")])]),e._v(" "),t("td",[t("code",[e._v("number")])]),e._v(" "),t("td",[t("code",[e._v("2")])]),e._v(" "),t("td",[e._v("Arc stroke width.")])]),e._v(" "),t("tr",[t("td",[t("code",[e._v("circular")])]),e._v(" "),t("td",[t("code",[e._v("boolean")])]),e._v(" "),t("td",[t("code",[e._v("true")])]),e._v(" "),t("td",[e._v("By default the Arc is curved. If "),t("code",[e._v("circular: false")]),e._v(" the Arc will be flat")])])])])])}),[],!1,null,null,null);t.default=v.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/162.b8f3900a.js b/docs/master/assets/js/162.92d71b56.js similarity index 99% rename from docs/master/assets/js/162.b8f3900a.js rename to docs/master/assets/js/162.92d71b56.js index 7a9b32b2d3..53a29452b9 100644 --- a/docs/master/assets/js/162.b8f3900a.js +++ b/docs/master/assets/js/162.92d71b56.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[162],{494:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"interactions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("options.interaction")]),t._v(", the global interaction configuration is at "),s("code",[t._v("Chart.defaults.interaction")]),t._v(". To configure which events trigger chart interactions, see "),s("a",{attrs:{href:"#events"}},[t._v("events")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("mode")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'nearest'")])]),t._v(" "),s("td",[t._v("Sets which elements appear in the interaction. See "),s("a",{attrs:{href:"#modes"}},[t._v("Interaction Modes")]),t._v(" for details.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("intersect")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("if true, the interaction mode only applies when the mouse position intersects an item on the chart.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("axis")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'x'")])]),t._v(" "),s("td",[t._v("Can be set to "),s("code",[t._v("'x'")]),t._v(", "),s("code",[t._v("'y'")]),t._v(", "),s("code",[t._v("'xy'")]),t._v(" or "),s("code",[t._v("'r'")]),t._v(" to define which directions are used in calculating distances. Defaults to "),s("code",[t._v("'x'")]),t._v(" for "),s("code",[t._v("'index'")]),t._v(" mode and "),s("code",[t._v("'xy'")]),t._v(" in "),s("code",[t._v("dataset")]),t._v(" and "),s("code",[t._v("'nearest'")]),t._v(" modes.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("includeInvisible")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("false")])]),t._v(" "),s("td",[t._v("if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.")])])])]),t._v(" "),s("p",[t._v("By default, these options apply to both the hover and tooltip interactions. The same options can be set in the "),s("code",[t._v("options.hover")]),t._v(" namespace, in which case they will only affect the hover interaction. Similarly, the options can be set in the "),s("code",[t._v("options.plugins.tooltip")]),t._v(" namespace to independently configure the tooltip interactions.")]),t._v(" "),s("h2",{attrs:{id:"events"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[t._v("#")]),t._v(" Events")]),t._v(" "),s("p",[t._v("The following properties define how the chart interacts with events.\nNamespace: "),s("code",[t._v("options")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("events")])]),t._v(" "),s("td",[s("code",[t._v("string[]")])]),t._v(" "),s("td",[s("code",[t._v("['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']")])]),t._v(" "),s("td",[t._v("The "),s("code",[t._v("events")]),t._v(" option defines the browser events that the chart should listen to for. Each of these events trigger hover and are passed to plugins. "),s("a",{attrs:{href:"#event-option"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("onHover")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td",[s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("Called when any of the events fire over chartArea. Passed the event, an array of active elements (bars, points, etc), and the chart.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("onClick")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td",[s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("Called if the event is of type "),s("code",[t._v("'mouseup'")]),t._v(", "),s("code",[t._v("'click'")]),t._v(" or '"),s("code",[t._v("'contextmenu'")]),t._v(" over chartArea. Passed the event, an array of active elements, and the chart.")])])])]),t._v(" "),s("h3",{attrs:{id:"event-option"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#event-option"}},[t._v("#")]),t._v(" Event Option")]),t._v(" "),s("p",[t._v("For example, to have the chart only respond to click events, you could do:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// This chart will not respond to mousemove, etc")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("events")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'click'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Events for each plugin can be further limited by defining (allowed) events array in plugin options:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// All of these (default) events trigger a hover and are passed to all plugins,")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unless limited at plugin options")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("events")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mousemove'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mouseout'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'click'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'touchstart'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'touchmove'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Tooltip will only receive click events")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("events")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'click'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Events that do not fire over chartArea, like "),s("code",[t._v("mouseout")]),t._v(", can be captured using a simple plugin:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// these are the default events:")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// events: ['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove'],")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myEventCatcher'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("beforeEvent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" args"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" pluginOptions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" event "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" args"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("event"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("event"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("type "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mouseout'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// process the event")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("For more information about plugins, see "),s("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1),t._v(" "),s("h3",{attrs:{id:"converting-events-to-data-values"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#converting-events-to-data-values"}},[t._v("#")]),t._v(" Converting Events to Data Values")]),t._v(" "),s("p",[t._v("A common occurrence is taking an event, such as a click, and finding the data coordinates on the chart where the event occurred. Chart.js provides helpers that make this a straightforward process.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onClick")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" canvasPosition "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("helpers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRelativePosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Substitute the appropriate scale IDs")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataX "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataY "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("When using a bundler, the helper functions have to be imported separately, for a full explanation of this please head over to the "),s("RouterLink",{attrs:{to:"/getting-started/integration.html#helper-functions"}},[t._v("integration")]),t._v(" page")],1),t._v(" "),s("h2",{attrs:{id:"modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#modes"}},[t._v("#")]),t._v(" Modes")]),t._v(" "),s("p",[t._v("When configuring the interaction with the graph via "),s("code",[t._v("interaction")]),t._v(", "),s("code",[t._v("hover")]),t._v(" or "),s("code",[t._v("tooltips")]),t._v(", a number of different modes are available.")]),t._v(" "),s("p",[s("code",[t._v("options.hover")]),t._v(" and "),s("code",[t._v("options.plugins.tooltip")]),t._v(" extend from "),s("code",[t._v("options.interaction")]),t._v(". So if "),s("code",[t._v("mode")]),t._v(", "),s("code",[t._v("intersect")]),t._v(" or any other common settings are configured only in "),s("code",[t._v("options.interaction")]),t._v(", both hover and tooltips obey that.")]),t._v(" "),s("p",[t._v("The modes are detailed below and how they behave in conjunction with the "),s("code",[t._v("intersect")]),t._v(" setting.")]),t._v(" "),s("p",[t._v("See how different modes work with the tooltip in "),s("RouterLink",{attrs:{to:"/samples/tooltip/interactions.html"}},[t._v("tooltip interactions sample")])],1),t._v(" "),s("h3",{attrs:{id:"point"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#point"}},[t._v("#")]),t._v(" point")]),t._v(" "),s("p",[t._v("Finds all of the items that intersect the point.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'point'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"nearest"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#nearest"}},[t._v("#")]),t._v(" nearest")]),t._v(" "),s("p",[t._v("Gets the items that are at the nearest distance to the point. The nearest item is determined based on the distance to the center of the chart item (point, bar). You can use the "),s("code",[t._v("axis")]),t._v(" setting to define which coordinates are considered in distance calculation. If "),s("code",[t._v("intersect")]),t._v(" is true, this is only triggered when the mouse position intersects an item in the graph. This is very useful for combo charts where points are hidden behind bars.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nearest'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),s("p",[t._v("Finds item at the same index. If the "),s("code",[t._v("intersect")]),t._v(" setting is true, the first intersecting item is used to determine the index in the data. If "),s("code",[t._v("intersect")]),t._v(" false the nearest item, in the x direction, is used to determine the index.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'index'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("To use index mode in a chart like the horizontal bar chart, where we search along the y direction, you can use the "),s("code",[t._v("axis")]),t._v(" setting introduced in v2.7.0. By setting this value to "),s("code",[t._v("'y'")]),t._v(" on the y direction is used.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'index'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("axis")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"dataset"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),s("p",[t._v("Finds items in the same dataset. If the "),s("code",[t._v("intersect")]),t._v(" setting is true, the first intersecting item is used to determine the index in the data. If "),s("code",[t._v("intersect")]),t._v(" false the nearest item is used to determine the index.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'dataset'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"x"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),s("p",[t._v("Returns all items that would intersect based on the "),s("code",[t._v("X")]),t._v(" coordinate of the position only. Would be useful for a vertical cursor implementation. Note that this only applies to cartesian charts.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"y"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),s("p",[t._v("Returns all items that would intersect based on the "),s("code",[t._v("Y")]),t._v(" coordinate of the position. This would be useful for a horizontal cursor implementation. Note that this only applies to cartesian charts.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"custom-interaction-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#custom-interaction-modes"}},[t._v("#")]),t._v(" Custom Interaction Modes")]),t._v(" "),s("p",[t._v("New modes can be defined by adding functions to the "),s("code",[t._v("Chart.Interaction.modes")]),t._v(" map. You can use the "),s("code",[t._v("Chart.Interaction.evaluateInteractionItems")]),t._v(" function to help implement these.")]),t._v(" "),s("p",[t._v("Example:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Interaction "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" getRelativePosition "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/helpers'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/**\n * Custom interaction mode\n * @function Interaction.modes.myCustomMode\n * @param {Chart} chart - the chart we are returning items from\n * @param {Event} e - the event we are find things at\n * @param {InteractionOptions} options - options to use\n * @param {boolean} [useFinalPosition] - use final element position (animation target)\n * @return {InteractionItem[]} - items that are found\n */")]),t._v("\nInteraction"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("modes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("myCustomMode")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" useFinalPosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" position "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRelativePosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" items "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n Interaction"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("evaluateInteractionItems")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" datasetIndex"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("inXRange")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" useFinalPosition"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("myCustomLogic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n items"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" datasetIndex"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" items"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Then, to use it...")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("js")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myCustomMode'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("If you're using TypeScript, you'll also need to register the new mode:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("declare")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("module")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("interface")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("InteractionModeMap")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myCustomMode"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" InteractionModeFunction"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[162],{495:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"interactions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[t._v("#")]),t._v(" Interactions")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("options.interaction")]),t._v(", the global interaction configuration is at "),s("code",[t._v("Chart.defaults.interaction")]),t._v(". To configure which events trigger chart interactions, see "),s("a",{attrs:{href:"#events"}},[t._v("events")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("mode")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'nearest'")])]),t._v(" "),s("td",[t._v("Sets which elements appear in the interaction. See "),s("a",{attrs:{href:"#modes"}},[t._v("Interaction Modes")]),t._v(" for details.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("intersect")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("if true, the interaction mode only applies when the mouse position intersects an item on the chart.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("axis")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'x'")])]),t._v(" "),s("td",[t._v("Can be set to "),s("code",[t._v("'x'")]),t._v(", "),s("code",[t._v("'y'")]),t._v(", "),s("code",[t._v("'xy'")]),t._v(" or "),s("code",[t._v("'r'")]),t._v(" to define which directions are used in calculating distances. Defaults to "),s("code",[t._v("'x'")]),t._v(" for "),s("code",[t._v("'index'")]),t._v(" mode and "),s("code",[t._v("'xy'")]),t._v(" in "),s("code",[t._v("dataset")]),t._v(" and "),s("code",[t._v("'nearest'")]),t._v(" modes.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("includeInvisible")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("false")])]),t._v(" "),s("td",[t._v("if true, the invisible points that are outside of the chart area will also be included when evaluating interactions.")])])])]),t._v(" "),s("p",[t._v("By default, these options apply to both the hover and tooltip interactions. The same options can be set in the "),s("code",[t._v("options.hover")]),t._v(" namespace, in which case they will only affect the hover interaction. Similarly, the options can be set in the "),s("code",[t._v("options.plugins.tooltip")]),t._v(" namespace to independently configure the tooltip interactions.")]),t._v(" "),s("h2",{attrs:{id:"events"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[t._v("#")]),t._v(" Events")]),t._v(" "),s("p",[t._v("The following properties define how the chart interacts with events.\nNamespace: "),s("code",[t._v("options")])]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("events")])]),t._v(" "),s("td",[s("code",[t._v("string[]")])]),t._v(" "),s("td",[s("code",[t._v("['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove']")])]),t._v(" "),s("td",[t._v("The "),s("code",[t._v("events")]),t._v(" option defines the browser events that the chart should listen to for. Each of these events trigger hover and are passed to plugins. "),s("a",{attrs:{href:"#event-option"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("onHover")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td",[s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("Called when any of the events fire over chartArea. Passed the event, an array of active elements (bars, points, etc), and the chart.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("onClick")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td",[s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("Called if the event is of type "),s("code",[t._v("'mouseup'")]),t._v(", "),s("code",[t._v("'click'")]),t._v(" or '"),s("code",[t._v("'contextmenu'")]),t._v(" over chartArea. Passed the event, an array of active elements, and the chart.")])])])]),t._v(" "),s("h3",{attrs:{id:"event-option"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#event-option"}},[t._v("#")]),t._v(" Event Option")]),t._v(" "),s("p",[t._v("For example, to have the chart only respond to click events, you could do:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// This chart will not respond to mousemove, etc")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("events")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'click'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Events for each plugin can be further limited by defining (allowed) events array in plugin options:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// All of these (default) events trigger a hover and are passed to all plugins,")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// unless limited at plugin options")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("events")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mousemove'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mouseout'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'click'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'touchstart'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'touchmove'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Tooltip will only receive click events")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("events")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'click'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("Events that do not fire over chartArea, like "),s("code",[t._v("mouseout")]),t._v(", can be captured using a simple plugin:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// these are the default events:")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// events: ['mousemove', 'mouseout', 'click', 'touchstart', 'touchmove'],")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myEventCatcher'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("beforeEvent")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" args"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" pluginOptions")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" event "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" args"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("event"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("event"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("type "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'mouseout'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// process the event")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("For more information about plugins, see "),s("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1),t._v(" "),s("h3",{attrs:{id:"converting-events-to-data-values"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#converting-events-to-data-values"}},[t._v("#")]),t._v(" Converting Events to Data Values")]),t._v(" "),s("p",[t._v("A common occurrence is taking an event, such as a click, and finding the data coordinates on the chart where the event occurred. Chart.js provides helpers that make this a straightforward process.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onClick")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" canvasPosition "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("helpers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRelativePosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Substitute the appropriate scale IDs")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataX "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataY "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("When using a bundler, the helper functions have to be imported separately, for a full explanation of this please head over to the "),s("RouterLink",{attrs:{to:"/getting-started/integration.html#helper-functions"}},[t._v("integration")]),t._v(" page")],1),t._v(" "),s("h2",{attrs:{id:"modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#modes"}},[t._v("#")]),t._v(" Modes")]),t._v(" "),s("p",[t._v("When configuring the interaction with the graph via "),s("code",[t._v("interaction")]),t._v(", "),s("code",[t._v("hover")]),t._v(" or "),s("code",[t._v("tooltips")]),t._v(", a number of different modes are available.")]),t._v(" "),s("p",[s("code",[t._v("options.hover")]),t._v(" and "),s("code",[t._v("options.plugins.tooltip")]),t._v(" extend from "),s("code",[t._v("options.interaction")]),t._v(". So if "),s("code",[t._v("mode")]),t._v(", "),s("code",[t._v("intersect")]),t._v(" or any other common settings are configured only in "),s("code",[t._v("options.interaction")]),t._v(", both hover and tooltips obey that.")]),t._v(" "),s("p",[t._v("The modes are detailed below and how they behave in conjunction with the "),s("code",[t._v("intersect")]),t._v(" setting.")]),t._v(" "),s("p",[t._v("See how different modes work with the tooltip in "),s("RouterLink",{attrs:{to:"/samples/tooltip/interactions.html"}},[t._v("tooltip interactions sample")])],1),t._v(" "),s("h3",{attrs:{id:"point"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#point"}},[t._v("#")]),t._v(" point")]),t._v(" "),s("p",[t._v("Finds all of the items that intersect the point.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'point'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"nearest"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#nearest"}},[t._v("#")]),t._v(" nearest")]),t._v(" "),s("p",[t._v("Gets the items that are at the nearest distance to the point. The nearest item is determined based on the distance to the center of the chart item (point, bar). You can use the "),s("code",[t._v("axis")]),t._v(" setting to define which coordinates are considered in distance calculation. If "),s("code",[t._v("intersect")]),t._v(" is true, this is only triggered when the mouse position intersects an item in the graph. This is very useful for combo charts where points are hidden behind bars.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nearest'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"index"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),s("p",[t._v("Finds item at the same index. If the "),s("code",[t._v("intersect")]),t._v(" setting is true, the first intersecting item is used to determine the index in the data. If "),s("code",[t._v("intersect")]),t._v(" false the nearest item, in the x direction, is used to determine the index.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'index'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("To use index mode in a chart like the horizontal bar chart, where we search along the y direction, you can use the "),s("code",[t._v("axis")]),t._v(" setting introduced in v2.7.0. By setting this value to "),s("code",[t._v("'y'")]),t._v(" on the y direction is used.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'index'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("axis")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"dataset"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),s("p",[t._v("Finds items in the same dataset. If the "),s("code",[t._v("intersect")]),t._v(" setting is true, the first intersecting item is used to determine the index in the data. If "),s("code",[t._v("intersect")]),t._v(" false the nearest item is used to determine the index.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'dataset'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"x"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),s("p",[t._v("Returns all items that would intersect based on the "),s("code",[t._v("X")]),t._v(" coordinate of the position only. Would be useful for a vertical cursor implementation. Note that this only applies to cartesian charts.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"y"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),s("p",[t._v("Returns all items that would intersect based on the "),s("code",[t._v("Y")]),t._v(" coordinate of the position. This would be useful for a horizontal cursor implementation. Note that this only applies to cartesian charts.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"custom-interaction-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#custom-interaction-modes"}},[t._v("#")]),t._v(" Custom Interaction Modes")]),t._v(" "),s("p",[t._v("New modes can be defined by adding functions to the "),s("code",[t._v("Chart.Interaction.modes")]),t._v(" map. You can use the "),s("code",[t._v("Chart.Interaction.evaluateInteractionItems")]),t._v(" function to help implement these.")]),t._v(" "),s("p",[t._v("Example:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Interaction "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" getRelativePosition "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/helpers'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/**\n * Custom interaction mode\n * @function Interaction.modes.myCustomMode\n * @param {Chart} chart - the chart we are returning items from\n * @param {Event} e - the event we are find things at\n * @param {InteractionOptions} options - options to use\n * @param {boolean} [useFinalPosition] - use final element position (animation target)\n * @return {InteractionItem[]} - items that are found\n */")]),t._v("\nInteraction"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("modes"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("myCustomMode")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" useFinalPosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" position "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRelativePosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" items "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n Interaction"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("evaluateInteractionItems")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" datasetIndex"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("inXRange")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" useFinalPosition"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("myCustomLogic")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n items"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" datasetIndex"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" items"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Then, to use it...")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("js")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("interaction")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myCustomMode'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("If you're using TypeScript, you'll also need to register the new mode:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("declare")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("module")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("interface")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("InteractionModeMap")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myCustomMode"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" InteractionModeFunction"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/163.29d33456.js b/docs/master/assets/js/163.7805558a.js similarity index 96% rename from docs/master/assets/js/163.29d33456.js rename to docs/master/assets/js/163.7805558a.js index dafb554254..802923cd6d 100644 --- a/docs/master/assets/js/163.29d33456.js +++ b/docs/master/assets/js/163.7805558a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[163],{493:function(t,e,a){"use strict";a.r(e);var o=a(3),d=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"layout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#layout"}},[t._v("#")]),t._v(" Layout")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.layout")]),t._v(", the global options for the chart layout is defined in "),e("code",[t._v("Chart.defaults.layout")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("autoPadding")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("No")]),t._v(" "),e("td",[t._v("Apply automatic padding so visible elements are completely drawn.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("The padding to add inside the chart.")])])])])])}),[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[163],{494:function(t,e,a){"use strict";a.r(e);var o=a(3),d=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"layout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#layout"}},[t._v("#")]),t._v(" Layout")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.layout")]),t._v(", the global options for the chart layout is defined in "),e("code",[t._v("Chart.defaults.layout")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",{staticStyle:{"text-align":"center"}},[e("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("autoPadding")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("No")]),t._v(" "),e("td",[t._v("Apply automatic padding so visible elements are completely drawn.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),e("td",[t._v("The padding to add inside the chart.")])])])])])}),[],!1,null,null,null);e.default=d.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/164.48c0bf9d.js b/docs/master/assets/js/164.629aa385.js similarity index 99% rename from docs/master/assets/js/164.48c0bf9d.js rename to docs/master/assets/js/164.629aa385.js index 3a8ccf78c7..4da5317ca5 100644 --- a/docs/master/assets/js/164.48c0bf9d.js +++ b/docs/master/assets/js/164.629aa385.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[164],{498:function(t,e,a){"use strict";a.r(e);var s=a(3),n=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"legend"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend"}},[t._v("#")]),t._v(" Legend")]),t._v(" "),e("p",[t._v("The chart legend displays data about the datasets that are appearing on the chart.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.legend")]),t._v(", the global options for the chart legend is defined in "),e("code",[t._v("Chart.defaults.plugins.legend")]),t._v(".")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The doughnut, pie, and polar area charts override the legend defaults. To change the overrides for those chart types, the options are defined in "),e("code",[t._v("Chart.overrides[type].plugins.legend")]),t._v(".")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Is the legend shown?")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'top'")])]),t._v(" "),e("td",[t._v("Position of the legend. "),e("a",{attrs:{href:"#position"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("Alignment of the legend. "),e("a",{attrs:{href:"#align"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxHeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Maximum height of the legend, in pixels")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Maximum width of the legend, in pixels")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("fullSize")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("onClick")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("A callback that is called when a click event is registered on a label item. Arguments: "),e("code",[t._v("[event, legendItem, legend]")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("onHover")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("A callback that is called when a 'mousemove' event is registered on top of a label item. Arguments: "),e("code",[t._v("[event, legendItem, legend]")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("onLeave")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item. Arguments: "),e("code",[t._v("[event, legendItem, legend]")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Legend will show datasets in reverse order.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labels")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("See the "),e("a",{attrs:{href:"#legend-label-configuration"}},[t._v("Legend Label Configuration")]),t._v(" section below.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rtl")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for rendering the legends from right to left.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textDirection")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("canvas' default")]),t._v(" "),e("td",[t._v("This will force the text direction "),e("code",[t._v("'rtl'")]),t._v(" or "),e("code",[t._v("'ltr'")]),t._v(" on the canvas for rendering the legend, regardless of the css specified on the canvas")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("See the "),e("a",{attrs:{href:"#legend-title-configuration"}},[t._v("Legend Title Configuration")]),t._v(" section below.")])])])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("If you need more visual customizations, please use an "),e("RouterLink",{attrs:{to:"/samples/legend/html.html"}},[t._v("HTML legend")]),t._v(".")],1)]),t._v(" "),e("h2",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" Position")]),t._v(" "),e("p",[t._v("Position of the legend. Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'top'")])]),t._v(" "),e("li",[e("code",[t._v("'left'")])]),t._v(" "),e("li",[e("code",[t._v("'bottom'")])]),t._v(" "),e("li",[e("code",[t._v("'right'")])]),t._v(" "),e("li",[e("code",[t._v("'chartArea'")])])]),t._v(" "),e("p",[t._v("When using the "),e("code",[t._v("'chartArea'")]),t._v(" option the legend position is at the moment not configurable, it will always be on the left side of the chart in the middle.")]),t._v(" "),e("h2",{attrs:{id:"align"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" Align")]),t._v(" "),e("p",[t._v("Alignment of the legend. Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'start'")])]),t._v(" "),e("li",[e("code",[t._v("'center'")])]),t._v(" "),e("li",[e("code",[t._v("'end'")])])]),t._v(" "),e("p",[t._v("Defaults to "),e("code",[t._v("'center'")]),t._v(" for unrecognized values.")]),t._v(" "),e("h2",{attrs:{id:"legend-label-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend-label-configuration"}},[t._v("#")]),t._v(" Legend Label Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.legend.labels")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("boxWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("40")])]),t._v(" "),e("td",[t._v("Width of coloured box.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("boxHeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("font.size")])]),t._v(" "),e("td",[t._v("Height of the coloured box.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of label and the strikethrough.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("10")])]),t._v(" "),e("td",[t._v("Padding between rows of colored boxes.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("generateLabels")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See "),e("a",{attrs:{href:"#legend-item-interface"}},[t._v("Legend Item")]),t._v(" for details.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("filter")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("Filters legend items out of the legend. Receives 2 parameters, a "),e("a",{attrs:{href:"#legend-item-interface"}},[t._v("Legend Item")]),t._v(" and the chart data.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sort")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("Sorts legend items. Type is : "),e("code",[t._v("sort(a: LegendItem, b: LegendItem, data: ChartData): number;")]),t._v(". Receives 3 parameters, two "),e("a",{attrs:{href:"#legend-item-interface"}},[t._v("Legend Items")]),t._v(" and the chart data. The return value of the function is a number that indicates the order of the two legend item parameters. The ordering matches the "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description",target:"_blank",rel:"noopener noreferrer"}},[t._v("return value"),e("OutboundLink")],1),t._v(" of "),e("code",[t._v("Array.prototype.sort()")])])]),t._v(" "),e("tr",[e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#types"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",[e("code",[t._v("'circle'")])]),t._v(" "),e("td",[t._v("If specified, this style of point is used for the legend. Only used if "),e("code",[t._v("usePointStyle")]),t._v(" is true.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("Horizontal alignment of the label text. Options are: "),e("code",[t._v("'left'")]),t._v(", "),e("code",[t._v("'right'")]),t._v(" or "),e("code",[t._v("'center'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("usePointStyle")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Label style will match corresponding point style (size is based on pointStyleWidth or the minimum value between boxWidth and font.size).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointStyleWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("If "),e("code",[t._v("usePointStyle")]),t._v(" is true, the width of the point style used for the legend.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("useBorderRadius")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Label borderRadius will match corresponding borderRadius.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderRadius")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("Override the borderRadius to use.")])])])]),t._v(" "),e("h2",{attrs:{id:"legend-title-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend-title-configuration"}},[t._v("#")]),t._v(" Legend Title Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.legend.title")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Is the legend title displayed.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding around the title.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("text")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The string title.")])])])]),t._v(" "),e("h2",{attrs:{id:"legend-item-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend-item-interface"}},[t._v("#")]),t._v(" Legend Item Interface")]),t._v(" "),e("p",[t._v("Items passed to the legend "),e("code",[t._v("onClick")]),t._v(" function are the ones returned from "),e("code",[t._v("labels.generateLabels")]),t._v(". These items must implement the following interface.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Label that will be displayed")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Border radius of the legend item.")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Introduced in 3.1.0")]),t._v("\n borderRadius"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" BorderRadius"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Index of the associated dataset")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetIndex")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Fill style of the legend box")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fillStyle")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Text color")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fontColor")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If true, this item represents a hidden dataset. Label will be rendered with a strike-through effect")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("hidden")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" boolean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineCap")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineDash")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineDashOffset")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineJoin")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Width of box border")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineWidth")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stroke style of the legend box")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("strokeStyle")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Point style of the legend box (only used if usePointStyle is true)")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointStyle")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" Image "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" HTMLCanvasElement"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Rotation of the point in degrees (only used if usePointStyle is true)")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("rotation")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("h2",{attrs:{id:"example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[t._v("#")]),t._v(" Example")]),t._v(" "),e("p",[t._v("The following example will create a chart with the legend enabled and turn all the text red in color.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("legend")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 99, 132)'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"custom-on-click-actions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#custom-on-click-actions"}},[t._v("#")]),t._v(" Custom On Click Actions")]),t._v(" "),e("p",[t._v("It can be common to want to trigger different behaviour when clicking an item in the legend. This can be easily achieved using a callback in the config object.")]),t._v(" "),e("p",[t._v("The default legend click handler is:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasetIndex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ci "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("isDatasetVisible")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hide")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("show")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("p",[t._v("Let's say we wanted instead to link the display of the first two datasets. We could change the click handler accordingly.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" defaultLegendClickHandler "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("plugins"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("onClick"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" pieDoughnutLegendClickHandler "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("controllers"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("doughnut"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("overrides"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("plugins"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("onClick"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("newLegendClickHandler")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasetIndex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("config"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("type"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Do the original logic")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'pie'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'doughnut'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("pieDoughnutLegendClickHandler")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("defaultLegendClickHandler")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" ci "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDatasetMeta")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDatasetMeta")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("meta")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n meta"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("legend")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("onClick")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" newLegendClickHandler\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("Now when you click the legend in this chart, the visibility of the first two datasets will be linked together.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[164],{496:function(t,e,a){"use strict";a.r(e);var s=a(3),n=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"legend"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend"}},[t._v("#")]),t._v(" Legend")]),t._v(" "),e("p",[t._v("The chart legend displays data about the datasets that are appearing on the chart.")]),t._v(" "),e("h2",{attrs:{id:"configuration-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration options")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.legend")]),t._v(", the global options for the chart legend is defined in "),e("code",[t._v("Chart.defaults.plugins.legend")]),t._v(".")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The doughnut, pie, and polar area charts override the legend defaults. To change the overrides for those chart types, the options are defined in "),e("code",[t._v("Chart.overrides[type].plugins.legend")]),t._v(".")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Is the legend shown?")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("position")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'top'")])]),t._v(" "),e("td",[t._v("Position of the legend. "),e("a",{attrs:{href:"#position"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("align")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("Alignment of the legend. "),e("a",{attrs:{href:"#align"}},[t._v("more...")])])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxHeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Maximum height of the legend, in pixels")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("maxWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Maximum width of the legend, in pixels")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("fullSize")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("true")])]),t._v(" "),e("td",[t._v("Marks that this box should take the full width/height of the canvas (moving other boxes). This is unlikely to need to be changed in day-to-day use.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("onClick")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("A callback that is called when a click event is registered on a label item. Arguments: "),e("code",[t._v("[event, legendItem, legend]")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("onHover")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("A callback that is called when a 'mousemove' event is registered on top of a label item. Arguments: "),e("code",[t._v("[event, legendItem, legend]")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("onLeave")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("A callback that is called when a 'mousemove' event is registered outside of a previously hovered label item. Arguments: "),e("code",[t._v("[event, legendItem, legend]")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("reverse")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Legend will show datasets in reverse order.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("labels")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("See the "),e("a",{attrs:{href:"#legend-label-configuration"}},[t._v("Legend Label Configuration")]),t._v(" section below.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("rtl")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td"),t._v(" "),e("td",[e("code",[t._v("true")]),t._v(" for rendering the legends from right to left.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textDirection")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[t._v("canvas' default")]),t._v(" "),e("td",[t._v("This will force the text direction "),e("code",[t._v("'rtl'")]),t._v(" or "),e("code",[t._v("'ltr'")]),t._v(" on the canvas for rendering the legend, regardless of the css specified on the canvas")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("title")])]),t._v(" "),e("td",[e("code",[t._v("object")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("See the "),e("a",{attrs:{href:"#legend-title-configuration"}},[t._v("Legend Title Configuration")]),t._v(" section below.")])])])]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("If you need more visual customizations, please use an "),e("RouterLink",{attrs:{to:"/samples/legend/html.html"}},[t._v("HTML legend")]),t._v(".")],1)]),t._v(" "),e("h2",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" Position")]),t._v(" "),e("p",[t._v("Position of the legend. Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'top'")])]),t._v(" "),e("li",[e("code",[t._v("'left'")])]),t._v(" "),e("li",[e("code",[t._v("'bottom'")])]),t._v(" "),e("li",[e("code",[t._v("'right'")])]),t._v(" "),e("li",[e("code",[t._v("'chartArea'")])])]),t._v(" "),e("p",[t._v("When using the "),e("code",[t._v("'chartArea'")]),t._v(" option the legend position is at the moment not configurable, it will always be on the left side of the chart in the middle.")]),t._v(" "),e("h2",{attrs:{id:"align"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" Align")]),t._v(" "),e("p",[t._v("Alignment of the legend. Options are:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("'start'")])]),t._v(" "),e("li",[e("code",[t._v("'center'")])]),t._v(" "),e("li",[e("code",[t._v("'end'")])])]),t._v(" "),e("p",[t._v("Defaults to "),e("code",[t._v("'center'")]),t._v(" for unrecognized values.")]),t._v(" "),e("h2",{attrs:{id:"legend-label-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend-label-configuration"}},[t._v("#")]),t._v(" Legend Label Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.legend.labels")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("boxWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("40")])]),t._v(" "),e("td",[t._v("Width of coloured box.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("boxHeight")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("font.size")])]),t._v(" "),e("td",[t._v("Height of the coloured box.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of label and the strikethrough.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("10")])]),t._v(" "),e("td",[t._v("Padding between rows of colored boxes.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("generateLabels")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("Generates legend items for each thing in the legend. Default implementation returns the text + styling for the color box. See "),e("a",{attrs:{href:"#legend-item-interface"}},[t._v("Legend Item")]),t._v(" for details.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("filter")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("Filters legend items out of the legend. Receives 2 parameters, a "),e("a",{attrs:{href:"#legend-item-interface"}},[t._v("Legend Item")]),t._v(" and the chart data.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("sort")])]),t._v(" "),e("td",[e("code",[t._v("function")])]),t._v(" "),e("td",[e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("Sorts legend items. Type is : "),e("code",[t._v("sort(a: LegendItem, b: LegendItem, data: ChartData): number;")]),t._v(". Receives 3 parameters, two "),e("a",{attrs:{href:"#legend-item-interface"}},[t._v("Legend Items")]),t._v(" and the chart data. The return value of the function is a number that indicates the order of the two legend item parameters. The ordering matches the "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#description",target:"_blank",rel:"noopener noreferrer"}},[t._v("return value"),e("OutboundLink")],1),t._v(" of "),e("code",[t._v("Array.prototype.sort()")])])]),t._v(" "),e("tr",[e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/configuration/elements.html#types"}},[e("code",[t._v("pointStyle")])])],1),t._v(" "),e("td",[e("code",[t._v("'circle'")])]),t._v(" "),e("td",[t._v("If specified, this style of point is used for the legend. Only used if "),e("code",[t._v("usePointStyle")]),t._v(" is true.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("textAlign")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'center'")])]),t._v(" "),e("td",[t._v("Horizontal alignment of the label text. Options are: "),e("code",[t._v("'left'")]),t._v(", "),e("code",[t._v("'right'")]),t._v(" or "),e("code",[t._v("'center'")]),t._v(".")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("usePointStyle")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Label style will match corresponding point style (size is based on pointStyleWidth or the minimum value between boxWidth and font.size).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("pointStyleWidth")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("null")])]),t._v(" "),e("td",[t._v("If "),e("code",[t._v("usePointStyle")]),t._v(" is true, the width of the point style used for the legend.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("useBorderRadius")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Label borderRadius will match corresponding borderRadius.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("borderRadius")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("Override the borderRadius to use.")])])])]),t._v(" "),e("h2",{attrs:{id:"legend-title-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend-title-configuration"}},[t._v("#")]),t._v(" Legend Title Configuration")]),t._v(" "),e("p",[t._v("Namespace: "),e("code",[t._v("options.plugins.legend.title")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("color")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/colors.html"}},[e("code",[t._v("Color")])])],1),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.color")])]),t._v(" "),e("td",[t._v("Color of text.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("display")])]),t._v(" "),e("td",[e("code",[t._v("boolean")])]),t._v(" "),e("td",[e("code",[t._v("false")])]),t._v(" "),e("td",[t._v("Is the legend title displayed.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("font")])]),t._v(" "),e("td",[e("code",[t._v("Font")])]),t._v(" "),e("td",[e("code",[t._v("Chart.defaults.font")])]),t._v(" "),e("td",[t._v("See "),e("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),e("tr",[e("td",[e("code",[t._v("padding")])]),t._v(" "),e("td",[e("RouterLink",{attrs:{to:"/general/padding.html"}},[e("code",[t._v("Padding")])])],1),t._v(" "),e("td",[e("code",[t._v("0")])]),t._v(" "),e("td",[t._v("Padding around the title.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("text")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td"),t._v(" "),e("td",[t._v("The string title.")])])])]),t._v(" "),e("h2",{attrs:{id:"legend-item-interface"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend-item-interface"}},[t._v("#")]),t._v(" Legend Item Interface")]),t._v(" "),e("p",[t._v("Items passed to the legend "),e("code",[t._v("onClick")]),t._v(" function are the ones returned from "),e("code",[t._v("labels.generateLabels")]),t._v(". These items must implement the following interface.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Label that will be displayed")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Border radius of the legend item.")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Introduced in 3.1.0")]),t._v("\n borderRadius"),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" BorderRadius"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Index of the associated dataset")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetIndex")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Fill style of the legend box")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fillStyle")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Text color")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("fontColor")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If true, this item represents a hidden dataset. Label will be rendered with a strike-through effect")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("hidden")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" boolean"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineCap")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineDash")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineDashOffset")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For box border. See https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineJoin")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Width of box border")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("lineWidth")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stroke style of the legend box")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("strokeStyle")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Point style of the legend box (only used if usePointStyle is true)")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointStyle")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" Image "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" HTMLCanvasElement"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Rotation of the point in degrees (only used if usePointStyle is true)")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("rotation")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("h2",{attrs:{id:"example"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#example"}},[t._v("#")]),t._v(" Example")]),t._v(" "),e("p",[t._v("The following example will create a chart with the legend enabled and turn all the text red in color.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("legend")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 99, 132)'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("h2",{attrs:{id:"custom-on-click-actions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#custom-on-click-actions"}},[t._v("#")]),t._v(" Custom On Click Actions")]),t._v(" "),e("p",[t._v("It can be common to want to trigger different behaviour when clicking an item in the legend. This can be easily achieved using a callback in the config object.")]),t._v(" "),e("p",[t._v("The default legend click handler is:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasetIndex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ci "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("isDatasetVisible")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("hide")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("show")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("p",[t._v("Let's say we wanted instead to link the display of the first two datasets. We could change the click handler accordingly.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" defaultLegendClickHandler "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("plugins"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("onClick"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" pieDoughnutLegendClickHandler "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("controllers"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("doughnut"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("overrides"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("plugins"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("onClick"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("newLegendClickHandler")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasetIndex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("config"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("type"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Do the original logic")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'pie'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" type "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'doughnut'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("pieDoughnutLegendClickHandler")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("defaultLegendClickHandler")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legendItem"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" ci "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" legend"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDatasetMeta")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDatasetMeta")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("meta")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n meta"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("hidden "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ci"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("legend")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("onClick")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" newLegendClickHandler\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("p",[t._v("Now when you click the legend in this chart, the visibility of the first two datasets will be linked together.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/165.d8155065.js b/docs/master/assets/js/165.baa44d50.js similarity index 97% rename from docs/master/assets/js/165.d8155065.js rename to docs/master/assets/js/165.baa44d50.js index a451f6f8c9..a7e0576f61 100644 --- a/docs/master/assets/js/165.d8155065.js +++ b/docs/master/assets/js/165.baa44d50.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[165],{495:function(e,t,o){"use strict";o.r(t);var a=o(3),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"locale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#locale"}},[e._v("#")]),e._v(" Locale")]),e._v(" "),t("p",[e._v("For applications where the numbers of ticks on scales must be formatted accordingly with a language sensitive number formatting, you can enable this kind of formatting by setting the "),t("code",[e._v("locale")]),e._v(" option.")]),e._v(" "),t("p",[e._v("The locale is a string that is a "),t("a",{attrs:{href:"https://www.unicode.org/reports/tr35/tr35.html#BCP_47_Conformance",target:"_blank",rel:"noopener noreferrer"}},[e._v("Unicode BCP 47 locale identifier"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("A Unicode BCP 47 locale identifier consists of")]),e._v(" "),t("ol",[t("li",[e._v("a language code,")]),e._v(" "),t("li",[e._v("(optionally) a script code,")]),e._v(" "),t("li",[e._v("(optionally) a region (or country) code,")]),e._v(" "),t("li",[e._v("(optionally) one or more variant codes, and")]),e._v(" "),t("li",[e._v("(optionally) one or more extension sequences,")])]),e._v(" "),t("p",[e._v("with all present components separated by hyphens.")]),e._v(" "),t("p",[e._v("By default, the chart is using the default locale of the platform which is running on.")]),e._v(" "),t("h2",{attrs:{id:"configuration-options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[e._v("#")]),e._v(" Configuration Options")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("locale")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("undefined")])]),e._v(" "),t("td",[e._v("a string with a BCP 47 language tag, leveraging on "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e._v("INTL NumberFormat"),t("OutboundLink")],1),e._v(".")])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[165],{497:function(e,t,o){"use strict";o.r(t);var a=o(3),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"locale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#locale"}},[e._v("#")]),e._v(" Locale")]),e._v(" "),t("p",[e._v("For applications where the numbers of ticks on scales must be formatted accordingly with a language sensitive number formatting, you can enable this kind of formatting by setting the "),t("code",[e._v("locale")]),e._v(" option.")]),e._v(" "),t("p",[e._v("The locale is a string that is a "),t("a",{attrs:{href:"https://www.unicode.org/reports/tr35/tr35.html#BCP_47_Conformance",target:"_blank",rel:"noopener noreferrer"}},[e._v("Unicode BCP 47 locale identifier"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("A Unicode BCP 47 locale identifier consists of")]),e._v(" "),t("ol",[t("li",[e._v("a language code,")]),e._v(" "),t("li",[e._v("(optionally) a script code,")]),e._v(" "),t("li",[e._v("(optionally) a region (or country) code,")]),e._v(" "),t("li",[e._v("(optionally) one or more variant codes, and")]),e._v(" "),t("li",[e._v("(optionally) one or more extension sequences,")])]),e._v(" "),t("p",[e._v("with all present components separated by hyphens.")]),e._v(" "),t("p",[e._v("By default, the chart is using the default locale of the platform which is running on.")]),e._v(" "),t("h2",{attrs:{id:"configuration-options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[e._v("#")]),e._v(" Configuration Options")]),e._v(" "),t("p",[e._v("Namespace: "),t("code",[e._v("options")])]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Name")]),e._v(" "),t("th",[e._v("Type")]),e._v(" "),t("th",[e._v("Default")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[t("code",[e._v("locale")])]),e._v(" "),t("td",[t("code",[e._v("string")])]),e._v(" "),t("td",[t("code",[e._v("undefined")])]),e._v(" "),t("td",[e._v("a string with a BCP 47 language tag, leveraging on "),t("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat",target:"_blank",rel:"noopener noreferrer"}},[e._v("INTL NumberFormat"),t("OutboundLink")],1),e._v(".")])])])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/166.8044ec15.js b/docs/master/assets/js/166.abbfe5a1.js similarity index 99% rename from docs/master/assets/js/166.8044ec15.js rename to docs/master/assets/js/166.abbfe5a1.js index 6dcbdaa32c..d3483941cc 100644 --- a/docs/master/assets/js/166.8044ec15.js +++ b/docs/master/assets/js/166.abbfe5a1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[166],{496:function(t,a,e){"use strict";e.r(a);var s=e(3),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"responsive-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#responsive-charts"}},[t._v("#")]),t._v(" Responsive Charts")]),t._v(" "),a("p",[t._v("When it comes to changing the chart size based on the window size, a major limitation is that the canvas "),a("em",[t._v("render")]),t._v(" size ("),a("code",[t._v("canvas.width")]),t._v(" and "),a("code",[t._v(".height")]),t._v(") can "),a("strong",[t._v("not")]),t._v(" be expressed with relative values, contrary to the "),a("em",[t._v("display")]),t._v(" size ("),a("code",[t._v("canvas.style.width")]),t._v(" and "),a("code",[t._v(".height")]),t._v("). Furthermore, these sizes are independent of each other and thus the canvas "),a("em",[t._v("render")]),t._v(" size does not adjust automatically based on the "),a("em",[t._v("display")]),t._v(" size, making the rendering inaccurate.")]),t._v(" "),a("p",[t._v("The following examples "),a("strong",[t._v("do not work")]),t._v(":")]),t._v(" "),a("ul",[a("li",[a("code",[t._v('')]),t._v(": "),a("strong",[t._v("invalid")]),t._v(" values, the canvas doesn't resize ("),a("a",{attrs:{href:"https://codepen.io/chartjs/pen/oWLZaR",target:"_blank",rel:"noopener noreferrer"}},[t._v("example"),a("OutboundLink")],1),t._v(")")]),t._v(" "),a("li",[a("code",[t._v('')]),t._v(": "),a("strong",[t._v("invalid")]),t._v(" behavior, the canvas is resized but becomes blurry ("),a("a",{attrs:{href:"https://codepen.io/chartjs/pen/WjxpmO",target:"_blank",rel:"noopener noreferrer"}},[t._v("example"),a("OutboundLink")],1),t._v(")")]),t._v(" "),a("li",[a("code",[t._v('')]),t._v(": "),a("strong",[t._v("invalid")]),t._v(" behavior, the canvas continually shrinks. Chart.js needs a dedicated container for each canvas and this styling should be applied there.")])]),t._v(" "),a("p",[t._v("Chart.js provides a "),a("a",{attrs:{href:"#configuration-options"}},[t._v("few options")]),t._v(" to enable responsiveness and control the resize behavior of charts by detecting when the canvas "),a("em",[t._v("display")]),t._v(" size changes and update the "),a("em",[t._v("render")]),t._v(" size accordingly.")]),t._v(" "),a("h2",{attrs:{id:"configuration-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("responsive")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("Resizes the chart canvas when its container does ("),a("a",{attrs:{href:"#important-note"}},[t._v("important note...")]),t._v(").")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("maintainAspectRatio")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("Maintain the original canvas aspect ratio "),a("code",[t._v("(width / height)")]),t._v(" when resizing.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("aspectRatio")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("1")]),t._v("|"),a("code",[t._v("2")])]),t._v(" "),a("td",[t._v("Canvas aspect ratio (i.e. "),a("code",[t._v("width / height")]),t._v(", a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style. The default value varies by chart type; Radial charts (doughnut, pie, polarArea, radar) default to "),a("code",[t._v("1")]),t._v(" and others default to "),a("code",[t._v("2")]),t._v(".")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("onResize")])]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("resizeDelay")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("0")])]),t._v(" "),a("td",[t._v("Delay the resize update by the given amount of milliseconds. This can ease the resize process by debouncing the update of the elements.")])])])]),t._v(" "),a("h2",{attrs:{id:"important-note"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#important-note"}},[t._v("#")]),t._v(" Important Note")]),t._v(" "),a("p",[t._v("Detecting when the canvas size changes can not be done directly from the "),a("code",[t._v("canvas")]),t._v(" element. Chart.js uses its parent container to update the canvas "),a("em",[t._v("render")]),t._v(" and "),a("em",[t._v("display")]),t._v(" sizes. However, this method requires the container to be "),a("strong",[t._v("relatively positioned")]),t._v(" and "),a("strong",[t._v("dedicated to the chart canvas only")]),t._v(". Responsiveness can then be achieved by setting relative values for the container size ("),a("a",{attrs:{href:"https://codepen.io/chartjs/pen/YVWZbz",target:"_blank",rel:"noopener noreferrer"}},[t._v("example"),a("OutboundLink")],1),t._v("):")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("div")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("class")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("chart-container"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token special-attr"}},[a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("style")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),a("span",{pre:!0,attrs:{class:"token value css language-css"}},[a("span",{pre:!0,attrs:{class:"token property"}},[t._v("position")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" relative"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("40vh"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("80vw")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("The chart can also be programmatically resized by modifying the container size:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parentNode"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("height "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'128px'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parentNode"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("width "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'128px'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Note that in order for the above code to correctly resize the chart height, the "),a("a",{attrs:{href:"#configuration-options"}},[a("code",[t._v("maintainAspectRatio")])]),t._v(" option must also be set to "),a("code",[t._v("false")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"printing-resizable-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#printing-resizable-charts"}},[t._v("#")]),t._v(" Printing Resizable Charts")]),t._v(" "),a("p",[t._v("CSS media queries allow changing styles when printing a page. The CSS applied from these media queries may cause charts to need to resize. However, the resize won't happen automatically. To support resizing charts when printing, you need to hook the "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeprint",target:"_blank",rel:"noopener noreferrer"}},[t._v("onbeforeprint"),a("OutboundLink")],1),t._v(" event and manually trigger resizing of each chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("beforePrintHandler")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" id "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("in")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("instances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("instances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("id"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("You may also find that, due to complexities in when the browser lays out the document for printing and when resize events are fired, Chart.js is unable to properly resize for the print layout. To work around this, you can pass an explicit size to "),a("code",[t._v(".resize()")]),t._v(" then use an "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onafterprint",target:"_blank",rel:"noopener noreferrer"}},[t._v("onafterprint"),a("OutboundLink")],1),t._v(" event to restore the automatic size when done.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("window"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addEventListener")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'beforeprint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("600")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("600")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nwindow"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addEventListener")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'afterprint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[166],{498:function(t,a,e){"use strict";e.r(a);var s=e(3),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"responsive-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#responsive-charts"}},[t._v("#")]),t._v(" Responsive Charts")]),t._v(" "),a("p",[t._v("When it comes to changing the chart size based on the window size, a major limitation is that the canvas "),a("em",[t._v("render")]),t._v(" size ("),a("code",[t._v("canvas.width")]),t._v(" and "),a("code",[t._v(".height")]),t._v(") can "),a("strong",[t._v("not")]),t._v(" be expressed with relative values, contrary to the "),a("em",[t._v("display")]),t._v(" size ("),a("code",[t._v("canvas.style.width")]),t._v(" and "),a("code",[t._v(".height")]),t._v("). Furthermore, these sizes are independent of each other and thus the canvas "),a("em",[t._v("render")]),t._v(" size does not adjust automatically based on the "),a("em",[t._v("display")]),t._v(" size, making the rendering inaccurate.")]),t._v(" "),a("p",[t._v("The following examples "),a("strong",[t._v("do not work")]),t._v(":")]),t._v(" "),a("ul",[a("li",[a("code",[t._v('')]),t._v(": "),a("strong",[t._v("invalid")]),t._v(" values, the canvas doesn't resize ("),a("a",{attrs:{href:"https://codepen.io/chartjs/pen/oWLZaR",target:"_blank",rel:"noopener noreferrer"}},[t._v("example"),a("OutboundLink")],1),t._v(")")]),t._v(" "),a("li",[a("code",[t._v('')]),t._v(": "),a("strong",[t._v("invalid")]),t._v(" behavior, the canvas is resized but becomes blurry ("),a("a",{attrs:{href:"https://codepen.io/chartjs/pen/WjxpmO",target:"_blank",rel:"noopener noreferrer"}},[t._v("example"),a("OutboundLink")],1),t._v(")")]),t._v(" "),a("li",[a("code",[t._v('')]),t._v(": "),a("strong",[t._v("invalid")]),t._v(" behavior, the canvas continually shrinks. Chart.js needs a dedicated container for each canvas and this styling should be applied there.")])]),t._v(" "),a("p",[t._v("Chart.js provides a "),a("a",{attrs:{href:"#configuration-options"}},[t._v("few options")]),t._v(" to enable responsiveness and control the resize behavior of charts by detecting when the canvas "),a("em",[t._v("display")]),t._v(" size changes and update the "),a("em",[t._v("render")]),t._v(" size accordingly.")]),t._v(" "),a("h2",{attrs:{id:"configuration-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration-options"}},[t._v("#")]),t._v(" Configuration Options")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("responsive")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("Resizes the chart canvas when its container does ("),a("a",{attrs:{href:"#important-note"}},[t._v("important note...")]),t._v(").")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("maintainAspectRatio")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",[t._v("Maintain the original canvas aspect ratio "),a("code",[t._v("(width / height)")]),t._v(" when resizing.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("aspectRatio")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("1")]),t._v("|"),a("code",[t._v("2")])]),t._v(" "),a("td",[t._v("Canvas aspect ratio (i.e. "),a("code",[t._v("width / height")]),t._v(", a value of 1 representing a square canvas). Note that this option is ignored if the height is explicitly defined either as attribute or via the style. The default value varies by chart type; Radial charts (doughnut, pie, polarArea, radar) default to "),a("code",[t._v("1")]),t._v(" and others default to "),a("code",[t._v("2")]),t._v(".")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("onResize")])]),t._v(" "),a("td",[a("code",[t._v("function")])]),t._v(" "),a("td",[a("code",[t._v("null")])]),t._v(" "),a("td",[t._v("Called when a resize occurs. Gets passed two arguments: the chart instance and the new size.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("resizeDelay")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[a("code",[t._v("0")])]),t._v(" "),a("td",[t._v("Delay the resize update by the given amount of milliseconds. This can ease the resize process by debouncing the update of the elements.")])])])]),t._v(" "),a("h2",{attrs:{id:"important-note"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#important-note"}},[t._v("#")]),t._v(" Important Note")]),t._v(" "),a("p",[t._v("Detecting when the canvas size changes can not be done directly from the "),a("code",[t._v("canvas")]),t._v(" element. Chart.js uses its parent container to update the canvas "),a("em",[t._v("render")]),t._v(" and "),a("em",[t._v("display")]),t._v(" sizes. However, this method requires the container to be "),a("strong",[t._v("relatively positioned")]),t._v(" and "),a("strong",[t._v("dedicated to the chart canvas only")]),t._v(". Responsiveness can then be achieved by setting relative values for the container size ("),a("a",{attrs:{href:"https://codepen.io/chartjs/pen/YVWZbz",target:"_blank",rel:"noopener noreferrer"}},[t._v("example"),a("OutboundLink")],1),t._v("):")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("div")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("class")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("chart-container"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token special-attr"}},[a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("style")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),a("span",{pre:!0,attrs:{class:"token value css language-css"}},[a("span",{pre:!0,attrs:{class:"token property"}},[t._v("position")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" relative"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("40vh"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v("80vw")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("The chart can also be programmatically resized by modifying the container size:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parentNode"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("height "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'128px'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parentNode"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("width "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'128px'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Note that in order for the above code to correctly resize the chart height, the "),a("a",{attrs:{href:"#configuration-options"}},[a("code",[t._v("maintainAspectRatio")])]),t._v(" option must also be set to "),a("code",[t._v("false")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"printing-resizable-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#printing-resizable-charts"}},[t._v("#")]),t._v(" Printing Resizable Charts")]),t._v(" "),a("p",[t._v("CSS media queries allow changing styles when printing a page. The CSS applied from these media queries may cause charts to need to resize. However, the resize won't happen automatically. To support resizing charts when printing, you need to hook the "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onbeforeprint",target:"_blank",rel:"noopener noreferrer"}},[t._v("onbeforeprint"),a("OutboundLink")],1),t._v(" event and manually trigger resizing of each chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("beforePrintHandler")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" id "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("in")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("instances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("instances"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("id"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("You may also find that, due to complexities in when the browser lays out the document for printing and when resize events are fired, Chart.js is unable to properly resize for the print layout. To work around this, you can pass an explicit size to "),a("code",[t._v(".resize()")]),t._v(" then use an "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/WindowEventHandlers/onafterprint",target:"_blank",rel:"noopener noreferrer"}},[t._v("onafterprint"),a("OutboundLink")],1),t._v(" event to restore the automatic size when done.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("window"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addEventListener")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'beforeprint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("600")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("600")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nwindow"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addEventListener")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'afterprint'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/167.23d5c951.js b/docs/master/assets/js/167.9e300ac1.js similarity index 98% rename from docs/master/assets/js/167.23d5c951.js rename to docs/master/assets/js/167.9e300ac1.js index dd5d45c037..5430a4eb79 100644 --- a/docs/master/assets/js/167.23d5c951.js +++ b/docs/master/assets/js/167.9e300ac1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[167],{497:function(t,a,s){"use strict";s.r(a);var e=s(3),r=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"subtitle"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subtitle"}},[t._v("#")]),t._v(" Subtitle")]),t._v(" "),a("p",[t._v("Subtitle is a second title placed under the main title, by default. It has exactly the same configuration options with the main "),a("RouterLink",{attrs:{to:"/configuration/title.html"}},[t._v("title")]),t._v(".")],1),t._v(" "),a("h2",{attrs:{id:"subtitle-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subtitle-configuration"}},[t._v("#")]),t._v(" Subtitle Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.plugins.subtitle")]),t._v(". The global defaults for subtitle are configured in "),a("code",[t._v("Chart.defaults.plugins.subtitle")]),t._v(".")]),t._v(" "),a("p",[t._v("Exactly the same configuration options with "),a("RouterLink",{attrs:{to:"/configuration/title.html"}},[t._v("title")]),t._v(" are available for subtitle, the namespaces only differ.")],1),t._v(" "),a("h2",{attrs:{id:"example-usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-usage"}},[t._v("#")]),t._v(" Example Usage")]),t._v(" "),a("p",[t._v("The example below would enable a title of 'Custom Chart Subtitle' on the chart that is created.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("subtitle")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Custom Chart Subtitle'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[167],{499:function(t,a,s){"use strict";s.r(a);var e=s(3),r=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"subtitle"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subtitle"}},[t._v("#")]),t._v(" Subtitle")]),t._v(" "),a("p",[t._v("Subtitle is a second title placed under the main title, by default. It has exactly the same configuration options with the main "),a("RouterLink",{attrs:{to:"/configuration/title.html"}},[t._v("title")]),t._v(".")],1),t._v(" "),a("h2",{attrs:{id:"subtitle-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#subtitle-configuration"}},[t._v("#")]),t._v(" Subtitle Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.plugins.subtitle")]),t._v(". The global defaults for subtitle are configured in "),a("code",[t._v("Chart.defaults.plugins.subtitle")]),t._v(".")]),t._v(" "),a("p",[t._v("Exactly the same configuration options with "),a("RouterLink",{attrs:{to:"/configuration/title.html"}},[t._v("title")]),t._v(" are available for subtitle, the namespaces only differ.")],1),t._v(" "),a("h2",{attrs:{id:"example-usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-usage"}},[t._v("#")]),t._v(" Example Usage")]),t._v(" "),a("p",[t._v("The example below would enable a title of 'Custom Chart Subtitle' on the chart that is created.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("subtitle")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Custom Chart Subtitle'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/168.a2527666.js b/docs/master/assets/js/168.714edf6c.js similarity index 99% rename from docs/master/assets/js/168.a2527666.js rename to docs/master/assets/js/168.714edf6c.js index 5762d5854f..3ccc5cc06c 100644 --- a/docs/master/assets/js/168.a2527666.js +++ b/docs/master/assets/js/168.714edf6c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[168],{499:function(t,a,e){"use strict";e.r(a);var s=e(3),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"title"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" Title")]),t._v(" "),a("p",[t._v("The chart title defines text to draw at the top of the chart.")]),t._v(" "),a("h2",{attrs:{id:"title-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#title-configuration"}},[t._v("#")]),t._v(" Title Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.plugins.title")]),t._v(", the global options for the chart title is defined in "),a("code",[t._v("Chart.defaults.plugins.title")]),t._v(".")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",{staticStyle:{"text-align":"center"}},[a("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("align")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'center'")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Alignment of the title. "),a("a",{attrs:{href:"#align"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("color")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/colors.html"}},[a("code",[t._v("Color")])])],1),t._v(" "),a("td",[a("code",[t._v("Chart.defaults.color")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Color of text.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("display")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Is the title shown?")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("fullSize")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Marks that this box should take the full width/height of the canvas. If "),a("code",[t._v("false")]),t._v(", the box is sized and placed above/beside the chart area.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("position")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'top'")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Position of title. "),a("a",{attrs:{href:"#position"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("font")])]),t._v(" "),a("td",[a("code",[t._v("Font")])]),t._v(" "),a("td",[a("code",[t._v("{weight: 'bold'}")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("See "),a("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("padding")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/padding.html"}},[a("code",[t._v("Padding")])])],1),t._v(" "),a("td",[a("code",[t._v("10")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Padding to apply around the title. Only "),a("code",[t._v("top")]),t._v(" and "),a("code",[t._v("bottom")]),t._v(" are implemented.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("text")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v("|"),a("code",[t._v("string[]")])]),t._v(" "),a("td",[a("code",[t._v("''")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Title text to display. If specified as an array, text is rendered on multiple lines.")])])])]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("If you need more visual customizations, you can implement the title with HTML and CSS.")])]),t._v(" "),a("h3",{attrs:{id:"position"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" Position")]),t._v(" "),a("p",[t._v("Possible title position values are:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'top'")])]),t._v(" "),a("li",[a("code",[t._v("'left'")])]),t._v(" "),a("li",[a("code",[t._v("'bottom'")])]),t._v(" "),a("li",[a("code",[t._v("'right'")])])]),t._v(" "),a("h2",{attrs:{id:"align"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" Align")]),t._v(" "),a("p",[t._v("Alignment of the title. Options are:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'start'")])]),t._v(" "),a("li",[a("code",[t._v("'center'")])]),t._v(" "),a("li",[a("code",[t._v("'end'")])])]),t._v(" "),a("h2",{attrs:{id:"example-usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-usage"}},[t._v("#")]),t._v(" Example Usage")]),t._v(" "),a("p",[t._v("The example below would enable a title of 'Custom Chart Title' on the chart that is created.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Custom Chart Title'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("This example shows how to specify separate top and bottom title text padding:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Custom Chart Title'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("padding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("top")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[168],{500:function(t,a,e){"use strict";e.r(a);var s=e(3),r=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"title"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#title"}},[t._v("#")]),t._v(" Title")]),t._v(" "),a("p",[t._v("The chart title defines text to draw at the top of the chart.")]),t._v(" "),a("h2",{attrs:{id:"title-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#title-configuration"}},[t._v("#")]),t._v(" Title Configuration")]),t._v(" "),a("p",[t._v("Namespace: "),a("code",[t._v("options.plugins.title")]),t._v(", the global options for the chart title is defined in "),a("code",[t._v("Chart.defaults.plugins.title")]),t._v(".")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Default")]),t._v(" "),a("th",{staticStyle:{"text-align":"center"}},[a("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable")])],1),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("align")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'center'")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Alignment of the title. "),a("a",{attrs:{href:"#align"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("color")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/colors.html"}},[a("code",[t._v("Color")])])],1),t._v(" "),a("td",[a("code",[t._v("Chart.defaults.color")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Color of text.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("display")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("false")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Is the title shown?")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("fullSize")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[a("code",[t._v("true")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Marks that this box should take the full width/height of the canvas. If "),a("code",[t._v("false")]),t._v(", the box is sized and placed above/beside the chart area.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("position")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[a("code",[t._v("'top'")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Position of title. "),a("a",{attrs:{href:"#position"}},[t._v("more...")])])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("font")])]),t._v(" "),a("td",[a("code",[t._v("Font")])]),t._v(" "),a("td",[a("code",[t._v("{weight: 'bold'}")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("See "),a("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")])],1)]),t._v(" "),a("tr",[a("td",[a("code",[t._v("padding")])]),t._v(" "),a("td",[a("RouterLink",{attrs:{to:"/general/padding.html"}},[a("code",[t._v("Padding")])])],1),t._v(" "),a("td",[a("code",[t._v("10")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Padding to apply around the title. Only "),a("code",[t._v("top")]),t._v(" and "),a("code",[t._v("bottom")]),t._v(" are implemented.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("text")])]),t._v(" "),a("td",[a("code",[t._v("string")]),t._v("|"),a("code",[t._v("string[]")])]),t._v(" "),a("td",[a("code",[t._v("''")])]),t._v(" "),a("td",{staticStyle:{"text-align":"center"}},[t._v("Yes")]),t._v(" "),a("td",[t._v("Title text to display. If specified as an array, text is rendered on multiple lines.")])])])]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("If you need more visual customizations, you can implement the title with HTML and CSS.")])]),t._v(" "),a("h3",{attrs:{id:"position"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" Position")]),t._v(" "),a("p",[t._v("Possible title position values are:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'top'")])]),t._v(" "),a("li",[a("code",[t._v("'left'")])]),t._v(" "),a("li",[a("code",[t._v("'bottom'")])]),t._v(" "),a("li",[a("code",[t._v("'right'")])])]),t._v(" "),a("h2",{attrs:{id:"align"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#align"}},[t._v("#")]),t._v(" Align")]),t._v(" "),a("p",[t._v("Alignment of the title. Options are:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("'start'")])]),t._v(" "),a("li",[a("code",[t._v("'center'")])]),t._v(" "),a("li",[a("code",[t._v("'end'")])])]),t._v(" "),a("h2",{attrs:{id:"example-usage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-usage"}},[t._v("#")]),t._v(" Example Usage")]),t._v(" "),a("p",[t._v("The example below would enable a title of 'Custom Chart Title' on the chart that is created.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Custom Chart Title'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("This example shows how to specify separate top and bottom title text padding:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Custom Chart Title'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("padding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("top")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/169.098f9a45.js b/docs/master/assets/js/169.5f5dbf48.js similarity index 99% rename from docs/master/assets/js/169.098f9a45.js rename to docs/master/assets/js/169.5f5dbf48.js index d8a834dfa5..40f734f522 100644 --- a/docs/master/assets/js/169.098f9a45.js +++ b/docs/master/assets/js/169.5f5dbf48.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[169],{500:function(t,s,a){"use strict";a.r(s);var e=a(3),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"tooltip"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" Tooltip")]),t._v(" "),s("h2",{attrs:{id:"tooltip-configuration"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-configuration"}},[t._v("#")]),t._v(" Tooltip Configuration")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("options.plugins.tooltip")]),t._v(", the global options for the chart tooltips is defined in "),s("code",[t._v("Chart.defaults.plugins.tooltip")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("enabled")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("Are on-canvas tooltips enabled?")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("external")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td",[s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("See "),s("a",{attrs:{href:"#external-custom-tooltips"}},[t._v("external tooltip")]),t._v(" section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("mode")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("interaction.mode")])]),t._v(" "),s("td",[t._v("Sets which elements appear in the tooltip. "),s("RouterLink",{attrs:{to:"/configuration/interactions.html#modes"}},[t._v("more...")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("intersect")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("interaction.intersect")])]),t._v(" "),s("td",[t._v("If true, the tooltip mode applies only when the mouse position intersects with an element. If false, the mode will be applied at all times.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("position")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'average'")])]),t._v(" "),s("td",[t._v("The mode for positioning the tooltip. "),s("a",{attrs:{href:"#position-modes"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("callbacks")])]),t._v(" "),s("td",[s("code",[t._v("object")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("See the "),s("a",{attrs:{href:"#tooltip-callbacks"}},[t._v("callbacks section")]),t._v(".")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("itemSort")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Sort tooltip items. "),s("a",{attrs:{href:"#sort-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("filter")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Filter tooltip items. "),s("a",{attrs:{href:"#filter-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("backgroundColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'rgba(0, 0, 0, 0.8)'")])]),t._v(" "),s("td",[t._v("Background color of the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color of title text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleFont")])]),t._v(" "),s("td",[s("code",[t._v("Font")])]),t._v(" "),s("td",[s("code",[t._v("{weight: 'bold'}")])]),t._v(" "),s("td",[t._v("See "),s("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'left'")])]),t._v(" "),s("td",[t._v("Horizontal alignment of the title text lines. "),s("a",{attrs:{href:"#text-alignment"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleSpacing")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Spacing to add to top and bottom of each title line.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleMarginBottom")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Margin to add on bottom of title section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodyColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color of body text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodyFont")])]),t._v(" "),s("td",[s("code",[t._v("Font")])]),t._v(" "),s("td",[s("code",[t._v("{}")])]),t._v(" "),s("td",[t._v("See "),s("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodyAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'left'")])]),t._v(" "),s("td",[t._v("Horizontal alignment of the body text lines. "),s("a",{attrs:{href:"#text-alignment"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodySpacing")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Spacing to add to top and bottom of each tooltip item.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color of footer text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerFont")])]),t._v(" "),s("td",[s("code",[t._v("Font")])]),t._v(" "),s("td",[s("code",[t._v("{weight: 'bold'}")])]),t._v(" "),s("td",[t._v("See "),s("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'left'")])]),t._v(" "),s("td",[t._v("Horizontal alignment of the footer text lines. "),s("a",{attrs:{href:"#text-alignment"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerSpacing")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Spacing to add to top and bottom of each footer line.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerMarginTop")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Margin to add before drawing the footer.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("padding")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/padding.html"}},[s("code",[t._v("Padding")])])],1),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Padding inside the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("caretPadding")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Extra distance to move the end of the tooltip arrow away from the tooltip point.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("caretSize")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("5")])]),t._v(" "),s("td",[t._v("Size, in px, of the tooltip arrow.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("cornerRadius")])]),t._v(" "),s("td",[s("code",[t._v("number")]),t._v("|"),s("code",[t._v("object")])]),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Radius of tooltip corner curves.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("multiKeyBackground")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color to draw behind the colored boxes when multiple items are in the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("displayColors")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("If true, color boxes are shown in the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("boxWidth")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("bodyFont.size")])]),t._v(" "),s("td",[t._v("Width of the color box if displayColors is true.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("boxHeight")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("bodyFont.size")])]),t._v(" "),s("td",[t._v("Height of the color box if displayColors is true.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("boxPadding")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("1")])]),t._v(" "),s("td",[t._v("Padding between the color box and the text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("usePointStyle")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("false")])]),t._v(" "),s("td",[t._v("Use the corresponding point style (from dataset options) instead of color boxes, ex: star, triangle etc. (size is based on the minimum value between boxWidth and boxHeight).")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("borderColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'rgba(0, 0, 0, 0)'")])]),t._v(" "),s("td",[t._v("Color of the border.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("borderWidth")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("0")])]),t._v(" "),s("td",[t._v("Size of the border.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("rtl")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td"),t._v(" "),s("td",[s("code",[t._v("true")]),t._v(" for rendering the tooltip from right to left.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("textDirection")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("canvas' default")]),t._v(" "),s("td",[t._v("This will force the text direction "),s("code",[t._v("'rtl'")]),t._v(" or "),s("code",[t._v("'ltr'")]),t._v(" on the canvas for rendering the tooltips, regardless of the css specified on the canvas")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("xAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("undefined")])]),t._v(" "),s("td",[t._v("Position of the tooltip caret in the X direction. "),s("a",{attrs:{href:"#tooltip-alignment"}},[t._v("more")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("yAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("undefined")])]),t._v(" "),s("td",[t._v("Position of the tooltip caret in the Y direction. "),s("a",{attrs:{href:"#tooltip-alignment"}},[t._v("more")])])])])]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("If you need more visual customizations, please use an "),s("RouterLink",{attrs:{to:"/samples/tooltip/html.html"}},[t._v("HTML tooltip")]),t._v(".")],1)]),t._v(" "),s("h3",{attrs:{id:"position-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#position-modes"}},[t._v("#")]),t._v(" Position Modes")]),t._v(" "),s("p",[t._v("Possible modes are:")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'average'")])]),t._v(" "),s("li",[s("code",[t._v("'nearest'")])])]),t._v(" "),s("p",[s("code",[t._v("'average'")]),t._v(" mode will place the tooltip at the average position of the items displayed in the tooltip. "),s("code",[t._v("'nearest'")]),t._v(" will place the tooltip at the position of the element closest to the event position.")]),t._v(" "),s("p",[t._v("You can also define "),s("a",{attrs:{href:"#custom-position-modes"}},[t._v("custom position modes")]),t._v(".")]),t._v(" "),s("h3",{attrs:{id:"tooltip-alignment"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-alignment"}},[t._v("#")]),t._v(" Tooltip Alignment")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("xAlign")]),t._v(" and "),s("code",[t._v("yAlign")]),t._v(" options define the position of the tooltip caret. If these parameters are unset, the optimal caret position is determined.")]),t._v(" "),s("p",[t._v("The following values for the "),s("code",[t._v("xAlign")]),t._v(" setting are supported.")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'left'")])]),t._v(" "),s("li",[s("code",[t._v("'center'")])]),t._v(" "),s("li",[s("code",[t._v("'right'")])])]),t._v(" "),s("p",[t._v("The following values for the "),s("code",[t._v("yAlign")]),t._v(" setting are supported.")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'top'")])]),t._v(" "),s("li",[s("code",[t._v("'center'")])]),t._v(" "),s("li",[s("code",[t._v("'bottom'")])])]),t._v(" "),s("h3",{attrs:{id:"text-alignment"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#text-alignment"}},[t._v("#")]),t._v(" Text Alignment")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("titleAlign")]),t._v(", "),s("code",[t._v("bodyAlign")]),t._v(" and "),s("code",[t._v("footerAlign")]),t._v(" options define the horizontal position of the text lines with respect to the tooltip box. The following values are supported.")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'left'")]),t._v(" (default)")]),t._v(" "),s("li",[s("code",[t._v("'right'")])]),t._v(" "),s("li",[s("code",[t._v("'center'")])])]),t._v(" "),s("p",[t._v("These options are only applied to text lines. Color boxes are always aligned to the left edge.")]),t._v(" "),s("h3",{attrs:{id:"sort-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sort-callback"}},[t._v("#")]),t._v(" Sort Callback")]),t._v(" "),s("p",[t._v("Allows sorting of "),s("a",{attrs:{href:"#tooltip-item-context"}},[t._v("tooltip items")]),t._v(". Must implement at minimum a function that can be passed to "),s("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort",target:"_blank",rel:"noopener noreferrer"}},[t._v("Array.prototype.sort"),s("OutboundLink")],1),t._v(". This function can also accept a third parameter that is the data object passed to the chart.")]),t._v(" "),s("h3",{attrs:{id:"filter-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#filter-callback"}},[t._v("#")]),t._v(" Filter Callback")]),t._v(" "),s("p",[t._v("Allows filtering of "),s("a",{attrs:{href:"#tooltip-item-context"}},[t._v("tooltip items")]),t._v(". Must implement at minimum a function that can be passed to "),s("a",{attrs:{href:"https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/filter",target:"_blank",rel:"noopener noreferrer"}},[t._v("Array.prototype.filter"),s("OutboundLink")],1),t._v(". This function can also accept a fourth parameter that is the data object passed to the chart.")]),t._v(" "),s("h2",{attrs:{id:"tooltip-callbacks"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-callbacks"}},[t._v("#")]),t._v(" Tooltip Callbacks")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("options.plugins.tooltip.callbacks")]),t._v(", the tooltip has the following callbacks for providing text. For all functions, "),s("code",[t._v("this")]),t._v(" will be the tooltip object created from the "),s("code",[t._v("Tooltip")]),t._v(" constructor. If the callback returns "),s("code",[t._v("undefined")]),t._v(", then the default callback will be used. To remove things from the tooltip callback should return an empty string.")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("data.datasets[].tooltip.callbacks")]),t._v(", items marked with "),s("code",[t._v("Yes")]),t._v(" in the column "),s("code",[t._v("Dataset override")]),t._v(" can be overridden per dataset.")]),t._v(" "),s("p",[t._v("A "),s("a",{attrs:{href:"#tooltip-item-context"}},[t._v("tooltip item context")]),t._v(" is generated for each item that appears in the tooltip. This is the primary model that the callback methods interact with. For functions that return text, arrays of strings are treated as multiple lines of text.")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Arguments")]),t._v(" "),s("th",[t._v("Return Type")]),t._v(" "),s("th",[t._v("Dataset override")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("beforeTitle")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns the text to render before the title.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("title")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render as the title of the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterTitle")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render after the title.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("beforeBody")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render before the body section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("beforeLabel")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns text to render before an individual label. This will be called for each item in the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("label")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns text to render for an individual item in the tooltip. "),s("a",{attrs:{href:"#label-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("labelColor")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("object | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns the colors to render for the tooltip item. "),s("a",{attrs:{href:"#label-color-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("labelTextColor")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("Color | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns the colors for the text of the label for the tooltip item.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("labelPointStyle")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("object | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns the point style to use instead of color boxes if usePointStyle is true (object with values "),s("code",[t._v("pointStyle")]),t._v(" and "),s("code",[t._v("rotation")]),t._v("). Default implementation uses the point style from the dataset points. "),s("a",{attrs:{href:"#label-point-style-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterLabel")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns text to render after an individual label.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterBody")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render after the body section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("beforeFooter")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render before the footer section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footer")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render as the footer of the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterFooter")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Text to render after the footer section.")])])])]),t._v(" "),s("h3",{attrs:{id:"label-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#label-callback"}},[t._v("#")]),t._v(" Label Callback")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("label")]),t._v(" callback can change the text that displays for a given data point. A common example to show a unit. The example below puts a "),s("code",[t._v("'$'")]),t._v(" before every row.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("callbacks")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("dataset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("label"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("': '")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parsed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!==")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Intl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("NumberFormat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'en-US'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("style")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'currency'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("currency")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'USD'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("format")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parsed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" label"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"label-color-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#label-color-callback"}},[t._v("#")]),t._v(" Label Color Callback")]),t._v(" "),s("p",[t._v("For example, to return a red box with a blue dashed border that has a border radius for each item in the tooltip you could do:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("callbacks")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("labelColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(0, 0, 255)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("backgroundColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 0, 0)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderWidth")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderDash")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderRadius")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("labelTextColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#543453'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"label-point-style-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#label-point-style-callback"}},[t._v("#")]),t._v(" Label Point Style Callback")]),t._v(" "),s("p",[t._v("For example, to draw triangles instead of the regular color box for each item in the tooltip, you could do:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("usePointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("callbacks")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("labelPointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'triangle'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("rotation")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"tooltip-item-context"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-item-context"}},[t._v("#")]),t._v(" Tooltip Item Context")]),t._v(" "),s("p",[t._v("The tooltip items passed to the tooltip callbacks implement the following interface.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The chart the tooltip is being shown on")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("chart")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Chart\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Label for the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Parsed data values for the given `dataIndex` and `datasetIndex`")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsed")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Raw data values for the given `dataIndex` and `datasetIndex`")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("raw")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Formatted value for the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("formattedValue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The dataset the item comes from")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataset")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Index of the dataset the item comes from")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetIndex")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Index of this data item in the dataset")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataIndex")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The chart element (point, arc, bar, etc.) for this tooltip item")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("element")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"external-custom-tooltips"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#external-custom-tooltips"}},[t._v("#")]),t._v(" External (Custom) Tooltips")]),t._v(" "),s("p",[t._v("External tooltips allow you to hook into the tooltip rendering process so that you can render the tooltip in your own custom way. Generally this is used to create an HTML tooltip instead of an on-canvas tooltip. The "),s("code",[t._v("external")]),t._v(" option takes a function which is passed a context parameter containing the "),s("code",[t._v("chart")]),t._v(" and "),s("code",[t._v("tooltip")]),t._v(". You can enable external tooltips in the global or chart configuration like so:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myPieChart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'pie'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Disable the on-canvas tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("enabled")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("external")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Tooltip Element")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" tooltipEl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementById")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-tooltip'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create element on first render")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createElement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'div'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-tooltip'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("innerHTML "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'
'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("appendChild")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Hide if no tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" tooltipModel "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tooltip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Set caret Position")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("classList"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("remove")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'above'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'below'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'no-transform'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("yAlign"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("classList"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("yAlign"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("classList"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'no-transform'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBody")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("bodyItem")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" bodyItem"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("lines"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Set Text")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" titleLines "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("title "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" bodyLines "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("getBody"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n titleLines"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("title")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" title "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n bodyLines"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" i")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" colors "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labelColors"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" style "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'background:'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" colors"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("backgroundColor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n style "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'; border-color:'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" colors"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("borderColor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n style "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'; border-width: 2px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" span "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" body "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" span "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" tableRoot "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("querySelector")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'table'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tableRoot"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("innerHTML "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" innerHtml"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" position "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("canvas"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBoundingClientRect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" bodyFont "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("helpers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toFont")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("bodyFont"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Display, position, and set styles for font")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("position "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'absolute'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("left "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("left "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" window"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("pageXOffset "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("caretX "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("top "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("top "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" window"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("pageYOffset "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("caretY "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("font "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" bodyFont"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("padding "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("padding "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("padding "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("pointerEvents "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'none'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("See "),s("RouterLink",{attrs:{to:"/samples/tooltip/html.html"}},[t._v("samples")]),t._v(" for examples on how to get started with external tooltips.")],1),t._v(" "),s("h2",{attrs:{id:"tooltip-model"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-model"}},[t._v("#")]),t._v(" Tooltip Model")]),t._v(" "),s("p",[t._v("The tooltip model contains parameters that can be used to render the tooltip.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("chart")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The items that we are rendering in the tooltip. See Tooltip Item Interface section")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataPoints")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" TooltipItem"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Positioning")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("xAlign")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAlign")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// X and Y properties are the top left of the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("width")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("height")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Where the tooltip points to")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("caretX")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("caretY")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Body")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The body lines that need to be rendered")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Each object contains 3 parameters")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// before: string[] // lines of text before the line with the color square")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines: string[], // lines of text to render as the main item with color square")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// after: string[], // lines of text to render after the main lines")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines of text that appear after the title but before the body")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("beforeBody")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// line of text that appear after the body and before the footer")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("afterBody")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Title")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines of text that form the title")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Footer")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines of text that form the footer")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("footer")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// style to render for each item in body[]. This is the style of the squares in the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labelColors")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" TooltipLabelStyle"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labelTextColors")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labelPointStyles")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" PointStyle"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" rotation"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0 opacity is a hidden tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("opacity")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// tooltip options")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Object\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"custom-position-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#custom-position-modes"}},[t._v("#")]),t._v(" Custom Position Modes")]),t._v(" "),s("p",[t._v("New modes can be defined by adding functions to the "),s("code",[t._v("Chart.Tooltip.positioners")]),t._v(" map.")]),t._v(" "),s("p",[t._v("Example:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Tooltip "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/**\n * Custom positioner\n * @function Tooltip.positioners.myCustomPositioner\n * @param elements {Chart.Element[]} the tooltip elements\n * @param eventPosition {Point} the position of the event in canvas coordinates\n * @returns {TooltipPosition} the tooltip position\n */")]),t._v("\nTooltip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("positioners"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("myCustomPositioner")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("elements"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" eventPosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// A reference to the tooltip model")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" tooltip "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ... */")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// You may also include xAlign and yAlign to override those tooltip options.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Then, to use it...")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("js")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("position")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myCustomPositioner'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("See "),s("RouterLink",{attrs:{to:"/samples/tooltip/position.html"}},[t._v("samples")]),t._v(" for a more detailed example.")],1),t._v(" "),s("p",[t._v("If you're using TypeScript, you'll also need to register the new mode:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("declare")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("module")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("interface")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TooltipPositionerMap")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myCustomPositioner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" TooltipPositionerFunction"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("ChartType"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[169],{501:function(t,s,a){"use strict";a.r(s);var e=a(3),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"tooltip"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" Tooltip")]),t._v(" "),s("h2",{attrs:{id:"tooltip-configuration"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-configuration"}},[t._v("#")]),t._v(" Tooltip Configuration")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("options.plugins.tooltip")]),t._v(", the global options for the chart tooltips is defined in "),s("code",[t._v("Chart.defaults.plugins.tooltip")]),t._v(".")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Default")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("enabled")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("Are on-canvas tooltips enabled?")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("external")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td",[s("code",[t._v("null")])]),t._v(" "),s("td",[t._v("See "),s("a",{attrs:{href:"#external-custom-tooltips"}},[t._v("external tooltip")]),t._v(" section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("mode")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("interaction.mode")])]),t._v(" "),s("td",[t._v("Sets which elements appear in the tooltip. "),s("RouterLink",{attrs:{to:"/configuration/interactions.html#modes"}},[t._v("more...")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("intersect")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("interaction.intersect")])]),t._v(" "),s("td",[t._v("If true, the tooltip mode applies only when the mouse position intersects with an element. If false, the mode will be applied at all times.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("position")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'average'")])]),t._v(" "),s("td",[t._v("The mode for positioning the tooltip. "),s("a",{attrs:{href:"#position-modes"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("callbacks")])]),t._v(" "),s("td",[s("code",[t._v("object")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("See the "),s("a",{attrs:{href:"#tooltip-callbacks"}},[t._v("callbacks section")]),t._v(".")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("itemSort")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Sort tooltip items. "),s("a",{attrs:{href:"#sort-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("filter")])]),t._v(" "),s("td",[s("code",[t._v("function")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Filter tooltip items. "),s("a",{attrs:{href:"#filter-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("backgroundColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'rgba(0, 0, 0, 0.8)'")])]),t._v(" "),s("td",[t._v("Background color of the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color of title text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleFont")])]),t._v(" "),s("td",[s("code",[t._v("Font")])]),t._v(" "),s("td",[s("code",[t._v("{weight: 'bold'}")])]),t._v(" "),s("td",[t._v("See "),s("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'left'")])]),t._v(" "),s("td",[t._v("Horizontal alignment of the title text lines. "),s("a",{attrs:{href:"#text-alignment"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleSpacing")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Spacing to add to top and bottom of each title line.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("titleMarginBottom")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Margin to add on bottom of title section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodyColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color of body text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodyFont")])]),t._v(" "),s("td",[s("code",[t._v("Font")])]),t._v(" "),s("td",[s("code",[t._v("{}")])]),t._v(" "),s("td",[t._v("See "),s("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodyAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'left'")])]),t._v(" "),s("td",[t._v("Horizontal alignment of the body text lines. "),s("a",{attrs:{href:"#text-alignment"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("bodySpacing")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Spacing to add to top and bottom of each tooltip item.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color of footer text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerFont")])]),t._v(" "),s("td",[s("code",[t._v("Font")])]),t._v(" "),s("td",[s("code",[t._v("{weight: 'bold'}")])]),t._v(" "),s("td",[t._v("See "),s("RouterLink",{attrs:{to:"/general/fonts.html"}},[t._v("Fonts")]),t._v(".")],1)]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("'left'")])]),t._v(" "),s("td",[t._v("Horizontal alignment of the footer text lines. "),s("a",{attrs:{href:"#text-alignment"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerSpacing")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Spacing to add to top and bottom of each footer line.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footerMarginTop")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Margin to add before drawing the footer.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("padding")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/padding.html"}},[s("code",[t._v("Padding")])])],1),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Padding inside the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("caretPadding")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("2")])]),t._v(" "),s("td",[t._v("Extra distance to move the end of the tooltip arrow away from the tooltip point.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("caretSize")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("5")])]),t._v(" "),s("td",[t._v("Size, in px, of the tooltip arrow.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("cornerRadius")])]),t._v(" "),s("td",[s("code",[t._v("number")]),t._v("|"),s("code",[t._v("object")])]),t._v(" "),s("td",[s("code",[t._v("6")])]),t._v(" "),s("td",[t._v("Radius of tooltip corner curves.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("multiKeyBackground")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'#fff'")])]),t._v(" "),s("td",[t._v("Color to draw behind the colored boxes when multiple items are in the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("displayColors")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("true")])]),t._v(" "),s("td",[t._v("If true, color boxes are shown in the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("boxWidth")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("bodyFont.size")])]),t._v(" "),s("td",[t._v("Width of the color box if displayColors is true.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("boxHeight")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("bodyFont.size")])]),t._v(" "),s("td",[t._v("Height of the color box if displayColors is true.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("boxPadding")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("1")])]),t._v(" "),s("td",[t._v("Padding between the color box and the text.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("usePointStyle")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td",[s("code",[t._v("false")])]),t._v(" "),s("td",[t._v("Use the corresponding point style (from dataset options) instead of color boxes, ex: star, triangle etc. (size is based on the minimum value between boxWidth and boxHeight).")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("borderColor")])]),t._v(" "),s("td",[s("RouterLink",{attrs:{to:"/general/colors.html"}},[s("code",[t._v("Color")])])],1),t._v(" "),s("td",[s("code",[t._v("'rgba(0, 0, 0, 0)'")])]),t._v(" "),s("td",[t._v("Color of the border.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("borderWidth")])]),t._v(" "),s("td",[s("code",[t._v("number")])]),t._v(" "),s("td",[s("code",[t._v("0")])]),t._v(" "),s("td",[t._v("Size of the border.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("rtl")])]),t._v(" "),s("td",[s("code",[t._v("boolean")])]),t._v(" "),s("td"),t._v(" "),s("td",[s("code",[t._v("true")]),t._v(" for rendering the tooltip from right to left.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("textDirection")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[t._v("canvas' default")]),t._v(" "),s("td",[t._v("This will force the text direction "),s("code",[t._v("'rtl'")]),t._v(" or "),s("code",[t._v("'ltr'")]),t._v(" on the canvas for rendering the tooltips, regardless of the css specified on the canvas")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("xAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("undefined")])]),t._v(" "),s("td",[t._v("Position of the tooltip caret in the X direction. "),s("a",{attrs:{href:"#tooltip-alignment"}},[t._v("more")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("yAlign")])]),t._v(" "),s("td",[s("code",[t._v("string")])]),t._v(" "),s("td",[s("code",[t._v("undefined")])]),t._v(" "),s("td",[t._v("Position of the tooltip caret in the Y direction. "),s("a",{attrs:{href:"#tooltip-alignment"}},[t._v("more")])])])])]),t._v(" "),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),s("p",[t._v("If you need more visual customizations, please use an "),s("RouterLink",{attrs:{to:"/samples/tooltip/html.html"}},[t._v("HTML tooltip")]),t._v(".")],1)]),t._v(" "),s("h3",{attrs:{id:"position-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#position-modes"}},[t._v("#")]),t._v(" Position Modes")]),t._v(" "),s("p",[t._v("Possible modes are:")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'average'")])]),t._v(" "),s("li",[s("code",[t._v("'nearest'")])])]),t._v(" "),s("p",[s("code",[t._v("'average'")]),t._v(" mode will place the tooltip at the average position of the items displayed in the tooltip. "),s("code",[t._v("'nearest'")]),t._v(" will place the tooltip at the position of the element closest to the event position.")]),t._v(" "),s("p",[t._v("You can also define "),s("a",{attrs:{href:"#custom-position-modes"}},[t._v("custom position modes")]),t._v(".")]),t._v(" "),s("h3",{attrs:{id:"tooltip-alignment"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-alignment"}},[t._v("#")]),t._v(" Tooltip Alignment")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("xAlign")]),t._v(" and "),s("code",[t._v("yAlign")]),t._v(" options define the position of the tooltip caret. If these parameters are unset, the optimal caret position is determined.")]),t._v(" "),s("p",[t._v("The following values for the "),s("code",[t._v("xAlign")]),t._v(" setting are supported.")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'left'")])]),t._v(" "),s("li",[s("code",[t._v("'center'")])]),t._v(" "),s("li",[s("code",[t._v("'right'")])])]),t._v(" "),s("p",[t._v("The following values for the "),s("code",[t._v("yAlign")]),t._v(" setting are supported.")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'top'")])]),t._v(" "),s("li",[s("code",[t._v("'center'")])]),t._v(" "),s("li",[s("code",[t._v("'bottom'")])])]),t._v(" "),s("h3",{attrs:{id:"text-alignment"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#text-alignment"}},[t._v("#")]),t._v(" Text Alignment")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("titleAlign")]),t._v(", "),s("code",[t._v("bodyAlign")]),t._v(" and "),s("code",[t._v("footerAlign")]),t._v(" options define the horizontal position of the text lines with respect to the tooltip box. The following values are supported.")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("'left'")]),t._v(" (default)")]),t._v(" "),s("li",[s("code",[t._v("'right'")])]),t._v(" "),s("li",[s("code",[t._v("'center'")])])]),t._v(" "),s("p",[t._v("These options are only applied to text lines. Color boxes are always aligned to the left edge.")]),t._v(" "),s("h3",{attrs:{id:"sort-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sort-callback"}},[t._v("#")]),t._v(" Sort Callback")]),t._v(" "),s("p",[t._v("Allows sorting of "),s("a",{attrs:{href:"#tooltip-item-context"}},[t._v("tooltip items")]),t._v(". Must implement at minimum a function that can be passed to "),s("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort",target:"_blank",rel:"noopener noreferrer"}},[t._v("Array.prototype.sort"),s("OutboundLink")],1),t._v(". This function can also accept a third parameter that is the data object passed to the chart.")]),t._v(" "),s("h3",{attrs:{id:"filter-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#filter-callback"}},[t._v("#")]),t._v(" Filter Callback")]),t._v(" "),s("p",[t._v("Allows filtering of "),s("a",{attrs:{href:"#tooltip-item-context"}},[t._v("tooltip items")]),t._v(". Must implement at minimum a function that can be passed to "),s("a",{attrs:{href:"https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Global_Objects/Array/filter",target:"_blank",rel:"noopener noreferrer"}},[t._v("Array.prototype.filter"),s("OutboundLink")],1),t._v(". This function can also accept a fourth parameter that is the data object passed to the chart.")]),t._v(" "),s("h2",{attrs:{id:"tooltip-callbacks"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-callbacks"}},[t._v("#")]),t._v(" Tooltip Callbacks")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("options.plugins.tooltip.callbacks")]),t._v(", the tooltip has the following callbacks for providing text. For all functions, "),s("code",[t._v("this")]),t._v(" will be the tooltip object created from the "),s("code",[t._v("Tooltip")]),t._v(" constructor. If the callback returns "),s("code",[t._v("undefined")]),t._v(", then the default callback will be used. To remove things from the tooltip callback should return an empty string.")]),t._v(" "),s("p",[t._v("Namespace: "),s("code",[t._v("data.datasets[].tooltip.callbacks")]),t._v(", items marked with "),s("code",[t._v("Yes")]),t._v(" in the column "),s("code",[t._v("Dataset override")]),t._v(" can be overridden per dataset.")]),t._v(" "),s("p",[t._v("A "),s("a",{attrs:{href:"#tooltip-item-context"}},[t._v("tooltip item context")]),t._v(" is generated for each item that appears in the tooltip. This is the primary model that the callback methods interact with. For functions that return text, arrays of strings are treated as multiple lines of text.")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Name")]),t._v(" "),s("th",[t._v("Arguments")]),t._v(" "),s("th",[t._v("Return Type")]),t._v(" "),s("th",[t._v("Dataset override")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v("beforeTitle")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns the text to render before the title.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("title")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render as the title of the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterTitle")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render after the title.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("beforeBody")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render before the body section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("beforeLabel")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns text to render before an individual label. This will be called for each item in the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("label")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns text to render for an individual item in the tooltip. "),s("a",{attrs:{href:"#label-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("labelColor")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("object | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns the colors to render for the tooltip item. "),s("a",{attrs:{href:"#label-color-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("labelTextColor")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("Color | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns the colors for the text of the label for the tooltip item.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("labelPointStyle")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("object | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns the point style to use instead of color boxes if usePointStyle is true (object with values "),s("code",[t._v("pointStyle")]),t._v(" and "),s("code",[t._v("rotation")]),t._v("). Default implementation uses the point style from the dataset points. "),s("a",{attrs:{href:"#label-point-style-callback"}},[t._v("more...")])])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterLabel")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td",[t._v("Yes")]),t._v(" "),s("td",[t._v("Returns text to render after an individual label.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterBody")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render after the body section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("beforeFooter")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render before the footer section.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("footer")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Returns text to render as the footer of the tooltip.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v("afterFooter")])]),t._v(" "),s("td",[s("code",[t._v("TooltipItem[]")])]),t._v(" "),s("td",[s("code",[t._v("string | string[] | undefined")])]),t._v(" "),s("td"),t._v(" "),s("td",[t._v("Text to render after the footer section.")])])])]),t._v(" "),s("h3",{attrs:{id:"label-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#label-callback"}},[t._v("#")]),t._v(" Label Callback")]),t._v(" "),s("p",[t._v("The "),s("code",[t._v("label")]),t._v(" callback can change the text that displays for a given data point. A common example to show a unit. The example below puts a "),s("code",[t._v("'$'")]),t._v(" before every row.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("callbacks")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("dataset"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("label"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("': '")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parsed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!==")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n label "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Intl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("NumberFormat")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'en-US'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("style")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'currency'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("currency")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'USD'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("format")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("parsed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" label"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"label-color-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#label-color-callback"}},[t._v("#")]),t._v(" Label Color Callback")]),t._v(" "),s("p",[t._v("For example, to return a red box with a blue dashed border that has a border radius for each item in the tooltip you could do:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("callbacks")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("labelColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(0, 0, 255)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("backgroundColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 0, 0)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderWidth")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderDash")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("borderRadius")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("labelTextColor")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#543453'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"label-point-style-callback"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#label-point-style-callback"}},[t._v("#")]),t._v(" Label Point Style Callback")]),t._v(" "),s("p",[t._v("For example, to draw triangles instead of the regular color box for each item in the tooltip, you could do:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("usePointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("callbacks")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("labelPointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'triangle'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("rotation")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h3",{attrs:{id:"tooltip-item-context"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-item-context"}},[t._v("#")]),t._v(" Tooltip Item Context")]),t._v(" "),s("p",[t._v("The tooltip items passed to the tooltip callbacks implement the following interface.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The chart the tooltip is being shown on")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("chart")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Chart\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Label for the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Parsed data values for the given `dataIndex` and `datasetIndex`")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsed")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Raw data values for the given `dataIndex` and `datasetIndex`")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("raw")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Formatted value for the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("formattedValue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The dataset the item comes from")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataset")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Index of the dataset the item comes from")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetIndex")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Index of this data item in the dataset")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataIndex")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The chart element (point, arc, bar, etc.) for this tooltip item")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("element")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Element"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"external-custom-tooltips"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#external-custom-tooltips"}},[t._v("#")]),t._v(" External (Custom) Tooltips")]),t._v(" "),s("p",[t._v("External tooltips allow you to hook into the tooltip rendering process so that you can render the tooltip in your own custom way. Generally this is used to create an HTML tooltip instead of an on-canvas tooltip. The "),s("code",[t._v("external")]),t._v(" option takes a function which is passed a context parameter containing the "),s("code",[t._v("chart")]),t._v(" and "),s("code",[t._v("tooltip")]),t._v(". You can enable external tooltips in the global or chart configuration like so:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myPieChart "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'pie'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Disable the on-canvas tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("enabled")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("external")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Tooltip Element")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" tooltipEl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementById")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-tooltip'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create element on first render")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createElement")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'div'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-tooltip'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("innerHTML "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'
'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n document"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("appendChild")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Hide if no tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" tooltipModel "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("tooltip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Set caret Position")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("classList"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("remove")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'above'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'below'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'no-transform'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("yAlign"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("classList"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("yAlign"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("classList"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("add")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'no-transform'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBody")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("bodyItem")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" bodyItem"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("lines"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Set Text")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" titleLines "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("title "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" bodyLines "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("getBody"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n titleLines"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("title")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" title "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n bodyLines"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("body"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" i")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" colors "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labelColors"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" style "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'background:'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" colors"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("backgroundColor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n style "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'; border-color:'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" colors"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("borderColor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n style "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'; border-width: 2px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" span "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" body "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" span "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n innerHtml "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" tableRoot "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("querySelector")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'table'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tableRoot"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("innerHTML "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" innerHtml"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" position "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("canvas"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getBoundingClientRect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" bodyFont "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("helpers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toFont")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("bodyFont"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Display, position, and set styles for font")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("position "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'absolute'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("left "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("left "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" window"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("pageXOffset "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("caretX "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("top "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" position"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("top "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" window"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("pageYOffset "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("caretY "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("font "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" bodyFont"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("padding "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("padding "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" tooltipModel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("padding "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'px'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n tooltipEl"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("style"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("pointerEvents "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'none'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[t._v("See "),s("RouterLink",{attrs:{to:"/samples/tooltip/html.html"}},[t._v("samples")]),t._v(" for examples on how to get started with external tooltips.")],1),t._v(" "),s("h2",{attrs:{id:"tooltip-model"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#tooltip-model"}},[t._v("#")]),t._v(" Tooltip Model")]),t._v(" "),s("p",[t._v("The tooltip model contains parameters that can be used to render the tooltip.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("chart")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The items that we are rendering in the tooltip. See Tooltip Item Interface section")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataPoints")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" TooltipItem"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Positioning")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("xAlign")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAlign")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// X and Y properties are the top left of the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("width")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("height")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Where the tooltip points to")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("caretX")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("caretY")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Body")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The body lines that need to be rendered")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Each object contains 3 parameters")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// before: string[] // lines of text before the line with the color square")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines: string[], // lines of text to render as the main item with color square")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// after: string[], // lines of text to render after the main lines")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" object"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines of text that appear after the title but before the body")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("beforeBody")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// line of text that appear after the body and before the footer")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("afterBody")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Title")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines of text that form the title")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Footer")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// lines of text that form the footer")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("footer")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// style to render for each item in body[]. This is the style of the squares in the tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labelColors")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" TooltipLabelStyle"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labelTextColors")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Color"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labelPointStyles")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" PointStyle"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" rotation"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// 0 opacity is a hidden tooltip")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("opacity")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// tooltip options")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Object\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"custom-position-modes"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#custom-position-modes"}},[t._v("#")]),t._v(" Custom Position Modes")]),t._v(" "),s("p",[t._v("New modes can be defined by adding functions to the "),s("code",[t._v("Chart.Tooltip.positioners")]),t._v(" map.")]),t._v(" "),s("p",[t._v("Example:")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Tooltip "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/**\n * Custom positioner\n * @function Tooltip.positioners.myCustomPositioner\n * @param elements {Chart.Element[]} the tooltip elements\n * @param eventPosition {Point} the position of the event in canvas coordinates\n * @returns {TooltipPosition} the tooltip position\n */")]),t._v("\nTooltip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("positioners"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("myCustomPositioner")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("elements"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" eventPosition")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// A reference to the tooltip model")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" tooltip "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* ... */")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// You may also include xAlign and yAlign to override those tooltip options.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Then, to use it...")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("js")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("tooltip")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("position")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myCustomPositioner'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("See "),s("RouterLink",{attrs:{to:"/samples/tooltip/position.html"}},[t._v("samples")]),t._v(" for a more detailed example.")],1),t._v(" "),s("p",[t._v("If you're using TypeScript, you'll also need to register the new mode:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("declare")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("module")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("interface")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("TooltipPositionerMap")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n myCustomPositioner"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" TooltipPositionerFunction"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("ChartType"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/17.2f842622.js b/docs/master/assets/js/17.643f26a9.js similarity index 96% rename from docs/master/assets/js/17.2f842622.js rename to docs/master/assets/js/17.643f26a9.js index c92c58f52b..a6f4e56b3a 100644 --- a/docs/master/assets/js/17.2f842622.js +++ b/docs/master/assets/js/17.643f26a9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{351:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-baseplatform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-baseplatform"}},[t._v("#")]),t._v(" Class: BasePlatform")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("BasePlatform")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/classes/BasicPlatform.html"}},[e("code",[t._v("BasicPlatform")])])],1),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/classes/DomPlatform.html"}},[e("code",[t._v("DomPlatform")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new BasePlatform")]),t._v("()")]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"acquirecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#acquirecontext"}},[t._v("#")]),t._v(" acquireContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("acquireContext")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("p",[t._v("Called at chart construction time, returns a context2d instance implementing\nthe [W3C Canvas 2D Context API standard]"),e("a",{attrs:{href:"https://www.w3.org/TR/2dcontext/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.w3.org/TR/2dcontext/"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas from which to acquire context (platform specific)")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2DSettings")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart options")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addeventlistener"}},[t._v("#")]),t._v(" addEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Registers the specified listener on the given chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to listen for event")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to listen for")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Receives a notification (an object that implements the "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(" interface) when an event of the specified type occurs.")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2165"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevicepixelratio"}},[t._v("#")]),t._v(" getDevicePixelRatio")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDevicePixelRatio")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("the current devicePixelRatio of the device this platform is connected to.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2176",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2176"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaximumsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaximumsize"}},[t._v("#")]),t._v(" getMaximumSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMaximumSize")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v(", "),e("code",[t._v("aspectRatio?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas for which to calculate the maximum size")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content width")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content height")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("aspectRatio?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The aspect ratio to maintain")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("p",[t._v("the maximum size available.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isattached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isattached"}},[t._v("#")]),t._v(" isAttached")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isAttached")]),t._v("("),e("code",[t._v("canvas")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the canvas is attached to the platform, false if not.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2189",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2189"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"releasecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#releasecontext"}},[t._v("#")]),t._v(" releaseContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("releaseContext")]),t._v("("),e("code",[t._v("context")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Called at chart destruction time, releases any resources associated to the context\npreviously returned by the acquireContext() method.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("context")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The context2d instance")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the method succeeded, else false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removeeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removeeventlistener"}},[t._v("#")]),t._v(" removeEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Removes the specified listener previously registered with addEventListener.")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to remove the listener")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to remove")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The listener function to remove from the event target.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2172",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2172"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateconfig"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateConfig")]),t._v("("),e("code",[t._v("config")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Updates config with platform specific requirements")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2194",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2194"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[17],{348:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-baseplatform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-baseplatform"}},[t._v("#")]),t._v(" Class: BasePlatform")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("BasePlatform")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/classes/BasicPlatform.html"}},[e("code",[t._v("BasicPlatform")])])],1),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/classes/DomPlatform.html"}},[e("code",[t._v("DomPlatform")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new BasePlatform")]),t._v("()")]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"acquirecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#acquirecontext"}},[t._v("#")]),t._v(" acquireContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("acquireContext")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("p",[t._v("Called at chart construction time, returns a context2d instance implementing\nthe [W3C Canvas 2D Context API standard]"),e("a",{attrs:{href:"https://www.w3.org/TR/2dcontext/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.w3.org/TR/2dcontext/"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas from which to acquire context (platform specific)")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2DSettings")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart options")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addeventlistener"}},[t._v("#")]),t._v(" addEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Registers the specified listener on the given chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to listen for event")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to listen for")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Receives a notification (an object that implements the "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(" interface) when an event of the specified type occurs.")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2165"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevicepixelratio"}},[t._v("#")]),t._v(" getDevicePixelRatio")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDevicePixelRatio")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("the current devicePixelRatio of the device this platform is connected to.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2176",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2176"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaximumsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaximumsize"}},[t._v("#")]),t._v(" getMaximumSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMaximumSize")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v(", "),e("code",[t._v("aspectRatio?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas for which to calculate the maximum size")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content width")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content height")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("aspectRatio?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The aspect ratio to maintain")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("p",[t._v("the maximum size available.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isattached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isattached"}},[t._v("#")]),t._v(" isAttached")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isAttached")]),t._v("("),e("code",[t._v("canvas")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the canvas is attached to the platform, false if not.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2189",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2189"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"releasecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#releasecontext"}},[t._v("#")]),t._v(" releaseContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("releaseContext")]),t._v("("),e("code",[t._v("context")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Called at chart destruction time, releases any resources associated to the context\npreviously returned by the acquireContext() method.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("context")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The context2d instance")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the method succeeded, else false")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removeeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removeeventlistener"}},[t._v("#")]),t._v(" removeEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Removes the specified listener previously registered with addEventListener.")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to remove the listener")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to remove")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The listener function to remove from the event target.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2172",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2172"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateconfig"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateConfig")]),t._v("("),e("code",[t._v("config")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Updates config with platform specific requirements")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2194",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2194"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/170.c3413165.js b/docs/master/assets/js/170.92278958.js similarity index 99% rename from docs/master/assets/js/170.c3413165.js rename to docs/master/assets/js/170.92278958.js index 3e809b95f8..9e5699611b 100644 --- a/docs/master/assets/js/170.c3413165.js +++ b/docs/master/assets/js/170.92278958.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[170],{501:function(t,a,s){"use strict";s.r(a);var e=s(3),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"api"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#api"}},[t._v("#")]),t._v(" API")]),t._v(" "),a("p",[t._v("For each chart, there are a set of global prototype methods on the shared chart type which you may find useful. These are available on all charts created with Chart.js, but for the examples, let's use a line chart we've made.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For example:")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myLineChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"destroy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#destroy"}},[t._v("#")]),t._v(" .destroy()")]),t._v(" "),a("p",[t._v("Use this to destroy any chart instances that are created. This will clean up any references stored to the chart object within Chart.js, along with any associated event listeners attached by Chart.js.\nThis must be called before the canvas is reused for a new chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Destroys a specific chart instance")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("destroy")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"update-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-mode"}},[t._v("#")]),t._v(" .update(mode?)")]),t._v(" "),a("p",[t._v("Triggers an update of the chart. This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Would update the first dataset's value of 'March' to be 50")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Calling update now animates the position of March from 90 to 50.")]),t._v("\n")])])]),a("p",[t._v("A "),a("code",[t._v("mode")]),t._v(" string can be provided to indicate transition configuration should be used. Core calls this method using any of "),a("code",[t._v("'active'")]),t._v(", "),a("code",[t._v("'hide'")]),t._v(", "),a("code",[t._v("'reset'")]),t._v(", "),a("code",[t._v("'resize'")]),t._v(", "),a("code",[t._v("'show'")]),t._v(" or "),a("code",[t._v("undefined")]),t._v(". "),a("code",[t._v("'none'")]),t._v(" is also a supported mode for skipping animations for single update. Please see "),a("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("animations")]),t._v(" docs for more details.")],1),t._v(" "),a("p",[t._v("Example:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'active'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("See "),a("RouterLink",{attrs:{to:"/developers/updates.html"}},[t._v("Updating Charts")]),t._v(" for more details.")],1),t._v(" "),a("h2",{attrs:{id:"reset"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" .reset()")]),t._v(" "),a("p",[t._v("Reset the chart to its state before the initial animation. A new animation can then be triggered using "),a("code",[t._v("update")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("reset")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"render"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#render"}},[t._v("#")]),t._v(" .render()")]),t._v(" "),a("p",[t._v("Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use "),a("code",[t._v(".update()")]),t._v(" in that case.")]),t._v(" "),a("h2",{attrs:{id:"stop"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" .stop()")]),t._v(" "),a("p",[t._v("Use this to stop any current animation. This will pause the chart during any current animation frame. Call "),a("code",[t._v(".render()")]),t._v(" to re-animate.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stops the charts animation loop at its current frame")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stop")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns 'this' for chainability")]),t._v("\n")])])]),a("h2",{attrs:{id:"resize-width-height"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#resize-width-height"}},[t._v("#")]),t._v(" .resize(width?, height?)")]),t._v(" "),a("p",[t._v("Use this to manually resize the canvas element. This is run each time the canvas container is resized, but you can call this method manually if you change the size of the canvas nodes container element.")]),t._v(" "),a("p",[t._v("You can call "),a("code",[t._v(".resize()")]),t._v(" with no parameters to have the chart take the size of its container element, or you can pass explicit dimensions (e.g., for "),a("RouterLink",{attrs:{to:"/configuration/responsive.html#printing-resizable-charts"}},[t._v("printing")]),t._v(").")],1),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Resizes & redraws to fill its container element")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns 'this' for chainability")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// With an explicit size:")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("width"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" height"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"clear"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clear"}},[t._v("#")]),t._v(" .clear()")]),t._v(" "),a("p",[t._v("Will clear the chart canvas. Used extensively internally between animation frames, but you might find it useful.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Will clear the canvas that myLineChart is drawn on")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("clear")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns 'this' for chainability")]),t._v("\n")])])]),a("h2",{attrs:{id:"tobase64image-type-quality"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tobase64image-type-quality"}},[t._v("#")]),t._v(" .toBase64Image(type?, quality?)")]),t._v(" "),a("p",[t._v("This returns a base 64 encoded string of the chart in its current state.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toBase64Image")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns png data url of the image on the canvas")]),t._v("\n\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toBase64Image")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'image/jpeg'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns a jpeg data url in the highest quality of the canvas")]),t._v("\n")])])]),a("h2",{attrs:{id:"getelementsateventformode-e-mode-options-usefinalposition"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getelementsateventformode-e-mode-options-usefinalposition"}},[t._v("#")]),t._v(" .getElementsAtEventForMode(e, mode, options, useFinalPosition)")]),t._v(" "),a("p",[t._v("Calling "),a("code",[t._v("getElementsAtEventForMode(e, mode, options, useFinalPosition)")]),t._v(" on your Chart instance passing an event and a mode will return the elements that are found. The "),a("code",[t._v("options")]),t._v(" and "),a("code",[t._v("useFinalPosition")]),t._v(" arguments are passed through to the handlers.")]),t._v(" "),a("p",[t._v("To get an item that was clicked on, "),a("code",[t._v("getElementsAtEventForMode")]),t._v(" can be used.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("clickHandler")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("evt")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" points "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementsAtEventForMode")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("evt"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nearest'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("intersect")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("points"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" firstPoint "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" points"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" label "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labels"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("firstPoint"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("firstPoint"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasetIndex"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("firstPoint"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"getsortedvisibledatasetmetas"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getsortedvisibledatasetmetas"}},[t._v("#")]),t._v(" .getSortedVisibleDatasetMetas()")]),t._v(" "),a("p",[t._v("Returns an array of all the dataset meta's in the order that they are drawn on the canvas that are not hidden.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" visibleMetas "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSortedVisibleDatasetMetas")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"getdatasetmeta-index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getdatasetmeta-index"}},[t._v("#")]),t._v(" .getDatasetMeta(index)")]),t._v(" "),a("p",[t._v("Looks for the dataset that matches the current index and returns that metadata. This returned data has all of the metadata that is used to construct the chart.")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("data")]),t._v(" property of the metadata will contain information about each point, bar, etc. depending on the chart type.")]),t._v(" "),a("p",[t._v("Extensive examples of usage are available in the "),a("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/master/test",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chart.js tests"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" meta "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDatasetMeta")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" x "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"getvisibledatasetcount"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getvisibledatasetcount"}},[t._v("#")]),t._v(" getVisibleDatasetCount")]),t._v(" "),a("p",[t._v("Returns the number of datasets that are currently not hidden.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" numberOfVisibleDatasets "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getVisibleDatasetCount")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"setdatasetvisibility-datasetindex-visibility"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setdatasetvisibility-datasetindex-visibility"}},[t._v("#")]),t._v(" setDatasetVisibility(datasetIndex, visibility)")]),t._v(" "),a("p",[t._v("Sets the visibility for a given dataset. This can be used to build a chart legend in HTML. During click on one of the HTML items, you can call "),a("code",[t._v("setDatasetVisibility")]),t._v(" to change the appropriate dataset.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("setDatasetVisibility")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hides dataset at index 1")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// chart now renders with dataset hidden")]),t._v("\n")])])]),a("h2",{attrs:{id:"toggledatavisibility-index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#toggledatavisibility-index"}},[t._v("#")]),t._v(" toggleDataVisibility(index)")]),t._v(" "),a("p",[t._v("Toggles the visibility of an item in all datasets. A dataset needs to explicitly support this feature for it to have an effect. From internal chart types, doughnut / pie, polar area, and bar use this.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toggleDataVisibility")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// toggles the item in all datasets, at index 2")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// chart now renders with item hidden")]),t._v("\n")])])]),a("h2",{attrs:{id:"getdatavisibility-index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getdatavisibility-index"}},[t._v("#")]),t._v(" getDataVisibility(index)")]),t._v(" "),a("p",[t._v("Returns the stored visibility state of a data index for all datasets. Set by "),a("a",{attrs:{href:"#toggleDataVisibility"}},[t._v("toggleDataVisibility")]),t._v(". A dataset controller should use this method to determine if an item should not be visible.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" visible "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDataVisibility")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"hide-datasetindex-dataindex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hide-datasetindex-dataindex"}},[t._v("#")]),t._v(" hide(datasetIndex, dataIndex?)")]),t._v(" "),a("p",[t._v("If dataIndex is not specified, sets the visibility for the given dataset to false. Updates the chart and animates the dataset with "),a("code",[t._v("'hide'")]),t._v(" mode. This animation can be configured under the "),a("code",[t._v("hide")]),t._v(" key in animation options. Please see "),a("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("animations")]),t._v(" docs for more details.")],1),t._v(" "),a("p",[t._v("If dataIndex is specified, sets the hidden flag of that element to true and updates the chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("hide")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hides dataset at index 1 and does 'hide' animation.")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("hide")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hides the data element at index 2 of the first dataset.")]),t._v("\n")])])]),a("h2",{attrs:{id:"show-datasetindex-dataindex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#show-datasetindex-dataindex"}},[t._v("#")]),t._v(" show(datasetIndex, dataIndex?)")]),t._v(" "),a("p",[t._v("If dataIndex is not specified, sets the visibility for the given dataset to true. Updates the chart and animates the dataset with "),a("code",[t._v("'show'")]),t._v(" mode. This animation can be configured under the "),a("code",[t._v("show")]),t._v(" key in animation options. Please see "),a("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("animations")]),t._v(" docs for more details.")],1),t._v(" "),a("p",[t._v("If dataIndex is specified, sets the hidden flag of that element to false and updates the chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("show")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// shows dataset at index 1 and does 'show' animation.")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("show")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// shows the data element at index 2 of the first dataset.")]),t._v("\n")])])]),a("h2",{attrs:{id:"setactiveelements-activeelements"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setactiveelements-activeelements"}},[t._v("#")]),t._v(" setActiveElements(activeElements)")]),t._v(" "),a("p",[t._v('Sets the active (hovered) elements for the chart. See the "Programmatic Events" sample file to see this in action.')]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("setActiveElements")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetIndex")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("index")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"ispluginenabled-pluginid"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ispluginenabled-pluginid"}},[t._v("#")]),t._v(" isPluginEnabled(pluginId)")]),t._v(" "),a("p",[t._v("Returns a boolean if a plugin with the given ID has been registered to the chart instance.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isPluginEnabled")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'filler'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"static-getchart-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-getchart-key"}},[t._v("#")]),t._v(" Static: getChart(key)")]),t._v(" "),a("p",[t._v("Finds the chart instance from the given key. If the key is a "),a("code",[t._v("string")]),t._v(", it is interpreted as the ID of the Canvas node for the Chart. The key can also be a "),a("code",[t._v("CanvasRenderingContext2D")]),t._v(" or an "),a("code",[t._v("HTMLDOMElement")]),t._v(". This will return "),a("code",[t._v("undefined")]),t._v(" if no Chart is found. To be found, the chart must have previously been created.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getChart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"canvas-id"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"static-register-chartcomponentlike"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-register-chartcomponentlike"}},[t._v("#")]),t._v(" Static: register(chartComponentLike)")]),t._v(" "),a("p",[t._v("Used to register plugins, axis types or chart types globally to all your charts.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" Tooltip"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" LinearScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" PointElement"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" BubbleController "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Tooltip"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" LinearScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" PointElement"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" BubbleController"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"static-unregister-chartcomponentlike"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-unregister-chartcomponentlike"}},[t._v("#")]),t._v(" Static: unregister(chartComponentLike)")]),t._v(" "),a("p",[t._v("Used to unregister plugins, axis types or chart types globally from all your charts.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[170],{503:function(t,a,s){"use strict";s.r(a);var e=s(3),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"api"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#api"}},[t._v("#")]),t._v(" API")]),t._v(" "),a("p",[t._v("For each chart, there are a set of global prototype methods on the shared chart type which you may find useful. These are available on all charts created with Chart.js, but for the examples, let's use a line chart we've made.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For example:")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myLineChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"destroy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#destroy"}},[t._v("#")]),t._v(" .destroy()")]),t._v(" "),a("p",[t._v("Use this to destroy any chart instances that are created. This will clean up any references stored to the chart object within Chart.js, along with any associated event listeners attached by Chart.js.\nThis must be called before the canvas is reused for a new chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Destroys a specific chart instance")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("destroy")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"update-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-mode"}},[t._v("#")]),t._v(" .update(mode?)")]),t._v(" "),a("p",[t._v("Triggers an update of the chart. This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Would update the first dataset's value of 'March' to be 50")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Calling update now animates the position of March from 90 to 50.")]),t._v("\n")])])]),a("p",[t._v("A "),a("code",[t._v("mode")]),t._v(" string can be provided to indicate transition configuration should be used. Core calls this method using any of "),a("code",[t._v("'active'")]),t._v(", "),a("code",[t._v("'hide'")]),t._v(", "),a("code",[t._v("'reset'")]),t._v(", "),a("code",[t._v("'resize'")]),t._v(", "),a("code",[t._v("'show'")]),t._v(" or "),a("code",[t._v("undefined")]),t._v(". "),a("code",[t._v("'none'")]),t._v(" is also a supported mode for skipping animations for single update. Please see "),a("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("animations")]),t._v(" docs for more details.")],1),t._v(" "),a("p",[t._v("Example:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'active'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("See "),a("RouterLink",{attrs:{to:"/developers/updates.html"}},[t._v("Updating Charts")]),t._v(" for more details.")],1),t._v(" "),a("h2",{attrs:{id:"reset"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" .reset()")]),t._v(" "),a("p",[t._v("Reset the chart to its state before the initial animation. A new animation can then be triggered using "),a("code",[t._v("update")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("reset")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"render"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#render"}},[t._v("#")]),t._v(" .render()")]),t._v(" "),a("p",[t._v("Triggers a redraw of all chart elements. Note, this does not update elements for new data. Use "),a("code",[t._v(".update()")]),t._v(" in that case.")]),t._v(" "),a("h2",{attrs:{id:"stop"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" .stop()")]),t._v(" "),a("p",[t._v("Use this to stop any current animation. This will pause the chart during any current animation frame. Call "),a("code",[t._v(".render()")]),t._v(" to re-animate.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stops the charts animation loop at its current frame")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("stop")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns 'this' for chainability")]),t._v("\n")])])]),a("h2",{attrs:{id:"resize-width-height"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#resize-width-height"}},[t._v("#")]),t._v(" .resize(width?, height?)")]),t._v(" "),a("p",[t._v("Use this to manually resize the canvas element. This is run each time the canvas container is resized, but you can call this method manually if you change the size of the canvas nodes container element.")]),t._v(" "),a("p",[t._v("You can call "),a("code",[t._v(".resize()")]),t._v(" with no parameters to have the chart take the size of its container element, or you can pass explicit dimensions (e.g., for "),a("RouterLink",{attrs:{to:"/configuration/responsive.html#printing-resizable-charts"}},[t._v("printing")]),t._v(").")],1),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Resizes & redraws to fill its container element")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns 'this' for chainability")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// With an explicit size:")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("width"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" height"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"clear"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#clear"}},[t._v("#")]),t._v(" .clear()")]),t._v(" "),a("p",[t._v("Will clear the chart canvas. Used extensively internally between animation frames, but you might find it useful.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Will clear the canvas that myLineChart is drawn on")]),t._v("\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("clear")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns 'this' for chainability")]),t._v("\n")])])]),a("h2",{attrs:{id:"tobase64image-type-quality"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tobase64image-type-quality"}},[t._v("#")]),t._v(" .toBase64Image(type?, quality?)")]),t._v(" "),a("p",[t._v("This returns a base 64 encoded string of the chart in its current state.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toBase64Image")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns png data url of the image on the canvas")]),t._v("\n\nmyLineChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toBase64Image")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'image/jpeg'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// => returns a jpeg data url in the highest quality of the canvas")]),t._v("\n")])])]),a("h2",{attrs:{id:"getelementsateventformode-e-mode-options-usefinalposition"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getelementsateventformode-e-mode-options-usefinalposition"}},[t._v("#")]),t._v(" .getElementsAtEventForMode(e, mode, options, useFinalPosition)")]),t._v(" "),a("p",[t._v("Calling "),a("code",[t._v("getElementsAtEventForMode(e, mode, options, useFinalPosition)")]),t._v(" on your Chart instance passing an event and a mode will return the elements that are found. The "),a("code",[t._v("options")]),t._v(" and "),a("code",[t._v("useFinalPosition")]),t._v(" arguments are passed through to the handlers.")]),t._v(" "),a("p",[t._v("To get an item that was clicked on, "),a("code",[t._v("getElementsAtEventForMode")]),t._v(" can be used.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("clickHandler")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("evt")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" points "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getElementsAtEventForMode")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("evt"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nearest'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("intersect")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("points"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" firstPoint "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" points"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" label "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labels"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("firstPoint"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("firstPoint"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasetIndex"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("firstPoint"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("index"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"getsortedvisibledatasetmetas"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getsortedvisibledatasetmetas"}},[t._v("#")]),t._v(" .getSortedVisibleDatasetMetas()")]),t._v(" "),a("p",[t._v("Returns an array of all the dataset meta's in the order that they are drawn on the canvas that are not hidden.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" visibleMetas "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getSortedVisibleDatasetMetas")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"getdatasetmeta-index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getdatasetmeta-index"}},[t._v("#")]),t._v(" .getDatasetMeta(index)")]),t._v(" "),a("p",[t._v("Looks for the dataset that matches the current index and returns that metadata. This returned data has all of the metadata that is used to construct the chart.")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("data")]),t._v(" property of the metadata will contain information about each point, bar, etc. depending on the chart type.")]),t._v(" "),a("p",[t._v("Extensive examples of usage are available in the "),a("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/master/test",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chart.js tests"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" meta "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDatasetMeta")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" x "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"getvisibledatasetcount"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getvisibledatasetcount"}},[t._v("#")]),t._v(" getVisibleDatasetCount")]),t._v(" "),a("p",[t._v("Returns the number of datasets that are currently not hidden.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" numberOfVisibleDatasets "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getVisibleDatasetCount")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"setdatasetvisibility-datasetindex-visibility"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setdatasetvisibility-datasetindex-visibility"}},[t._v("#")]),t._v(" setDatasetVisibility(datasetIndex, visibility)")]),t._v(" "),a("p",[t._v("Sets the visibility for a given dataset. This can be used to build a chart legend in HTML. During click on one of the HTML items, you can call "),a("code",[t._v("setDatasetVisibility")]),t._v(" to change the appropriate dataset.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("setDatasetVisibility")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hides dataset at index 1")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// chart now renders with dataset hidden")]),t._v("\n")])])]),a("h2",{attrs:{id:"toggledatavisibility-index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#toggledatavisibility-index"}},[t._v("#")]),t._v(" toggleDataVisibility(index)")]),t._v(" "),a("p",[t._v("Toggles the visibility of an item in all datasets. A dataset needs to explicitly support this feature for it to have an effect. From internal chart types, doughnut / pie, polar area, and bar use this.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("toggleDataVisibility")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// toggles the item in all datasets, at index 2")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// chart now renders with item hidden")]),t._v("\n")])])]),a("h2",{attrs:{id:"getdatavisibility-index"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#getdatavisibility-index"}},[t._v("#")]),t._v(" getDataVisibility(index)")]),t._v(" "),a("p",[t._v("Returns the stored visibility state of a data index for all datasets. Set by "),a("a",{attrs:{href:"#toggleDataVisibility"}},[t._v("toggleDataVisibility")]),t._v(". A dataset controller should use this method to determine if an item should not be visible.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" visible "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDataVisibility")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"hide-datasetindex-dataindex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#hide-datasetindex-dataindex"}},[t._v("#")]),t._v(" hide(datasetIndex, dataIndex?)")]),t._v(" "),a("p",[t._v("If dataIndex is not specified, sets the visibility for the given dataset to false. Updates the chart and animates the dataset with "),a("code",[t._v("'hide'")]),t._v(" mode. This animation can be configured under the "),a("code",[t._v("hide")]),t._v(" key in animation options. Please see "),a("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("animations")]),t._v(" docs for more details.")],1),t._v(" "),a("p",[t._v("If dataIndex is specified, sets the hidden flag of that element to true and updates the chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("hide")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hides dataset at index 1 and does 'hide' animation.")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("hide")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// hides the data element at index 2 of the first dataset.")]),t._v("\n")])])]),a("h2",{attrs:{id:"show-datasetindex-dataindex"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#show-datasetindex-dataindex"}},[t._v("#")]),t._v(" show(datasetIndex, dataIndex?)")]),t._v(" "),a("p",[t._v("If dataIndex is not specified, sets the visibility for the given dataset to true. Updates the chart and animates the dataset with "),a("code",[t._v("'show'")]),t._v(" mode. This animation can be configured under the "),a("code",[t._v("show")]),t._v(" key in animation options. Please see "),a("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("animations")]),t._v(" docs for more details.")],1),t._v(" "),a("p",[t._v("If dataIndex is specified, sets the hidden flag of that element to false and updates the chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("show")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// shows dataset at index 1 and does 'show' animation.")]),t._v("\nchart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("show")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// shows the data element at index 2 of the first dataset.")]),t._v("\n")])])]),a("h2",{attrs:{id:"setactiveelements-activeelements"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#setactiveelements-activeelements"}},[t._v("#")]),t._v(" setActiveElements(activeElements)")]),t._v(" "),a("p",[t._v('Sets the active (hovered) elements for the chart. See the "Programmatic Events" sample file to see this in action.')]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("setActiveElements")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetIndex")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("index")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"ispluginenabled-pluginid"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#ispluginenabled-pluginid"}},[t._v("#")]),t._v(" isPluginEnabled(pluginId)")]),t._v(" "),a("p",[t._v("Returns a boolean if a plugin with the given ID has been registered to the chart instance.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isPluginEnabled")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'filler'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"static-getchart-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-getchart-key"}},[t._v("#")]),t._v(" Static: getChart(key)")]),t._v(" "),a("p",[t._v("Finds the chart instance from the given key. If the key is a "),a("code",[t._v("string")]),t._v(", it is interpreted as the ID of the Canvas node for the Chart. The key can also be a "),a("code",[t._v("CanvasRenderingContext2D")]),t._v(" or an "),a("code",[t._v("HTMLDOMElement")]),t._v(". This will return "),a("code",[t._v("undefined")]),t._v(" if no Chart is found. To be found, the chart must have previously been created.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getChart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"canvas-id"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"static-register-chartcomponentlike"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-register-chartcomponentlike"}},[t._v("#")]),t._v(" Static: register(chartComponentLike)")]),t._v(" "),a("p",[t._v("Used to register plugins, axis types or chart types globally to all your charts.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" Tooltip"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" LinearScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" PointElement"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" BubbleController "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\nChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Tooltip"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" LinearScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" PointElement"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" BubbleController"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"static-unregister-chartcomponentlike"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#static-unregister-chartcomponentlike"}},[t._v("#")]),t._v(" Static: unregister(chartComponentLike)")]),t._v(" "),a("p",[t._v("Used to unregister plugins, axis types or chart types globally from all your charts.")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/171.80b8a56d.js b/docs/master/assets/js/171.760242a4.js similarity index 99% rename from docs/master/assets/js/171.80b8a56d.js rename to docs/master/assets/js/171.760242a4.js index 38d70c697d..79ba1ef70a 100644 --- a/docs/master/assets/js/171.80b8a56d.js +++ b/docs/master/assets/js/171.760242a4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[171],{506:function(t,a,s){"use strict";s.r(a);var n=s(3),e=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"new-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#new-axes"}},[t._v("#")]),t._v(" New Axes")]),t._v(" "),a("p",[t._v("Axes in Chart.js can be individually extended. Axes should always derive from "),a("code",[t._v("Chart.Scale")]),t._v(" but this is not a mandatory requirement.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("MyScale")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Scale")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* extensions ... */")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\nMyScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myScale'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nMyScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" defaultConfigObject"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// MyScale is now derived from Chart.Scale")]),t._v("\n")])])]),a("p",[t._v("Once you have created your scale class, you need to register it with the global chart object so that it can be used.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If the new scale is not extending Chart.Scale, the prototype can not be used to detect what")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// you are trying to register - so you need to be explicit:")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chart.registry.addScales(MyScale);")]),t._v("\n")])])]),a("p",[t._v("To use the new scale, simply pass in the string key to the config when creating a chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" lineChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myScale'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this is the same id that was set on the scale")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"scale-properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scale-properties"}},[t._v("#")]),t._v(" Scale Properties")]),t._v(" "),a("p",[t._v("Scale instances are given the following properties during the fitting process.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("left")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// left edge of the scale bounding box")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("right")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// right edge of the bounding box")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("top")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the same as right - left")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the same as bottom - top")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Margin on each side. Like css, this is outside the bounding box.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("margins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("left")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("right")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("top")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Amount of padding on the inside of the bounding box (like CSS)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingLeft")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingRight")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingTop")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingBottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"scale-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scale-interface"}},[t._v("#")]),t._v(" Scale Interface")]),t._v(" "),a("p",[t._v("To work with Chart.js, custom scale types must implement the following interface.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Determines the data limits. Should set this.min and this.max to be the data max/min")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("determineDataLimits")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Generate tick marks. this.chart is the chart instance. The data object can be accessed as this.chart.data")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// buildTicks() should create a ticks array on the axis instance, if you intend to use any of the implementations from the base class")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("buildTicks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the label to show for the given value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getLabelForValue")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param index: index into the ticks array")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getPixelForTick")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("index")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param value : the value to get the pixel for")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param [index] : index into the data array of the value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getPixelForValue")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the value for a given pixel (x coordinate for horizontal axis, y coordinate for vertical axis)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param pixel : pixel value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getValueForPixel")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("pixel")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Optionally, the following methods may also be overwritten, but an implementation is already provided by the "),a("code",[t._v("Chart.Scale")]),t._v(" base class.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Adds labels to objects in the ticks array. The default implementation simply calls this.options.ticks.callback(numericalTick, index, ticks);")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("generateTickLabels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Determine how much the labels will rotate by. The default implementation will only rotate labels if the scale is horizontal.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("calculateLabelRotation")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Fits the scale into the canvas.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this.maxWidth and this.maxHeight will tell you the maximum dimensions the scale instance can be. Scales should endeavour to be as efficient as possible with canvas space.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this.margins is the amount of space you have on either side of your scale that you may expand in to. This is used already for calculating the best label rotation")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// You must set this.minSize to be the size of your scale. It must be an object containing 2 properties: width and height.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// You must set this.width to be the width and this.height to be the height of the scale")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("fit")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Draws the scale onto the canvas. this.(left|right|top|bottom) will have been populated to tell you the area on the canvas to draw in")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param chartArea : an object containing four properties: left, right, top, bottom. This is the rectangle that lines, bars, etc will be drawn in. It may be used, for example, to draw grid lines.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("draw")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chartArea")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("The Core.Scale base class also has some utility functions that you may find useful.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Returns true if the scale instance is horizontal")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("isHorizontal")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Returns the scale tick objects ({label, major})")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getTicks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[171],{502:function(t,a,s){"use strict";s.r(a);var n=s(3),e=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"new-axes"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#new-axes"}},[t._v("#")]),t._v(" New Axes")]),t._v(" "),a("p",[t._v("Axes in Chart.js can be individually extended. Axes should always derive from "),a("code",[t._v("Chart.Scale")]),t._v(" but this is not a mandatory requirement.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("MyScale")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("Scale")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/* extensions ... */")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\nMyScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myScale'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nMyScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" defaultConfigObject"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// MyScale is now derived from Chart.Scale")]),t._v("\n")])])]),a("p",[t._v("Once you have created your scale class, you need to register it with the global chart object so that it can be used.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("Chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyScale"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If the new scale is not extending Chart.Scale, the prototype can not be used to detect what")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// you are trying to register - so you need to be explicit:")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chart.registry.addScales(MyScale);")]),t._v("\n")])])]),a("p",[t._v("To use the new scale, simply pass in the string key to the config when creating a chart.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" lineChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'myScale'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this is the same id that was set on the scale")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"scale-properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scale-properties"}},[t._v("#")]),t._v(" Scale Properties")]),t._v(" "),a("p",[t._v("Scale instances are given the following properties during the fitting process.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("left")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// left edge of the scale bounding box")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("right")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// right edge of the bounding box")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("top")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the same as right - left")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// the same as bottom - top")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Margin on each side. Like css, this is outside the bounding box.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("margins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("left")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("right")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("top")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("bottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Amount of padding on the inside of the bounding box (like CSS)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingLeft")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingRight")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingTop")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("paddingBottom")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" number\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"scale-interface"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scale-interface"}},[t._v("#")]),t._v(" Scale Interface")]),t._v(" "),a("p",[t._v("To work with Chart.js, custom scale types must implement the following interface.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Determines the data limits. Should set this.min and this.max to be the data max/min")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("determineDataLimits")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Generate tick marks. this.chart is the chart instance. The data object can be accessed as this.chart.data")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// buildTicks() should create a ticks array on the axis instance, if you intend to use any of the implementations from the base class")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("buildTicks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the label to show for the given value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getLabelForValue")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param index: index into the ticks array")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getPixelForTick")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("index")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the pixel (x coordinate for horizontal axis, y coordinate for vertical axis) for a given value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param value : the value to get the pixel for")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param [index] : index into the data array of the value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getPixelForValue")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the value for a given pixel (x coordinate for horizontal axis, y coordinate for vertical axis)")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param pixel : pixel value")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getValueForPixel")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("pixel")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Optionally, the following methods may also be overwritten, but an implementation is already provided by the "),a("code",[t._v("Chart.Scale")]),t._v(" base class.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Adds labels to objects in the ticks array. The default implementation simply calls this.options.ticks.callback(numericalTick, index, ticks);")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("generateTickLabels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Determine how much the labels will rotate by. The default implementation will only rotate labels if the scale is horizontal.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("calculateLabelRotation")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Fits the scale into the canvas.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this.maxWidth and this.maxHeight will tell you the maximum dimensions the scale instance can be. Scales should endeavour to be as efficient as possible with canvas space.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this.margins is the amount of space you have on either side of your scale that you may expand in to. This is used already for calculating the best label rotation")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// You must set this.minSize to be the size of your scale. It must be an object containing 2 properties: width and height.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// You must set this.width to be the width and this.height to be the height of the scale")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("fit")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Draws the scale onto the canvas. this.(left|right|top|bottom) will have been populated to tell you the area on the canvas to draw in")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param chartArea : an object containing four properties: left, right, top, bottom. This is the rectangle that lines, bars, etc will be drawn in. It may be used, for example, to draw grid lines.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("draw")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chartArea")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("The Core.Scale base class also has some utility functions that you may find useful.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Returns true if the scale instance is horizontal")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("isHorizontal")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Returns the scale tick objects ({label, major})")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("getTicks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/172.b21548fa.js b/docs/master/assets/js/172.80a7a650.js similarity index 99% rename from docs/master/assets/js/172.b21548fa.js rename to docs/master/assets/js/172.80a7a650.js index 01080e878d..9c9e8c86e5 100644 --- a/docs/master/assets/js/172.b21548fa.js +++ b/docs/master/assets/js/172.80a7a650.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[172],{502:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"new-charts"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#new-charts"}},[t._v("#")]),t._v(" New Charts")]),t._v(" "),s("p",[t._v("Chart.js 2.0 introduced the concept of controllers for each dataset. Like scales, new controllers can be written as needed.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("MyType")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("DatasetController")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyType"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can create a new instance of our chart, using the Chart.js API")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this is the string the constructor was registered at, ie Chart.controllers.MyType")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MyType'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" options\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"dataset-controller-interface"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dataset-controller-interface"}},[t._v("#")]),t._v(" Dataset Controller Interface")]),t._v(" "),s("p",[t._v("Dataset controllers must implement the following interface.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Defaults for charts of this type")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("defaults")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to `false` or `null`, no dataset level element is created.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to a string, this is the type of element to create for the dataset.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For example, a line create needs to create a line element so this is the string 'line'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetElementType")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to `false` or `null`, no elements are created for each data value.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to a string, this is the type of element to create for each data value.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For example, a line create needs to create a point element so this is the string 'point'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataElementType")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ID of the controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Update the elements in response to new data")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param mode : update mode, core calls this method using any of `'active'`, `'hide'`, `'reset'`, `'resize'`, `'show'` or `undefined`")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("update")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("The following methods may optionally be overridden by derived dataset controllers.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Draw the representation of the dataset. The base implementation works in most cases, and an example of a derived version")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// can be found in the line controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Initializes the controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("initialize")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Ensures that the dataset represented by this controller is linked to a scale. Overridden to helpers.noop in the polar area and doughnut controllers as these")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// chart types using a single scale")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("linkScales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Parse the data into the controller meta data. The default implementation will work for cartesian parsing, but an example of an overridden")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// version can be found in the doughnut controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("parse")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("start"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" count")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"extending-existing-chart-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#extending-existing-chart-types"}},[t._v("#")]),t._v(" Extending Existing Chart Types")]),t._v(" "),s("p",[t._v("Extending or replacing an existing controller type is easy. Simply replace the constructor for one of the built-in types with your own.")]),t._v(" "),s("p",[t._v("The built-in controller types are:")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("BarController")])]),t._v(" "),s("li",[s("code",[t._v("BubbleController")])]),t._v(" "),s("li",[s("code",[t._v("DoughnutController")])]),t._v(" "),s("li",[s("code",[t._v("LineController")])]),t._v(" "),s("li",[s("code",[t._v("PieController")])]),t._v(" "),s("li",[s("code",[t._v("PolarAreaController")])]),t._v(" "),s("li",[s("code",[t._v("RadarController")])]),t._v(" "),s("li",[s("code",[t._v("ScatterController")])])]),t._v(" "),s("p",[t._v("These controllers are also available in the UMD package, directly under "),s("code",[t._v("Chart")]),t._v(". Eg: "),s("code",[t._v("Chart.BarController")]),t._v(".")]),t._v(" "),s("p",[t._v("For example, to derive a new chart type that extends from a bubble chart, you would do the following.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("BubbleController"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Custom")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BubbleController")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Call bubble controller method to draw all the points")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("arguments"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can do some custom drawing for this dataset. Here we'll draw a red box around the first point in each dataset")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" meta "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMeta")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" pt0 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getProps")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("strokeStyle "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("lineWidth "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("strokeRect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("x "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("restore")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'derivedBubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" BubbleController"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stores the controller so that the chart initialization routine can look it up")]),t._v("\nChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Custom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can create and use our new chart type")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'derivedBubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" options\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"typescript-typings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#typescript-typings"}},[t._v("#")]),t._v(" TypeScript Typings")]),t._v(" "),s("p",[t._v("If you want your new chart type to be statically typed, you must provide a "),s("code",[t._v(".d.ts")]),t._v(' TypeScript declaration file. Chart.js provides a way to augment built-in types with user-defined ones, by using the concept of "declaration merging".')]),t._v(" "),s("p",[t._v("When adding a new chart type, "),s("code",[t._v("ChartTypeRegistry")]),t._v(" must contain the declarations for the new type, either by extending an existing entry in "),s("code",[t._v("ChartTypeRegistry")]),t._v(" or by creating a new one.")]),t._v(" "),s("p",[t._v("For example, to provide typings for a new chart type that extends from a bubble chart, you would add a "),s("code",[t._v(".d.ts")]),t._v(" containing:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ChartTypeRegistry "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("declare")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("module")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("interface")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ChartTypeRegistry")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n derivedBubble"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" ChartTypeRegistry"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[172],{505:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"new-charts"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#new-charts"}},[t._v("#")]),t._v(" New Charts")]),t._v(" "),s("p",[t._v("Chart.js 2.0 introduced the concept of controllers for each dataset. Like scales, new controllers can be written as needed.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("MyType")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("DatasetController")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("MyType"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can create a new instance of our chart, using the Chart.js API")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// this is the string the constructor was registered at, ie Chart.controllers.MyType")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MyType'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" options\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"dataset-controller-interface"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#dataset-controller-interface"}},[t._v("#")]),t._v(" Dataset Controller Interface")]),t._v(" "),s("p",[t._v("Dataset controllers must implement the following interface.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Defaults for charts of this type")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("defaults")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to `false` or `null`, no dataset level element is created.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to a string, this is the type of element to create for the dataset.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For example, a line create needs to create a line element so this is the string 'line'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasetElementType")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to `false` or `null`, no elements are created for each data value.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// If set to a string, this is the type of element to create for each data value.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// For example, a line create needs to create a point element so this is the string 'point'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("dataElementType")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("|")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// ID of the controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" string"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Update the elements in response to new data")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// @param mode : update mode, core calls this method using any of `'active'`, `'hide'`, `'reset'`, `'resize'`, `'show'` or `undefined`")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("update")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("mode")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("The following methods may optionally be overridden by derived dataset controllers.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Draw the representation of the dataset. The base implementation works in most cases, and an example of a derived version")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// can be found in the line controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Initializes the controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("initialize")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Ensures that the dataset represented by this controller is linked to a scale. Overridden to helpers.noop in the polar area and doughnut controllers as these")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// chart types using a single scale")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("linkScales")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Parse the data into the controller meta data. The default implementation will work for cartesian parsing, but an example of an overridden")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// version can be found in the doughnut controller")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("parse")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("start"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" count")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h2",{attrs:{id:"extending-existing-chart-types"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#extending-existing-chart-types"}},[t._v("#")]),t._v(" Extending Existing Chart Types")]),t._v(" "),s("p",[t._v("Extending or replacing an existing controller type is easy. Simply replace the constructor for one of the built-in types with your own.")]),t._v(" "),s("p",[t._v("The built-in controller types are:")]),t._v(" "),s("ul",[s("li",[s("code",[t._v("BarController")])]),t._v(" "),s("li",[s("code",[t._v("BubbleController")])]),t._v(" "),s("li",[s("code",[t._v("DoughnutController")])]),t._v(" "),s("li",[s("code",[t._v("LineController")])]),t._v(" "),s("li",[s("code",[t._v("PieController")])]),t._v(" "),s("li",[s("code",[t._v("PolarAreaController")])]),t._v(" "),s("li",[s("code",[t._v("RadarController")])]),t._v(" "),s("li",[s("code",[t._v("ScatterController")])])]),t._v(" "),s("p",[t._v("These controllers are also available in the UMD package, directly under "),s("code",[t._v("Chart")]),t._v(". Eg: "),s("code",[t._v("Chart.BarController")]),t._v(".")]),t._v(" "),s("p",[t._v("For example, to derive a new chart type that extends from a bubble chart, you would do the following.")]),t._v(" "),s("div",{staticClass:"language-javascript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-javascript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("BubbleController"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Custom")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BubbleController")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Call bubble controller method to draw all the points")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("arguments"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can do some custom drawing for this dataset. Here we'll draw a red box around the first point in each dataset")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" meta "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMeta")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" pt0 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getProps")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("strokeStyle "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("lineWidth "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("strokeRect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("x "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("restore")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'derivedBubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" BubbleController"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stores the controller so that the chart initialization routine can look it up")]),t._v("\nChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Custom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can create and use our new chart type")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'derivedBubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" options\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"typescript-typings"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#typescript-typings"}},[t._v("#")]),t._v(" TypeScript Typings")]),t._v(" "),s("p",[t._v("If you want your new chart type to be statically typed, you must provide a "),s("code",[t._v(".d.ts")]),t._v(' TypeScript declaration file. Chart.js provides a way to augment built-in types with user-defined ones, by using the concept of "declaration merging".')]),t._v(" "),s("p",[t._v("When adding a new chart type, "),s("code",[t._v("ChartTypeRegistry")]),t._v(" must contain the declarations for the new type, either by extending an existing entry in "),s("code",[t._v("ChartTypeRegistry")]),t._v(" or by creating a new one.")]),t._v(" "),s("p",[t._v("For example, to provide typings for a new chart type that extends from a bubble chart, you would add a "),s("code",[t._v(".d.ts")]),t._v(" containing:")]),t._v(" "),s("div",{staticClass:"language-typescript extra-class"},[s("pre",{pre:!0,attrs:{class:"language-typescript"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" ChartTypeRegistry "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("declare")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("module")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("interface")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("ChartTypeRegistry")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n derivedBubble"),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" ChartTypeRegistry"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/174.5ccd6046.js b/docs/master/assets/js/174.5a3bc3f1.js similarity index 98% rename from docs/master/assets/js/174.5ccd6046.js rename to docs/master/assets/js/174.5a3bc3f1.js index 862f4a4067..6f542444ed 100644 --- a/docs/master/assets/js/174.5ccd6046.js +++ b/docs/master/assets/js/174.5a3bc3f1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[174],{503:function(e,r,t){"use strict";t.r(r);var s=t(3),a=Object(s.a)({},(function(){var e=this,r=e._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"developers"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#developers"}},[e._v("#")]),e._v(" Developers")]),e._v(" "),r("p",[e._v("Developer features allow extending and enhancing Chart.js in many different ways.")]),e._v(" "),r("h2",{attrs:{id:"latest-resources"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#latest-resources"}},[e._v("#")]),e._v(" Latest resources")]),e._v(" "),r("p",[e._v("The latest documentation and samples, including unreleased features, are available at:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://www.chartjs.org/docs/master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/docs/master/"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://www.chartjs.org/samples/master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/samples/master/"),r("OutboundLink")],1)])]),e._v(" "),r("h2",{attrs:{id:"development-releases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#development-releases"}},[e._v("#")]),e._v(" Development releases")]),e._v(" "),r("p",[e._v("Latest builds are available for testing at:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://www.chartjs.org/dist/master/chart.js",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/dist/master/chart.js"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://www.chartjs.org/dist/master/chart.min.js",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/dist/master/chart.min.js"),r("OutboundLink")],1)])]),e._v(" "),r("div",{staticClass:"custom-block warning"},[r("p",{staticClass:"custom-block-title"},[e._v("Warning")]),e._v(" "),r("p",[e._v("Development builds "),r("strong",[e._v("must not")]),e._v(" be used for production purposes or as replacement for a CDN. See "),r("RouterLink",{attrs:{to:"/getting-started/installation.html#cdn"}},[e._v("available CDNs")]),e._v(".")],1)]),e._v(" "),r("h2",{attrs:{id:"browser-support"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#browser-support"}},[e._v("#")]),e._v(" Browser support")]),e._v(" "),r("p",[e._v("All modern and up-to-date browsers are supported, including, but not limited to:")]),e._v(" "),r("ul",[r("li",[e._v("Chrome")]),e._v(" "),r("li",[e._v("Edge")]),e._v(" "),r("li",[e._v("Firefox")]),e._v(" "),r("li",[e._v("Safari")])]),e._v(" "),r("p",[e._v("As of version 3, we have dropped Internet Explorer 11 support.")]),e._v(" "),r("p",[e._v("Browser support for the canvas element is available in all modern & major mobile browsers. "),r("a",{attrs:{href:"https://caniuse.com/#feat=canvas",target:"_blank",rel:"noopener noreferrer"}},[e._v("CanIUse"),r("OutboundLink")],1)]),e._v(" "),r("p",[e._v("Run "),r("code",[e._v("npx browserslist")]),e._v(" at the root of the "),r("a",{attrs:{href:"https://github.com/chartjs/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[e._v("codebase"),r("OutboundLink")],1),e._v(" to get a list of supported browsers.")]),e._v(" "),r("p",[e._v("Thanks to "),r("a",{attrs:{href:"https://browserstack.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("BrowserStack"),r("OutboundLink")],1),e._v(" for allowing our team to test on thousands of browsers.")]),e._v(" "),r("h2",{attrs:{id:"previous-versions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#previous-versions"}},[e._v("#")]),e._v(" Previous versions")]),e._v(" "),r("p",[e._v("To migrate from version 2 to version 3, please see "),r("a",{attrs:{href:"../getting-started/v3-migration"}},[e._v("the v3 migration guide")]),e._v(".")]),e._v(" "),r("p",[e._v("Version 3 has a largely different API than earlier versions.")]),e._v(" "),r("p",[e._v("Most earlier version options have current equivalents or are the same.")]),e._v(" "),r("p",[e._v("Please note - documentation for previous versions is available online or in the GitHub repo.")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://www.chartjs.org/docs/2.9.4/",target:"_blank",rel:"noopener noreferrer"}},[e._v("2.9.4 Documentation"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/v1.1.1/docs",target:"_blank",rel:"noopener noreferrer"}},[e._v("1.x Documentation"),r("OutboundLink")],1)])])])}),[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[174],{506:function(e,r,t){"use strict";t.r(r);var s=t(3),a=Object(s.a)({},(function(){var e=this,r=e._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"developers"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#developers"}},[e._v("#")]),e._v(" Developers")]),e._v(" "),r("p",[e._v("Developer features allow extending and enhancing Chart.js in many different ways.")]),e._v(" "),r("h2",{attrs:{id:"latest-resources"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#latest-resources"}},[e._v("#")]),e._v(" Latest resources")]),e._v(" "),r("p",[e._v("The latest documentation and samples, including unreleased features, are available at:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://www.chartjs.org/docs/master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/docs/master/"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://www.chartjs.org/samples/master/",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/samples/master/"),r("OutboundLink")],1)])]),e._v(" "),r("h2",{attrs:{id:"development-releases"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#development-releases"}},[e._v("#")]),e._v(" Development releases")]),e._v(" "),r("p",[e._v("Latest builds are available for testing at:")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://www.chartjs.org/dist/master/chart.js",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/dist/master/chart.js"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://www.chartjs.org/dist/master/chart.min.js",target:"_blank",rel:"noopener noreferrer"}},[e._v("https://www.chartjs.org/dist/master/chart.min.js"),r("OutboundLink")],1)])]),e._v(" "),r("div",{staticClass:"custom-block warning"},[r("p",{staticClass:"custom-block-title"},[e._v("Warning")]),e._v(" "),r("p",[e._v("Development builds "),r("strong",[e._v("must not")]),e._v(" be used for production purposes or as replacement for a CDN. See "),r("RouterLink",{attrs:{to:"/getting-started/installation.html#cdn"}},[e._v("available CDNs")]),e._v(".")],1)]),e._v(" "),r("h2",{attrs:{id:"browser-support"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#browser-support"}},[e._v("#")]),e._v(" Browser support")]),e._v(" "),r("p",[e._v("All modern and up-to-date browsers are supported, including, but not limited to:")]),e._v(" "),r("ul",[r("li",[e._v("Chrome")]),e._v(" "),r("li",[e._v("Edge")]),e._v(" "),r("li",[e._v("Firefox")]),e._v(" "),r("li",[e._v("Safari")])]),e._v(" "),r("p",[e._v("As of version 3, we have dropped Internet Explorer 11 support.")]),e._v(" "),r("p",[e._v("Browser support for the canvas element is available in all modern & major mobile browsers. "),r("a",{attrs:{href:"https://caniuse.com/#feat=canvas",target:"_blank",rel:"noopener noreferrer"}},[e._v("CanIUse"),r("OutboundLink")],1)]),e._v(" "),r("p",[e._v("Run "),r("code",[e._v("npx browserslist")]),e._v(" at the root of the "),r("a",{attrs:{href:"https://github.com/chartjs/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[e._v("codebase"),r("OutboundLink")],1),e._v(" to get a list of supported browsers.")]),e._v(" "),r("p",[e._v("Thanks to "),r("a",{attrs:{href:"https://browserstack.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("BrowserStack"),r("OutboundLink")],1),e._v(" for allowing our team to test on thousands of browsers.")]),e._v(" "),r("h2",{attrs:{id:"previous-versions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#previous-versions"}},[e._v("#")]),e._v(" Previous versions")]),e._v(" "),r("p",[e._v("To migrate from version 2 to version 3, please see "),r("a",{attrs:{href:"../getting-started/v3-migration"}},[e._v("the v3 migration guide")]),e._v(".")]),e._v(" "),r("p",[e._v("Version 3 has a largely different API than earlier versions.")]),e._v(" "),r("p",[e._v("Most earlier version options have current equivalents or are the same.")]),e._v(" "),r("p",[e._v("Please note - documentation for previous versions is available online or in the GitHub repo.")]),e._v(" "),r("ul",[r("li",[r("a",{attrs:{href:"https://www.chartjs.org/docs/2.9.4/",target:"_blank",rel:"noopener noreferrer"}},[e._v("2.9.4 Documentation"),r("OutboundLink")],1)]),e._v(" "),r("li",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/v1.1.1/docs",target:"_blank",rel:"noopener noreferrer"}},[e._v("1.x Documentation"),r("OutboundLink")],1)])])])}),[],!1,null,null,null);r.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/176.11de8735.js b/docs/master/assets/js/176.fac0280b.js similarity index 99% rename from docs/master/assets/js/176.11de8735.js rename to docs/master/assets/js/176.fac0280b.js index b0927b1da7..b8b6112662 100644 --- a/docs/master/assets/js/176.11de8735.js +++ b/docs/master/assets/js/176.fac0280b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[176],{507:function(t,a,s){"use strict";s.r(a);var n=s(3),p=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"updating-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#updating-charts"}},[t._v("#")]),t._v(" Updating Charts")]),t._v(" "),a("p",[t._v("It's pretty common to want to update charts after they've been created. When the chart data or options are changed, Chart.js will animate to the new data values and options.")]),t._v(" "),a("h2",{attrs:{id:"adding-or-removing-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#adding-or-removing-data"}},[t._v("#")]),t._v(" Adding or Removing Data")]),t._v(" "),a("p",[t._v("Adding and removing data is supported by changing the data array. To add data, just add data into the data array as seen in this example, to remove it you can pop it again.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addData")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" label"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newData")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labels"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("label"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("dataset")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n dataset"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("newData"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeData")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labels"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pop")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("dataset")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n dataset"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pop")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"updating-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#updating-options"}},[t._v("#")]),t._v(" Updating Options")]),t._v(" "),a("p",[t._v("To update the options, mutating the "),a("code",[t._v("options")]),t._v(" property in place or passing in a new options object are supported.")]),t._v(" "),a("ul",[a("li",[t._v("If the options are mutated in place, other option properties would be preserved, including those calculated by Chart.js.")]),t._v(" "),a("li",[t._v("If created as a new object, it would be like creating a new chart with the options - old options would be discarded.")])]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateConfigByMutating")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("plugins"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("title"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("text "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new title'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateConfigAsNewObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("responsive")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Chart.js'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Scales can be updated separately without changing other options.\nTo update the scales, pass in an object containing all the customization including those unchanged ones.")]),t._v(" "),a("p",[t._v("Variables referencing any one from "),a("code",[t._v("chart.scales")]),t._v(" would be lost after updating scales with a new "),a("code",[t._v("id")]),t._v(" or the changed "),a("code",[t._v("type")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateScales")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" xScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" yScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("newId")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'logarithmic'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// need to update the reference")]),t._v("\n xScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("newId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n yScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("You can update a specific scale by its id as well.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateScale")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'logarithmic'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Code sample for updating options can be found in "),a("a",{attrs:{href:"https://www.chartjs.org/docs/latest/samples/area/line-datasets.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("line-datasets.html"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"preventing-animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#preventing-animations"}},[t._v("#")]),t._v(" Preventing Animations")]),t._v(" "),a("p",[t._v("Sometimes when a chart updates, you may not want an animation. To achieve this you can call "),a("code",[t._v("update")]),t._v(" with "),a("code",[t._v("'none'")]),t._v(" as mode.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'none'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=p.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[176],{509:function(t,a,s){"use strict";s.r(a);var n=s(3),p=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"updating-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#updating-charts"}},[t._v("#")]),t._v(" Updating Charts")]),t._v(" "),a("p",[t._v("It's pretty common to want to update charts after they've been created. When the chart data or options are changed, Chart.js will animate to the new data values and options.")]),t._v(" "),a("h2",{attrs:{id:"adding-or-removing-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#adding-or-removing-data"}},[t._v("#")]),t._v(" Adding or Removing Data")]),t._v(" "),a("p",[t._v("Adding and removing data is supported by changing the data array. To add data, just add data into the data array as seen in this example, to remove it you can pop it again.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("addData")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" label"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" newData")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labels"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("label"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("dataset")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n dataset"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("newData"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("removeData")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("labels"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pop")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("datasets"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("forEach")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("dataset")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n dataset"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("pop")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"updating-options"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#updating-options"}},[t._v("#")]),t._v(" Updating Options")]),t._v(" "),a("p",[t._v("To update the options, mutating the "),a("code",[t._v("options")]),t._v(" property in place or passing in a new options object are supported.")]),t._v(" "),a("ul",[a("li",[t._v("If the options are mutated in place, other option properties would be preserved, including those calculated by Chart.js.")]),t._v(" "),a("li",[t._v("If created as a new object, it would be like creating a new chart with the options - old options would be discarded.")])]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateConfigByMutating")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("plugins"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("title"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("text "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'new title'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateConfigAsNewObject")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("responsive")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("title")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("text")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Chart.js'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Scales can be updated separately without changing other options.\nTo update the scales, pass in an object containing all the customization including those unchanged ones.")]),t._v(" "),a("p",[t._v("Variables referencing any one from "),a("code",[t._v("chart.scales")]),t._v(" would be lost after updating scales with a new "),a("code",[t._v("id")]),t._v(" or the changed "),a("code",[t._v("type")]),t._v(".")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateScales")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" xScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" yScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("newId")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("display")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'logarithmic'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// need to update the reference")]),t._v("\n xScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("newId"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n yScale "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("You can update a specific scale by its id as well.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("updateScale")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'logarithmic'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Code sample for updating options can be found in "),a("a",{attrs:{href:"https://www.chartjs.org/docs/latest/samples/area/line-datasets.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("line-datasets.html"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"preventing-animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#preventing-animations"}},[t._v("#")]),t._v(" Preventing Animations")]),t._v(" "),a("p",[t._v("Sometimes when a chart updates, you may not want an animation. To achieve this you can call "),a("code",[t._v("update")]),t._v(" with "),a("code",[t._v("'none'")]),t._v(" as mode.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[t._v("myChart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'none'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=p.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/177.f8ac138c.js b/docs/master/assets/js/177.50ce93c5.js similarity index 99% rename from docs/master/assets/js/177.f8ac138c.js rename to docs/master/assets/js/177.50ce93c5.js index bc7b3f94fa..79739968a3 100644 --- a/docs/master/assets/js/177.f8ac138c.js +++ b/docs/master/assets/js/177.50ce93c5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[177],{509:function(t,a,s){"use strict";s.r(a);var n=s(3),e=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"accessibility"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accessibility"}},[t._v("#")]),t._v(" Accessibility")]),t._v(" "),a("p",[t._v("Chart.js charts are rendered on user provided "),a("code",[t._v("canvas")]),t._v(" elements. Thus, it is up to the user to create the "),a("code",[t._v("canvas")]),t._v(" element in a way that is accessible. The "),a("code",[t._v("canvas")]),t._v(" element has support in all browsers and will render on screen but the "),a("code",[t._v("canvas")]),t._v(" content will not be accessible to screen readers.")]),t._v(" "),a("p",[t._v("With "),a("code",[t._v("canvas")]),t._v(", the accessibility has to be added with ARIA attributes on the "),a("code",[t._v("canvas")]),t._v(" element or added using internal fallback content placed within the opening and closing canvas tags.")]),t._v(" "),a("p",[t._v("This "),a("a",{attrs:{href:"http://pauljadam.com/demos/canvas.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("website"),a("OutboundLink")],1),t._v(" has a more detailed explanation of "),a("code",[t._v("canvas")]),t._v(" accessibility as well as in depth examples.")]),t._v(" "),a("h2",{attrs:{id:"examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),a("p",[t._v("These are some examples of "),a("strong",[t._v("accessible")]),t._v(" "),a("code",[t._v("canvas")]),t._v(" elements.")]),t._v(" "),a("p",[t._v("By setting the "),a("code",[t._v("role")]),t._v(" and "),a("code",[t._v("aria-label")]),t._v(", this "),a("code",[t._v("canvas")]),t._v(" now has an accessible name.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("goodCanvas1"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("aria-label")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("Hello ARIA World"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("role")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("img"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("This "),a("code",[t._v("canvas")]),t._v(" element has a text alternative via fallback content.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("okCanvas2"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("p")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("Hello Fallback World"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("These are some bad examples of "),a("strong",[t._v("inaccessible")]),t._v(" "),a("code",[t._v("canvas")]),t._v(" elements.")]),t._v(" "),a("p",[t._v("This "),a("code",[t._v("canvas")]),t._v(" element does not have an accessible name or role.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("badCanvas1"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("This "),a("code",[t._v("canvas")]),t._v(" element has inaccessible fallback content.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("badCanvas2"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("Your browser does not support the canvas element."),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[177],{511:function(t,a,s){"use strict";s.r(a);var n=s(3),e=Object(n.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"accessibility"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#accessibility"}},[t._v("#")]),t._v(" Accessibility")]),t._v(" "),a("p",[t._v("Chart.js charts are rendered on user provided "),a("code",[t._v("canvas")]),t._v(" elements. Thus, it is up to the user to create the "),a("code",[t._v("canvas")]),t._v(" element in a way that is accessible. The "),a("code",[t._v("canvas")]),t._v(" element has support in all browsers and will render on screen but the "),a("code",[t._v("canvas")]),t._v(" content will not be accessible to screen readers.")]),t._v(" "),a("p",[t._v("With "),a("code",[t._v("canvas")]),t._v(", the accessibility has to be added with ARIA attributes on the "),a("code",[t._v("canvas")]),t._v(" element or added using internal fallback content placed within the opening and closing canvas tags.")]),t._v(" "),a("p",[t._v("This "),a("a",{attrs:{href:"http://pauljadam.com/demos/canvas.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("website"),a("OutboundLink")],1),t._v(" has a more detailed explanation of "),a("code",[t._v("canvas")]),t._v(" accessibility as well as in depth examples.")]),t._v(" "),a("h2",{attrs:{id:"examples"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),a("p",[t._v("These are some examples of "),a("strong",[t._v("accessible")]),t._v(" "),a("code",[t._v("canvas")]),t._v(" elements.")]),t._v(" "),a("p",[t._v("By setting the "),a("code",[t._v("role")]),t._v(" and "),a("code",[t._v("aria-label")]),t._v(", this "),a("code",[t._v("canvas")]),t._v(" now has an accessible name.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("goodCanvas1"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("aria-label")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("Hello ARIA World"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("role")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("img"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("This "),a("code",[t._v("canvas")]),t._v(" element has a text alternative via fallback content.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("okCanvas2"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("p")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("Hello Fallback World"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("These are some bad examples of "),a("strong",[t._v("inaccessible")]),t._v(" "),a("code",[t._v("canvas")]),t._v(" elements.")]),t._v(" "),a("p",[t._v("This "),a("code",[t._v("canvas")]),t._v(" element does not have an accessible name or role.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("badCanvas1"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("p",[t._v("This "),a("code",[t._v("canvas")]),t._v(" element has inaccessible fallback content.")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("badCanvas2"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("width")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("400"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("height")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("100"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("Your browser does not support the canvas element."),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/178.48e5e8a6.js b/docs/master/assets/js/178.23b9baa1.js similarity index 99% rename from docs/master/assets/js/178.48e5e8a6.js rename to docs/master/assets/js/178.23b9baa1.js index 7a96908017..65bb59c6f5 100644 --- a/docs/master/assets/js/178.48e5e8a6.js +++ b/docs/master/assets/js/178.23b9baa1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[178],{510:function(t,a,s){"use strict";s.r(a);var r=s(3),e=Object(r.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"data-structures"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-structures"}},[t._v("#")]),t._v(" Data structures")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("data")]),t._v(" property of a dataset can be passed in various formats. By default, that "),a("code",[t._v("data")]),t._v(" is parsed using the associated chart type and scales.")]),t._v(" "),a("p",[t._v("If the "),a("code",[t._v("labels")]),t._v(" property of the main "),a("code",[t._v("data")]),t._v(" property is used, it has to contain the same amount of elements as the dataset with the most values. These labels are used to label the index axis (default x axes). The values for the labels have to be provided in an array.\nThe provided labels can be of the type string or number to be rendered correctly. In case you want multiline labels you can provide an array with each line as one entry in the array.")]),t._v(" "),a("h2",{attrs:{id:"primitive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#primitive"}},[t._v("#")]),t._v(" Primitive[]")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'b'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("When the "),a("code",[t._v("data")]),t._v(" is an array of numbers, values from "),a("code",[t._v("labels")]),t._v(" array at the same index are used for the index axis ("),a("code",[t._v("x")]),t._v(" for vertical, "),a("code",[t._v("y")]),t._v(" for horizontal charts).")]),t._v(" "),a("h2",{attrs:{id:"object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#object"}},[t._v("#")]),t._v(" Object[]")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2016-12-25'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2016-12-26'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Revenue'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("This is also the internal format used for parsed data. In this mode, parsing can be disabled by specifying "),a("code",[t._v("parsing: false")]),t._v(" at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),a("p",[t._v("The values provided must be parsable by the associated scales or in the internal format of the associated scales. A common mistake would be to provide integers for the "),a("code",[t._v("category")]),t._v(" scale, which uses integers as an internal format, where each integer represents an index in the labels array. "),a("code",[t._v("null")]),t._v(" can be used for skipped values.")]),t._v(" "),a("h2",{attrs:{id:"object-using-custom-properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#object-using-custom-properties"}},[t._v("#")]),t._v(" Object[] using custom properties")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purchases'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("xAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'id'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nested.value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("When using the pie/doughnut, radar or polarArea chart type, the "),a("code",[t._v("parsing")]),t._v(" object should have a "),a("code",[t._v("key")]),t._v(" item that points to the value to look at. In this example, the doughnut chart will show two items with values 1500 and 500.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'doughnut'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purchases'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("key")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nested.value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("If the key contains a dot, it needs to be escaped with a double slash:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.key'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'one'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.value'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.key'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'two'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.value'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("xAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'data\\\\.key'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'data\\\\.value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),a("p",[t._v("When using object notation in a radar chart, you still need a labels array with labels for the chart to show correctly.")])]),t._v(" "),a("h2",{attrs:{id:"object-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#object-2"}},[t._v("#")]),t._v(" Object")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("January")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("February")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("In this mode, property name is used for "),a("code",[t._v("index")]),t._v(" scale and value for "),a("code",[t._v("value")]),t._v(" scale. For vertical charts, index scale is "),a("code",[t._v("x")]),t._v(" and value scale is "),a("code",[t._v("y")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"dataset-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#dataset-configuration"}},[t._v("#")]),t._v(" Dataset Configuration")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("label")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("The label for the dataset which appears in the legend and tooltips.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("clip")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("object")])]),t._v(" "),a("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("order")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stack")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). Defaults to dataset "),a("code",[t._v("type")]),t._v(".")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("parsing")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("object")])]),t._v(" "),a("td",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("hidden")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Configure the visibility of the dataset. Using "),a("code",[t._v("hidden: true")]),t._v(" will hide the dataset from being rendered in the Chart.")])])])]),t._v(" "),a("h3",{attrs:{id:"parsing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" data "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Jan'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("net")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("cogs")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("gm")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Feb'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("net")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("120")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("cogs")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("55")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("gm")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("75")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Jan'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Feb'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Net sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'net'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Cost of goods sold'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'cogs'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Gross margin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'gm'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"typescript"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#typescript"}},[t._v("#")]),t._v(" Typescript")]),t._v(" "),a("p",[t._v("When using typescript, if you want to use a data structure that is not the default data structure, you will need to pass it to the type interface when instantiating the data variable.")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("ChartData"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" datasets"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" ChartData "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("key"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("string")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("number")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n datasets"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("key"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("key"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Revenue'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n parsing"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n xAxisKey"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n yAxisKey"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[178],{513:function(t,a,s){"use strict";s.r(a);var r=s(3),e=Object(r.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"data-structures"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-structures"}},[t._v("#")]),t._v(" Data structures")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("data")]),t._v(" property of a dataset can be passed in various formats. By default, that "),a("code",[t._v("data")]),t._v(" is parsed using the associated chart type and scales.")]),t._v(" "),a("p",[t._v("If the "),a("code",[t._v("labels")]),t._v(" property of the main "),a("code",[t._v("data")]),t._v(" property is used, it has to contain the same amount of elements as the dataset with the most values. These labels are used to label the index axis (default x axes). The values for the labels have to be provided in an array.\nThe provided labels can be of the type string or number to be rendered correctly. In case you want multiline labels you can provide an array with each line as one entry in the array.")]),t._v(" "),a("h2",{attrs:{id:"primitive"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#primitive"}},[t._v("#")]),t._v(" Primitive[]")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'a'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'b'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("When the "),a("code",[t._v("data")]),t._v(" is an array of numbers, values from "),a("code",[t._v("labels")]),t._v(" array at the same index are used for the index axis ("),a("code",[t._v("x")]),t._v(" for vertical, "),a("code",[t._v("y")]),t._v(" for horizontal charts).")]),t._v(" "),a("h2",{attrs:{id:"object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#object"}},[t._v("#")]),t._v(" Object[]")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2016-12-25'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2016-12-26'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Revenue'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("This is also the internal format used for parsed data. In this mode, parsing can be disabled by specifying "),a("code",[t._v("parsing: false")]),t._v(" at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),a("p",[t._v("The values provided must be parsable by the associated scales or in the internal format of the associated scales. A common mistake would be to provide integers for the "),a("code",[t._v("category")]),t._v(" scale, which uses integers as an internal format, where each integer represents an index in the labels array. "),a("code",[t._v("null")]),t._v(" can be used for skipped values.")]),t._v(" "),a("h2",{attrs:{id:"object-using-custom-properties"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#object-using-custom-properties"}},[t._v("#")]),t._v(" Object[] using custom properties")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purchases'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("xAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'id'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nested.value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("When using the pie/doughnut, radar or polarArea chart type, the "),a("code",[t._v("parsing")]),t._v(" object should have a "),a("code",[t._v("key")]),t._v(" item that points to the value to look at. In this example, the doughnut chart will show two items with values 1500 and 500.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'doughnut'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Purchases'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("nested")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("500")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("key")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'nested.value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("If the key contains a dot, it needs to be escaped with a double slash:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.key'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'one'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.value'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.key'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'two'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'data.value'")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("xAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'data\\\\.key'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'data\\\\.value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),a("p",[t._v("When using object notation in a radar chart, you still need a labels array with labels for the chart to show correctly.")])]),t._v(" "),a("h2",{attrs:{id:"object-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#object-2"}},[t._v("#")]),t._v(" Object")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("January")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("February")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("In this mode, property name is used for "),a("code",[t._v("index")]),t._v(" scale and value for "),a("code",[t._v("value")]),t._v(" scale. For vertical charts, index scale is "),a("code",[t._v("x")]),t._v(" and value scale is "),a("code",[t._v("y")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"dataset-configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#dataset-configuration"}},[t._v("#")]),t._v(" Dataset Configuration")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Name")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("label")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("The label for the dataset which appears in the legend and tooltips.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("clip")])]),t._v(" "),a("td",[a("code",[t._v("number")]),t._v("|"),a("code",[t._v("object")])]),t._v(" "),a("td",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("order")])]),t._v(" "),a("td",[a("code",[t._v("number")])]),t._v(" "),a("td",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("stack")])]),t._v(" "),a("td",[a("code",[t._v("string")])]),t._v(" "),a("td",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack). Defaults to dataset "),a("code",[t._v("type")]),t._v(".")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("parsing")])]),t._v(" "),a("td",[a("code",[t._v("boolean")]),t._v("|"),a("code",[t._v("object")])]),t._v(" "),a("td",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("hidden")])]),t._v(" "),a("td",[a("code",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Configure the visibility of the dataset. Using "),a("code",[t._v("hidden: true")]),t._v(" will hide the dataset from being rendered in the Chart.")])])])]),t._v(" "),a("h3",{attrs:{id:"parsing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" data "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Jan'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("net")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("cogs")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("gm")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Feb'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("net")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("120")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("cogs")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("55")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("gm")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("75")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" cfg "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Jan'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Feb'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Net sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'net'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Cost of goods sold'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'cogs'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Gross margin'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("parsing")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yAxisKey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'gm'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"typescript"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#typescript"}},[t._v("#")]),t._v(" Typescript")]),t._v(" "),a("p",[t._v("When using typescript, if you want to use a data structure that is not the default data structure, you will need to pass it to the type interface when instantiating the data variable.")]),t._v(" "),a("div",{staticClass:"language-ts extra-class"},[a("pre",{pre:!0,attrs:{class:"language-ts"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("ChartData"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" datasets"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" ChartData "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'bar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("key"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("string")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token builtin"}},[t._v("number")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n datasets"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("key"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Sales'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("key"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Revenue'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n parsing"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n xAxisKey"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'key'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n yAxisKey"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'value'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/179.36eb3e13.js b/docs/master/assets/js/179.76713dec.js similarity index 99% rename from docs/master/assets/js/179.36eb3e13.js rename to docs/master/assets/js/179.76713dec.js index ad5044fdac..6ed31ac071 100644 --- a/docs/master/assets/js/179.36eb3e13.js +++ b/docs/master/assets/js/179.76713dec.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[179],{511:function(t,e,s){"use strict";s.r(e);var a=s(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"fonts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fonts"}},[t._v("#")]),t._v(" Fonts")]),t._v(" "),e("p",[t._v("There are special global settings that can change all the fonts on the chart. These options are in "),e("code",[t._v("Chart.defaults.font")]),t._v(". The global font settings only apply when more specific options are not included in the config.")]),t._v(" "),e("p",[t._v("For example, in this chart, the text will have a font size of 16px except for the labels in the legend.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("font"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("legend")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// This more specific font property overrides the global property")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("font")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("size")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("14")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("family")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("\"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif\"")])]),t._v(" "),e("td",[t._v("Default font family for all text, follows CSS font-family options.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("size")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("12")])]),t._v(" "),e("td",[t._v("Default font size (in px) for text. Does not apply to radialLinear scale point labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("style")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'normal'")])]),t._v(" "),e("td",[t._v("Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("normal")]),t._v(" | "),e("code",[t._v("bold")]),t._v(" | "),e("code",[t._v("lighter")]),t._v(" | "),e("code",[t._v("bolder")]),t._v(" | "),e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("Default font weight (boldness). (see "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(").")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineHeight")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("1.2")])]),t._v(" "),e("td",[t._v("Height of an individual line of text (see "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/CSS/line-height",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(").")])])])]),t._v(" "),e("h2",{attrs:{id:"missing-fonts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#missing-fonts"}},[t._v("#")]),t._v(" Missing Fonts")]),t._v(" "),e("p",[t._v("If a font is specified for a chart that does exist on the system, the browser will not apply the font when it is set. If you notice odd fonts appearing in your charts, check that the font you are applying exists on your system. See "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/issues/3318",target:"_blank",rel:"noopener noreferrer"}},[t._v("issue 3318"),e("OutboundLink")],1),t._v(" for more details.")]),t._v(" "),e("h2",{attrs:{id:"loading-fonts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#loading-fonts"}},[t._v("#")]),t._v(" Loading Fonts")]),t._v(" "),e("p",[t._v("If a font is not cached and needs to be loaded, charts that use the font will need to be updated once the font is loaded. This can be accomplished using the "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CSS_Font_Loading_API",target:"_blank",rel:"noopener noreferrer"}},[t._v("Font Loading APIs"),e("OutboundLink")],1),t._v(". See "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/issues/8020",target:"_blank",rel:"noopener noreferrer"}},[t._v("issue 8020"),e("OutboundLink")],1),t._v(" for more details.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[179],{512:function(t,e,s){"use strict";s.r(e);var a=s(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"fonts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fonts"}},[t._v("#")]),t._v(" Fonts")]),t._v(" "),e("p",[t._v("There are special global settings that can change all the fonts on the chart. These options are in "),e("code",[t._v("Chart.defaults.font")]),t._v(". The global font settings only apply when more specific options are not included in the config.")]),t._v(" "),e("p",[t._v("For example, in this chart, the text will have a font size of 16px except for the labels in the legend.")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[t._v("Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("font"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("size "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("16")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("plugins")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("legend")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("labels")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// This more specific font property overrides the global property")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("font")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("size")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("14")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),e("table",[e("thead",[e("tr",[e("th",[t._v("Name")]),t._v(" "),e("th",[t._v("Type")]),t._v(" "),e("th",[t._v("Default")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[e("code",[t._v("family")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("\"'Helvetica Neue', 'Helvetica', 'Arial', sans-serif\"")])]),t._v(" "),e("td",[t._v("Default font family for all text, follows CSS font-family options.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("size")])]),t._v(" "),e("td",[e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("12")])]),t._v(" "),e("td",[t._v("Default font size (in px) for text. Does not apply to radialLinear scale point labels.")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("style")])]),t._v(" "),e("td",[e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("'normal'")])]),t._v(" "),e("td",[t._v("Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("weight")])]),t._v(" "),e("td",[e("code",[t._v("normal")]),t._v(" | "),e("code",[t._v("bold")]),t._v(" | "),e("code",[t._v("lighter")]),t._v(" | "),e("code",[t._v("bolder")]),t._v(" | "),e("code",[t._v("number")])]),t._v(" "),e("td",[e("code",[t._v("undefined")])]),t._v(" "),e("td",[t._v("Default font weight (boldness). (see "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(").")])]),t._v(" "),e("tr",[e("td",[e("code",[t._v("lineHeight")])]),t._v(" "),e("td",[e("code",[t._v("number")]),t._v("|"),e("code",[t._v("string")])]),t._v(" "),e("td",[e("code",[t._v("1.2")])]),t._v(" "),e("td",[t._v("Height of an individual line of text (see "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/CSS/line-height",target:"_blank",rel:"noopener noreferrer"}},[t._v("MDN"),e("OutboundLink")],1),t._v(").")])])])]),t._v(" "),e("h2",{attrs:{id:"missing-fonts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#missing-fonts"}},[t._v("#")]),t._v(" Missing Fonts")]),t._v(" "),e("p",[t._v("If a font is specified for a chart that does exist on the system, the browser will not apply the font when it is set. If you notice odd fonts appearing in your charts, check that the font you are applying exists on your system. See "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/issues/3318",target:"_blank",rel:"noopener noreferrer"}},[t._v("issue 3318"),e("OutboundLink")],1),t._v(" for more details.")]),t._v(" "),e("h2",{attrs:{id:"loading-fonts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#loading-fonts"}},[t._v("#")]),t._v(" Loading Fonts")]),t._v(" "),e("p",[t._v("If a font is not cached and needs to be loaded, charts that use the font will need to be updated once the font is loaded. This can be accomplished using the "),e("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/CSS_Font_Loading_API",target:"_blank",rel:"noopener noreferrer"}},[t._v("Font Loading APIs"),e("OutboundLink")],1),t._v(". See "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/issues/8020",target:"_blank",rel:"noopener noreferrer"}},[t._v("issue 8020"),e("OutboundLink")],1),t._v(" for more details.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/18.c43fd95b.js b/docs/master/assets/js/18.2fb8c1a3.js similarity index 97% rename from docs/master/assets/js/18.c43fd95b.js rename to docs/master/assets/js/18.2fb8c1a3.js index 99b345c974..7aa11a4cc3 100644 --- a/docs/master/assets/js/18.c43fd95b.js +++ b/docs/master/assets/js/18.2fb8c1a3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{350:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-basicplatform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-basicplatform"}},[t._v("#")]),t._v(" Class: BasicPlatform")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[e("code",[t._v("BasePlatform")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("BasicPlatform")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new BasicPlatform")]),t._v("()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#constructor"}},[t._v("constructor")])],1),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"acquirecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#acquirecontext"}},[t._v("#")]),t._v(" acquireContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("acquireContext")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("p",[t._v("Called at chart construction time, returns a context2d instance implementing\nthe [W3C Canvas 2D Context API standard]"),e("a",{attrs:{href:"https://www.w3.org/TR/2dcontext/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.w3.org/TR/2dcontext/"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas from which to acquire context (platform specific)")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2DSettings")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart options")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#acquirecontext"}},[t._v("acquireContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addeventlistener"}},[t._v("#")]),t._v(" addEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Registers the specified listener on the given chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to listen for event")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to listen for")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Receives a notification (an object that implements the "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(" interface) when an event of the specified type occurs.")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#addeventlistener"}},[t._v("addEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2165"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevicepixelratio"}},[t._v("#")]),t._v(" getDevicePixelRatio")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDevicePixelRatio")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("the current devicePixelRatio of the device this platform is connected to.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getdevicepixelratio"}},[t._v("getDevicePixelRatio")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2176",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2176"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaximumsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaximumsize"}},[t._v("#")]),t._v(" getMaximumSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMaximumSize")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v(", "),e("code",[t._v("aspectRatio?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas for which to calculate the maximum size")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content width")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content height")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("aspectRatio?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The aspect ratio to maintain")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("p",[t._v("the maximum size available.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getmaximumsize"}},[t._v("getMaximumSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isattached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isattached"}},[t._v("#")]),t._v(" isAttached")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isAttached")]),t._v("("),e("code",[t._v("canvas")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the canvas is attached to the platform, false if not.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#isattached"}},[t._v("isAttached")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2189",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2189"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"releasecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#releasecontext"}},[t._v("#")]),t._v(" releaseContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("releaseContext")]),t._v("("),e("code",[t._v("context")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Called at chart destruction time, releases any resources associated to the context\npreviously returned by the acquireContext() method.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("context")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The context2d instance")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the method succeeded, else false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#releasecontext"}},[t._v("releaseContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removeeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removeeventlistener"}},[t._v("#")]),t._v(" removeEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Removes the specified listener previously registered with addEventListener.")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to remove the listener")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to remove")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The listener function to remove from the event target.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#removeeventlistener"}},[t._v("removeEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2172",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2172"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateconfig"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateConfig")]),t._v("("),e("code",[t._v("config")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Updates config with platform specific requirements")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#updateconfig"}},[t._v("updateConfig")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2194",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2194"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{349:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-basicplatform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-basicplatform"}},[t._v("#")]),t._v(" Class: BasicPlatform")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[e("code",[t._v("BasePlatform")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("BasicPlatform")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new BasicPlatform")]),t._v("()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#constructor"}},[t._v("constructor")])],1),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"acquirecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#acquirecontext"}},[t._v("#")]),t._v(" acquireContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("acquireContext")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("p",[t._v("Called at chart construction time, returns a context2d instance implementing\nthe [W3C Canvas 2D Context API standard]"),e("a",{attrs:{href:"https://www.w3.org/TR/2dcontext/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.w3.org/TR/2dcontext/"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas from which to acquire context (platform specific)")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2DSettings")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart options")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#acquirecontext"}},[t._v("acquireContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addeventlistener"}},[t._v("#")]),t._v(" addEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Registers the specified listener on the given chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to listen for event")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to listen for")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Receives a notification (an object that implements the "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(" interface) when an event of the specified type occurs.")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#addeventlistener"}},[t._v("addEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2165"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevicepixelratio"}},[t._v("#")]),t._v(" getDevicePixelRatio")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDevicePixelRatio")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("the current devicePixelRatio of the device this platform is connected to.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getdevicepixelratio"}},[t._v("getDevicePixelRatio")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2176",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2176"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaximumsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaximumsize"}},[t._v("#")]),t._v(" getMaximumSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMaximumSize")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v(", "),e("code",[t._v("aspectRatio?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas for which to calculate the maximum size")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content width")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content height")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("aspectRatio?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The aspect ratio to maintain")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("p",[t._v("the maximum size available.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getmaximumsize"}},[t._v("getMaximumSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isattached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isattached"}},[t._v("#")]),t._v(" isAttached")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isAttached")]),t._v("("),e("code",[t._v("canvas")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the canvas is attached to the platform, false if not.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#isattached"}},[t._v("isAttached")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2189",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2189"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"releasecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#releasecontext"}},[t._v("#")]),t._v(" releaseContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("releaseContext")]),t._v("("),e("code",[t._v("context")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Called at chart destruction time, releases any resources associated to the context\npreviously returned by the acquireContext() method.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("context")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The context2d instance")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the method succeeded, else false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#releasecontext"}},[t._v("releaseContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removeeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removeeventlistener"}},[t._v("#")]),t._v(" removeEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Removes the specified listener previously registered with addEventListener.")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to remove the listener")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to remove")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The listener function to remove from the event target.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#removeeventlistener"}},[t._v("removeEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2172",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2172"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateconfig"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateConfig")]),t._v("("),e("code",[t._v("config")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Updates config with platform specific requirements")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#updateconfig"}},[t._v("updateConfig")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2194",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2194"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/180.d0e9a651.js b/docs/master/assets/js/180.649de464.js similarity index 99% rename from docs/master/assets/js/180.d0e9a651.js rename to docs/master/assets/js/180.649de464.js index 85d81ccd28..15ec8b8a81 100644 --- a/docs/master/assets/js/180.d0e9a651.js +++ b/docs/master/assets/js/180.649de464.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[180],{513:function(t,e,a){"use strict";a.r(e);var s=a(3),o=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" Options")]),t._v(" "),e("h2",{attrs:{id:"option-resolution"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-resolution"}},[t._v("#")]),t._v(" Option resolution")]),t._v(" "),e("p",[t._v("Options are resolved from top to bottom, using a context dependent route.")]),t._v(" "),e("h3",{attrs:{id:"chart-level-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart-level-options"}},[t._v("#")]),t._v(" Chart level options")]),t._v(" "),e("ul",[e("li",[t._v("options")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults")])]),t._v(" "),e("h3",{attrs:{id:"dataset-level-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-level-options"}},[t._v("#")]),t._v(" Dataset level options")]),t._v(" "),e("p",[e("code",[t._v("dataset.type")]),t._v(" defaults to "),e("code",[t._v("config.type")]),t._v(", if not specified.")]),t._v(" "),e("ul",[e("li",[t._v("dataset")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("options")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults")])]),t._v(" "),e("h3",{attrs:{id:"dataset-animation-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-animation-options"}},[t._v("#")]),t._v(" Dataset animation options")]),t._v(" "),e("ul",[e("li",[t._v("dataset.animation")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("].animation")]),t._v(" "),e("li",[t._v("options.animation")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("].animation")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("].animation")]),t._v(" "),e("li",[t._v("defaults.animation")])]),t._v(" "),e("h3",{attrs:{id:"dataset-element-level-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-element-level-options"}},[t._v("#")]),t._v(" Dataset element level options")]),t._v(" "),e("p",[t._v("Each scope is looked up with "),e("code",[t._v("elementType")]),t._v(" prefix in the option name first, then without the prefix. For example, "),e("code",[t._v("radius")]),t._v(" for "),e("code",[t._v("point")]),t._v(" element is looked up using "),e("code",[t._v("pointRadius")]),t._v(" and if that does not hit, then "),e("code",[t._v("radius")]),t._v(".")]),t._v(" "),e("ul",[e("li",[t._v("dataset")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("].elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("options.elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("options")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("].elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("].elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults")])]),t._v(" "),e("h3",{attrs:{id:"scale-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale-options"}},[t._v("#")]),t._v(" Scale options")]),t._v(" "),e("ul",[e("li",[t._v("options.scales")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].scales")]),t._v(" "),e("li",[t._v("defaults.scales")]),t._v(" "),e("li",[t._v("defaults.scale")])]),t._v(" "),e("h3",{attrs:{id:"plugin-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugin-options"}},[t._v("#")]),t._v(" Plugin options")]),t._v(" "),e("p",[t._v("A plugin can provide "),e("code",[t._v("additionalOptionScopes")]),t._v(" array of paths to additionally look for its options in. For root scope, use empty string: "),e("code",[t._v("''")]),t._v(". Most core plugins also take options from root scope.")]),t._v(" "),e("ul",[e("li",[t._v("options.plugins["),e("code",[t._v("plugin.id")]),t._v("]")]),t._v(" "),e("li",[t._v("(options.["),e("code",[t._v("...plugin.additionalOptionScopes")]),t._v("])")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].plugins["),e("code",[t._v("plugin.id")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.plugins["),e("code",[t._v("plugin.id")]),t._v("]")]),t._v(" "),e("li",[t._v("(defaults.["),e("code",[t._v("...plugin.additionalOptionScopes")]),t._v("])")])]),t._v(" "),e("h2",{attrs:{id:"scriptable-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptable-options"}},[t._v("#")]),t._v(" Scriptable Options")]),t._v(" "),e("p",[t._v("Scriptable options also accept a function which is called for each of the underlying data values and that takes the unique argument "),e("code",[t._v("context")]),t._v(" representing contextual information (see "),e("RouterLink",{attrs:{to:"/general/options.html#option-context"}},[t._v("option context")]),t._v(").\nA resolver is passed as second parameter, that can be used to access other options in the same context.")],1),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("context")]),t._v(" argument should be validated in the scriptable function, because the function can be invoked in different contexts. The "),e("code",[t._v("type")]),t._v(" field is a good candidate for this validation.")])]),t._v(" "),e("p",[t._v("Example:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("dataIndex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("dataset"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" value "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// draw negative values in red")]),t._v("\n index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'blue'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// else, alternate values in blue and green")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'green'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("borderColor")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" color "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" options"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resolve the value of another scriptable option: 'red', 'blue' or 'green'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("helpers"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("lighten")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.2")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("h2",{attrs:{id:"indexable-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#indexable-options"}},[t._v("#")]),t._v(" Indexable Options")]),t._v(" "),e("p",[t._v("Indexable options also accept an array in which each item corresponds to the element at the same index. Note that if there are less items than data, the items are looped over. In many cases, using a "),e("a",{attrs:{href:"#scriptable-options"}},[t._v("function")]),t._v(" is more appropriate if supported.")]),t._v(" "),e("p",[t._v("Example:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 0")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'blue'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 1")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'green'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 2")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'black'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 3")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//...")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),e("h2",{attrs:{id:"option-context"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-context"}},[t._v("#")]),t._v(" Option Context")]),t._v(" "),e("p",[t._v("The option context is used to give contextual information when resolving options and currently only applies to "),e("a",{attrs:{href:"#scriptable-options"}},[t._v("scriptable options")]),t._v(".\nThe object is preserved, so it can be used to store and pass information between calls.")]),t._v(" "),e("p",[t._v("There are multiple levels of context objects:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("chart")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("dataset")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data")])])])]),t._v(" "),e("li",[e("code",[t._v("scale")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("tick")])]),t._v(" "),e("li",[e("code",[t._v("pointLabel")]),t._v(" (only used in the radial linear scale)")])])]),t._v(" "),e("li",[e("code",[t._v("tooltip")])])])])]),t._v(" "),e("p",[t._v("Each level inherits its parent(s) and any contextual information stored in the parent is available through the child.")]),t._v(" "),e("p",[t._v("The context object contains the following properties:")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("chart")]),t._v(": the associated chart")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'chart'")])])]),t._v(" "),e("h3",{attrs:{id:"dataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#chart"}},[t._v("chart")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("active")]),t._v(": true if an element is active (hovered)")]),t._v(" "),e("li",[e("code",[t._v("dataset")]),t._v(": dataset at index "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("datasetIndex")]),t._v(": index of the current dataset")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": same as "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("mode")]),t._v(": the update mode")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'dataset'")])])]),t._v(" "),e("h3",{attrs:{id:"data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data"}},[t._v("#")]),t._v(" data")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#dataset"}},[t._v("dataset")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("active")]),t._v(": true if an element is active (hovered)")]),t._v(" "),e("li",[e("code",[t._v("dataIndex")]),t._v(": index of the current data")]),t._v(" "),e("li",[e("code",[t._v("parsed")]),t._v(": the parsed data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("raw")]),t._v(": the raw data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("element")]),t._v(": the element (point, arc, bar, etc.) for this data")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": same as "),e("code",[t._v("dataIndex")])]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'data'")])])]),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#chart"}},[t._v("chart")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("scale")]),t._v(": the associated scale")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'scale'")])])]),t._v(" "),e("h3",{attrs:{id:"tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick"}},[t._v("#")]),t._v(" tick")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#scale"}},[t._v("scale")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("tick")]),t._v(": the associated tick object")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": tick index")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'tick'")])])]),t._v(" "),e("h3",{attrs:{id:"pointlabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointlabel"}},[t._v("#")]),t._v(" pointLabel")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#scale"}},[t._v("scale")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("label")]),t._v(": the associated label value")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": label index")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'pointLabel'")])])]),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" tooltip")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#chart"}},[t._v("chart")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("tooltip")]),t._v(": the tooltip object")]),t._v(" "),e("li",[e("code",[t._v("tooltipItems")]),t._v(": the items the tooltip is displaying")])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[180],{515:function(t,e,a){"use strict";a.r(e);var s=a(3),o=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" Options")]),t._v(" "),e("h2",{attrs:{id:"option-resolution"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-resolution"}},[t._v("#")]),t._v(" Option resolution")]),t._v(" "),e("p",[t._v("Options are resolved from top to bottom, using a context dependent route.")]),t._v(" "),e("h3",{attrs:{id:"chart-level-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart-level-options"}},[t._v("#")]),t._v(" Chart level options")]),t._v(" "),e("ul",[e("li",[t._v("options")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults")])]),t._v(" "),e("h3",{attrs:{id:"dataset-level-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-level-options"}},[t._v("#")]),t._v(" Dataset level options")]),t._v(" "),e("p",[e("code",[t._v("dataset.type")]),t._v(" defaults to "),e("code",[t._v("config.type")]),t._v(", if not specified.")]),t._v(" "),e("ul",[e("li",[t._v("dataset")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("options")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults")])]),t._v(" "),e("h3",{attrs:{id:"dataset-animation-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-animation-options"}},[t._v("#")]),t._v(" Dataset animation options")]),t._v(" "),e("ul",[e("li",[t._v("dataset.animation")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("].animation")]),t._v(" "),e("li",[t._v("options.animation")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("].animation")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("].animation")]),t._v(" "),e("li",[t._v("defaults.animation")])]),t._v(" "),e("h3",{attrs:{id:"dataset-element-level-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset-element-level-options"}},[t._v("#")]),t._v(" Dataset element level options")]),t._v(" "),e("p",[t._v("Each scope is looked up with "),e("code",[t._v("elementType")]),t._v(" prefix in the option name first, then without the prefix. For example, "),e("code",[t._v("radius")]),t._v(" for "),e("code",[t._v("point")]),t._v(" element is looked up using "),e("code",[t._v("pointRadius")]),t._v(" and if that does not hit, then "),e("code",[t._v("radius")]),t._v(".")]),t._v(" "),e("ul",[e("li",[t._v("dataset")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("options.datasets["),e("code",[t._v("dataset.type")]),t._v("].elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("options.elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("options")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].datasets["),e("code",[t._v("dataset.type")]),t._v("].elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.datasets["),e("code",[t._v("dataset.type")]),t._v("].elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.elements["),e("code",[t._v("elementType")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults")])]),t._v(" "),e("h3",{attrs:{id:"scale-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale-options"}},[t._v("#")]),t._v(" Scale options")]),t._v(" "),e("ul",[e("li",[t._v("options.scales")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].scales")]),t._v(" "),e("li",[t._v("defaults.scales")]),t._v(" "),e("li",[t._v("defaults.scale")])]),t._v(" "),e("h3",{attrs:{id:"plugin-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugin-options"}},[t._v("#")]),t._v(" Plugin options")]),t._v(" "),e("p",[t._v("A plugin can provide "),e("code",[t._v("additionalOptionScopes")]),t._v(" array of paths to additionally look for its options in. For root scope, use empty string: "),e("code",[t._v("''")]),t._v(". Most core plugins also take options from root scope.")]),t._v(" "),e("ul",[e("li",[t._v("options.plugins["),e("code",[t._v("plugin.id")]),t._v("]")]),t._v(" "),e("li",[t._v("(options.["),e("code",[t._v("...plugin.additionalOptionScopes")]),t._v("])")]),t._v(" "),e("li",[t._v("overrides["),e("code",[t._v("config.type")]),t._v("].plugins["),e("code",[t._v("plugin.id")]),t._v("]")]),t._v(" "),e("li",[t._v("defaults.plugins["),e("code",[t._v("plugin.id")]),t._v("]")]),t._v(" "),e("li",[t._v("(defaults.["),e("code",[t._v("...plugin.additionalOptionScopes")]),t._v("])")])]),t._v(" "),e("h2",{attrs:{id:"scriptable-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scriptable-options"}},[t._v("#")]),t._v(" Scriptable Options")]),t._v(" "),e("p",[t._v("Scriptable options also accept a function which is called for each of the underlying data values and that takes the unique argument "),e("code",[t._v("context")]),t._v(" representing contextual information (see "),e("RouterLink",{attrs:{to:"/general/options.html#option-context"}},[t._v("option context")]),t._v(").\nA resolver is passed as second parameter, that can be used to access other options in the same context.")],1),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("context")]),t._v(" argument should be validated in the scriptable function, because the function can be invoked in different contexts. The "),e("code",[t._v("type")]),t._v(" field is a good candidate for this validation.")])]),t._v(" "),e("p",[t._v("Example:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("dataIndex"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("dataset"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" value "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// draw negative values in red")]),t._v("\n index "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'blue'")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// else, alternate values in blue and green")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'green'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("borderColor")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("context"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" options")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" color "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" options"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// resolve the value of another scriptable option: 'red', 'blue' or 'green'")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" Chart"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("helpers"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("color"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("lighten")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.2")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),e("h2",{attrs:{id:"indexable-options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#indexable-options"}},[t._v("#")]),t._v(" Indexable Options")]),t._v(" "),e("p",[t._v("Indexable options also accept an array in which each item corresponds to the element at the same index. Note that if there are less items than data, the items are looped over. In many cases, using a "),e("a",{attrs:{href:"#scriptable-options"}},[t._v("function")]),t._v(" is more appropriate if supported.")]),t._v(" "),e("p",[t._v("Example:")]),t._v(" "),e("div",{staticClass:"language-javascript extra-class"},[e("pre",{pre:!0,attrs:{class:"language-javascript"}},[e("code",[e("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("color")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 0")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'blue'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 1")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'green'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 2")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v("'black'")]),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// color for data at index 3")]),t._v("\n "),e("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//...")]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),e("h2",{attrs:{id:"option-context"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-context"}},[t._v("#")]),t._v(" Option Context")]),t._v(" "),e("p",[t._v("The option context is used to give contextual information when resolving options and currently only applies to "),e("a",{attrs:{href:"#scriptable-options"}},[t._v("scriptable options")]),t._v(".\nThe object is preserved, so it can be used to store and pass information between calls.")]),t._v(" "),e("p",[t._v("There are multiple levels of context objects:")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("chart")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("dataset")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("data")])])])]),t._v(" "),e("li",[e("code",[t._v("scale")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("tick")])]),t._v(" "),e("li",[e("code",[t._v("pointLabel")]),t._v(" (only used in the radial linear scale)")])])]),t._v(" "),e("li",[e("code",[t._v("tooltip")])])])])]),t._v(" "),e("p",[t._v("Each level inherits its parent(s) and any contextual information stored in the parent is available through the child.")]),t._v(" "),e("p",[t._v("The context object contains the following properties:")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("ul",[e("li",[e("code",[t._v("chart")]),t._v(": the associated chart")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'chart'")])])]),t._v(" "),e("h3",{attrs:{id:"dataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dataset"}},[t._v("#")]),t._v(" dataset")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#chart"}},[t._v("chart")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("active")]),t._v(": true if an element is active (hovered)")]),t._v(" "),e("li",[e("code",[t._v("dataset")]),t._v(": dataset at index "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("datasetIndex")]),t._v(": index of the current dataset")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": same as "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("mode")]),t._v(": the update mode")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'dataset'")])])]),t._v(" "),e("h3",{attrs:{id:"data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data"}},[t._v("#")]),t._v(" data")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#dataset"}},[t._v("dataset")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("active")]),t._v(": true if an element is active (hovered)")]),t._v(" "),e("li",[e("code",[t._v("dataIndex")]),t._v(": index of the current data")]),t._v(" "),e("li",[e("code",[t._v("parsed")]),t._v(": the parsed data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("raw")]),t._v(": the raw data values for the given "),e("code",[t._v("dataIndex")]),t._v(" and "),e("code",[t._v("datasetIndex")])]),t._v(" "),e("li",[e("code",[t._v("element")]),t._v(": the element (point, arc, bar, etc.) for this data")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": same as "),e("code",[t._v("dataIndex")])]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'data'")])])]),t._v(" "),e("h3",{attrs:{id:"scale"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scale"}},[t._v("#")]),t._v(" scale")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#chart"}},[t._v("chart")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("scale")]),t._v(": the associated scale")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'scale'")])])]),t._v(" "),e("h3",{attrs:{id:"tick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tick"}},[t._v("#")]),t._v(" tick")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#scale"}},[t._v("scale")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("tick")]),t._v(": the associated tick object")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": tick index")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'tick'")])])]),t._v(" "),e("h3",{attrs:{id:"pointlabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointlabel"}},[t._v("#")]),t._v(" pointLabel")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#scale"}},[t._v("scale")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("label")]),t._v(": the associated label value")]),t._v(" "),e("li",[e("code",[t._v("index")]),t._v(": label index")]),t._v(" "),e("li",[e("code",[t._v("type")]),t._v(": "),e("code",[t._v("'pointLabel'")])])]),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" tooltip")]),t._v(" "),e("p",[t._v("In addition to "),e("a",{attrs:{href:"#chart"}},[t._v("chart")])]),t._v(" "),e("ul",[e("li",[e("code",[t._v("tooltip")]),t._v(": the tooltip object")]),t._v(" "),e("li",[e("code",[t._v("tooltipItems")]),t._v(": the items the tooltip is displaying")])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/181.0cc4c2da.js b/docs/master/assets/js/181.441580f6.js similarity index 99% rename from docs/master/assets/js/181.0cc4c2da.js rename to docs/master/assets/js/181.441580f6.js index 2c8d1991a4..d953079356 100644 --- a/docs/master/assets/js/181.0cc4c2da.js +++ b/docs/master/assets/js/181.441580f6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[181],{517:function(t,a,s){"use strict";s.r(a);var r=s(3),e=Object(r.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"padding"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" Padding")]),t._v(" "),a("p",[t._v("Padding values in Chart options can be supplied in a couple of different formats.")]),t._v(" "),a("h2",{attrs:{id:"number"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#number"}},[t._v("#")]),t._v(" Number")]),t._v(" "),a("p",[t._v("If this value is a number, it is applied to all sides (left, top, right, bottom).")]),t._v(" "),a("p",[t._v("For example, defining a 20px padding to all sides of the chart:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("layout")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("padding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"top-left-bottom-right-object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#top-left-bottom-right-object"}},[t._v("#")]),t._v(" {top, left, bottom, right} object")]),t._v(" "),a("p",[t._v("If this value is an object, the "),a("code",[t._v("left")]),t._v(" property defines the left padding. Similarly, the "),a("code",[t._v("right")]),t._v(", "),a("code",[t._v("top")]),t._v(" and "),a("code",[t._v("bottom")]),t._v(" properties can also be specified.\nOmitted properties default to "),a("code",[t._v("0")]),t._v(".")]),t._v(" "),a("p",[t._v("Let's say you wanted to add 50px of padding to the left side of the chart canvas, you would do:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("layout")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("padding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("left")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"x-y-object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#x-y-object"}},[t._v("#")]),t._v(" {x, y} object")]),t._v(" "),a("p",[t._v("This is a shorthand for defining left/right and top/bottom to the same values.")]),t._v(" "),a("p",[t._v("For example, 10px left / right and 4px top / bottom padding on a Radial Linear Axis "),a("RouterLink",{attrs:{to:"/axes/radial/linear.html#linear-radial-axis-specific-tick-options"}},[t._v("tick backdropPadding")]),t._v(":")],1),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'radar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("backdropPadding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[181],{514:function(t,a,s){"use strict";s.r(a);var r=s(3),e=Object(r.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"padding"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#padding"}},[t._v("#")]),t._v(" Padding")]),t._v(" "),a("p",[t._v("Padding values in Chart options can be supplied in a couple of different formats.")]),t._v(" "),a("h2",{attrs:{id:"number"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#number"}},[t._v("#")]),t._v(" Number")]),t._v(" "),a("p",[t._v("If this value is a number, it is applied to all sides (left, top, right, bottom).")]),t._v(" "),a("p",[t._v("For example, defining a 20px padding to all sides of the chart:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("layout")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("padding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"top-left-bottom-right-object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#top-left-bottom-right-object"}},[t._v("#")]),t._v(" {top, left, bottom, right} object")]),t._v(" "),a("p",[t._v("If this value is an object, the "),a("code",[t._v("left")]),t._v(" property defines the left padding. Similarly, the "),a("code",[t._v("right")]),t._v(", "),a("code",[t._v("top")]),t._v(" and "),a("code",[t._v("bottom")]),t._v(" properties can also be specified.\nOmitted properties default to "),a("code",[t._v("0")]),t._v(".")]),t._v(" "),a("p",[t._v("Let's say you wanted to add 50px of padding to the left side of the chart canvas, you would do:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("layout")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("padding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("left")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"x-y-object"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#x-y-object"}},[t._v("#")]),t._v(" {x, y} object")]),t._v(" "),a("p",[t._v("This is a shorthand for defining left/right and top/bottom to the same values.")]),t._v(" "),a("p",[t._v("For example, 10px left / right and 4px top / bottom padding on a Radial Linear Axis "),a("RouterLink",{attrs:{to:"/axes/radial/linear.html#linear-radial-axis-specific-tick-options"}},[t._v("tick backdropPadding")]),t._v(":")],1),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'radar'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("r")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("ticks")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("backdropPadding")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("4")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/182.8027e704.js b/docs/master/assets/js/182.2419a684.js similarity index 99% rename from docs/master/assets/js/182.8027e704.js rename to docs/master/assets/js/182.2419a684.js index 8a90a3a229..b35cff3b41 100644 --- a/docs/master/assets/js/182.8027e704.js +++ b/docs/master/assets/js/182.2419a684.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[182],{515:function(t,a,s){"use strict";s.r(a);var e=s(3),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"performance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#performance"}},[t._v("#")]),t._v(" Performance")]),t._v(" "),a("p",[t._v("Chart.js charts are rendered on "),a("code",[t._v("canvas")]),t._v(" elements, which makes rendering quite fast. For large datasets or performance sensitive applications, you may wish to consider the tips below.")]),t._v(" "),a("h2",{attrs:{id:"data-structure-and-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-structure-and-format"}},[t._v("#")]),t._v(" Data structure and format")]),t._v(" "),a("h3",{attrs:{id:"parsing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" Parsing")]),t._v(" "),a("p",[t._v("Provide prepared data in the internal format accepted by the dataset and scales, and set "),a("code",[t._v("parsing: false")]),t._v(". See "),a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures")]),t._v(" for more information.")],1),t._v(" "),a("h3",{attrs:{id:"data-normalization"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-normalization"}},[t._v("#")]),t._v(" Data normalization")]),t._v(" "),a("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the "),a("code",[t._v("normalized: true")]),t._v(" option to let Chart.js know that you have done so. Even without this option, it can sometimes still be faster to provide sorted data.")]),t._v(" "),a("h3",{attrs:{id:"decimation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#decimation"}},[t._v("#")]),t._v(" Decimation")]),t._v(" "),a("p",[t._v("Decimating your data will achieve the best results. When there is a lot of data to display on the graph, it doesn't make sense to show tens of thousands of data points on a graph that is only a few hundred pixels wide.")]),t._v(" "),a("p",[t._v("The "),a("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[t._v("decimation plugin")]),t._v(" can be used with line charts to decimate data before the chart is rendered. This will provide the best performance since it will reduce the memory needed to render the chart.")],1),t._v(" "),a("p",[t._v("Line charts are able to do "),a("a",{attrs:{href:"#automatic-data-decimation-during-draw"}},[t._v("automatic data decimation during draw")]),t._v(", when certain conditions are met. You should still consider decimating data yourself before passing it in for maximum performance since the automatic decimation occurs late in the chart life cycle.")]),t._v(" "),a("h2",{attrs:{id:"tick-calculation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tick-calculation"}},[t._v("#")]),t._v(" Tick Calculation")]),t._v(" "),a("h3",{attrs:{id:"rotation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" Rotation")]),t._v(" "),a("p",[a("RouterLink",{attrs:{to:"/axes/cartesian/#tick-configuration"}},[t._v("Specify a rotation value")]),t._v(" by setting "),a("code",[t._v("minRotation")]),t._v(" and "),a("code",[t._v("maxRotation")]),t._v(" to the same value, which avoids the chart from having to automatically determine a value to use.")],1),t._v(" "),a("h3",{attrs:{id:"sampling"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sampling"}},[t._v("#")]),t._v(" Sampling")]),t._v(" "),a("p",[t._v("Set the "),a("RouterLink",{attrs:{to:"/axes/cartesian/#tick-configuration"}},[a("code",[t._v("ticks.sampleSize")])]),t._v(" option. This will determine how large your labels are by looking at only a subset of them in order to render axes more quickly. This works best if there is not a large variance in the size of your labels.")],1),t._v(" "),a("h2",{attrs:{id:"disable-animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disable-animations"}},[t._v("#")]),t._v(" Disable Animations")]),t._v(" "),a("p",[t._v("If your charts have long render times, it is a good idea to disable animations. Doing so will mean that the chart needs to only be rendered once during an update instead of multiple times. This will have the effect of reducing CPU usage and improving general page performance.\nLine charts use Path2D caching when animations are disabled and Path2D is available.")]),t._v(" "),a("p",[t._v("To disable animations")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("animation")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"specify-min-and-max-for-scales"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#specify-min-and-max-for-scales"}},[t._v("#")]),t._v(" Specify "),a("code",[t._v("min")]),t._v(" and "),a("code",[t._v("max")]),t._v(" for scales")]),t._v(" "),a("p",[t._v("If you specify the "),a("code",[t._v("min")]),t._v(" and "),a("code",[t._v("max")]),t._v(", the scale does not have to compute the range from the data.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Date")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2019-01-01'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOf")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Date")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2019-12-31'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOf")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'linear'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"parallel-rendering-with-web-workers-chromium-only"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parallel-rendering-with-web-workers-chromium-only"}},[t._v("#")]),t._v(" Parallel rendering with web workers (Chromium only)")]),t._v(" "),a("p",[t._v("Chromium (Chrome: version 69, Edge: 79, Opera: 56) added the ability to "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/transferControlToOffscreen",target:"_blank",rel:"noopener noreferrer"}},[t._v("transfer rendering control of a canvas"),a("OutboundLink")],1),t._v(" to a web worker. Web workers can use the "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas",target:"_blank",rel:"noopener noreferrer"}},[t._v("OffscreenCanvas API"),a("OutboundLink")],1),t._v(" to render from a web worker onto canvases in the DOM. Chart.js is a canvas-based library and supports rendering in a web worker - just pass an OffscreenCanvas into the Chart constructor instead of a Canvas element. Note that as of today, this API is only supported in Chromium based browsers.")]),t._v(" "),a("p",[t._v("By moving all Chart.js calculations onto a separate thread, the main thread can be freed up for other uses. Some tips and tricks when using Chart.js in a web worker:")]),t._v(" "),a("ul",[a("li",[t._v("Transferring data between threads can be expensive, so ensure that your config and data objects are as small as possible. Try generating them on the worker side if you can (workers can make HTTP requests!) or passing them to your worker as ArrayBuffers, which can be transferred quickly from one thread to another.")]),t._v(" "),a("li",[t._v("You can't transfer functions between threads, so if your config object includes functions you'll have to strip them out before transferring and then add them back later.")]),t._v(" "),a("li",[t._v("You can't access the DOM from worker threads, so Chart.js plugins that use the DOM (including any mouse interactions) will likely not work.")]),t._v(" "),a("li",[t._v("Ensure that you have a fallback if you support browsers other than the most modern Chromium browsers.")]),t._v(" "),a("li",[t._v("Resizing the chart must be done manually. See an example in the worker code below.")])]),t._v(" "),a("p",[t._v("Example main thread code:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" config "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" canvas "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("HTMLCanvasElement")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" offscreenCanvas "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transferControlToOffscreen")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" worker "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Worker")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'worker.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nworker"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("postMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("canvas")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" offscreenCanvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("offscreenCanvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Example worker code, in "),a("code",[t._v("worker.js")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onmessage")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("event")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" event"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Resizing the chart must be done manually, since OffscreenCanvas does not include event listeners.")]),t._v("\n canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("width "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("height "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"line-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#line-charts"}},[t._v("#")]),t._v(" Line Charts")]),t._v(" "),a("h3",{attrs:{id:"leave-bezier-curves-disabled"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#leave-bezier-curves-disabled"}},[t._v("#")]),t._v(" Leave Bézier curves disabled")]),t._v(" "),a("p",[t._v("If you are drawing lines on your chart, disabling Bézier curves will improve render times since drawing a straight line is more performant than a Bézier curve. Bézier curves are disabled by default.")]),t._v(" "),a("h3",{attrs:{id:"automatic-data-decimation-during-draw"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#automatic-data-decimation-during-draw"}},[t._v("#")]),t._v(" Automatic data decimation during draw")]),t._v(" "),a("p",[t._v("Line element will automatically decimate data, when "),a("code",[t._v("tension")]),t._v(", "),a("code",[t._v("stepped")]),t._v(", and "),a("code",[t._v("borderDash")]),t._v(" are left set to their default values ("),a("code",[t._v("false")]),t._v(", "),a("code",[t._v("0")]),t._v(", and "),a("code",[t._v("[]")]),t._v(" respectively). This improves rendering speed by skipping drawing of invisible line segments.")]),t._v(" "),a("h3",{attrs:{id:"enable-spangaps"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enable-spangaps"}},[t._v("#")]),t._v(" Enable spanGaps")]),t._v(" "),a("p",[t._v("If you have a lot of data points, it can be more performant to enable "),a("code",[t._v("spanGaps")]),t._v(". This disables segmentation of the line, which can be an unneeded step.")]),t._v(" "),a("p",[t._v("To enable "),a("code",[t._v("spanGaps")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("spanGaps")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// enable for a single dataset")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("spanGaps")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// enable for all datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"disable-line-drawing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disable-line-drawing"}},[t._v("#")]),t._v(" Disable Line Drawing")]),t._v(" "),a("p",[t._v("If you have a lot of data points, it can be more performant to disable rendering of the line for a dataset and only draw points. Doing this means that there is less to draw on the canvas which will improve render performance.")]),t._v(" "),a("p",[t._v("To disable lines:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("showLine")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for a single dataset")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("showLine")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for all datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"disable-point-drawing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disable-point-drawing"}},[t._v("#")]),t._v(" Disable Point Drawing")]),t._v(" "),a("p",[t._v("If you have a lot of data points, it can be more performant to disable rendering of the points for a dataset and only draw line. Doing this means that there is less to draw on the canvas which will improve render performance.")]),t._v(" "),a("p",[t._v("To disable point drawing:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointRadius")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for a single dataset")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("line")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointRadius")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for all `'line'` datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("elements")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("point")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("radius")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// default to disabled in all datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"when-transpiling-with-babel-consider-using-loose-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#when-transpiling-with-babel-consider-using-loose-mode"}},[t._v("#")]),t._v(" When transpiling with Babel, consider using "),a("code",[t._v("loose")]),t._v(" mode")]),t._v(" "),a("p",[t._v("Babel 7.9 changed the way classes are constructed. It is slow, unless used with "),a("code",[t._v("loose")]),t._v(" mode.\n"),a("a",{attrs:{href:"https://github.com/babel/babel/issues/11356",target:"_blank",rel:"noopener noreferrer"}},[t._v("More information"),a("OutboundLink")],1)])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[182],{516:function(t,a,s){"use strict";s.r(a);var e=s(3),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"performance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#performance"}},[t._v("#")]),t._v(" Performance")]),t._v(" "),a("p",[t._v("Chart.js charts are rendered on "),a("code",[t._v("canvas")]),t._v(" elements, which makes rendering quite fast. For large datasets or performance sensitive applications, you may wish to consider the tips below.")]),t._v(" "),a("h2",{attrs:{id:"data-structure-and-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-structure-and-format"}},[t._v("#")]),t._v(" Data structure and format")]),t._v(" "),a("h3",{attrs:{id:"parsing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" Parsing")]),t._v(" "),a("p",[t._v("Provide prepared data in the internal format accepted by the dataset and scales, and set "),a("code",[t._v("parsing: false")]),t._v(". See "),a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures")]),t._v(" for more information.")],1),t._v(" "),a("h3",{attrs:{id:"data-normalization"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#data-normalization"}},[t._v("#")]),t._v(" Data normalization")]),t._v(" "),a("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the "),a("code",[t._v("normalized: true")]),t._v(" option to let Chart.js know that you have done so. Even without this option, it can sometimes still be faster to provide sorted data.")]),t._v(" "),a("h3",{attrs:{id:"decimation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#decimation"}},[t._v("#")]),t._v(" Decimation")]),t._v(" "),a("p",[t._v("Decimating your data will achieve the best results. When there is a lot of data to display on the graph, it doesn't make sense to show tens of thousands of data points on a graph that is only a few hundred pixels wide.")]),t._v(" "),a("p",[t._v("The "),a("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[t._v("decimation plugin")]),t._v(" can be used with line charts to decimate data before the chart is rendered. This will provide the best performance since it will reduce the memory needed to render the chart.")],1),t._v(" "),a("p",[t._v("Line charts are able to do "),a("a",{attrs:{href:"#automatic-data-decimation-during-draw"}},[t._v("automatic data decimation during draw")]),t._v(", when certain conditions are met. You should still consider decimating data yourself before passing it in for maximum performance since the automatic decimation occurs late in the chart life cycle.")]),t._v(" "),a("h2",{attrs:{id:"tick-calculation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tick-calculation"}},[t._v("#")]),t._v(" Tick Calculation")]),t._v(" "),a("h3",{attrs:{id:"rotation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rotation"}},[t._v("#")]),t._v(" Rotation")]),t._v(" "),a("p",[a("RouterLink",{attrs:{to:"/axes/cartesian/#tick-configuration"}},[t._v("Specify a rotation value")]),t._v(" by setting "),a("code",[t._v("minRotation")]),t._v(" and "),a("code",[t._v("maxRotation")]),t._v(" to the same value, which avoids the chart from having to automatically determine a value to use.")],1),t._v(" "),a("h3",{attrs:{id:"sampling"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sampling"}},[t._v("#")]),t._v(" Sampling")]),t._v(" "),a("p",[t._v("Set the "),a("RouterLink",{attrs:{to:"/axes/cartesian/#tick-configuration"}},[a("code",[t._v("ticks.sampleSize")])]),t._v(" option. This will determine how large your labels are by looking at only a subset of them in order to render axes more quickly. This works best if there is not a large variance in the size of your labels.")],1),t._v(" "),a("h2",{attrs:{id:"disable-animations"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disable-animations"}},[t._v("#")]),t._v(" Disable Animations")]),t._v(" "),a("p",[t._v("If your charts have long render times, it is a good idea to disable animations. Doing so will mean that the chart needs to only be rendered once during an update instead of multiple times. This will have the effect of reducing CPU usage and improving general page performance.\nLine charts use Path2D caching when animations are disabled and Path2D is available.")]),t._v(" "),a("p",[t._v("To disable animations")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("animation")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"specify-min-and-max-for-scales"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#specify-min-and-max-for-scales"}},[t._v("#")]),t._v(" Specify "),a("code",[t._v("min")]),t._v(" and "),a("code",[t._v("max")]),t._v(" for scales")]),t._v(" "),a("p",[t._v("If you specify the "),a("code",[t._v("min")]),t._v(" and "),a("code",[t._v("max")]),t._v(", the scale does not have to compute the range from the data.")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("scales")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("x")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'time'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Date")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2019-01-01'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOf")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Date")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'2019-12-31'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOf")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'linear'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("min")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("max")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"parallel-rendering-with-web-workers-chromium-only"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parallel-rendering-with-web-workers-chromium-only"}},[t._v("#")]),t._v(" Parallel rendering with web workers (Chromium only)")]),t._v(" "),a("p",[t._v("Chromium (Chrome: version 69, Edge: 79, Opera: 56) added the ability to "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/HTMLCanvasElement/transferControlToOffscreen",target:"_blank",rel:"noopener noreferrer"}},[t._v("transfer rendering control of a canvas"),a("OutboundLink")],1),t._v(" to a web worker. Web workers can use the "),a("a",{attrs:{href:"https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas",target:"_blank",rel:"noopener noreferrer"}},[t._v("OffscreenCanvas API"),a("OutboundLink")],1),t._v(" to render from a web worker onto canvases in the DOM. Chart.js is a canvas-based library and supports rendering in a web worker - just pass an OffscreenCanvas into the Chart constructor instead of a Canvas element. Note that as of today, this API is only supported in Chromium based browsers.")]),t._v(" "),a("p",[t._v("By moving all Chart.js calculations onto a separate thread, the main thread can be freed up for other uses. Some tips and tricks when using Chart.js in a web worker:")]),t._v(" "),a("ul",[a("li",[t._v("Transferring data between threads can be expensive, so ensure that your config and data objects are as small as possible. Try generating them on the worker side if you can (workers can make HTTP requests!) or passing them to your worker as ArrayBuffers, which can be transferred quickly from one thread to another.")]),t._v(" "),a("li",[t._v("You can't transfer functions between threads, so if your config object includes functions you'll have to strip them out before transferring and then add them back later.")]),t._v(" "),a("li",[t._v("You can't access the DOM from worker threads, so Chart.js plugins that use the DOM (including any mouse interactions) will likely not work.")]),t._v(" "),a("li",[t._v("Ensure that you have a fallback if you support browsers other than the most modern Chromium browsers.")]),t._v(" "),a("li",[t._v("Resizing the chart must be done manually. See an example in the worker code below.")])]),t._v(" "),a("p",[t._v("Example main thread code:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" config "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" canvas "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("HTMLCanvasElement")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" offscreenCanvas "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("transferControlToOffscreen")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" worker "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Worker")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'worker.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nworker"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("postMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("canvas")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" offscreenCanvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("offscreenCanvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("Example worker code, in "),a("code",[t._v("worker.js")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onmessage")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("event")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" event"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Resizing the chart must be done manually, since OffscreenCanvas does not include event listeners.")]),t._v("\n canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("width "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n canvas"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("height "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("resize")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"line-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#line-charts"}},[t._v("#")]),t._v(" Line Charts")]),t._v(" "),a("h3",{attrs:{id:"leave-bezier-curves-disabled"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#leave-bezier-curves-disabled"}},[t._v("#")]),t._v(" Leave Bézier curves disabled")]),t._v(" "),a("p",[t._v("If you are drawing lines on your chart, disabling Bézier curves will improve render times since drawing a straight line is more performant than a Bézier curve. Bézier curves are disabled by default.")]),t._v(" "),a("h3",{attrs:{id:"automatic-data-decimation-during-draw"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#automatic-data-decimation-during-draw"}},[t._v("#")]),t._v(" Automatic data decimation during draw")]),t._v(" "),a("p",[t._v("Line element will automatically decimate data, when "),a("code",[t._v("tension")]),t._v(", "),a("code",[t._v("stepped")]),t._v(", and "),a("code",[t._v("borderDash")]),t._v(" are left set to their default values ("),a("code",[t._v("false")]),t._v(", "),a("code",[t._v("0")]),t._v(", and "),a("code",[t._v("[]")]),t._v(" respectively). This improves rendering speed by skipping drawing of invisible line segments.")]),t._v(" "),a("h3",{attrs:{id:"enable-spangaps"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#enable-spangaps"}},[t._v("#")]),t._v(" Enable spanGaps")]),t._v(" "),a("p",[t._v("If you have a lot of data points, it can be more performant to enable "),a("code",[t._v("spanGaps")]),t._v(". This disables segmentation of the line, which can be an unneeded step.")]),t._v(" "),a("p",[t._v("To enable "),a("code",[t._v("spanGaps")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("spanGaps")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// enable for a single dataset")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("spanGaps")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// enable for all datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"disable-line-drawing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disable-line-drawing"}},[t._v("#")]),t._v(" Disable Line Drawing")]),t._v(" "),a("p",[t._v("If you have a lot of data points, it can be more performant to disable rendering of the line for a dataset and only draw points. Doing this means that there is less to draw on the canvas which will improve render performance.")]),t._v(" "),a("p",[t._v("To disable lines:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("showLine")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for a single dataset")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("showLine")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for all datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"disable-point-drawing"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#disable-point-drawing"}},[t._v("#")]),t._v(" Disable Point Drawing")]),t._v(" "),a("p",[t._v("If you have a lot of data points, it can be more performant to disable rendering of the points for a dataset and only draw line. Doing this means that there is less to draw on the canvas which will improve render performance.")]),t._v(" "),a("p",[t._v("To disable point drawing:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointRadius")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for a single dataset")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("datasets")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("line")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("pointRadius")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// disable for all `'line'` datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("elements")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("point")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("radius")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// default to disabled in all datasets")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"when-transpiling-with-babel-consider-using-loose-mode"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#when-transpiling-with-babel-consider-using-loose-mode"}},[t._v("#")]),t._v(" When transpiling with Babel, consider using "),a("code",[t._v("loose")]),t._v(" mode")]),t._v(" "),a("p",[t._v("Babel 7.9 changed the way classes are constructed. It is slow, unless used with "),a("code",[t._v("loose")]),t._v(" mode.\n"),a("a",{attrs:{href:"https://github.com/babel/babel/issues/11356",target:"_blank",rel:"noopener noreferrer"}},[t._v("More information"),a("OutboundLink")],1)])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/183.93427d6d.js b/docs/master/assets/js/183.4af08f02.js similarity index 98% rename from docs/master/assets/js/183.93427d6d.js rename to docs/master/assets/js/183.4af08f02.js index 247d4e53f7..272ffc5310 100644 --- a/docs/master/assets/js/183.93427d6d.js +++ b/docs/master/assets/js/183.4af08f02.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[183],{516:function(t,r,a){"use strict";a.r(r);var e=a(3),s=Object(e.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"installation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),r("h2",{attrs:{id:"npm"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#npm"}},[t._v("#")]),t._v(" npm")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://npmjs.com/package/chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/npm/v/chart.js.svg?style=flat-square&maxAge=600",alt:"npm"}}),r("OutboundLink")],1),t._v(" "),r("a",{attrs:{href:"https://npmjs.com/package/chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/npm/dm/chart.js.svg?style=flat-square&maxAge=600",alt:"npm"}}),r("OutboundLink")],1)]),t._v(" "),r("div",{staticClass:"language-sh extra-class"},[r("pre",{pre:!0,attrs:{class:"language-sh"}},[r("code",[r("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" chart.js\n")])])]),r("h2",{attrs:{id:"cdn"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#cdn"}},[t._v("#")]),t._v(" CDN")]),t._v(" "),r("h3",{attrs:{id:"cdnjs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#cdnjs"}},[t._v("#")]),t._v(" CDNJS")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://cdnjs.com/libraries/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/cdnjs/v/Chart.js.svg?style=flat-square&maxAge=600",alt:"cdnjs"}}),r("OutboundLink")],1)]),t._v(" "),r("p",[t._v("Chart.js built files are available on "),r("a",{attrs:{href:"https://cdnjs.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("CDNJS"),r("OutboundLink")],1),t._v(":")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://cdnjs.com/libraries/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://cdnjs.com/libraries/Chart.js"),r("OutboundLink")],1)]),t._v(" "),r("h3",{attrs:{id:"jsdelivr"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#jsdelivr"}},[t._v("#")]),t._v(" jsDelivr")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://cdn.jsdelivr.net/npm/chart.js@latest/dist/",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/npm/v/chart.js.svg?label=jsdelivr&style=flat-square&maxAge=600",alt:"jsdelivr"}}),r("OutboundLink")],1),t._v(" "),r("a",{attrs:{href:"https://www.jsdelivr.com/package/npm/chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://data.jsdelivr.com/v1/package/npm/chart.js/badge",alt:"jsdelivr hits"}}),r("OutboundLink")],1)]),t._v(" "),r("p",[t._v("Chart.js built files are also available through "),r("a",{attrs:{href:"https://www.jsdelivr.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("jsDelivr"),r("OutboundLink")],1),t._v(":")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://www.jsdelivr.com/package/npm/chart.js?path=dist",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.jsdelivr.com/package/npm/chart.js?path=dist"),r("OutboundLink")],1)]),t._v(" "),r("h2",{attrs:{id:"github"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#github"}},[t._v("#")]),t._v(" GitHub")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/github/release/chartjs/Chart.js.svg?style=flat-square&maxAge=600",alt:"github"}}),r("OutboundLink")],1)]),t._v(" "),r("p",[t._v("You can download the latest version of "),r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chart.js on GitHub"),r("OutboundLink")],1),t._v(".")]),t._v(" "),r("p",[t._v("If you download or clone the repository, you must "),r("RouterLink",{attrs:{to:"/developers/contributing.html#building-and-testing"}},[t._v("build")]),t._v(" Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is "),r("strong",[t._v("strongly")]),t._v(" advised.")],1)])}),[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[183],{518:function(t,r,a){"use strict";a.r(r);var e=a(3),s=Object(e.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"installation"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),r("h2",{attrs:{id:"npm"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#npm"}},[t._v("#")]),t._v(" npm")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://npmjs.com/package/chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/npm/v/chart.js.svg?style=flat-square&maxAge=600",alt:"npm"}}),r("OutboundLink")],1),t._v(" "),r("a",{attrs:{href:"https://npmjs.com/package/chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/npm/dm/chart.js.svg?style=flat-square&maxAge=600",alt:"npm"}}),r("OutboundLink")],1)]),t._v(" "),r("div",{staticClass:"language-sh extra-class"},[r("pre",{pre:!0,attrs:{class:"language-sh"}},[r("code",[r("span",{pre:!0,attrs:{class:"token function"}},[t._v("npm")]),t._v(" "),r("span",{pre:!0,attrs:{class:"token function"}},[t._v("install")]),t._v(" chart.js\n")])])]),r("h2",{attrs:{id:"cdn"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#cdn"}},[t._v("#")]),t._v(" CDN")]),t._v(" "),r("h3",{attrs:{id:"cdnjs"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#cdnjs"}},[t._v("#")]),t._v(" CDNJS")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://cdnjs.com/libraries/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/cdnjs/v/Chart.js.svg?style=flat-square&maxAge=600",alt:"cdnjs"}}),r("OutboundLink")],1)]),t._v(" "),r("p",[t._v("Chart.js built files are available on "),r("a",{attrs:{href:"https://cdnjs.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("CDNJS"),r("OutboundLink")],1),t._v(":")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://cdnjs.com/libraries/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://cdnjs.com/libraries/Chart.js"),r("OutboundLink")],1)]),t._v(" "),r("h3",{attrs:{id:"jsdelivr"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#jsdelivr"}},[t._v("#")]),t._v(" jsDelivr")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://cdn.jsdelivr.net/npm/chart.js@latest/dist/",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/npm/v/chart.js.svg?label=jsdelivr&style=flat-square&maxAge=600",alt:"jsdelivr"}}),r("OutboundLink")],1),t._v(" "),r("a",{attrs:{href:"https://www.jsdelivr.com/package/npm/chart.js",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://data.jsdelivr.com/v1/package/npm/chart.js/badge",alt:"jsdelivr hits"}}),r("OutboundLink")],1)]),t._v(" "),r("p",[t._v("Chart.js built files are also available through "),r("a",{attrs:{href:"https://www.jsdelivr.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("jsDelivr"),r("OutboundLink")],1),t._v(":")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://www.jsdelivr.com/package/npm/chart.js?path=dist",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.jsdelivr.com/package/npm/chart.js?path=dist"),r("OutboundLink")],1)]),t._v(" "),r("h2",{attrs:{id:"github"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#github"}},[t._v("#")]),t._v(" GitHub")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[r("img",{attrs:{src:"https://img.shields.io/github/release/chartjs/Chart.js.svg?style=flat-square&maxAge=600",alt:"github"}}),r("OutboundLink")],1)]),t._v(" "),r("p",[t._v("You can download the latest version of "),r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chart.js on GitHub"),r("OutboundLink")],1),t._v(".")]),t._v(" "),r("p",[t._v("If you download or clone the repository, you must "),r("RouterLink",{attrs:{to:"/developers/contributing.html#building-and-testing"}},[t._v("build")]),t._v(" Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is "),r("strong",[t._v("strongly")]),t._v(" advised.")],1)])}),[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/184.67dee573.js b/docs/master/assets/js/184.63dd7b0d.js similarity index 99% rename from docs/master/assets/js/184.67dee573.js rename to docs/master/assets/js/184.63dd7b0d.js index ecfbdabf17..f975534b29 100644 --- a/docs/master/assets/js/184.67dee573.js +++ b/docs/master/assets/js/184.63dd7b0d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[184],{520:function(t,a,s){"use strict";s.r(a);var e=s(3),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integration"}},[t._v("#")]),t._v(" Integration")]),t._v(" "),a("p",[t._v("Chart.js can be integrated with plain JavaScript or with different module loaders. The examples below show how to load Chart.js in different systems.")]),t._v(" "),a("p",[t._v("If you're using a front-end framework (e.g., React, Angular, or Vue), please see "),a("a",{attrs:{href:"https://github.com/chartjs/awesome#integrations",target:"_blank",rel:"noopener noreferrer"}},[t._v("available integrations"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"script-tag"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#script-tag"}},[t._v("#")]),t._v(" Script Tag")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("path/to/chartjs/dist/chart.umd.js"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token script"}}),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token script"}},[a("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("h2",{attrs:{id:"bundlers-webpack-rollup-etc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bundlers-webpack-rollup-etc"}},[t._v("#")]),t._v(" Bundlers (Webpack, Rollup, etc.)")]),t._v(" "),a("p",[t._v("Chart.js is tree-shakeable, so it is necessary to import and register the controllers, elements, scales and plugins you are going to use.")]),t._v(" "),a("h3",{attrs:{id:"quick-start"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#quick-start"}},[t._v("#")]),t._v(" Quick start")]),t._v(" "),a("p",[t._v("If you don't care about the bundle size, you can use the "),a("code",[t._v("auto")]),t._v(" package ensuring all features are available:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Chart "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/auto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"bundle-optimization"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bundle-optimization"}},[t._v("#")]),t._v(" Bundle optimization")]),t._v(" "),a("p",[t._v("When optimizing the bundle, you need to import and register the components that are needed in your application.")]),t._v(" "),a("p",[t._v("The options are categorized into controllers, elements, plugins, scales. You can pick and choose many of these, e.g. if you are not going to use tooltips, don't import and register the "),a("code",[t._v("Tooltip")]),t._v(" plugin. But each type of chart has its own bare-minimum requirements (typically the type's controller, element(s) used by that controller and scale(s)):")]),t._v(" "),a("ul",[a("li",[t._v("Bar chart\n"),a("ul",[a("li",[a("code",[t._v("BarController")])]),t._v(" "),a("li",[a("code",[t._v("BarElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("CategoryScale")]),t._v(" (x), "),a("code",[t._v("LinearScale")]),t._v(" (y)")])])]),t._v(" "),a("li",[t._v("Bubble chart\n"),a("ul",[a("li",[a("code",[t._v("BubbleController")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("LinearScale")]),t._v(" (x/y)")])])]),t._v(" "),a("li",[t._v("Doughnut chart\n"),a("ul",[a("li",[a("code",[t._v("DoughnutController")])]),t._v(" "),a("li",[a("code",[t._v("ArcElement")])]),t._v(" "),a("li",[t._v("Not using scales")])])]),t._v(" "),a("li",[t._v("Line chart\n"),a("ul",[a("li",[a("code",[t._v("LineController")])]),t._v(" "),a("li",[a("code",[t._v("LineElement")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("CategoryScale")]),t._v(" (x), "),a("code",[t._v("LinearScale")]),t._v(" (y)")])])]),t._v(" "),a("li",[t._v("Pie chart\n"),a("ul",[a("li",[a("code",[t._v("PieController")])]),t._v(" "),a("li",[a("code",[t._v("ArcElement")])]),t._v(" "),a("li",[t._v("Not using scales")])])]),t._v(" "),a("li",[t._v("PolarArea chart\n"),a("ul",[a("li",[a("code",[t._v("PolarAreaController")])]),t._v(" "),a("li",[a("code",[t._v("ArcElement")])]),t._v(" "),a("li",[t._v("Default scale: "),a("code",[t._v("RadialLinearScale")]),t._v(" (r)")])])]),t._v(" "),a("li",[t._v("Radar chart\n"),a("ul",[a("li",[a("code",[t._v("RadarController")])]),t._v(" "),a("li",[a("code",[t._v("LineElement")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scale: "),a("code",[t._v("RadialLinearScale")]),t._v(" (r)")])])]),t._v(" "),a("li",[t._v("Scatter chart\n"),a("ul",[a("li",[a("code",[t._v("ScatterController")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("LinearScale")]),t._v(" (x/y)")])])])]),t._v(" "),a("p",[t._v("Available plugins:")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[a("code",[t._v("Decimation")])])],1),t._v(" "),a("li",[a("code",[t._v("Filler")]),t._v(" - used to fill area described by "),a("code",[t._v("LineElement")]),t._v(", see "),a("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("Area charts")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/legend.html"}},[a("code",[t._v("Legend")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/subtitle.html"}},[a("code",[t._v("SubTitle")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/title.html"}},[a("code",[t._v("Title")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[a("code",[t._v("Tooltip")])])],1)]),t._v(" "),a("p",[t._v("Available scales:")]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Cartesian scales (x/y)")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/category.html"}},[a("code",[t._v("CategoryScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/linear.html"}},[a("code",[t._v("LinearScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/logarithmic.html"}},[a("code",[t._v("LogarithmicScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[a("code",[t._v("TimeScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/timeseries.html"}},[a("code",[t._v("TimeSeriesScale")])])],1)])]),t._v(" "),a("li",[a("p",[t._v("Radial scales (r)")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[a("code",[t._v("RadialLinearScale")])])],1)])])]),t._v(" "),a("h3",{attrs:{id:"helper-functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#helper-functions"}},[t._v("#")]),t._v(" Helper functions")]),t._v(" "),a("p",[t._v("If you want to use the helper functions, you will need to import these separately from the helpers package and use them as stand-alone functions.")]),t._v(" "),a("p",[t._v("Example of "),a("RouterLink",{attrs:{to:"/configuration/interactions.html#converting-events-to-data-values"}},[t._v("Converting Events to Data Values")]),t._v(" using bundlers.")],1),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Chart "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/auto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" getRelativePosition "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/helpers'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onClick")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" canvasPosition "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRelativePosition")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Substitute the appropriate scale IDs")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataX "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataY "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"commonjs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#commonjs"}},[t._v("#")]),t._v(" CommonJS")]),t._v(" "),a("p",[t._v("Because Chart.js is an ESM library, in CommonJS modules you should use a dynamic "),a("code",[t._v("import")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Chart "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"requirejs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#requirejs"}},[t._v("#")]),t._v(" RequireJS")]),t._v(" "),a("p",[a("strong",[t._v("Important:")]),t._v(" RequireJS can load only "),a("a",{attrs:{href:"https://requirejs.org/docs/whyamd.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("AMD modules"),a("OutboundLink")],1),t._v(", so be sure to require one of the UMD builds instead (i.e. "),a("code",[t._v("dist/chart.umd.js")]),t._v(").")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/chartjs/dist/chart.umd.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("In order to use the time scale, you need to make sure "),a("a",{attrs:{href:"https://github.com/chartjs/awesome#adapters",target:"_blank",rel:"noopener noreferrer"}},[t._v("one of the available date adapters"),a("OutboundLink")],1),t._v(" and corresponding date library are fully loaded "),a("strong",[t._v("after")]),t._v(" requiring Chart.js. For this you can use nested requires:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'moment'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-adapter-moment'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[184],{519:function(t,a,s){"use strict";s.r(a);var e=s(3),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"integration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#integration"}},[t._v("#")]),t._v(" Integration")]),t._v(" "),a("p",[t._v("Chart.js can be integrated with plain JavaScript or with different module loaders. The examples below show how to load Chart.js in different systems.")]),t._v(" "),a("p",[t._v("If you're using a front-end framework (e.g., React, Angular, or Vue), please see "),a("a",{attrs:{href:"https://github.com/chartjs/awesome#integrations",target:"_blank",rel:"noopener noreferrer"}},[t._v("available integrations"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"script-tag"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#script-tag"}},[t._v("#")]),t._v(" Script Tag")]),t._v(" "),a("div",{staticClass:"language-html extra-class"},[a("pre",{pre:!0,attrs:{class:"language-html"}},[a("code",[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("src")]),a("span",{pre:!0,attrs:{class:"token attr-value"}},[a("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("path/to/chartjs/dist/chart.umd.js"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token script"}}),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("script")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),a("span",{pre:!0,attrs:{class:"token script"}},[a("span",{pre:!0,attrs:{class:"token language-javascript"}},[t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])]),a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token tag"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n")])])]),a("h2",{attrs:{id:"bundlers-webpack-rollup-etc"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bundlers-webpack-rollup-etc"}},[t._v("#")]),t._v(" Bundlers (Webpack, Rollup, etc.)")]),t._v(" "),a("p",[t._v("Chart.js is tree-shakeable, so it is necessary to import and register the controllers, elements, scales and plugins you are going to use.")]),t._v(" "),a("h3",{attrs:{id:"quick-start"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#quick-start"}},[t._v("#")]),t._v(" Quick start")]),t._v(" "),a("p",[t._v("If you don't care about the bundle size, you can use the "),a("code",[t._v("auto")]),t._v(" package ensuring all features are available:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Chart "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/auto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h3",{attrs:{id:"bundle-optimization"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#bundle-optimization"}},[t._v("#")]),t._v(" Bundle optimization")]),t._v(" "),a("p",[t._v("When optimizing the bundle, you need to import and register the components that are needed in your application.")]),t._v(" "),a("p",[t._v("The options are categorized into controllers, elements, plugins, scales. You can pick and choose many of these, e.g. if you are not going to use tooltips, don't import and register the "),a("code",[t._v("Tooltip")]),t._v(" plugin. But each type of chart has its own bare-minimum requirements (typically the type's controller, element(s) used by that controller and scale(s)):")]),t._v(" "),a("ul",[a("li",[t._v("Bar chart\n"),a("ul",[a("li",[a("code",[t._v("BarController")])]),t._v(" "),a("li",[a("code",[t._v("BarElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("CategoryScale")]),t._v(" (x), "),a("code",[t._v("LinearScale")]),t._v(" (y)")])])]),t._v(" "),a("li",[t._v("Bubble chart\n"),a("ul",[a("li",[a("code",[t._v("BubbleController")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("LinearScale")]),t._v(" (x/y)")])])]),t._v(" "),a("li",[t._v("Doughnut chart\n"),a("ul",[a("li",[a("code",[t._v("DoughnutController")])]),t._v(" "),a("li",[a("code",[t._v("ArcElement")])]),t._v(" "),a("li",[t._v("Not using scales")])])]),t._v(" "),a("li",[t._v("Line chart\n"),a("ul",[a("li",[a("code",[t._v("LineController")])]),t._v(" "),a("li",[a("code",[t._v("LineElement")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("CategoryScale")]),t._v(" (x), "),a("code",[t._v("LinearScale")]),t._v(" (y)")])])]),t._v(" "),a("li",[t._v("Pie chart\n"),a("ul",[a("li",[a("code",[t._v("PieController")])]),t._v(" "),a("li",[a("code",[t._v("ArcElement")])]),t._v(" "),a("li",[t._v("Not using scales")])])]),t._v(" "),a("li",[t._v("PolarArea chart\n"),a("ul",[a("li",[a("code",[t._v("PolarAreaController")])]),t._v(" "),a("li",[a("code",[t._v("ArcElement")])]),t._v(" "),a("li",[t._v("Default scale: "),a("code",[t._v("RadialLinearScale")]),t._v(" (r)")])])]),t._v(" "),a("li",[t._v("Radar chart\n"),a("ul",[a("li",[a("code",[t._v("RadarController")])]),t._v(" "),a("li",[a("code",[t._v("LineElement")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scale: "),a("code",[t._v("RadialLinearScale")]),t._v(" (r)")])])]),t._v(" "),a("li",[t._v("Scatter chart\n"),a("ul",[a("li",[a("code",[t._v("ScatterController")])]),t._v(" "),a("li",[a("code",[t._v("PointElement")])]),t._v(" "),a("li",[t._v("Default scales: "),a("code",[t._v("LinearScale")]),t._v(" (x/y)")])])])]),t._v(" "),a("p",[t._v("Available plugins:")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[a("code",[t._v("Decimation")])])],1),t._v(" "),a("li",[a("code",[t._v("Filler")]),t._v(" - used to fill area described by "),a("code",[t._v("LineElement")]),t._v(", see "),a("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("Area charts")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/legend.html"}},[a("code",[t._v("Legend")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/subtitle.html"}},[a("code",[t._v("SubTitle")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/title.html"}},[a("code",[t._v("Title")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[a("code",[t._v("Tooltip")])])],1)]),t._v(" "),a("p",[t._v("Available scales:")]),t._v(" "),a("ul",[a("li",[a("p",[t._v("Cartesian scales (x/y)")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/category.html"}},[a("code",[t._v("CategoryScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/linear.html"}},[a("code",[t._v("LinearScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/logarithmic.html"}},[a("code",[t._v("LogarithmicScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[a("code",[t._v("TimeScale")])])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/cartesian/timeseries.html"}},[a("code",[t._v("TimeSeriesScale")])])],1)])]),t._v(" "),a("li",[a("p",[t._v("Radial scales (r)")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[a("code",[t._v("RadialLinearScale")])])],1)])])]),t._v(" "),a("h3",{attrs:{id:"helper-functions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#helper-functions"}},[t._v("#")]),t._v(" Helper functions")]),t._v(" "),a("p",[t._v("If you want to use the helper functions, you will need to import these separately from the helpers package and use them as stand-alone functions.")]),t._v(" "),a("p",[t._v("Example of "),a("RouterLink",{attrs:{to:"/configuration/interactions.html#converting-events-to-data-values"}},[t._v("Converting Events to Data Values")]),t._v(" using bundlers.")],1),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" Chart "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/auto'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" getRelativePosition "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js/helpers'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" chart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("type")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'line'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("data")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" data"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("options")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("onClick")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" canvasPosition "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getRelativePosition")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("e"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Substitute the appropriate scale IDs")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataX "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("x"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" dataY "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" chart"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("scales"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("canvasPosition"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("y"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"commonjs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#commonjs"}},[t._v("#")]),t._v(" CommonJS")]),t._v(" "),a("p",[t._v("Because Chart.js is an ESM library, in CommonJS modules you should use a dynamic "),a("code",[t._v("import")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" Chart "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("await")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("h2",{attrs:{id:"requirejs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#requirejs"}},[t._v("#")]),t._v(" RequireJS")]),t._v(" "),a("p",[a("strong",[t._v("Important:")]),t._v(" RequireJS can load only "),a("a",{attrs:{href:"https://requirejs.org/docs/whyamd.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("AMD modules"),a("OutboundLink")],1),t._v(", so be sure to require one of the UMD builds instead (i.e. "),a("code",[t._v("dist/chart.umd.js")]),t._v(").")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'path/to/chartjs/dist/chart.umd.js'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" myChart "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Note")]),t._v(" "),a("p",[t._v("In order to use the time scale, you need to make sure "),a("a",{attrs:{href:"https://github.com/chartjs/awesome#adapters",target:"_blank",rel:"noopener noreferrer"}},[t._v("one of the available date adapters"),a("OutboundLink")],1),t._v(" and corresponding date library are fully loaded "),a("strong",[t._v("after")]),t._v(" requiring Chart.js. For this you can use nested requires:")]),t._v(" "),a("div",{staticClass:"language-javascript extra-class"},[a("pre",{pre:!0,attrs:{class:"language-javascript"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'moment'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-adapter-moment'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Chart")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("ctx"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("...")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/185.6c133733.js b/docs/master/assets/js/185.cc5cd307.js similarity index 99% rename from docs/master/assets/js/185.6c133733.js rename to docs/master/assets/js/185.cc5cd307.js index 06de20fdc3..65a7c83aee 100644 --- a/docs/master/assets/js/185.6c133733.js +++ b/docs/master/assets/js/185.cc5cd307.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[185],{519:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"chart-js"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart-js"}},[t._v("#")]),t._v(" Chart.js")]),t._v(" "),e("p",[t._v("Welcome to Chart.js!")]),t._v(" "),e("ul",[e("li",[e("strong",[e("RouterLink",{attrs:{to:"/getting-started/"}},[t._v("Get started with Chart.js")]),t._v(" — best if you're new to Chart.js")],1)]),t._v(" "),e("li",[t._v("Migrate from "),e("RouterLink",{attrs:{to:"/migration/v4-migration.html"}},[t._v("Chart.js v3")]),t._v(" or "),e("RouterLink",{attrs:{to:"/migration/v3-migration.html"}},[t._v("Chart.js v2")])],1),t._v(" "),e("li",[t._v("Join the community on "),e("a",{attrs:{href:"https://discord.gg/HxEguTK6av",target:"_blank",rel:"noopener noreferrer"}},[t._v("Discord"),e("OutboundLink")],1),t._v(" and "),e("a",{attrs:{href:"https://twitter.com/chartjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("Twitter"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Post a question tagged with "),e("code",[t._v("chart.js")]),t._v(" on "),e("a",{attrs:{href:"https://stackoverflow.com/questions/tagged/chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("Stack Overflow"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/developers/contributing.html"}},[t._v("Contribute to Chart.js")])],1)]),t._v(" "),e("h2",{attrs:{id:"why-chart-js"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#why-chart-js"}},[t._v("#")]),t._v(" Why Chart.js")]),t._v(" "),e("p",[t._v("Among "),e("a",{attrs:{href:"https://awesome.cube.dev/?tools=charts&ref=eco-chartjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("many charting libraries"),e("OutboundLink")],1),t._v(" for JavaScript application developers, Chart.js is currently the most popular one according to "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub stars"),e("OutboundLink")],1),t._v(" (~60,000) and "),e("a",{attrs:{href:"https://www.npmjs.com/package/chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("npm downloads"),e("OutboundLink")],1),t._v(" (~2,400,000 weekly).")]),t._v(" "),e("p",[t._v("Chart.js was created and "),e("a",{attrs:{href:"https://twitter.com/_nnnick/status/313599208387137536",target:"_blank",rel:"noopener noreferrer"}},[t._v("announced"),e("OutboundLink")],1),t._v(" in 2013 but has come a long way since then. It’s open-source, licensed under the very permissive "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/LICENSE.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("MIT license"),e("OutboundLink")],1),t._v(", and maintained by an active community.")]),t._v(" "),e("h3",{attrs:{id:"features"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#features"}},[t._v("#")]),t._v(" Features")]),t._v(" "),e("p",[t._v("Chart.js provides a set of frequently used chart types, plugins, and customization options. In addition to a reasonable set of "),e("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("built-in chart types")]),t._v(", you can use additional community-maintained "),e("a",{attrs:{href:"https://github.com/chartjs/awesome#charts",target:"_blank",rel:"noopener noreferrer"}},[t._v("chart types"),e("OutboundLink")],1),t._v(". On top of that, it’s possible to combine several chart types into a "),e("RouterLink",{attrs:{to:"/charts/mixed.html"}},[t._v("mixed chart")]),t._v(" (essentially, blending multiple chart types into one on the same canvas).")],1),t._v(" "),e("p",[t._v("Chart.js is highly customizable with "),e("a",{attrs:{href:"https://github.com/chartjs/awesome#plugins",target:"_blank",rel:"noopener noreferrer"}},[t._v("custom plugins"),e("OutboundLink")],1),t._v(" to create annotations, zoom, or drag-and-drop functionalities to name a few things.")]),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" Defaults")]),t._v(" "),e("p",[t._v("Chart.js comes with a sound default configuration, making it very easy to start with and get an app that is ready for production. Chances are you will get a very appealing chart even if you don’t specify any options at all. For instance, Chart.js has animations turned on by default, so you can instantly bring attention to the story you’re telling with the data.")]),t._v(" "),e("h3",{attrs:{id:"integrations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrations"}},[t._v("#")]),t._v(" Integrations")]),t._v(" "),e("p",[t._v("Chart.js comes with built-in TypeScript typings and is compatible with all popular "),e("a",{attrs:{href:"https://github.com/chartjs/awesome#javascript",target:"_blank",rel:"noopener noreferrer"}},[t._v("JavaScript frameworks"),e("OutboundLink")],1),t._v(" including "),e("a",{attrs:{href:"https://github.com/reactchartjs/react-chartjs-2",target:"_blank",rel:"noopener noreferrer"}},[t._v("React"),e("OutboundLink")],1),t._v(", "),e("a",{attrs:{href:"https://github.com/apertureless/vue-chartjs/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vue"),e("OutboundLink")],1),t._v(", "),e("a",{attrs:{href:"https://github.com/SauravKanchan/svelte-chartjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("Svelte"),e("OutboundLink")],1),t._v(", and "),e("a",{attrs:{href:"https://github.com/valor-software/ng2-charts",target:"_blank",rel:"noopener noreferrer"}},[t._v("Angular"),e("OutboundLink")],1),t._v(". You can use Chart.js directly or leverage well-maintained wrapper packages that allow for a more native integration with your frameworks of choice.")]),t._v(" "),e("h3",{attrs:{id:"developer-experience"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#developer-experience"}},[t._v("#")]),t._v(" Developer experience")]),t._v(" "),e("p",[t._v("Chart.js has very thorough documentation (yes, you're reading it), "),e("RouterLink",{attrs:{to:"/api/"}},[t._v("API reference")]),t._v(", and "),e("RouterLink",{attrs:{to:"/samples/information.html"}},[t._v("examples")]),t._v(". Maintainers and community members eagerly engage in conversations on "),e("a",{attrs:{href:"https://discord.gg/HxEguTK6av",target:"_blank",rel:"noopener noreferrer"}},[t._v("Discord"),e("OutboundLink")],1),t._v(", "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/discussions",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub Discussions"),e("OutboundLink")],1),t._v(", and "),e("a",{attrs:{href:"https://stackoverflow.com/questions/tagged/chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("Stack Overflow"),e("OutboundLink")],1),t._v(" where more than 11,000 questions are tagged with "),e("code",[t._v("chart.js")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"canvas-rendering"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#canvas-rendering"}},[t._v("#")]),t._v(" Canvas rendering")]),t._v(" "),e("p",[t._v("Chart.js renders chart elements on an HTML5 canvas unlike several others, mostly D3.js-based, charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. At the same time, canvas rendering disallows CSS styling, so you will have to use built-in options for that, or create a custom plugin or chart type to render everything to your liking.")]),t._v(" "),e("h3",{attrs:{id:"performance"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#performance"}},[t._v("#")]),t._v(" Performance")]),t._v(" "),e("p",[t._v("Chart.js is very well suited for large datasets. Such datasets can be efficiently ingested using the internal format, so you can skip data "),e("RouterLink",{attrs:{to:"/general/performance.html#parsing"}},[t._v("parsing")]),t._v(" and "),e("RouterLink",{attrs:{to:"/general/performance.html#data-normalization"}},[t._v("normalization")]),t._v(". Alternatively, "),e("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[t._v("data decimation")]),t._v(" can be configured to sample the dataset and reduce its size before rendering.")],1),t._v(" "),e("p",[t._v("In the end, the canvas rendering that Chart.js uses reduces the toll on your DOM tree in comparison to SVG rendering. Also, tree-shaking support allows you to include minimal parts of Chart.js code in your bundle, reducing bundle size and page load time.")]),t._v(" "),e("h3",{attrs:{id:"community"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#community"}},[t._v("#")]),t._v(" Community")]),t._v(" "),e("p",[t._v("Chart.js is "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/pulls?q=is%3Apr+is%3Aclosed",target:"_blank",rel:"noopener noreferrer"}},[t._v("actively developed"),e("OutboundLink")],1),t._v(" and maintained by the community. With minor "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/releases",target:"_blank",rel:"noopener noreferrer"}},[t._v("releases"),e("OutboundLink")],1),t._v(" on an approximately bi-monthly basis and major releases with breaking changes every couple of years, Chart.js keeps the balance between adding new features and making it a hassle to keep up with them.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[185],{521:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"chart-js"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart-js"}},[t._v("#")]),t._v(" Chart.js")]),t._v(" "),e("p",[t._v("Welcome to Chart.js!")]),t._v(" "),e("ul",[e("li",[e("strong",[e("RouterLink",{attrs:{to:"/getting-started/"}},[t._v("Get started with Chart.js")]),t._v(" — best if you're new to Chart.js")],1)]),t._v(" "),e("li",[t._v("Migrate from "),e("RouterLink",{attrs:{to:"/migration/v4-migration.html"}},[t._v("Chart.js v3")]),t._v(" or "),e("RouterLink",{attrs:{to:"/migration/v3-migration.html"}},[t._v("Chart.js v2")])],1),t._v(" "),e("li",[t._v("Join the community on "),e("a",{attrs:{href:"https://discord.gg/HxEguTK6av",target:"_blank",rel:"noopener noreferrer"}},[t._v("Discord"),e("OutboundLink")],1),t._v(" and "),e("a",{attrs:{href:"https://twitter.com/chartjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("Twitter"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Post a question tagged with "),e("code",[t._v("chart.js")]),t._v(" on "),e("a",{attrs:{href:"https://stackoverflow.com/questions/tagged/chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("Stack Overflow"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/developers/contributing.html"}},[t._v("Contribute to Chart.js")])],1)]),t._v(" "),e("h2",{attrs:{id:"why-chart-js"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#why-chart-js"}},[t._v("#")]),t._v(" Why Chart.js")]),t._v(" "),e("p",[t._v("Among "),e("a",{attrs:{href:"https://awesome.cube.dev/?tools=charts&ref=eco-chartjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("many charting libraries"),e("OutboundLink")],1),t._v(" for JavaScript application developers, Chart.js is currently the most popular one according to "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub stars"),e("OutboundLink")],1),t._v(" (~60,000) and "),e("a",{attrs:{href:"https://www.npmjs.com/package/chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("npm downloads"),e("OutboundLink")],1),t._v(" (~2,400,000 weekly).")]),t._v(" "),e("p",[t._v("Chart.js was created and "),e("a",{attrs:{href:"https://twitter.com/_nnnick/status/313599208387137536",target:"_blank",rel:"noopener noreferrer"}},[t._v("announced"),e("OutboundLink")],1),t._v(" in 2013 but has come a long way since then. It’s open-source, licensed under the very permissive "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/LICENSE.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("MIT license"),e("OutboundLink")],1),t._v(", and maintained by an active community.")]),t._v(" "),e("h3",{attrs:{id:"features"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#features"}},[t._v("#")]),t._v(" Features")]),t._v(" "),e("p",[t._v("Chart.js provides a set of frequently used chart types, plugins, and customization options. In addition to a reasonable set of "),e("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("built-in chart types")]),t._v(", you can use additional community-maintained "),e("a",{attrs:{href:"https://github.com/chartjs/awesome#charts",target:"_blank",rel:"noopener noreferrer"}},[t._v("chart types"),e("OutboundLink")],1),t._v(". On top of that, it’s possible to combine several chart types into a "),e("RouterLink",{attrs:{to:"/charts/mixed.html"}},[t._v("mixed chart")]),t._v(" (essentially, blending multiple chart types into one on the same canvas).")],1),t._v(" "),e("p",[t._v("Chart.js is highly customizable with "),e("a",{attrs:{href:"https://github.com/chartjs/awesome#plugins",target:"_blank",rel:"noopener noreferrer"}},[t._v("custom plugins"),e("OutboundLink")],1),t._v(" to create annotations, zoom, or drag-and-drop functionalities to name a few things.")]),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" Defaults")]),t._v(" "),e("p",[t._v("Chart.js comes with a sound default configuration, making it very easy to start with and get an app that is ready for production. Chances are you will get a very appealing chart even if you don’t specify any options at all. For instance, Chart.js has animations turned on by default, so you can instantly bring attention to the story you’re telling with the data.")]),t._v(" "),e("h3",{attrs:{id:"integrations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrations"}},[t._v("#")]),t._v(" Integrations")]),t._v(" "),e("p",[t._v("Chart.js comes with built-in TypeScript typings and is compatible with all popular "),e("a",{attrs:{href:"https://github.com/chartjs/awesome#javascript",target:"_blank",rel:"noopener noreferrer"}},[t._v("JavaScript frameworks"),e("OutboundLink")],1),t._v(" including "),e("a",{attrs:{href:"https://github.com/reactchartjs/react-chartjs-2",target:"_blank",rel:"noopener noreferrer"}},[t._v("React"),e("OutboundLink")],1),t._v(", "),e("a",{attrs:{href:"https://github.com/apertureless/vue-chartjs/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Vue"),e("OutboundLink")],1),t._v(", "),e("a",{attrs:{href:"https://github.com/SauravKanchan/svelte-chartjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("Svelte"),e("OutboundLink")],1),t._v(", and "),e("a",{attrs:{href:"https://github.com/valor-software/ng2-charts",target:"_blank",rel:"noopener noreferrer"}},[t._v("Angular"),e("OutboundLink")],1),t._v(". You can use Chart.js directly or leverage well-maintained wrapper packages that allow for a more native integration with your frameworks of choice.")]),t._v(" "),e("h3",{attrs:{id:"developer-experience"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#developer-experience"}},[t._v("#")]),t._v(" Developer experience")]),t._v(" "),e("p",[t._v("Chart.js has very thorough documentation (yes, you're reading it), "),e("RouterLink",{attrs:{to:"/api/"}},[t._v("API reference")]),t._v(", and "),e("RouterLink",{attrs:{to:"/samples/information.html"}},[t._v("examples")]),t._v(". Maintainers and community members eagerly engage in conversations on "),e("a",{attrs:{href:"https://discord.gg/HxEguTK6av",target:"_blank",rel:"noopener noreferrer"}},[t._v("Discord"),e("OutboundLink")],1),t._v(", "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/discussions",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub Discussions"),e("OutboundLink")],1),t._v(", and "),e("a",{attrs:{href:"https://stackoverflow.com/questions/tagged/chart.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("Stack Overflow"),e("OutboundLink")],1),t._v(" where more than 11,000 questions are tagged with "),e("code",[t._v("chart.js")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"canvas-rendering"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#canvas-rendering"}},[t._v("#")]),t._v(" Canvas rendering")]),t._v(" "),e("p",[t._v("Chart.js renders chart elements on an HTML5 canvas unlike several others, mostly D3.js-based, charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. At the same time, canvas rendering disallows CSS styling, so you will have to use built-in options for that, or create a custom plugin or chart type to render everything to your liking.")]),t._v(" "),e("h3",{attrs:{id:"performance"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#performance"}},[t._v("#")]),t._v(" Performance")]),t._v(" "),e("p",[t._v("Chart.js is very well suited for large datasets. Such datasets can be efficiently ingested using the internal format, so you can skip data "),e("RouterLink",{attrs:{to:"/general/performance.html#parsing"}},[t._v("parsing")]),t._v(" and "),e("RouterLink",{attrs:{to:"/general/performance.html#data-normalization"}},[t._v("normalization")]),t._v(". Alternatively, "),e("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[t._v("data decimation")]),t._v(" can be configured to sample the dataset and reduce its size before rendering.")],1),t._v(" "),e("p",[t._v("In the end, the canvas rendering that Chart.js uses reduces the toll on your DOM tree in comparison to SVG rendering. Also, tree-shaking support allows you to include minimal parts of Chart.js code in your bundle, reducing bundle size and page load time.")]),t._v(" "),e("h3",{attrs:{id:"community"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#community"}},[t._v("#")]),t._v(" Community")]),t._v(" "),e("p",[t._v("Chart.js is "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/pulls?q=is%3Apr+is%3Aclosed",target:"_blank",rel:"noopener noreferrer"}},[t._v("actively developed"),e("OutboundLink")],1),t._v(" and maintained by the community. With minor "),e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/releases",target:"_blank",rel:"noopener noreferrer"}},[t._v("releases"),e("OutboundLink")],1),t._v(" on an approximately bi-monthly basis and major releases with breaking changes every couple of years, Chart.js keeps the balance between adding new features and making it a hassle to keep up with them.")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/186.59dec33d.js b/docs/master/assets/js/186.b2471650.js similarity index 99% rename from docs/master/assets/js/186.59dec33d.js rename to docs/master/assets/js/186.b2471650.js index b2b352497c..6259cbf737 100644 --- a/docs/master/assets/js/186.59dec33d.js +++ b/docs/master/assets/js/186.b2471650.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[186],{521:function(e,t,a){"use strict";a.r(t);var o=a(3),s=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"_3-x-migration-guide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_3-x-migration-guide"}},[e._v("#")]),e._v(" 3.x Migration Guide")]),e._v(" "),t("p",[e._v("Chart.js 3.0 introduces a number of breaking changes. Chart.js 2.0 was released in April 2016. In the years since then, as Chart.js has grown in popularity and feature set, we've learned some lessons about how to better create a charting library. In order to improve performance, offer new features, and improve maintainability, it was necessary to break backwards compatibility, but we aimed to do so only when worth the benefit. Some major highlights of v3 include:")]),e._v(" "),t("ul",[t("li",[e._v("Large "),t("RouterLink",{attrs:{to:"/general/performance.html"}},[e._v("performance")]),e._v(" improvements including the ability to skip data parsing and render charts in parallel via webworkers")],1),e._v(" "),t("li",[e._v("Additional configurability and scriptable options with better defaults")]),e._v(" "),t("li",[e._v("Completely rewritten animation system")]),e._v(" "),t("li",[e._v("Rewritten filler plugin with numerous bug fixes")]),e._v(" "),t("li",[e._v("Documentation migrated from GitBook to Vuepress")]),e._v(" "),t("li",[e._v("API documentation generated and verified by TypeDoc")]),e._v(" "),t("li",[e._v("No more CSS injection")]),e._v(" "),t("li",[e._v("Tons of bug fixes")]),e._v(" "),t("li",[e._v("Tree shaking")])]),e._v(" "),t("h2",{attrs:{id:"end-user-migration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#end-user-migration"}},[e._v("#")]),e._v(" End user migration")]),e._v(" "),t("h3",{attrs:{id:"setup-and-installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setup-and-installation"}},[e._v("#")]),e._v(" Setup and installation")]),e._v(" "),t("ul",[t("li",[e._v("Distributed files are now in lower case. For example: "),t("code",[e._v("dist/chart.js")]),e._v(".")]),e._v(" "),t("li",[e._v("Chart.js is no longer providing the "),t("code",[e._v("Chart.bundle.js")]),e._v(" and "),t("code",[e._v("Chart.bundle.min.js")]),e._v(". Please see the "),t("RouterLink",{attrs:{to:"/getting-started/installation.html"}},[e._v("installation")]),e._v(" and "),t("RouterLink",{attrs:{to:"/getting-started/integration.html"}},[e._v("integration")]),e._v(" docs for details on the recommended way to setup Chart.js if you were using these builds.")],1),e._v(" "),t("li",[t("code",[e._v("moment")]),e._v(" is no longer specified as an npm dependency. If you are using the "),t("code",[e._v("time")]),e._v(" or "),t("code",[e._v("timeseries")]),e._v(" scales, you must include one of "),t("a",{attrs:{href:"https://github.com/chartjs/awesome#adapters",target:"_blank",rel:"noopener noreferrer"}},[e._v("the available adapters"),t("OutboundLink")],1),e._v(" and corresponding date library. You no longer need to exclude moment from your build.")]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("Chart")]),e._v(" constructor will throw an error if the canvas/context provided is already in use")]),e._v(" "),t("li",[e._v("Chart.js 3 is tree-shakeable. So if you are using it as an "),t("code",[e._v("npm")]),e._v(" module in a project and want to make use of this feature, you need to import and register the controllers, elements, scales and plugins you want to use, for a list of all the available items to import see "),t("RouterLink",{attrs:{to:"/getting-started/integration.html#bundlers-webpack-rollup-etc"}},[e._v("integration")]),e._v(". You will not have to call "),t("code",[e._v("register")]),e._v(" if importing Chart.js via a "),t("code",[e._v("script")]),e._v(" tag or from the "),t("RouterLink",{attrs:{to:"/getting-started/integration.html#bundlers-webpack-rollup-etc"}},[t("code",[e._v("auto")])]),e._v(" register path as an "),t("code",[e._v("npm")]),e._v(" module, in this case you will not get the tree shaking benefits. Here is an example of registering components:")],1)]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("import")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" Chart"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LineController"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LineElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" PointElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LinearScale"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" Title "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("from")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token template-string"}},[t("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[e._v("`")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("chart.js")]),t("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[e._v("`")])]),e._v("\n\nChart"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("register")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("LineController"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LineElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" PointElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LinearScale"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" Title"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("const")]),e._v(" chart "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("new")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[e._v("Chart")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("ctx"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'line'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("// data: ...")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("options")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("plugins")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'Chart Title'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("scales")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("x")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'linear'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("y")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'linear'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("h3",{attrs:{id:"chart-types"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#chart-types"}},[e._v("#")]),e._v(" Chart types")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("horizontalBar")]),e._v(" chart type was removed. Horizontal bar charts can be configured using the new "),t("RouterLink",{attrs:{to:"/charts/bar.html#horizontal-bar-chart"}},[t("code",[e._v("indexAxis")])]),e._v(" option")],1)]),e._v(" "),t("h3",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("A number of changes were made to the configuration options passed to the "),t("code",[e._v("Chart")]),e._v(" constructor. Those changes are documented below.")]),e._v(" "),t("h4",{attrs:{id:"generic-changes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generic-changes"}},[e._v("#")]),e._v(" Generic changes")]),e._v(" "),t("ul",[t("li",[e._v("Indexable options are now looping. "),t("code",[e._v("backgroundColor: ['red', 'green']")]),e._v(" will result in alternating "),t("code",[e._v("'red'")]),e._v(" / "),t("code",[e._v("'green'")]),e._v(" if there are more than 2 data points.")]),e._v(" "),t("li",[e._v("The input properties of object data can now be freely specified, see "),t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[e._v("data structures")]),e._v(" for details.")],1),e._v(" "),t("li",[e._v("Most options are resolved utilizing proxies, instead of merging with defaults. In addition to easily enabling different resolution routes for different contexts, it allows using other resolved options in scriptable options.\n"),t("ul",[t("li",[e._v("Options are by default scriptable and indexable, unless disabled for some reason.")]),e._v(" "),t("li",[e._v("Scriptable options receive a option resolver as second parameter for accessing other options in same context.")]),e._v(" "),t("li",[e._v("Resolution falls to upper scopes, if no match is found earlier. See "),t("RouterLink",{attrs:{to:"/general/options.html"}},[e._v("options")]),e._v(" for details.")],1)])])]),e._v(" "),t("h4",{attrs:{id:"specific-changes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#specific-changes"}},[e._v("#")]),e._v(" Specific changes")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("elements.rectangle")]),e._v(" is now "),t("code",[e._v("elements.bar")])]),e._v(" "),t("li",[t("code",[e._v("hover.animationDuration")]),e._v(" is now configured in "),t("code",[e._v("animation.active.duration")])]),e._v(" "),t("li",[t("code",[e._v("responsiveAnimationDuration")]),e._v(" is now configured in "),t("code",[e._v("animation.resize.duration")])]),e._v(" "),t("li",[e._v("Polar area "),t("code",[e._v("elements.arc.angle")]),e._v(" is now configured in degrees instead of radians.")]),e._v(" "),t("li",[e._v("Polar area "),t("code",[e._v("startAngle")]),e._v(" option is now consistent with "),t("code",[e._v("Radar")]),e._v(", 0 is at top and value is in degrees. Default is changed from "),t("code",[e._v("-½π")]),e._v(" to "),t("code",[e._v("0")]),e._v(".")]),e._v(" "),t("li",[e._v("Doughnut "),t("code",[e._v("rotation")]),e._v(" option is now in degrees and 0 is at top. Default is changed from "),t("code",[e._v("-½π")]),e._v(" to "),t("code",[e._v("0")]),e._v(".")]),e._v(" "),t("li",[e._v("Doughnut "),t("code",[e._v("circumference")]),e._v(" option is now in degrees. Default is changed from "),t("code",[e._v("2π")]),e._v(" to "),t("code",[e._v("360")]),e._v(".")]),e._v(" "),t("li",[e._v("Doughnut "),t("code",[e._v("cutoutPercentage")]),e._v(" was renamed to "),t("code",[e._v("cutout")]),e._v("and accepts pixels as number and percent as string ending with "),t("code",[e._v("%")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("scale")]),e._v(" option was removed in favor of "),t("code",[e._v("options.scales.r")]),e._v(" (or any other scale id, with "),t("code",[e._v("axis: 'r'")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes")]),e._v(" arrays were removed. Scales are now configured directly to "),t("code",[e._v("options.scales")]),e._v(" object with the object key being the scale Id.")]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.barPercentage")]),e._v(" was moved to dataset option "),t("code",[e._v("barPercentage")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.barThickness")]),e._v(" was moved to dataset option "),t("code",[e._v("barThickness")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.categoryPercentage")]),e._v(" was moved to dataset option "),t("code",[e._v("categoryPercentage")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.maxBarThickness")]),e._v(" was moved to dataset option "),t("code",[e._v("maxBarThickness")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.minBarLength")]),e._v(" was moved to dataset option "),t("code",[e._v("minBarLength")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.scaleLabel")]),e._v(" was renamed to "),t("code",[e._v("scales[id].title")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.scaleLabel.labelString")]),e._v(" was renamed to "),t("code",[e._v("scales[id].title.text")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.beginAtZero")]),e._v(" was renamed to "),t("code",[e._v("scales[id].beginAtZero")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.max")]),e._v(" was renamed to "),t("code",[e._v("scales[id].max")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.min")]),e._v(" was renamed to "),t("code",[e._v("scales[id].min")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.reverse")]),e._v(" was renamed to "),t("code",[e._v("scales[id].reverse")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.suggestedMax")]),e._v(" was renamed to "),t("code",[e._v("scales[id].suggestedMax")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.suggestedMin")]),e._v(" was renamed to "),t("code",[e._v("scales[id].suggestedMin")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.unitStepSize")]),e._v(" was removed. Use "),t("code",[e._v("scales[id].ticks.stepSize")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.userCallback")]),e._v(" was renamed to "),t("code",[e._v("scales[id].ticks.callback")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.time.format")]),e._v(" was renamed to "),t("code",[e._v("scales[id].time.parser")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.time.max")]),e._v(" was renamed to "),t("code",[e._v("scales[id].max")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.time.min")]),e._v(" was renamed to "),t("code",[e._v("scales[id].min")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.zeroLine*")]),e._v(" options of axes were removed. Use scriptable scale options instead.")]),e._v(" "),t("li",[e._v("The dataset option "),t("code",[e._v("steppedLine")]),e._v(" was removed. Use "),t("code",[e._v("stepped")])]),e._v(" "),t("li",[e._v("The chart option "),t("code",[e._v("showLines")]),e._v(" was renamed to "),t("code",[e._v("showLine")]),e._v(" to match the dataset option.")]),e._v(" "),t("li",[e._v("The chart option "),t("code",[e._v("startAngle")]),e._v(" was moved to "),t("code",[e._v("radial")]),e._v(" scale options.")]),e._v(" "),t("li",[e._v("To override the platform class used in a chart instance, pass "),t("code",[e._v("platform: PlatformClass")]),e._v(" in the config object. Note that the class should be passed, not an instance of the class.")]),e._v(" "),t("li",[t("code",[e._v("aspectRatio")]),e._v(" defaults to 1 for doughnut, pie, polarArea, and radar charts")]),e._v(" "),t("li",[t("code",[e._v("TimeScale")]),e._v(" does not read "),t("code",[e._v("t")]),e._v(" from object data by default anymore. The default property is "),t("code",[e._v("x")]),e._v(" or "),t("code",[e._v("y")]),e._v(", depending on the orientation. See "),t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[e._v("data structures")]),e._v(" for details on how to change the default.")],1),e._v(" "),t("li",[t("code",[e._v("tooltips")]),e._v(" namespace was renamed to "),t("code",[e._v("tooltip")]),e._v(" to match the plugin name")]),e._v(" "),t("li",[t("code",[e._v("legend")]),e._v(", "),t("code",[e._v("title")]),e._v(" and "),t("code",[e._v("tooltip")]),e._v(" namespaces were moved from "),t("code",[e._v("options")]),e._v(" to "),t("code",[e._v("options.plugins")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("tooltips.custom")]),e._v(" was renamed to "),t("code",[e._v("plugins.tooltip.external")])])]),e._v(" "),t("h4",{attrs:{id:"defaults"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[e._v("#")]),e._v(" Defaults")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("global")]),e._v(" namespace was removed from "),t("code",[e._v("defaults")]),e._v(". So "),t("code",[e._v("Chart.defaults.global")]),e._v(" is now "),t("code",[e._v("Chart.defaults")])]),e._v(" "),t("li",[e._v("Dataset controller defaults were relocate to "),t("code",[e._v("overrides")]),e._v(". For example "),t("code",[e._v("Chart.defaults.line")]),e._v(" is now "),t("code",[e._v("Chart.overrides.line")])]),e._v(" "),t("li",[t("code",[e._v("default")]),e._v(" prefix was removed from defaults. For example "),t("code",[e._v("Chart.defaults.global.defaultColor")]),e._v(" is now "),t("code",[e._v("Chart.defaults.color")])]),e._v(" "),t("li",[t("code",[e._v("defaultColor")]),e._v(" was split to "),t("code",[e._v("color")]),e._v(", "),t("code",[e._v("borderColor")]),e._v(" and "),t("code",[e._v("backgroundColor")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontColor")]),e._v(" was renamed to "),t("code",[e._v("color")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontFamily")]),e._v(" was renamed to "),t("code",[e._v("font.family")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontSize")]),e._v(" was renamed to "),t("code",[e._v("font.size")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontStyle")]),e._v(" was renamed to "),t("code",[e._v("font.style")])]),e._v(" "),t("li",[t("code",[e._v("defaultLineHeight")]),e._v(" was renamed to "),t("code",[e._v("font.lineHeight")])]),e._v(" "),t("li",[e._v("Horizontal Bar default tooltip mode was changed from "),t("code",[e._v("'index'")]),e._v(" to "),t("code",[e._v("'nearest'")]),e._v(" to match vertical bar charts")]),e._v(" "),t("li",[t("code",[e._v("legend")]),e._v(", "),t("code",[e._v("title")]),e._v(" and "),t("code",[e._v("tooltip")]),e._v(" namespaces were moved from "),t("code",[e._v("Chart.defaults")]),e._v(" to "),t("code",[e._v("Chart.defaults.plugins")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("elements.line.fill")]),e._v(" default changed from "),t("code",[e._v("true")]),e._v(" to "),t("code",[e._v("false")]),e._v(".")]),e._v(" "),t("li",[e._v("Line charts no longer override the default "),t("code",[e._v("interaction")]),e._v(" mode. Default is changed from "),t("code",[e._v("'index'")]),e._v(" to "),t("code",[e._v("'nearest'")]),e._v(".")])]),e._v(" "),t("h4",{attrs:{id:"scales"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#scales"}},[e._v("#")]),e._v(" Scales")]),e._v(" "),t("p",[e._v("The configuration options for scales is the largest change in v3. The "),t("code",[e._v("xAxes")]),e._v(" and "),t("code",[e._v("yAxes")]),e._v(" arrays were removed and axis options are individual scales now keyed by scale ID.")]),e._v(" "),t("p",[e._v("The v2 configuration below is shown with it's new v3 configuration")]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("options")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("scales")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("xAxes")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("id")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'x'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'time'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'Date'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("ticks")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("major")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("enabled")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token function-variable function"}},[e._v("font")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("function")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token parameter"}},[e._v("context")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("if")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("major"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("return")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("weight")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'bold'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("color")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'#FF0000'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("yAxes")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("id")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'y'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'value'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("And now, in v3:")]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("options")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("scales")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("x")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'time'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'Date'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("ticks")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("major")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("enabled")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token function-variable function"}},[e._v("color")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token parameter"}},[e._v("context")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=>")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("major "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'#FF0000'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token function-variable function"}},[e._v("font")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("function")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token parameter"}},[e._v("context")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("if")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("major"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("return")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("weight")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'bold'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("y")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'value'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("ul",[t("li",[e._v("The time scale option "),t("code",[e._v("distribution: 'series'")]),e._v(" was removed and a new scale type "),t("code",[e._v("timeseries")]),e._v(" was introduced in its place")]),e._v(" "),t("li",[e._v("In the time scale, "),t("code",[e._v("autoSkip")]),e._v(" is now enabled by default for consistency with the other scales")])]),e._v(" "),t("h4",{attrs:{id:"animations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[e._v("#")]),e._v(" Animations")]),e._v(" "),t("p",[e._v("Animation system was completely rewritten in Chart.js v3. Each property can now be animated separately. Please see "),t("RouterLink",{attrs:{to:"/configuration/animations.html"}},[e._v("animations")]),e._v(" docs for details.")],1),e._v(" "),t("h4",{attrs:{id:"customizability"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#customizability"}},[e._v("#")]),e._v(" Customizability")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("custom")]),e._v(" attribute of elements was removed. Please use scriptable options")]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("hover")]),e._v(" property of scriptable options "),t("code",[e._v("context")]),e._v(" object was renamed to "),t("code",[e._v("active")]),e._v(" to align it with the datalabels plugin.")])]),e._v(" "),t("h4",{attrs:{id:"interactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[e._v("#")]),e._v(" Interactions")]),e._v(" "),t("ul",[t("li",[e._v("To allow DRY configuration, a root options scope for common interaction options was added. "),t("code",[e._v("options.hover")]),e._v(" and "),t("code",[e._v("options.plugins.tooltip")]),e._v(" now both extend from "),t("code",[e._v("options.interaction")]),e._v(". Defaults are defined at "),t("code",[e._v("defaults.interaction")]),e._v(" level, so by default hover and tooltip interactions share the same mode etc.")]),e._v(" "),t("li",[t("code",[e._v("interactions")]),e._v(" are now limited to the chart area + allowed overflow")]),e._v(" "),t("li",[t("code",[e._v("{mode: 'label'}")]),e._v(" was replaced with "),t("code",[e._v("{mode: 'index'}")])]),e._v(" "),t("li",[t("code",[e._v("{mode: 'single'}")]),e._v(" was replaced with "),t("code",[e._v("{mode: 'nearest', intersect: true}")])]),e._v(" "),t("li",[t("code",[e._v("modes['X-axis']")]),e._v(" was replaced with "),t("code",[e._v("{mode: 'index', intersect: false}")])]),e._v(" "),t("li",[t("code",[e._v("options.onClick")]),e._v(" is now limited to the chart area")]),e._v(" "),t("li",[t("code",[e._v("options.onClick")]),e._v(" and "),t("code",[e._v("options.onHover")]),e._v(" now receive the "),t("code",[e._v("chart")]),e._v(" instance as a 3rd argument")]),e._v(" "),t("li",[t("code",[e._v("options.onHover")]),e._v(" now receives a wrapped "),t("code",[e._v("event")]),e._v(" as the first parameter. The previous first parameter value is accessible via "),t("code",[e._v("event.native")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.hover.onHover")]),e._v(" was removed, use "),t("code",[e._v("options.onHover")]),e._v(".")])]),e._v(" "),t("h4",{attrs:{id:"ticks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[e._v("#")]),e._v(" Ticks")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("options.gridLines")]),e._v(" was renamed to "),t("code",[e._v("options.grid")])]),e._v(" "),t("li",[t("code",[e._v("options.gridLines.offsetGridLines")]),e._v(" was renamed to "),t("code",[e._v("options.grid.offset")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.gridLines.tickMarkLength")]),e._v(" was renamed to "),t("code",[e._v("options.grid.tickLength")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.ticks.fixedStepSize")]),e._v(" is no longer used. Use "),t("code",[e._v("options.ticks.stepSize")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.ticks.major")]),e._v(" and "),t("code",[e._v("options.ticks.minor")]),e._v(" were replaced with scriptable options for tick fonts.")]),e._v(" "),t("li",[t("code",[e._v("Chart.Ticks.formatters.linear")]),e._v(" was renamed to "),t("code",[e._v("Chart.Ticks.formatters.numeric")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.ticks.backdropPaddingX")]),e._v(" and "),t("code",[e._v("options.ticks.backdropPaddingY")]),e._v(" were replaced with "),t("code",[e._v("options.ticks.backdropPadding")]),e._v(" in the radial linear scale.")])]),e._v(" "),t("h4",{attrs:{id:"tooltip"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[e._v("#")]),e._v(" Tooltip")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("xLabel")]),e._v(" and "),t("code",[e._v("yLabel")]),e._v(" were removed. Please use "),t("code",[e._v("label")]),e._v(" and "),t("code",[e._v("formattedValue")])]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("filter")]),e._v(" option will now be passed additional parameters when called and should have the method signature "),t("code",[e._v("function(tooltipItem, index, tooltipItems, data)")])]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("custom")]),e._v(" callback now takes a context object that has "),t("code",[e._v("tooltip")]),e._v(" and "),t("code",[e._v("chart")]),e._v(" properties")]),e._v(" "),t("li",[e._v("All properties of tooltip model related to the tooltip options have been moved to reside within the "),t("code",[e._v("options")]),e._v(" property.")]),e._v(" "),t("li",[e._v("The callbacks no longer are given a "),t("code",[e._v("data")]),e._v(" parameter. The tooltip item parameter contains the chart and dataset instead")]),e._v(" "),t("li",[e._v("The tooltip item's "),t("code",[e._v("index")]),e._v(" parameter was renamed to "),t("code",[e._v("dataIndex")]),e._v(" and "),t("code",[e._v("value")]),e._v(" was renamed to "),t("code",[e._v("formattedValue")])]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("xPadding")]),e._v(" and "),t("code",[e._v("yPadding")]),e._v(" options were merged into a single "),t("code",[e._v("padding")]),e._v(" object")])]),e._v(" "),t("h2",{attrs:{id:"developer-migration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-migration"}},[e._v("#")]),e._v(" Developer migration")]),e._v(" "),t("p",[e._v("While the end-user migration for Chart.js 3 is fairly straight-forward, the developer migration can be more complicated. Please reach out for help in the #dev "),t("a",{attrs:{href:"https://discord.gg/HxEguTK6av",target:"_blank",rel:"noopener noreferrer"}},[e._v("Discord"),t("OutboundLink")],1),e._v(" channel if tips on migrating would be helpful.")]),e._v(" "),t("p",[e._v("Some of the biggest things that have changed:")]),e._v(" "),t("ul",[t("li",[e._v("There is a completely rewritten and more performant animation system.\n"),t("ul",[t("li",[t("code",[e._v("Element._model")]),e._v(" and "),t("code",[e._v("Element._view")]),e._v(" are no longer used and properties are now set directly on the elements. You will have to use the method "),t("code",[e._v("getProps")]),e._v(" to access these properties inside most methods such as "),t("code",[e._v("inXRange")]),e._v("/"),t("code",[e._v("inYRange")]),e._v(" and "),t("code",[e._v("getCenterPoint")]),e._v(". Please take a look at "),t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/master/src/elements",target:"_blank",rel:"noopener noreferrer"}},[e._v("the Chart.js-provided elements"),t("OutboundLink")],1),e._v(" for examples.")]),e._v(" "),t("li",[e._v("When building the elements in a controller, it's now suggested to call "),t("code",[e._v("updateElement")]),e._v(" to provide the element properties. There are also methods such as "),t("code",[e._v("getSharedOptions")]),e._v(" and "),t("code",[e._v("includeOptions")]),e._v(" that have been added to skip redundant computation. Please take a look at "),t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/master/src/controllers",target:"_blank",rel:"noopener noreferrer"}},[e._v("the Chart.js-provided controllers"),t("OutboundLink")],1),e._v(" for examples.")])])]),e._v(" "),t("li",[e._v("Scales introduced a new parsing API. This API takes user data and converts it into a more standard format. E.g. it allows users to provide numeric data as a "),t("code",[e._v("string")]),e._v(" and converts it to a "),t("code",[e._v("number")]),e._v(" where necessary. Previously this was done on the fly as charts were rendered. Now it's done up front with the ability to skip it for better performance if users provide data in the correct format. If you're using standard data format like "),t("code",[e._v("x")]),e._v("/"),t("code",[e._v("y")]),e._v(" you may not need to do anything. If you're using a custom data format you will have to override some of the parse methods in "),t("code",[e._v("core.datasetController.js")]),e._v(". An example can be found in "),t("a",{attrs:{href:"https://github.com/chartjs/chartjs-chart-financial",target:"_blank",rel:"noopener noreferrer"}},[e._v("chartjs-chart-financial"),t("OutboundLink")],1),e._v(", which uses an "),t("code",[e._v("{o, h, l, c}")]),e._v(" data format.")])]),e._v(" "),t("p",[e._v("A few changes were made to controllers that are more straight-forward, but will affect all controllers:")]),e._v(" "),t("ul",[t("li",[e._v("Options:\n"),t("ul",[t("li",[t("code",[e._v("global")]),e._v(" was removed from the defaults namespace as it was unnecessary and sometimes inconsistent")]),e._v(" "),t("li",[e._v("Dataset defaults are now under the chart type options instead of vice-versa. This was not able to be done when introduced in 2.x for backwards compatibility. Fixing it removes the biggest stumbling block that new chart developers encountered")]),e._v(" "),t("li",[e._v("Scale default options need to be updated as described in the end user migration section (e.g. "),t("code",[e._v("x")]),e._v(" instead of "),t("code",[e._v("xAxes")]),e._v(" and "),t("code",[e._v("y")]),e._v(" instead of "),t("code",[e._v("yAxes")]),e._v(")")])])]),e._v(" "),t("li",[t("code",[e._v("updateElement")]),e._v(" was changed to "),t("code",[e._v("updateElements")]),e._v(" and has a new method signature as described below. This provides performance enhancements such as allowing easier reuse of computations that are common to all elements and reducing the number of function calls")])]),e._v(" "),t("h3",{attrs:{id:"removed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed"}},[e._v("#")]),e._v(" Removed")]),e._v(" "),t("p",[e._v("The following properties and methods were removed:")]),e._v(" "),t("h4",{attrs:{id:"removed-from-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-chart"}},[e._v("#")]),e._v(" Removed from Chart")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart.animationService")])]),e._v(" "),t("li",[t("code",[e._v("Chart.active")])]),e._v(" "),t("li",[t("code",[e._v("Chart.borderWidth")])]),e._v(" "),t("li",[t("code",[e._v("Chart.chart.chart")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Bar")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.Bubble")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.Chart")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Controller")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Doughnut")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.innerRadius")]),e._v(" now lives on doughnut, pie, and polarArea controllers")]),e._v(" "),t("li",[t("code",[e._v("Chart.lastActive")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Legend")]),e._v(" was moved to "),t("code",[e._v("Chart.plugins.legend._element")]),e._v(" and made private")]),e._v(" "),t("li",[t("code",[e._v("Chart.Line")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.LinearScaleBase")]),e._v(" now must be imported and cannot be accessed off the "),t("code",[e._v("Chart")]),e._v(" object")]),e._v(" "),t("li",[t("code",[e._v("Chart.offsetX")])]),e._v(" "),t("li",[t("code",[e._v("Chart.offsetY")])]),e._v(" "),t("li",[t("code",[e._v("Chart.outerRadius")]),e._v(" now lives on doughnut, pie, and polarArea controllers")]),e._v(" "),t("li",[t("code",[e._v("Chart.plugins")]),e._v(" was replaced with "),t("code",[e._v("Chart.registry")]),e._v(". Plugin defaults are now in "),t("code",[e._v("Chart.defaults.plugins[id]")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Chart.plugins.register")]),e._v(" was replaced by "),t("code",[e._v("Chart.register")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Chart.PolarArea")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.prototype.generateLegend")])]),e._v(" "),t("li",[t("code",[e._v("Chart.platform")]),e._v(". It only contained "),t("code",[e._v("disableCSSInjection")]),e._v(". CSS is never injected in v3.")]),e._v(" "),t("li",[t("code",[e._v("Chart.PluginBase")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Radar")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.radiusLength")])]),e._v(" "),t("li",[t("code",[e._v("Chart.scaleService")]),e._v(" was replaced with "),t("code",[e._v("Chart.registry")]),e._v(". Scale defaults are now in "),t("code",[e._v("Chart.defaults.scales[type]")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Chart.Scatter")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.types")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Title")]),e._v(" was moved to "),t("code",[e._v("Chart.plugins.title._element")]),e._v(" and made private")]),e._v(" "),t("li",[t("code",[e._v("Chart.Tooltip")]),e._v(" is now provided by the tooltip plugin. The positioners can be accessed from "),t("code",[e._v("tooltipPlugin.positioners")])]),e._v(" "),t("li",[t("code",[e._v("ILayoutItem.minSize")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-dataset-controllers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-dataset-controllers"}},[e._v("#")]),e._v(" Removed from Dataset Controllers")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BarController.getDatasetMeta().bar")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.addElementAndReset")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.createMetaData")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.createMetaDataset")])]),e._v(" "),t("li",[t("code",[e._v("DoughnutController.getRingIndex")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-elements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-elements"}},[e._v("#")]),e._v(" Removed from Elements")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Element.getArea")])]),e._v(" "),t("li",[t("code",[e._v("Element.height")])]),e._v(" "),t("li",[t("code",[e._v("Element.hidden")]),e._v(" was replaced by chart level status, usable with "),t("code",[e._v("getDataVisibility(index)")]),e._v(" / "),t("code",[e._v("toggleDataVisibility(index)")])]),e._v(" "),t("li",[t("code",[e._v("Element.initialize")])]),e._v(" "),t("li",[t("code",[e._v("Element.inLabelRange")])]),e._v(" "),t("li",[t("code",[e._v("Line.calculatePointY")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-helpers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-helpers"}},[e._v("#")]),e._v(" Removed from Helpers")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("helpers.addEvent")])]),e._v(" "),t("li",[t("code",[e._v("helpers.aliasPixel")])]),e._v(" "),t("li",[t("code",[e._v("helpers.arrayEquals")])]),e._v(" "),t("li",[t("code",[e._v("helpers.configMerge")])]),e._v(" "),t("li",[t("code",[e._v("helpers.findIndex")])]),e._v(" "),t("li",[t("code",[e._v("helpers.findNextWhere")])]),e._v(" "),t("li",[t("code",[e._v("helpers.findPreviousWhere")])]),e._v(" "),t("li",[t("code",[e._v("helpers.extend")]),e._v(". Use "),t("code",[e._v("Object.assign")]),e._v(" instead")]),e._v(" "),t("li",[t("code",[e._v("helpers.getValueAtIndexOrDefault")]),e._v(". Use "),t("code",[e._v("helpers.resolve")]),e._v(" instead.")]),e._v(" "),t("li",[t("code",[e._v("helpers.indexOf")])]),e._v(" "),t("li",[t("code",[e._v("helpers.lineTo")])]),e._v(" "),t("li",[t("code",[e._v("helpers.longestText")]),e._v(" was made private")]),e._v(" "),t("li",[t("code",[e._v("helpers.max")])]),e._v(" "),t("li",[t("code",[e._v("helpers.measureText")]),e._v(" was made private")]),e._v(" "),t("li",[t("code",[e._v("helpers.min")])]),e._v(" "),t("li",[t("code",[e._v("helpers.nextItem")])]),e._v(" "),t("li",[t("code",[e._v("helpers.niceNum")])]),e._v(" "),t("li",[t("code",[e._v("helpers.numberOfLabelLines")])]),e._v(" "),t("li",[t("code",[e._v("helpers.previousItem")])]),e._v(" "),t("li",[t("code",[e._v("helpers.removeEvent")])]),e._v(" "),t("li",[t("code",[e._v("helpers.roundedRect")])]),e._v(" "),t("li",[t("code",[e._v("helpers.scaleMerge")])]),e._v(" "),t("li",[t("code",[e._v("helpers.where")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-layout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-layout"}},[e._v("#")]),e._v(" Removed from Layout")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Layout.defaults")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-scales"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-scales"}},[e._v("#")]),e._v(" Removed from Scales")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("LinearScaleBase.handleDirectionalChanges")])]),e._v(" "),t("li",[t("code",[e._v("LogarithmicScale.minNotZero")])]),e._v(" "),t("li",[t("code",[e._v("Scale.getRightValue")])]),e._v(" "),t("li",[t("code",[e._v("Scale.longestLabelWidth")])]),e._v(" "),t("li",[t("code",[e._v("Scale.longestTextCache")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("Scale.margins")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("Scale.mergeTicksOptions")])]),e._v(" "),t("li",[t("code",[e._v("Scale.ticksAsNumbers")])]),e._v(" "),t("li",[t("code",[e._v("Scale.tickValues")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("TimeScale.getLabelCapacity")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("TimeScale.tickFormatFunction")]),e._v(" is now private")])]),e._v(" "),t("h4",{attrs:{id:"removed-from-plugins-legend-title-and-tooltip"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-plugins-legend-title-and-tooltip"}},[e._v("#")]),e._v(" Removed from Plugins (Legend, Title, and Tooltip)")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("IPlugin.afterScaleUpdate")]),e._v(". Use "),t("code",[e._v("afterLayout")]),e._v(" instead")]),e._v(" "),t("li",[t("code",[e._v("Legend.margins")]),e._v(" is now private")]),e._v(" "),t("li",[e._v("Legend "),t("code",[e._v("onClick")]),e._v(", "),t("code",[e._v("onHover")]),e._v(", and "),t("code",[e._v("onLeave")]),e._v(" options now receive the legend as the 3rd argument in addition to implicitly via "),t("code",[e._v("this")])]),e._v(" "),t("li",[e._v("Legend "),t("code",[e._v("onClick")]),e._v(", "),t("code",[e._v("onHover")]),e._v(", and "),t("code",[e._v("onLeave")]),e._v(" options now receive a wrapped "),t("code",[e._v("event")]),e._v(" as the first parameter. The previous first parameter value is accessible via "),t("code",[e._v("event.native")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Title.margins")]),e._v(" is now private")]),e._v(" "),t("li",[e._v("The tooltip item's "),t("code",[e._v("x")]),e._v(" and "),t("code",[e._v("y")]),e._v(" attributes were replaced by "),t("code",[e._v("element")]),e._v(". You can use "),t("code",[e._v("element.x")]),e._v(" and "),t("code",[e._v("element.y")]),e._v(" or "),t("code",[e._v("element.tooltipPosition()")]),e._v(" instead.")])]),e._v(" "),t("h4",{attrs:{id:"removal-of-public-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removal-of-public-apis"}},[e._v("#")]),e._v(" Removal of Public APIs")]),e._v(" "),t("p",[e._v("The following public APIs were removed.")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("getElementAtEvent")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'nearest', { intersect: true }, false)")])]),e._v(" "),t("li",[t("code",[e._v("getElementsAtEvent")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'index', { intersect: true }, false)")])]),e._v(" "),t("li",[t("code",[e._v("getElementsAtXAxis")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'index', { intersect: false }, false)")])]),e._v(" "),t("li",[t("code",[e._v("getDatasetAtEvent")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'dataset', { intersect: true }, false)")])])]),e._v(" "),t("h4",{attrs:{id:"removal-of-private-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removal-of-private-apis"}},[e._v("#")]),e._v(" Removal of private APIs")]),e._v(" "),t("p",[e._v("The following private APIs were removed.")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart._bufferedRender")])]),e._v(" "),t("li",[t("code",[e._v("Chart._updating")])]),e._v(" "),t("li",[t("code",[e._v("Chart.data.datasets[datasetIndex]._meta")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getIndexScaleId")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getIndexScale")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getValueScaleId")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getValueScale")])]),e._v(" "),t("li",[t("code",[e._v("Element._ctx")])]),e._v(" "),t("li",[t("code",[e._v("Element._model")])]),e._v(" "),t("li",[t("code",[e._v("Element._view")])]),e._v(" "),t("li",[t("code",[e._v("LogarithmicScale._valueOffset")])]),e._v(" "),t("li",[t("code",[e._v("TimeScale.getPixelForOffset")])]),e._v(" "),t("li",[t("code",[e._v("TimeScale.getLabelWidth")])]),e._v(" "),t("li",[t("code",[e._v("Tooltip._lastActive")])])]),e._v(" "),t("h3",{attrs:{id:"renamed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#renamed"}},[e._v("#")]),e._v(" Renamed")]),e._v(" "),t("p",[e._v("The following properties were renamed during v3 development:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart.Animation.animationObject")]),e._v(" was renamed to "),t("code",[e._v("Chart.Animation")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Animation.chartInstance")]),e._v(" was renamed to "),t("code",[e._v("Chart.Animation.chart")])]),e._v(" "),t("li",[t("code",[e._v("Chart.canvasHelpers")]),e._v(" was merged with "),t("code",[e._v("Chart.helpers")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Arc")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.ArcElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Line")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.LineElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Point")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.PointElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Rectangle")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.BarElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.layoutService")]),e._v(" was renamed to "),t("code",[e._v("Chart.layouts")])]),e._v(" "),t("li",[t("code",[e._v("Chart.pluginService")]),e._v(" was renamed to "),t("code",[e._v("Chart.plugins")])]),e._v(" "),t("li",[t("code",[e._v("helpers.callCallback")]),e._v(" was renamed to "),t("code",[e._v("helpers.callback")])]),e._v(" "),t("li",[t("code",[e._v("helpers.drawRoundedRectangle")]),e._v(" was renamed to "),t("code",[e._v("helpers.roundedRect")])]),e._v(" "),t("li",[t("code",[e._v("helpers.getValueOrDefault")]),e._v(" was renamed to "),t("code",[e._v("helpers.valueOrDefault")])]),e._v(" "),t("li",[t("code",[e._v("LayoutItem.fullWidth")]),e._v(" was renamed to "),t("code",[e._v("LayoutItem.fullSize")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointPreviousX")]),e._v(" was renamed to "),t("code",[e._v("Point.cp1x")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointPreviousY")]),e._v(" was renamed to "),t("code",[e._v("Point.cp1y")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointNextX")]),e._v(" was renamed to "),t("code",[e._v("Point.cp2x")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointNextY")]),e._v(" was renamed to "),t("code",[e._v("Point.cp2y")])]),e._v(" "),t("li",[t("code",[e._v("Scale.calculateTickRotation")]),e._v(" was renamed to "),t("code",[e._v("Scale.calculateLabelRotation")])]),e._v(" "),t("li",[t("code",[e._v("Tooltip.options.legendColorBackgroupd")]),e._v(" was renamed to "),t("code",[e._v("Tooltip.options.multiKeyBackground")])])]),e._v(" "),t("h4",{attrs:{id:"renamed-private-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#renamed-private-apis"}},[e._v("#")]),e._v(" Renamed private APIs")]),e._v(" "),t("p",[e._v("The private APIs listed below were renamed:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BarController.calculateBarIndexPixels")]),e._v(" was renamed to "),t("code",[e._v("BarController._calculateBarIndexPixels")])]),e._v(" "),t("li",[t("code",[e._v("BarController.calculateBarValuePixels")]),e._v(" was renamed to "),t("code",[e._v("BarController._calculateBarValuePixels")])]),e._v(" "),t("li",[t("code",[e._v("BarController.getStackCount")]),e._v(" was renamed to "),t("code",[e._v("BarController._getStackCount")])]),e._v(" "),t("li",[t("code",[e._v("BarController.getStackIndex")]),e._v(" was renamed to "),t("code",[e._v("BarController._getStackIndex")])]),e._v(" "),t("li",[t("code",[e._v("BarController.getRuler")]),e._v(" was renamed to "),t("code",[e._v("BarController._getRuler")])]),e._v(" "),t("li",[t("code",[e._v("Chart.destroyDatasetMeta")]),e._v(" was renamed to "),t("code",[e._v("Chart._destroyDatasetMeta")])]),e._v(" "),t("li",[t("code",[e._v("Chart.drawDataset")]),e._v(" was renamed to "),t("code",[e._v("Chart._drawDataset")])]),e._v(" "),t("li",[t("code",[e._v("Chart.drawDatasets")]),e._v(" was renamed to "),t("code",[e._v("Chart._drawDatasets")])]),e._v(" "),t("li",[t("code",[e._v("Chart.eventHandler")]),e._v(" was renamed to "),t("code",[e._v("Chart._eventHandler")])]),e._v(" "),t("li",[t("code",[e._v("Chart.handleEvent")]),e._v(" was renamed to "),t("code",[e._v("Chart._handleEvent")])]),e._v(" "),t("li",[t("code",[e._v("Chart.initialize")]),e._v(" was renamed to "),t("code",[e._v("Chart._initialize")])]),e._v(" "),t("li",[t("code",[e._v("Chart.resetElements")]),e._v(" was renamed to "),t("code",[e._v("Chart._resetElements")])]),e._v(" "),t("li",[t("code",[e._v("Chart.unbindEvents")]),e._v(" was renamed to "),t("code",[e._v("Chart._unbindEvents")])]),e._v(" "),t("li",[t("code",[e._v("Chart.updateDataset")]),e._v(" was renamed to "),t("code",[e._v("Chart._updateDataset")])]),e._v(" "),t("li",[t("code",[e._v("Chart.updateDatasets")]),e._v(" was renamed to "),t("code",[e._v("Chart._updateDatasets")])]),e._v(" "),t("li",[t("code",[e._v("Chart.updateLayout")]),e._v(" was renamed to "),t("code",[e._v("Chart._updateLayout")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.destroy")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._destroy")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.insertElements")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._insertElements")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataPop")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataPop")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataPush")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataPush")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataShift")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataShift")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataSplice")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataSplice")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataUnshift")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataUnshift")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.removeElements")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._removeElements")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.resyncElements")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._resyncElements")])]),e._v(" "),t("li",[t("code",[e._v("LayoutItem.isFullWidth")]),e._v(" was renamed to "),t("code",[e._v("LayoutItem.isFullSize")])]),e._v(" "),t("li",[t("code",[e._v("RadialLinearScale.setReductions")]),e._v(" was renamed to "),t("code",[e._v("RadialLinearScale._setReductions")])]),e._v(" "),t("li",[t("code",[e._v("RadialLinearScale.pointLabels")]),e._v(" was renamed to "),t("code",[e._v("RadialLinearScale._pointLabels")])]),e._v(" "),t("li",[t("code",[e._v("Scale.handleMargins")]),e._v(" was renamed to "),t("code",[e._v("Scale._handleMargins")])])]),e._v(" "),t("h3",{attrs:{id:"changed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed"}},[e._v("#")]),e._v(" Changed")]),e._v(" "),t("p",[e._v("The APIs listed in this section have changed in signature or behaviour from version 2.")]),e._v(" "),t("h4",{attrs:{id:"changed-in-scales"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-scales"}},[e._v("#")]),e._v(" Changed in Scales")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Scale.getLabelForIndex")]),e._v(" was replaced by "),t("code",[e._v("scale.getLabelForValue")])]),e._v(" "),t("li",[t("code",[e._v("Scale.getPixelForValue")]),e._v(" now only requires one parameter. For the "),t("code",[e._v("TimeScale")]),e._v(" that parameter must be millis since the epoch. As a performance optimization, it may take an optional second parameter, giving the index of the data point.")])]),e._v(" "),t("h5",{attrs:{id:"changed-in-ticks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-ticks"}},[e._v("#")]),e._v(" Changed in Ticks")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Scale.afterBuildTicks")]),e._v(" now has no parameters like the other callbacks")]),e._v(" "),t("li",[t("code",[e._v("Scale.buildTicks")]),e._v(" is now expected to return tick objects")]),e._v(" "),t("li",[t("code",[e._v("Scale.convertTicksToLabels")]),e._v(" was renamed to "),t("code",[e._v("generateTickLabels")]),e._v(". It is now expected to set the label property on the ticks given as input")]),e._v(" "),t("li",[t("code",[e._v("Scale.ticks")]),e._v(" now contains objects instead of strings")]),e._v(" "),t("li",[e._v("When the "),t("code",[e._v("autoSkip")]),e._v(" option is enabled, "),t("code",[e._v("Scale.ticks")]),e._v(" now contains only the non-skipped ticks instead of all ticks.")]),e._v(" "),t("li",[e._v("Ticks are now always generated in monotonically increasing order")])]),e._v(" "),t("h5",{attrs:{id:"changed-in-time-scale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-time-scale"}},[e._v("#")]),e._v(" Changed in Time Scale")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("getValueForPixel")]),e._v(" now returns milliseconds since the epoch")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-controllers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-controllers"}},[e._v("#")]),e._v(" Changed in Controllers")]),e._v(" "),t("h5",{attrs:{id:"core-controller"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#core-controller"}},[e._v("#")]),e._v(" Core Controller")]),e._v(" "),t("ul",[t("li",[e._v("The first parameter to "),t("code",[e._v("updateHoverStyle")]),e._v(" is now an array of objects containing the "),t("code",[e._v("element")]),e._v(", "),t("code",[e._v("datasetIndex")]),e._v(", and "),t("code",[e._v("index")])]),e._v(" "),t("li",[e._v("The signature or "),t("code",[e._v("resize")]),e._v(" changed, the first "),t("code",[e._v("silent")]),e._v(" parameter was removed.")])]),e._v(" "),t("h5",{attrs:{id:"dataset-controllers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dataset-controllers"}},[e._v("#")]),e._v(" Dataset Controllers")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("updateElement")]),e._v(" was replaced with "),t("code",[e._v("updateElements")]),e._v(" now taking the elements to update, the "),t("code",[e._v("start")]),e._v(" index, "),t("code",[e._v("count")]),e._v(", and "),t("code",[e._v("mode")])]),e._v(" "),t("li",[t("code",[e._v("setHoverStyle")]),e._v(" and "),t("code",[e._v("removeHoverStyle")]),e._v(" now additionally take the "),t("code",[e._v("datasetIndex")]),e._v(" and "),t("code",[e._v("index")])])]),e._v(" "),t("h4",{attrs:{id:"changed-in-interactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-interactions"}},[e._v("#")]),e._v(" Changed in Interactions")]),e._v(" "),t("ul",[t("li",[e._v("Interaction mode methods now return an array of objects containing the "),t("code",[e._v("element")]),e._v(", "),t("code",[e._v("datasetIndex")]),e._v(", and "),t("code",[e._v("index")])])]),e._v(" "),t("h4",{attrs:{id:"changed-in-layout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-layout"}},[e._v("#")]),e._v(" Changed in Layout")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("ILayoutItem.update")]),e._v(" no longer has a return value")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-helpers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-helpers"}},[e._v("#")]),e._v(" Changed in Helpers")]),e._v(" "),t("p",[e._v("All helpers are now exposed in a flat hierarchy, e.g., "),t("code",[e._v("Chart.helpers.canvas.clipArea")]),e._v(" -> "),t("code",[e._v("Chart.helpers.clipArea")])]),e._v(" "),t("h5",{attrs:{id:"canvas-helper"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#canvas-helper"}},[e._v("#")]),e._v(" Canvas Helper")]),e._v(" "),t("ul",[t("li",[e._v("The second parameter to "),t("code",[e._v("drawPoint")]),e._v(" is now the full options object, so "),t("code",[e._v("style")]),e._v(", "),t("code",[e._v("rotation")]),e._v(", and "),t("code",[e._v("radius")]),e._v(" are no longer passed explicitly")]),e._v(" "),t("li",[t("code",[e._v("helpers.getMaximumHeight")]),e._v(" was replaced by "),t("code",[e._v("helpers.dom.getMaximumSize")])]),e._v(" "),t("li",[t("code",[e._v("helpers.getMaximumWidth")]),e._v(" was replaced by "),t("code",[e._v("helpers.dom.getMaximumSize")])]),e._v(" "),t("li",[t("code",[e._v("helpers.clear")]),e._v(" was renamed to "),t("code",[e._v("helpers.clearCanvas")]),e._v(" and now takes "),t("code",[e._v("canvas")]),e._v(" and optionally "),t("code",[e._v("ctx")]),e._v(" as parameter(s).")]),e._v(" "),t("li",[t("code",[e._v("helpers.retinaScale")]),e._v(" accepts optional third parameter "),t("code",[e._v("forceStyle")]),e._v(", which forces overriding current canvas style. "),t("code",[e._v("forceRatio")]),e._v(" no longer falls back to "),t("code",[e._v("window.devicePixelRatio")]),e._v(", instead it defaults to "),t("code",[e._v("1")]),e._v(".")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-platform"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-platform"}},[e._v("#")]),e._v(" Changed in Platform")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart.platform")]),e._v(" is no longer the platform object used by charts. Every chart instance now has a separate platform instance.")]),e._v(" "),t("li",[t("code",[e._v("Chart.platforms")]),e._v(" is an object that contains two usable platform classes, "),t("code",[e._v("BasicPlatform")]),e._v(" and "),t("code",[e._v("DomPlatform")]),e._v(". It also contains "),t("code",[e._v("BasePlatform")]),e._v(", a class that all platforms must extend from.")]),e._v(" "),t("li",[e._v("If the canvas passed in is an instance of "),t("code",[e._v("OffscreenCanvas")]),e._v(", the "),t("code",[e._v("BasicPlatform")]),e._v(" is automatically used.")]),e._v(" "),t("li",[t("code",[e._v("isAttached")]),e._v(" method was added to platform.")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-iplugin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-iplugin-interface"}},[e._v("#")]),e._v(" Changed in IPlugin interface")]),e._v(" "),t("ul",[t("li",[e._v("All plugin hooks have unified signature with 3 arguments: "),t("code",[e._v("chart")]),e._v(", "),t("code",[e._v("args")]),e._v(" and "),t("code",[e._v("options")]),e._v(". This means change in signature for these hooks: "),t("code",[e._v("beforeInit")]),e._v(", "),t("code",[e._v("afterInit")]),e._v(", "),t("code",[e._v("reset")]),e._v(", "),t("code",[e._v("beforeLayout")]),e._v(", "),t("code",[e._v("afterLayout")]),e._v(", "),t("code",[e._v("beforeRender")]),e._v(", "),t("code",[e._v("afterRender")]),e._v(", "),t("code",[e._v("beforeDraw")]),e._v(", "),t("code",[e._v("afterDraw")]),e._v(", "),t("code",[e._v("beforeDatasetsDraw")]),e._v(", "),t("code",[e._v("afterDatasetsDraw")]),e._v(", "),t("code",[e._v("beforeEvent")]),e._v(", "),t("code",[e._v("afterEvent")]),e._v(", "),t("code",[e._v("resize")]),e._v(", "),t("code",[e._v("destroy")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("afterDatasetsUpdate")]),e._v(", "),t("code",[e._v("afterUpdate")]),e._v(", "),t("code",[e._v("beforeDatasetsUpdate")]),e._v(", and "),t("code",[e._v("beforeUpdate")]),e._v(" now receive "),t("code",[e._v("args")]),e._v(" object as second argument. "),t("code",[e._v("options")]),e._v(" argument is always the last and thus was moved from 2nd to 3rd place.")]),e._v(" "),t("li",[t("code",[e._v("afterEvent")]),e._v(" and "),t("code",[e._v("beforeEvent")]),e._v(" now receive a wrapped "),t("code",[e._v("event")]),e._v(" as the "),t("code",[e._v("event")]),e._v(" property of the second argument. The native event is available via "),t("code",[e._v("args.event.native")]),e._v(".")]),e._v(" "),t("li",[e._v("Initial "),t("code",[e._v("resize")]),e._v(" is no longer silent. Meaning that "),t("code",[e._v("resize")]),e._v(" event can fire between "),t("code",[e._v("beforeInit")]),e._v(" and "),t("code",[e._v("afterInit")])]),e._v(" "),t("li",[e._v("New hooks: "),t("code",[e._v("install")]),e._v(", "),t("code",[e._v("start")]),e._v(", "),t("code",[e._v("stop")]),e._v(", and "),t("code",[e._v("uninstall")])]),e._v(" "),t("li",[t("code",[e._v("afterEvent")]),e._v(" should notify about changes that need a render by setting "),t("code",[e._v("args.changed")]),e._v(" to true. Because the "),t("code",[e._v("args")]),e._v(" are shared with all plugins, it should only be set to true and not false.")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[186],{523:function(e,t,a){"use strict";a.r(t);var o=a(3),s=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"_3-x-migration-guide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#_3-x-migration-guide"}},[e._v("#")]),e._v(" 3.x Migration Guide")]),e._v(" "),t("p",[e._v("Chart.js 3.0 introduces a number of breaking changes. Chart.js 2.0 was released in April 2016. In the years since then, as Chart.js has grown in popularity and feature set, we've learned some lessons about how to better create a charting library. In order to improve performance, offer new features, and improve maintainability, it was necessary to break backwards compatibility, but we aimed to do so only when worth the benefit. Some major highlights of v3 include:")]),e._v(" "),t("ul",[t("li",[e._v("Large "),t("RouterLink",{attrs:{to:"/general/performance.html"}},[e._v("performance")]),e._v(" improvements including the ability to skip data parsing and render charts in parallel via webworkers")],1),e._v(" "),t("li",[e._v("Additional configurability and scriptable options with better defaults")]),e._v(" "),t("li",[e._v("Completely rewritten animation system")]),e._v(" "),t("li",[e._v("Rewritten filler plugin with numerous bug fixes")]),e._v(" "),t("li",[e._v("Documentation migrated from GitBook to Vuepress")]),e._v(" "),t("li",[e._v("API documentation generated and verified by TypeDoc")]),e._v(" "),t("li",[e._v("No more CSS injection")]),e._v(" "),t("li",[e._v("Tons of bug fixes")]),e._v(" "),t("li",[e._v("Tree shaking")])]),e._v(" "),t("h2",{attrs:{id:"end-user-migration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#end-user-migration"}},[e._v("#")]),e._v(" End user migration")]),e._v(" "),t("h3",{attrs:{id:"setup-and-installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setup-and-installation"}},[e._v("#")]),e._v(" Setup and installation")]),e._v(" "),t("ul",[t("li",[e._v("Distributed files are now in lower case. For example: "),t("code",[e._v("dist/chart.js")]),e._v(".")]),e._v(" "),t("li",[e._v("Chart.js is no longer providing the "),t("code",[e._v("Chart.bundle.js")]),e._v(" and "),t("code",[e._v("Chart.bundle.min.js")]),e._v(". Please see the "),t("RouterLink",{attrs:{to:"/getting-started/installation.html"}},[e._v("installation")]),e._v(" and "),t("RouterLink",{attrs:{to:"/getting-started/integration.html"}},[e._v("integration")]),e._v(" docs for details on the recommended way to setup Chart.js if you were using these builds.")],1),e._v(" "),t("li",[t("code",[e._v("moment")]),e._v(" is no longer specified as an npm dependency. If you are using the "),t("code",[e._v("time")]),e._v(" or "),t("code",[e._v("timeseries")]),e._v(" scales, you must include one of "),t("a",{attrs:{href:"https://github.com/chartjs/awesome#adapters",target:"_blank",rel:"noopener noreferrer"}},[e._v("the available adapters"),t("OutboundLink")],1),e._v(" and corresponding date library. You no longer need to exclude moment from your build.")]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("Chart")]),e._v(" constructor will throw an error if the canvas/context provided is already in use")]),e._v(" "),t("li",[e._v("Chart.js 3 is tree-shakeable. So if you are using it as an "),t("code",[e._v("npm")]),e._v(" module in a project and want to make use of this feature, you need to import and register the controllers, elements, scales and plugins you want to use, for a list of all the available items to import see "),t("RouterLink",{attrs:{to:"/getting-started/integration.html#bundlers-webpack-rollup-etc"}},[e._v("integration")]),e._v(". You will not have to call "),t("code",[e._v("register")]),e._v(" if importing Chart.js via a "),t("code",[e._v("script")]),e._v(" tag or from the "),t("RouterLink",{attrs:{to:"/getting-started/integration.html#bundlers-webpack-rollup-etc"}},[t("code",[e._v("auto")])]),e._v(" register path as an "),t("code",[e._v("npm")]),e._v(" module, in this case you will not get the tree shaking benefits. Here is an example of registering components:")],1)]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("import")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" Chart"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LineController"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LineElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" PointElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LinearScale"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" Title "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("from")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token template-string"}},[t("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[e._v("`")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("chart.js")]),t("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[e._v("`")])]),e._v("\n\nChart"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("register")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("LineController"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LineElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" PointElement"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" LinearScale"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" Title"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("const")]),e._v(" chart "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("new")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token class-name"}},[e._v("Chart")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("ctx"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'line'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("// data: ...")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("options")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("plugins")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'Chart Title'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("scales")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("x")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'linear'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("y")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'linear'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("h3",{attrs:{id:"chart-types"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#chart-types"}},[e._v("#")]),e._v(" Chart types")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("horizontalBar")]),e._v(" chart type was removed. Horizontal bar charts can be configured using the new "),t("RouterLink",{attrs:{to:"/charts/bar.html#horizontal-bar-chart"}},[t("code",[e._v("indexAxis")])]),e._v(" option")],1)]),e._v(" "),t("h3",{attrs:{id:"options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[e._v("#")]),e._v(" Options")]),e._v(" "),t("p",[e._v("A number of changes were made to the configuration options passed to the "),t("code",[e._v("Chart")]),e._v(" constructor. Those changes are documented below.")]),e._v(" "),t("h4",{attrs:{id:"generic-changes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generic-changes"}},[e._v("#")]),e._v(" Generic changes")]),e._v(" "),t("ul",[t("li",[e._v("Indexable options are now looping. "),t("code",[e._v("backgroundColor: ['red', 'green']")]),e._v(" will result in alternating "),t("code",[e._v("'red'")]),e._v(" / "),t("code",[e._v("'green'")]),e._v(" if there are more than 2 data points.")]),e._v(" "),t("li",[e._v("The input properties of object data can now be freely specified, see "),t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[e._v("data structures")]),e._v(" for details.")],1),e._v(" "),t("li",[e._v("Most options are resolved utilizing proxies, instead of merging with defaults. In addition to easily enabling different resolution routes for different contexts, it allows using other resolved options in scriptable options.\n"),t("ul",[t("li",[e._v("Options are by default scriptable and indexable, unless disabled for some reason.")]),e._v(" "),t("li",[e._v("Scriptable options receive a option resolver as second parameter for accessing other options in same context.")]),e._v(" "),t("li",[e._v("Resolution falls to upper scopes, if no match is found earlier. See "),t("RouterLink",{attrs:{to:"/general/options.html"}},[e._v("options")]),e._v(" for details.")],1)])])]),e._v(" "),t("h4",{attrs:{id:"specific-changes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#specific-changes"}},[e._v("#")]),e._v(" Specific changes")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("elements.rectangle")]),e._v(" is now "),t("code",[e._v("elements.bar")])]),e._v(" "),t("li",[t("code",[e._v("hover.animationDuration")]),e._v(" is now configured in "),t("code",[e._v("animation.active.duration")])]),e._v(" "),t("li",[t("code",[e._v("responsiveAnimationDuration")]),e._v(" is now configured in "),t("code",[e._v("animation.resize.duration")])]),e._v(" "),t("li",[e._v("Polar area "),t("code",[e._v("elements.arc.angle")]),e._v(" is now configured in degrees instead of radians.")]),e._v(" "),t("li",[e._v("Polar area "),t("code",[e._v("startAngle")]),e._v(" option is now consistent with "),t("code",[e._v("Radar")]),e._v(", 0 is at top and value is in degrees. Default is changed from "),t("code",[e._v("-½π")]),e._v(" to "),t("code",[e._v("0")]),e._v(".")]),e._v(" "),t("li",[e._v("Doughnut "),t("code",[e._v("rotation")]),e._v(" option is now in degrees and 0 is at top. Default is changed from "),t("code",[e._v("-½π")]),e._v(" to "),t("code",[e._v("0")]),e._v(".")]),e._v(" "),t("li",[e._v("Doughnut "),t("code",[e._v("circumference")]),e._v(" option is now in degrees. Default is changed from "),t("code",[e._v("2π")]),e._v(" to "),t("code",[e._v("360")]),e._v(".")]),e._v(" "),t("li",[e._v("Doughnut "),t("code",[e._v("cutoutPercentage")]),e._v(" was renamed to "),t("code",[e._v("cutout")]),e._v("and accepts pixels as number and percent as string ending with "),t("code",[e._v("%")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("scale")]),e._v(" option was removed in favor of "),t("code",[e._v("options.scales.r")]),e._v(" (or any other scale id, with "),t("code",[e._v("axis: 'r'")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes")]),e._v(" arrays were removed. Scales are now configured directly to "),t("code",[e._v("options.scales")]),e._v(" object with the object key being the scale Id.")]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.barPercentage")]),e._v(" was moved to dataset option "),t("code",[e._v("barPercentage")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.barThickness")]),e._v(" was moved to dataset option "),t("code",[e._v("barThickness")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.categoryPercentage")]),e._v(" was moved to dataset option "),t("code",[e._v("categoryPercentage")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.maxBarThickness")]),e._v(" was moved to dataset option "),t("code",[e._v("maxBarThickness")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.minBarLength")]),e._v(" was moved to dataset option "),t("code",[e._v("minBarLength")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.scaleLabel")]),e._v(" was renamed to "),t("code",[e._v("scales[id].title")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.scaleLabel.labelString")]),e._v(" was renamed to "),t("code",[e._v("scales[id].title.text")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.beginAtZero")]),e._v(" was renamed to "),t("code",[e._v("scales[id].beginAtZero")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.max")]),e._v(" was renamed to "),t("code",[e._v("scales[id].max")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.min")]),e._v(" was renamed to "),t("code",[e._v("scales[id].min")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.reverse")]),e._v(" was renamed to "),t("code",[e._v("scales[id].reverse")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.suggestedMax")]),e._v(" was renamed to "),t("code",[e._v("scales[id].suggestedMax")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.suggestedMin")]),e._v(" was renamed to "),t("code",[e._v("scales[id].suggestedMin")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.unitStepSize")]),e._v(" was removed. Use "),t("code",[e._v("scales[id].ticks.stepSize")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.ticks.userCallback")]),e._v(" was renamed to "),t("code",[e._v("scales[id].ticks.callback")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.time.format")]),e._v(" was renamed to "),t("code",[e._v("scales[id].time.parser")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.time.max")]),e._v(" was renamed to "),t("code",[e._v("scales[id].max")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.time.min")]),e._v(" was renamed to "),t("code",[e._v("scales[id].min")])]),e._v(" "),t("li",[t("code",[e._v("scales.[x/y]Axes.zeroLine*")]),e._v(" options of axes were removed. Use scriptable scale options instead.")]),e._v(" "),t("li",[e._v("The dataset option "),t("code",[e._v("steppedLine")]),e._v(" was removed. Use "),t("code",[e._v("stepped")])]),e._v(" "),t("li",[e._v("The chart option "),t("code",[e._v("showLines")]),e._v(" was renamed to "),t("code",[e._v("showLine")]),e._v(" to match the dataset option.")]),e._v(" "),t("li",[e._v("The chart option "),t("code",[e._v("startAngle")]),e._v(" was moved to "),t("code",[e._v("radial")]),e._v(" scale options.")]),e._v(" "),t("li",[e._v("To override the platform class used in a chart instance, pass "),t("code",[e._v("platform: PlatformClass")]),e._v(" in the config object. Note that the class should be passed, not an instance of the class.")]),e._v(" "),t("li",[t("code",[e._v("aspectRatio")]),e._v(" defaults to 1 for doughnut, pie, polarArea, and radar charts")]),e._v(" "),t("li",[t("code",[e._v("TimeScale")]),e._v(" does not read "),t("code",[e._v("t")]),e._v(" from object data by default anymore. The default property is "),t("code",[e._v("x")]),e._v(" or "),t("code",[e._v("y")]),e._v(", depending on the orientation. See "),t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[e._v("data structures")]),e._v(" for details on how to change the default.")],1),e._v(" "),t("li",[t("code",[e._v("tooltips")]),e._v(" namespace was renamed to "),t("code",[e._v("tooltip")]),e._v(" to match the plugin name")]),e._v(" "),t("li",[t("code",[e._v("legend")]),e._v(", "),t("code",[e._v("title")]),e._v(" and "),t("code",[e._v("tooltip")]),e._v(" namespaces were moved from "),t("code",[e._v("options")]),e._v(" to "),t("code",[e._v("options.plugins")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("tooltips.custom")]),e._v(" was renamed to "),t("code",[e._v("plugins.tooltip.external")])])]),e._v(" "),t("h4",{attrs:{id:"defaults"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[e._v("#")]),e._v(" Defaults")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("global")]),e._v(" namespace was removed from "),t("code",[e._v("defaults")]),e._v(". So "),t("code",[e._v("Chart.defaults.global")]),e._v(" is now "),t("code",[e._v("Chart.defaults")])]),e._v(" "),t("li",[e._v("Dataset controller defaults were relocate to "),t("code",[e._v("overrides")]),e._v(". For example "),t("code",[e._v("Chart.defaults.line")]),e._v(" is now "),t("code",[e._v("Chart.overrides.line")])]),e._v(" "),t("li",[t("code",[e._v("default")]),e._v(" prefix was removed from defaults. For example "),t("code",[e._v("Chart.defaults.global.defaultColor")]),e._v(" is now "),t("code",[e._v("Chart.defaults.color")])]),e._v(" "),t("li",[t("code",[e._v("defaultColor")]),e._v(" was split to "),t("code",[e._v("color")]),e._v(", "),t("code",[e._v("borderColor")]),e._v(" and "),t("code",[e._v("backgroundColor")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontColor")]),e._v(" was renamed to "),t("code",[e._v("color")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontFamily")]),e._v(" was renamed to "),t("code",[e._v("font.family")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontSize")]),e._v(" was renamed to "),t("code",[e._v("font.size")])]),e._v(" "),t("li",[t("code",[e._v("defaultFontStyle")]),e._v(" was renamed to "),t("code",[e._v("font.style")])]),e._v(" "),t("li",[t("code",[e._v("defaultLineHeight")]),e._v(" was renamed to "),t("code",[e._v("font.lineHeight")])]),e._v(" "),t("li",[e._v("Horizontal Bar default tooltip mode was changed from "),t("code",[e._v("'index'")]),e._v(" to "),t("code",[e._v("'nearest'")]),e._v(" to match vertical bar charts")]),e._v(" "),t("li",[t("code",[e._v("legend")]),e._v(", "),t("code",[e._v("title")]),e._v(" and "),t("code",[e._v("tooltip")]),e._v(" namespaces were moved from "),t("code",[e._v("Chart.defaults")]),e._v(" to "),t("code",[e._v("Chart.defaults.plugins")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("elements.line.fill")]),e._v(" default changed from "),t("code",[e._v("true")]),e._v(" to "),t("code",[e._v("false")]),e._v(".")]),e._v(" "),t("li",[e._v("Line charts no longer override the default "),t("code",[e._v("interaction")]),e._v(" mode. Default is changed from "),t("code",[e._v("'index'")]),e._v(" to "),t("code",[e._v("'nearest'")]),e._v(".")])]),e._v(" "),t("h4",{attrs:{id:"scales"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#scales"}},[e._v("#")]),e._v(" Scales")]),e._v(" "),t("p",[e._v("The configuration options for scales is the largest change in v3. The "),t("code",[e._v("xAxes")]),e._v(" and "),t("code",[e._v("yAxes")]),e._v(" arrays were removed and axis options are individual scales now keyed by scale ID.")]),e._v(" "),t("p",[e._v("The v2 configuration below is shown with it's new v3 configuration")]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("options")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("scales")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("xAxes")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("id")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'x'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'time'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'Date'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("ticks")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("major")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("enabled")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token function-variable function"}},[e._v("font")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("function")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token parameter"}},[e._v("context")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("if")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("major"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("return")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("weight")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'bold'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("color")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'#FF0000'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("yAxes")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("id")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'y'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'value'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("And now, in v3:")]),e._v(" "),t("div",{staticClass:"language-javascript extra-class"},[t("pre",{pre:!0,attrs:{class:"language-javascript"}},[t("code",[t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("options")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("scales")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("x")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("type")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'time'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'Date'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("ticks")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("major")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("enabled")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token function-variable function"}},[e._v("color")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token parameter"}},[e._v("context")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=>")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("major "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'#FF0000'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token function-variable function"}},[e._v("font")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("function")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),t("span",{pre:!0,attrs:{class:"token parameter"}},[e._v("context")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("if")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&&")]),e._v(" context"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("tick"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("major"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("return")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("weight")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'bold'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("y")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("title")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("display")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token boolean"}},[e._v("true")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token literal-property property"}},[e._v("text")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'value'")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("ul",[t("li",[e._v("The time scale option "),t("code",[e._v("distribution: 'series'")]),e._v(" was removed and a new scale type "),t("code",[e._v("timeseries")]),e._v(" was introduced in its place")]),e._v(" "),t("li",[e._v("In the time scale, "),t("code",[e._v("autoSkip")]),e._v(" is now enabled by default for consistency with the other scales")])]),e._v(" "),t("h4",{attrs:{id:"animations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[e._v("#")]),e._v(" Animations")]),e._v(" "),t("p",[e._v("Animation system was completely rewritten in Chart.js v3. Each property can now be animated separately. Please see "),t("RouterLink",{attrs:{to:"/configuration/animations.html"}},[e._v("animations")]),e._v(" docs for details.")],1),e._v(" "),t("h4",{attrs:{id:"customizability"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#customizability"}},[e._v("#")]),e._v(" Customizability")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("custom")]),e._v(" attribute of elements was removed. Please use scriptable options")]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("hover")]),e._v(" property of scriptable options "),t("code",[e._v("context")]),e._v(" object was renamed to "),t("code",[e._v("active")]),e._v(" to align it with the datalabels plugin.")])]),e._v(" "),t("h4",{attrs:{id:"interactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interactions"}},[e._v("#")]),e._v(" Interactions")]),e._v(" "),t("ul",[t("li",[e._v("To allow DRY configuration, a root options scope for common interaction options was added. "),t("code",[e._v("options.hover")]),e._v(" and "),t("code",[e._v("options.plugins.tooltip")]),e._v(" now both extend from "),t("code",[e._v("options.interaction")]),e._v(". Defaults are defined at "),t("code",[e._v("defaults.interaction")]),e._v(" level, so by default hover and tooltip interactions share the same mode etc.")]),e._v(" "),t("li",[t("code",[e._v("interactions")]),e._v(" are now limited to the chart area + allowed overflow")]),e._v(" "),t("li",[t("code",[e._v("{mode: 'label'}")]),e._v(" was replaced with "),t("code",[e._v("{mode: 'index'}")])]),e._v(" "),t("li",[t("code",[e._v("{mode: 'single'}")]),e._v(" was replaced with "),t("code",[e._v("{mode: 'nearest', intersect: true}")])]),e._v(" "),t("li",[t("code",[e._v("modes['X-axis']")]),e._v(" was replaced with "),t("code",[e._v("{mode: 'index', intersect: false}")])]),e._v(" "),t("li",[t("code",[e._v("options.onClick")]),e._v(" is now limited to the chart area")]),e._v(" "),t("li",[t("code",[e._v("options.onClick")]),e._v(" and "),t("code",[e._v("options.onHover")]),e._v(" now receive the "),t("code",[e._v("chart")]),e._v(" instance as a 3rd argument")]),e._v(" "),t("li",[t("code",[e._v("options.onHover")]),e._v(" now receives a wrapped "),t("code",[e._v("event")]),e._v(" as the first parameter. The previous first parameter value is accessible via "),t("code",[e._v("event.native")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.hover.onHover")]),e._v(" was removed, use "),t("code",[e._v("options.onHover")]),e._v(".")])]),e._v(" "),t("h4",{attrs:{id:"ticks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[e._v("#")]),e._v(" Ticks")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("options.gridLines")]),e._v(" was renamed to "),t("code",[e._v("options.grid")])]),e._v(" "),t("li",[t("code",[e._v("options.gridLines.offsetGridLines")]),e._v(" was renamed to "),t("code",[e._v("options.grid.offset")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.gridLines.tickMarkLength")]),e._v(" was renamed to "),t("code",[e._v("options.grid.tickLength")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.ticks.fixedStepSize")]),e._v(" is no longer used. Use "),t("code",[e._v("options.ticks.stepSize")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.ticks.major")]),e._v(" and "),t("code",[e._v("options.ticks.minor")]),e._v(" were replaced with scriptable options for tick fonts.")]),e._v(" "),t("li",[t("code",[e._v("Chart.Ticks.formatters.linear")]),e._v(" was renamed to "),t("code",[e._v("Chart.Ticks.formatters.numeric")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("options.ticks.backdropPaddingX")]),e._v(" and "),t("code",[e._v("options.ticks.backdropPaddingY")]),e._v(" were replaced with "),t("code",[e._v("options.ticks.backdropPadding")]),e._v(" in the radial linear scale.")])]),e._v(" "),t("h4",{attrs:{id:"tooltip"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[e._v("#")]),e._v(" Tooltip")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("xLabel")]),e._v(" and "),t("code",[e._v("yLabel")]),e._v(" were removed. Please use "),t("code",[e._v("label")]),e._v(" and "),t("code",[e._v("formattedValue")])]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("filter")]),e._v(" option will now be passed additional parameters when called and should have the method signature "),t("code",[e._v("function(tooltipItem, index, tooltipItems, data)")])]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("custom")]),e._v(" callback now takes a context object that has "),t("code",[e._v("tooltip")]),e._v(" and "),t("code",[e._v("chart")]),e._v(" properties")]),e._v(" "),t("li",[e._v("All properties of tooltip model related to the tooltip options have been moved to reside within the "),t("code",[e._v("options")]),e._v(" property.")]),e._v(" "),t("li",[e._v("The callbacks no longer are given a "),t("code",[e._v("data")]),e._v(" parameter. The tooltip item parameter contains the chart and dataset instead")]),e._v(" "),t("li",[e._v("The tooltip item's "),t("code",[e._v("index")]),e._v(" parameter was renamed to "),t("code",[e._v("dataIndex")]),e._v(" and "),t("code",[e._v("value")]),e._v(" was renamed to "),t("code",[e._v("formattedValue")])]),e._v(" "),t("li",[e._v("The "),t("code",[e._v("xPadding")]),e._v(" and "),t("code",[e._v("yPadding")]),e._v(" options were merged into a single "),t("code",[e._v("padding")]),e._v(" object")])]),e._v(" "),t("h2",{attrs:{id:"developer-migration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-migration"}},[e._v("#")]),e._v(" Developer migration")]),e._v(" "),t("p",[e._v("While the end-user migration for Chart.js 3 is fairly straight-forward, the developer migration can be more complicated. Please reach out for help in the #dev "),t("a",{attrs:{href:"https://discord.gg/HxEguTK6av",target:"_blank",rel:"noopener noreferrer"}},[e._v("Discord"),t("OutboundLink")],1),e._v(" channel if tips on migrating would be helpful.")]),e._v(" "),t("p",[e._v("Some of the biggest things that have changed:")]),e._v(" "),t("ul",[t("li",[e._v("There is a completely rewritten and more performant animation system.\n"),t("ul",[t("li",[t("code",[e._v("Element._model")]),e._v(" and "),t("code",[e._v("Element._view")]),e._v(" are no longer used and properties are now set directly on the elements. You will have to use the method "),t("code",[e._v("getProps")]),e._v(" to access these properties inside most methods such as "),t("code",[e._v("inXRange")]),e._v("/"),t("code",[e._v("inYRange")]),e._v(" and "),t("code",[e._v("getCenterPoint")]),e._v(". Please take a look at "),t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/master/src/elements",target:"_blank",rel:"noopener noreferrer"}},[e._v("the Chart.js-provided elements"),t("OutboundLink")],1),e._v(" for examples.")]),e._v(" "),t("li",[e._v("When building the elements in a controller, it's now suggested to call "),t("code",[e._v("updateElement")]),e._v(" to provide the element properties. There are also methods such as "),t("code",[e._v("getSharedOptions")]),e._v(" and "),t("code",[e._v("includeOptions")]),e._v(" that have been added to skip redundant computation. Please take a look at "),t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/tree/master/src/controllers",target:"_blank",rel:"noopener noreferrer"}},[e._v("the Chart.js-provided controllers"),t("OutboundLink")],1),e._v(" for examples.")])])]),e._v(" "),t("li",[e._v("Scales introduced a new parsing API. This API takes user data and converts it into a more standard format. E.g. it allows users to provide numeric data as a "),t("code",[e._v("string")]),e._v(" and converts it to a "),t("code",[e._v("number")]),e._v(" where necessary. Previously this was done on the fly as charts were rendered. Now it's done up front with the ability to skip it for better performance if users provide data in the correct format. If you're using standard data format like "),t("code",[e._v("x")]),e._v("/"),t("code",[e._v("y")]),e._v(" you may not need to do anything. If you're using a custom data format you will have to override some of the parse methods in "),t("code",[e._v("core.datasetController.js")]),e._v(". An example can be found in "),t("a",{attrs:{href:"https://github.com/chartjs/chartjs-chart-financial",target:"_blank",rel:"noopener noreferrer"}},[e._v("chartjs-chart-financial"),t("OutboundLink")],1),e._v(", which uses an "),t("code",[e._v("{o, h, l, c}")]),e._v(" data format.")])]),e._v(" "),t("p",[e._v("A few changes were made to controllers that are more straight-forward, but will affect all controllers:")]),e._v(" "),t("ul",[t("li",[e._v("Options:\n"),t("ul",[t("li",[t("code",[e._v("global")]),e._v(" was removed from the defaults namespace as it was unnecessary and sometimes inconsistent")]),e._v(" "),t("li",[e._v("Dataset defaults are now under the chart type options instead of vice-versa. This was not able to be done when introduced in 2.x for backwards compatibility. Fixing it removes the biggest stumbling block that new chart developers encountered")]),e._v(" "),t("li",[e._v("Scale default options need to be updated as described in the end user migration section (e.g. "),t("code",[e._v("x")]),e._v(" instead of "),t("code",[e._v("xAxes")]),e._v(" and "),t("code",[e._v("y")]),e._v(" instead of "),t("code",[e._v("yAxes")]),e._v(")")])])]),e._v(" "),t("li",[t("code",[e._v("updateElement")]),e._v(" was changed to "),t("code",[e._v("updateElements")]),e._v(" and has a new method signature as described below. This provides performance enhancements such as allowing easier reuse of computations that are common to all elements and reducing the number of function calls")])]),e._v(" "),t("h3",{attrs:{id:"removed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed"}},[e._v("#")]),e._v(" Removed")]),e._v(" "),t("p",[e._v("The following properties and methods were removed:")]),e._v(" "),t("h4",{attrs:{id:"removed-from-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-chart"}},[e._v("#")]),e._v(" Removed from Chart")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart.animationService")])]),e._v(" "),t("li",[t("code",[e._v("Chart.active")])]),e._v(" "),t("li",[t("code",[e._v("Chart.borderWidth")])]),e._v(" "),t("li",[t("code",[e._v("Chart.chart.chart")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Bar")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.Bubble")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.Chart")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Controller")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Doughnut")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.innerRadius")]),e._v(" now lives on doughnut, pie, and polarArea controllers")]),e._v(" "),t("li",[t("code",[e._v("Chart.lastActive")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Legend")]),e._v(" was moved to "),t("code",[e._v("Chart.plugins.legend._element")]),e._v(" and made private")]),e._v(" "),t("li",[t("code",[e._v("Chart.Line")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.LinearScaleBase")]),e._v(" now must be imported and cannot be accessed off the "),t("code",[e._v("Chart")]),e._v(" object")]),e._v(" "),t("li",[t("code",[e._v("Chart.offsetX")])]),e._v(" "),t("li",[t("code",[e._v("Chart.offsetY")])]),e._v(" "),t("li",[t("code",[e._v("Chart.outerRadius")]),e._v(" now lives on doughnut, pie, and polarArea controllers")]),e._v(" "),t("li",[t("code",[e._v("Chart.plugins")]),e._v(" was replaced with "),t("code",[e._v("Chart.registry")]),e._v(". Plugin defaults are now in "),t("code",[e._v("Chart.defaults.plugins[id]")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Chart.plugins.register")]),e._v(" was replaced by "),t("code",[e._v("Chart.register")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Chart.PolarArea")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.prototype.generateLegend")])]),e._v(" "),t("li",[t("code",[e._v("Chart.platform")]),e._v(". It only contained "),t("code",[e._v("disableCSSInjection")]),e._v(". CSS is never injected in v3.")]),e._v(" "),t("li",[t("code",[e._v("Chart.PluginBase")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Radar")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.radiusLength")])]),e._v(" "),t("li",[t("code",[e._v("Chart.scaleService")]),e._v(" was replaced with "),t("code",[e._v("Chart.registry")]),e._v(". Scale defaults are now in "),t("code",[e._v("Chart.defaults.scales[type]")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Chart.Scatter")]),e._v(". New charts are created via "),t("code",[e._v("new Chart")]),e._v(" and providing the appropriate "),t("code",[e._v("type")]),e._v(" parameter")]),e._v(" "),t("li",[t("code",[e._v("Chart.types")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Title")]),e._v(" was moved to "),t("code",[e._v("Chart.plugins.title._element")]),e._v(" and made private")]),e._v(" "),t("li",[t("code",[e._v("Chart.Tooltip")]),e._v(" is now provided by the tooltip plugin. The positioners can be accessed from "),t("code",[e._v("tooltipPlugin.positioners")])]),e._v(" "),t("li",[t("code",[e._v("ILayoutItem.minSize")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-dataset-controllers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-dataset-controllers"}},[e._v("#")]),e._v(" Removed from Dataset Controllers")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BarController.getDatasetMeta().bar")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.addElementAndReset")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.createMetaData")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.createMetaDataset")])]),e._v(" "),t("li",[t("code",[e._v("DoughnutController.getRingIndex")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-elements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-elements"}},[e._v("#")]),e._v(" Removed from Elements")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Element.getArea")])]),e._v(" "),t("li",[t("code",[e._v("Element.height")])]),e._v(" "),t("li",[t("code",[e._v("Element.hidden")]),e._v(" was replaced by chart level status, usable with "),t("code",[e._v("getDataVisibility(index)")]),e._v(" / "),t("code",[e._v("toggleDataVisibility(index)")])]),e._v(" "),t("li",[t("code",[e._v("Element.initialize")])]),e._v(" "),t("li",[t("code",[e._v("Element.inLabelRange")])]),e._v(" "),t("li",[t("code",[e._v("Line.calculatePointY")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-helpers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-helpers"}},[e._v("#")]),e._v(" Removed from Helpers")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("helpers.addEvent")])]),e._v(" "),t("li",[t("code",[e._v("helpers.aliasPixel")])]),e._v(" "),t("li",[t("code",[e._v("helpers.arrayEquals")])]),e._v(" "),t("li",[t("code",[e._v("helpers.configMerge")])]),e._v(" "),t("li",[t("code",[e._v("helpers.findIndex")])]),e._v(" "),t("li",[t("code",[e._v("helpers.findNextWhere")])]),e._v(" "),t("li",[t("code",[e._v("helpers.findPreviousWhere")])]),e._v(" "),t("li",[t("code",[e._v("helpers.extend")]),e._v(". Use "),t("code",[e._v("Object.assign")]),e._v(" instead")]),e._v(" "),t("li",[t("code",[e._v("helpers.getValueAtIndexOrDefault")]),e._v(". Use "),t("code",[e._v("helpers.resolve")]),e._v(" instead.")]),e._v(" "),t("li",[t("code",[e._v("helpers.indexOf")])]),e._v(" "),t("li",[t("code",[e._v("helpers.lineTo")])]),e._v(" "),t("li",[t("code",[e._v("helpers.longestText")]),e._v(" was made private")]),e._v(" "),t("li",[t("code",[e._v("helpers.max")])]),e._v(" "),t("li",[t("code",[e._v("helpers.measureText")]),e._v(" was made private")]),e._v(" "),t("li",[t("code",[e._v("helpers.min")])]),e._v(" "),t("li",[t("code",[e._v("helpers.nextItem")])]),e._v(" "),t("li",[t("code",[e._v("helpers.niceNum")])]),e._v(" "),t("li",[t("code",[e._v("helpers.numberOfLabelLines")])]),e._v(" "),t("li",[t("code",[e._v("helpers.previousItem")])]),e._v(" "),t("li",[t("code",[e._v("helpers.removeEvent")])]),e._v(" "),t("li",[t("code",[e._v("helpers.roundedRect")])]),e._v(" "),t("li",[t("code",[e._v("helpers.scaleMerge")])]),e._v(" "),t("li",[t("code",[e._v("helpers.where")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-layout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-layout"}},[e._v("#")]),e._v(" Removed from Layout")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Layout.defaults")])])]),e._v(" "),t("h4",{attrs:{id:"removed-from-scales"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-scales"}},[e._v("#")]),e._v(" Removed from Scales")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("LinearScaleBase.handleDirectionalChanges")])]),e._v(" "),t("li",[t("code",[e._v("LogarithmicScale.minNotZero")])]),e._v(" "),t("li",[t("code",[e._v("Scale.getRightValue")])]),e._v(" "),t("li",[t("code",[e._v("Scale.longestLabelWidth")])]),e._v(" "),t("li",[t("code",[e._v("Scale.longestTextCache")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("Scale.margins")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("Scale.mergeTicksOptions")])]),e._v(" "),t("li",[t("code",[e._v("Scale.ticksAsNumbers")])]),e._v(" "),t("li",[t("code",[e._v("Scale.tickValues")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("TimeScale.getLabelCapacity")]),e._v(" is now private")]),e._v(" "),t("li",[t("code",[e._v("TimeScale.tickFormatFunction")]),e._v(" is now private")])]),e._v(" "),t("h4",{attrs:{id:"removed-from-plugins-legend-title-and-tooltip"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removed-from-plugins-legend-title-and-tooltip"}},[e._v("#")]),e._v(" Removed from Plugins (Legend, Title, and Tooltip)")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("IPlugin.afterScaleUpdate")]),e._v(". Use "),t("code",[e._v("afterLayout")]),e._v(" instead")]),e._v(" "),t("li",[t("code",[e._v("Legend.margins")]),e._v(" is now private")]),e._v(" "),t("li",[e._v("Legend "),t("code",[e._v("onClick")]),e._v(", "),t("code",[e._v("onHover")]),e._v(", and "),t("code",[e._v("onLeave")]),e._v(" options now receive the legend as the 3rd argument in addition to implicitly via "),t("code",[e._v("this")])]),e._v(" "),t("li",[e._v("Legend "),t("code",[e._v("onClick")]),e._v(", "),t("code",[e._v("onHover")]),e._v(", and "),t("code",[e._v("onLeave")]),e._v(" options now receive a wrapped "),t("code",[e._v("event")]),e._v(" as the first parameter. The previous first parameter value is accessible via "),t("code",[e._v("event.native")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("Title.margins")]),e._v(" is now private")]),e._v(" "),t("li",[e._v("The tooltip item's "),t("code",[e._v("x")]),e._v(" and "),t("code",[e._v("y")]),e._v(" attributes were replaced by "),t("code",[e._v("element")]),e._v(". You can use "),t("code",[e._v("element.x")]),e._v(" and "),t("code",[e._v("element.y")]),e._v(" or "),t("code",[e._v("element.tooltipPosition()")]),e._v(" instead.")])]),e._v(" "),t("h4",{attrs:{id:"removal-of-public-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removal-of-public-apis"}},[e._v("#")]),e._v(" Removal of Public APIs")]),e._v(" "),t("p",[e._v("The following public APIs were removed.")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("getElementAtEvent")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'nearest', { intersect: true }, false)")])]),e._v(" "),t("li",[t("code",[e._v("getElementsAtEvent")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'index', { intersect: true }, false)")])]),e._v(" "),t("li",[t("code",[e._v("getElementsAtXAxis")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'index', { intersect: false }, false)")])]),e._v(" "),t("li",[t("code",[e._v("getDatasetAtEvent")]),e._v(" is replaced with "),t("code",[e._v("chart.getElementsAtEventForMode(e, 'dataset', { intersect: true }, false)")])])]),e._v(" "),t("h4",{attrs:{id:"removal-of-private-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#removal-of-private-apis"}},[e._v("#")]),e._v(" Removal of private APIs")]),e._v(" "),t("p",[e._v("The following private APIs were removed.")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart._bufferedRender")])]),e._v(" "),t("li",[t("code",[e._v("Chart._updating")])]),e._v(" "),t("li",[t("code",[e._v("Chart.data.datasets[datasetIndex]._meta")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getIndexScaleId")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getIndexScale")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getValueScaleId")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController._getValueScale")])]),e._v(" "),t("li",[t("code",[e._v("Element._ctx")])]),e._v(" "),t("li",[t("code",[e._v("Element._model")])]),e._v(" "),t("li",[t("code",[e._v("Element._view")])]),e._v(" "),t("li",[t("code",[e._v("LogarithmicScale._valueOffset")])]),e._v(" "),t("li",[t("code",[e._v("TimeScale.getPixelForOffset")])]),e._v(" "),t("li",[t("code",[e._v("TimeScale.getLabelWidth")])]),e._v(" "),t("li",[t("code",[e._v("Tooltip._lastActive")])])]),e._v(" "),t("h3",{attrs:{id:"renamed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#renamed"}},[e._v("#")]),e._v(" Renamed")]),e._v(" "),t("p",[e._v("The following properties were renamed during v3 development:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart.Animation.animationObject")]),e._v(" was renamed to "),t("code",[e._v("Chart.Animation")])]),e._v(" "),t("li",[t("code",[e._v("Chart.Animation.chartInstance")]),e._v(" was renamed to "),t("code",[e._v("Chart.Animation.chart")])]),e._v(" "),t("li",[t("code",[e._v("Chart.canvasHelpers")]),e._v(" was merged with "),t("code",[e._v("Chart.helpers")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Arc")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.ArcElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Line")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.LineElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Point")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.PointElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.elements.Rectangle")]),e._v(" was renamed to "),t("code",[e._v("Chart.elements.BarElement")])]),e._v(" "),t("li",[t("code",[e._v("Chart.layoutService")]),e._v(" was renamed to "),t("code",[e._v("Chart.layouts")])]),e._v(" "),t("li",[t("code",[e._v("Chart.pluginService")]),e._v(" was renamed to "),t("code",[e._v("Chart.plugins")])]),e._v(" "),t("li",[t("code",[e._v("helpers.callCallback")]),e._v(" was renamed to "),t("code",[e._v("helpers.callback")])]),e._v(" "),t("li",[t("code",[e._v("helpers.drawRoundedRectangle")]),e._v(" was renamed to "),t("code",[e._v("helpers.roundedRect")])]),e._v(" "),t("li",[t("code",[e._v("helpers.getValueOrDefault")]),e._v(" was renamed to "),t("code",[e._v("helpers.valueOrDefault")])]),e._v(" "),t("li",[t("code",[e._v("LayoutItem.fullWidth")]),e._v(" was renamed to "),t("code",[e._v("LayoutItem.fullSize")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointPreviousX")]),e._v(" was renamed to "),t("code",[e._v("Point.cp1x")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointPreviousY")]),e._v(" was renamed to "),t("code",[e._v("Point.cp1y")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointNextX")]),e._v(" was renamed to "),t("code",[e._v("Point.cp2x")])]),e._v(" "),t("li",[t("code",[e._v("Point.controlPointNextY")]),e._v(" was renamed to "),t("code",[e._v("Point.cp2y")])]),e._v(" "),t("li",[t("code",[e._v("Scale.calculateTickRotation")]),e._v(" was renamed to "),t("code",[e._v("Scale.calculateLabelRotation")])]),e._v(" "),t("li",[t("code",[e._v("Tooltip.options.legendColorBackgroupd")]),e._v(" was renamed to "),t("code",[e._v("Tooltip.options.multiKeyBackground")])])]),e._v(" "),t("h4",{attrs:{id:"renamed-private-apis"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#renamed-private-apis"}},[e._v("#")]),e._v(" Renamed private APIs")]),e._v(" "),t("p",[e._v("The private APIs listed below were renamed:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BarController.calculateBarIndexPixels")]),e._v(" was renamed to "),t("code",[e._v("BarController._calculateBarIndexPixels")])]),e._v(" "),t("li",[t("code",[e._v("BarController.calculateBarValuePixels")]),e._v(" was renamed to "),t("code",[e._v("BarController._calculateBarValuePixels")])]),e._v(" "),t("li",[t("code",[e._v("BarController.getStackCount")]),e._v(" was renamed to "),t("code",[e._v("BarController._getStackCount")])]),e._v(" "),t("li",[t("code",[e._v("BarController.getStackIndex")]),e._v(" was renamed to "),t("code",[e._v("BarController._getStackIndex")])]),e._v(" "),t("li",[t("code",[e._v("BarController.getRuler")]),e._v(" was renamed to "),t("code",[e._v("BarController._getRuler")])]),e._v(" "),t("li",[t("code",[e._v("Chart.destroyDatasetMeta")]),e._v(" was renamed to "),t("code",[e._v("Chart._destroyDatasetMeta")])]),e._v(" "),t("li",[t("code",[e._v("Chart.drawDataset")]),e._v(" was renamed to "),t("code",[e._v("Chart._drawDataset")])]),e._v(" "),t("li",[t("code",[e._v("Chart.drawDatasets")]),e._v(" was renamed to "),t("code",[e._v("Chart._drawDatasets")])]),e._v(" "),t("li",[t("code",[e._v("Chart.eventHandler")]),e._v(" was renamed to "),t("code",[e._v("Chart._eventHandler")])]),e._v(" "),t("li",[t("code",[e._v("Chart.handleEvent")]),e._v(" was renamed to "),t("code",[e._v("Chart._handleEvent")])]),e._v(" "),t("li",[t("code",[e._v("Chart.initialize")]),e._v(" was renamed to "),t("code",[e._v("Chart._initialize")])]),e._v(" "),t("li",[t("code",[e._v("Chart.resetElements")]),e._v(" was renamed to "),t("code",[e._v("Chart._resetElements")])]),e._v(" "),t("li",[t("code",[e._v("Chart.unbindEvents")]),e._v(" was renamed to "),t("code",[e._v("Chart._unbindEvents")])]),e._v(" "),t("li",[t("code",[e._v("Chart.updateDataset")]),e._v(" was renamed to "),t("code",[e._v("Chart._updateDataset")])]),e._v(" "),t("li",[t("code",[e._v("Chart.updateDatasets")]),e._v(" was renamed to "),t("code",[e._v("Chart._updateDatasets")])]),e._v(" "),t("li",[t("code",[e._v("Chart.updateLayout")]),e._v(" was renamed to "),t("code",[e._v("Chart._updateLayout")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.destroy")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._destroy")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.insertElements")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._insertElements")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataPop")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataPop")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataPush")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataPush")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataShift")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataShift")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataSplice")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataSplice")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.onDataUnshift")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._onDataUnshift")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.removeElements")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._removeElements")])]),e._v(" "),t("li",[t("code",[e._v("DatasetController.resyncElements")]),e._v(" was renamed to "),t("code",[e._v("DatasetController._resyncElements")])]),e._v(" "),t("li",[t("code",[e._v("LayoutItem.isFullWidth")]),e._v(" was renamed to "),t("code",[e._v("LayoutItem.isFullSize")])]),e._v(" "),t("li",[t("code",[e._v("RadialLinearScale.setReductions")]),e._v(" was renamed to "),t("code",[e._v("RadialLinearScale._setReductions")])]),e._v(" "),t("li",[t("code",[e._v("RadialLinearScale.pointLabels")]),e._v(" was renamed to "),t("code",[e._v("RadialLinearScale._pointLabels")])]),e._v(" "),t("li",[t("code",[e._v("Scale.handleMargins")]),e._v(" was renamed to "),t("code",[e._v("Scale._handleMargins")])])]),e._v(" "),t("h3",{attrs:{id:"changed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed"}},[e._v("#")]),e._v(" Changed")]),e._v(" "),t("p",[e._v("The APIs listed in this section have changed in signature or behaviour from version 2.")]),e._v(" "),t("h4",{attrs:{id:"changed-in-scales"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-scales"}},[e._v("#")]),e._v(" Changed in Scales")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Scale.getLabelForIndex")]),e._v(" was replaced by "),t("code",[e._v("scale.getLabelForValue")])]),e._v(" "),t("li",[t("code",[e._v("Scale.getPixelForValue")]),e._v(" now only requires one parameter. For the "),t("code",[e._v("TimeScale")]),e._v(" that parameter must be millis since the epoch. As a performance optimization, it may take an optional second parameter, giving the index of the data point.")])]),e._v(" "),t("h5",{attrs:{id:"changed-in-ticks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-ticks"}},[e._v("#")]),e._v(" Changed in Ticks")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Scale.afterBuildTicks")]),e._v(" now has no parameters like the other callbacks")]),e._v(" "),t("li",[t("code",[e._v("Scale.buildTicks")]),e._v(" is now expected to return tick objects")]),e._v(" "),t("li",[t("code",[e._v("Scale.convertTicksToLabels")]),e._v(" was renamed to "),t("code",[e._v("generateTickLabels")]),e._v(". It is now expected to set the label property on the ticks given as input")]),e._v(" "),t("li",[t("code",[e._v("Scale.ticks")]),e._v(" now contains objects instead of strings")]),e._v(" "),t("li",[e._v("When the "),t("code",[e._v("autoSkip")]),e._v(" option is enabled, "),t("code",[e._v("Scale.ticks")]),e._v(" now contains only the non-skipped ticks instead of all ticks.")]),e._v(" "),t("li",[e._v("Ticks are now always generated in monotonically increasing order")])]),e._v(" "),t("h5",{attrs:{id:"changed-in-time-scale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-time-scale"}},[e._v("#")]),e._v(" Changed in Time Scale")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("getValueForPixel")]),e._v(" now returns milliseconds since the epoch")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-controllers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-controllers"}},[e._v("#")]),e._v(" Changed in Controllers")]),e._v(" "),t("h5",{attrs:{id:"core-controller"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#core-controller"}},[e._v("#")]),e._v(" Core Controller")]),e._v(" "),t("ul",[t("li",[e._v("The first parameter to "),t("code",[e._v("updateHoverStyle")]),e._v(" is now an array of objects containing the "),t("code",[e._v("element")]),e._v(", "),t("code",[e._v("datasetIndex")]),e._v(", and "),t("code",[e._v("index")])]),e._v(" "),t("li",[e._v("The signature or "),t("code",[e._v("resize")]),e._v(" changed, the first "),t("code",[e._v("silent")]),e._v(" parameter was removed.")])]),e._v(" "),t("h5",{attrs:{id:"dataset-controllers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dataset-controllers"}},[e._v("#")]),e._v(" Dataset Controllers")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("updateElement")]),e._v(" was replaced with "),t("code",[e._v("updateElements")]),e._v(" now taking the elements to update, the "),t("code",[e._v("start")]),e._v(" index, "),t("code",[e._v("count")]),e._v(", and "),t("code",[e._v("mode")])]),e._v(" "),t("li",[t("code",[e._v("setHoverStyle")]),e._v(" and "),t("code",[e._v("removeHoverStyle")]),e._v(" now additionally take the "),t("code",[e._v("datasetIndex")]),e._v(" and "),t("code",[e._v("index")])])]),e._v(" "),t("h4",{attrs:{id:"changed-in-interactions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-interactions"}},[e._v("#")]),e._v(" Changed in Interactions")]),e._v(" "),t("ul",[t("li",[e._v("Interaction mode methods now return an array of objects containing the "),t("code",[e._v("element")]),e._v(", "),t("code",[e._v("datasetIndex")]),e._v(", and "),t("code",[e._v("index")])])]),e._v(" "),t("h4",{attrs:{id:"changed-in-layout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-layout"}},[e._v("#")]),e._v(" Changed in Layout")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("ILayoutItem.update")]),e._v(" no longer has a return value")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-helpers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-helpers"}},[e._v("#")]),e._v(" Changed in Helpers")]),e._v(" "),t("p",[e._v("All helpers are now exposed in a flat hierarchy, e.g., "),t("code",[e._v("Chart.helpers.canvas.clipArea")]),e._v(" -> "),t("code",[e._v("Chart.helpers.clipArea")])]),e._v(" "),t("h5",{attrs:{id:"canvas-helper"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#canvas-helper"}},[e._v("#")]),e._v(" Canvas Helper")]),e._v(" "),t("ul",[t("li",[e._v("The second parameter to "),t("code",[e._v("drawPoint")]),e._v(" is now the full options object, so "),t("code",[e._v("style")]),e._v(", "),t("code",[e._v("rotation")]),e._v(", and "),t("code",[e._v("radius")]),e._v(" are no longer passed explicitly")]),e._v(" "),t("li",[t("code",[e._v("helpers.getMaximumHeight")]),e._v(" was replaced by "),t("code",[e._v("helpers.dom.getMaximumSize")])]),e._v(" "),t("li",[t("code",[e._v("helpers.getMaximumWidth")]),e._v(" was replaced by "),t("code",[e._v("helpers.dom.getMaximumSize")])]),e._v(" "),t("li",[t("code",[e._v("helpers.clear")]),e._v(" was renamed to "),t("code",[e._v("helpers.clearCanvas")]),e._v(" and now takes "),t("code",[e._v("canvas")]),e._v(" and optionally "),t("code",[e._v("ctx")]),e._v(" as parameter(s).")]),e._v(" "),t("li",[t("code",[e._v("helpers.retinaScale")]),e._v(" accepts optional third parameter "),t("code",[e._v("forceStyle")]),e._v(", which forces overriding current canvas style. "),t("code",[e._v("forceRatio")]),e._v(" no longer falls back to "),t("code",[e._v("window.devicePixelRatio")]),e._v(", instead it defaults to "),t("code",[e._v("1")]),e._v(".")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-platform"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-platform"}},[e._v("#")]),e._v(" Changed in Platform")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Chart.platform")]),e._v(" is no longer the platform object used by charts. Every chart instance now has a separate platform instance.")]),e._v(" "),t("li",[t("code",[e._v("Chart.platforms")]),e._v(" is an object that contains two usable platform classes, "),t("code",[e._v("BasicPlatform")]),e._v(" and "),t("code",[e._v("DomPlatform")]),e._v(". It also contains "),t("code",[e._v("BasePlatform")]),e._v(", a class that all platforms must extend from.")]),e._v(" "),t("li",[e._v("If the canvas passed in is an instance of "),t("code",[e._v("OffscreenCanvas")]),e._v(", the "),t("code",[e._v("BasicPlatform")]),e._v(" is automatically used.")]),e._v(" "),t("li",[t("code",[e._v("isAttached")]),e._v(" method was added to platform.")])]),e._v(" "),t("h4",{attrs:{id:"changed-in-iplugin-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#changed-in-iplugin-interface"}},[e._v("#")]),e._v(" Changed in IPlugin interface")]),e._v(" "),t("ul",[t("li",[e._v("All plugin hooks have unified signature with 3 arguments: "),t("code",[e._v("chart")]),e._v(", "),t("code",[e._v("args")]),e._v(" and "),t("code",[e._v("options")]),e._v(". This means change in signature for these hooks: "),t("code",[e._v("beforeInit")]),e._v(", "),t("code",[e._v("afterInit")]),e._v(", "),t("code",[e._v("reset")]),e._v(", "),t("code",[e._v("beforeLayout")]),e._v(", "),t("code",[e._v("afterLayout")]),e._v(", "),t("code",[e._v("beforeRender")]),e._v(", "),t("code",[e._v("afterRender")]),e._v(", "),t("code",[e._v("beforeDraw")]),e._v(", "),t("code",[e._v("afterDraw")]),e._v(", "),t("code",[e._v("beforeDatasetsDraw")]),e._v(", "),t("code",[e._v("afterDatasetsDraw")]),e._v(", "),t("code",[e._v("beforeEvent")]),e._v(", "),t("code",[e._v("afterEvent")]),e._v(", "),t("code",[e._v("resize")]),e._v(", "),t("code",[e._v("destroy")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("afterDatasetsUpdate")]),e._v(", "),t("code",[e._v("afterUpdate")]),e._v(", "),t("code",[e._v("beforeDatasetsUpdate")]),e._v(", and "),t("code",[e._v("beforeUpdate")]),e._v(" now receive "),t("code",[e._v("args")]),e._v(" object as second argument. "),t("code",[e._v("options")]),e._v(" argument is always the last and thus was moved from 2nd to 3rd place.")]),e._v(" "),t("li",[t("code",[e._v("afterEvent")]),e._v(" and "),t("code",[e._v("beforeEvent")]),e._v(" now receive a wrapped "),t("code",[e._v("event")]),e._v(" as the "),t("code",[e._v("event")]),e._v(" property of the second argument. The native event is available via "),t("code",[e._v("args.event.native")]),e._v(".")]),e._v(" "),t("li",[e._v("Initial "),t("code",[e._v("resize")]),e._v(" is no longer silent. Meaning that "),t("code",[e._v("resize")]),e._v(" event can fire between "),t("code",[e._v("beforeInit")]),e._v(" and "),t("code",[e._v("afterInit")])]),e._v(" "),t("li",[e._v("New hooks: "),t("code",[e._v("install")]),e._v(", "),t("code",[e._v("start")]),e._v(", "),t("code",[e._v("stop")]),e._v(", and "),t("code",[e._v("uninstall")])]),e._v(" "),t("li",[t("code",[e._v("afterEvent")]),e._v(" should notify about changes that need a render by setting "),t("code",[e._v("args.changed")]),e._v(" to true. Because the "),t("code",[e._v("args")]),e._v(" are shared with all plugins, it should only be set to true and not false.")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/188.50401256.js b/docs/master/assets/js/188.a317180e.js similarity index 98% rename from docs/master/assets/js/188.50401256.js rename to docs/master/assets/js/188.a317180e.js index c3f9b27d08..060d48faa2 100644 --- a/docs/master/assets/js/188.50401256.js +++ b/docs/master/assets/js/188.a317180e.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[188],{525:function(n,t,a){"use strict";a.r(t);var i=a(3),e=Object(i.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"data-decimation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#data-decimation"}},[n._v("#")]),n._v(" Data Decimation")]),n._v(" "),t("p",[n._v("This example shows how to use the built-in data decimation to reduce the number of points drawn on the graph for improved performance.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'No decimation (default)',\n handler(chart) {\n chart.options.plugins.decimation.enabled = false;\n chart.update();\n }\n },\n {\n name: 'min-max decimation',\n handler(chart) {\n chart.options.plugins.decimation.algorithm = 'min-max';\n chart.options.plugins.decimation.enabled = true;\n chart.update();\n },\n },\n {\n name: 'LTTB decimation (50 samples)',\n handler(chart) {\n chart.options.plugins.decimation.algorithm = 'lttb';\n chart.options.plugins.decimation.enabled = true;\n chart.options.plugins.decimation.samples = 50;\n chart.update();\n }\n },\n {\n name: 'LTTB decimation (500 samples)',\n handler(chart) {\n chart.options.plugins.decimation.algorithm = 'lttb';\n chart.options.plugins.decimation.enabled = true;\n chart.options.plugins.decimation.samples = 500;\n chart.update();\n }\n }\n];\n// \n\n// \nconst NUM_POINTS = 100000;\nUtils.srand(10);\n\n// parseISODate returns a luxon date object to work with in the samples\n// We will create points every 30s starting from this point in time\nconst start = Utils.parseISODate('2021-04-01T00:00:00Z').toMillis();\nconst pointData = [];\n\nfor (let i = 0; i < NUM_POINTS; ++i) {\n // Most data will be in the range [0, 20) but some rare data will be in the range [0, 100)\n const max = Math.random() < 0.001 ? 100 : 20;\n pointData.push({x: start + (i * 30000), y: Utils.rand(0, max)});\n}\n\nconst data = {\n datasets: [{\n borderColor: Utils.CHART_COLORS.red,\n borderWidth: 1,\n data: pointData,\n label: 'Large Dataset',\n radius: 0,\n }]\n};\n// \n\n// \nconst decimation = {\n enabled: false,\n algorithm: 'min-max',\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n // Turn off animations and data parsing for performance\n animation: false,\n parsing: false,\n\n interaction: {\n mode: 'nearest',\n axis: 'x',\n intersect: false\n },\n plugins: {\n decimation: decimation,\n },\n scales: {\n x: {\n type: 'time',\n ticks: {\n source: 'auto',\n // Disabled rotation for performance\n maxRotation: 0,\n autoSkip: true,\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[n._v("Data Decimation")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[n._v("Time Scale")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[188],{524:function(n,t,a){"use strict";a.r(t);var i=a(3),e=Object(i.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"data-decimation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#data-decimation"}},[n._v("#")]),n._v(" Data Decimation")]),n._v(" "),t("p",[n._v("This example shows how to use the built-in data decimation to reduce the number of points drawn on the graph for improved performance.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'No decimation (default)',\n handler(chart) {\n chart.options.plugins.decimation.enabled = false;\n chart.update();\n }\n },\n {\n name: 'min-max decimation',\n handler(chart) {\n chart.options.plugins.decimation.algorithm = 'min-max';\n chart.options.plugins.decimation.enabled = true;\n chart.update();\n },\n },\n {\n name: 'LTTB decimation (50 samples)',\n handler(chart) {\n chart.options.plugins.decimation.algorithm = 'lttb';\n chart.options.plugins.decimation.enabled = true;\n chart.options.plugins.decimation.samples = 50;\n chart.update();\n }\n },\n {\n name: 'LTTB decimation (500 samples)',\n handler(chart) {\n chart.options.plugins.decimation.algorithm = 'lttb';\n chart.options.plugins.decimation.enabled = true;\n chart.options.plugins.decimation.samples = 500;\n chart.update();\n }\n }\n];\n// \n\n// \nconst NUM_POINTS = 100000;\nUtils.srand(10);\n\n// parseISODate returns a luxon date object to work with in the samples\n// We will create points every 30s starting from this point in time\nconst start = Utils.parseISODate('2021-04-01T00:00:00Z').toMillis();\nconst pointData = [];\n\nfor (let i = 0; i < NUM_POINTS; ++i) {\n // Most data will be in the range [0, 20) but some rare data will be in the range [0, 100)\n const max = Math.random() < 0.001 ? 100 : 20;\n pointData.push({x: start + (i * 30000), y: Utils.rand(0, max)});\n}\n\nconst data = {\n datasets: [{\n borderColor: Utils.CHART_COLORS.red,\n borderWidth: 1,\n data: pointData,\n label: 'Large Dataset',\n radius: 0,\n }]\n};\n// \n\n// \nconst decimation = {\n enabled: false,\n algorithm: 'min-max',\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n // Turn off animations and data parsing for performance\n animation: false,\n parsing: false,\n\n interaction: {\n mode: 'nearest',\n axis: 'x',\n intersect: false\n },\n plugins: {\n decimation: decimation,\n },\n scales: {\n x: {\n type: 'time',\n ticks: {\n source: 'auto',\n // Disabled rotation for performance\n maxRotation: 0,\n autoSkip: true,\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/configuration/decimation.html"}},[n._v("Data Decimation")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[n._v("Time Scale")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/189.1a084e86.js b/docs/master/assets/js/189.5bcab025.js similarity index 99% rename from docs/master/assets/js/189.1a084e86.js rename to docs/master/assets/js/189.5bcab025.js index d2454285e6..3f779ae7b3 100644 --- a/docs/master/assets/js/189.1a084e86.js +++ b/docs/master/assets/js/189.5bcab025.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[189],{523:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"derived-axis-type"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#derived-axis-type"}},[t._v("#")]),t._v(" Derived Axis Type")]),t._v(" "),s("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 12;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 1000};\nconst labels = Utils.months({count: DATA_COUNT});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'My First dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n fill: false,\n }\n ],\n};\n// \n\n// \nconst config = {\n type: 'line',\n data,\n options: {\n responsive: true,\n scales: {\n x: {\n display: true,\n },\n y: {\n display: true,\n type: 'log2',\n }\n }\n }\n};\n\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),s("h2",{attrs:{id:"log2-axis-implementation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#log2-axis-implementation"}},[t._v("#")]),t._v(" Log2 axis implementation")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("Scale"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" LinearScale"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Log2Axis")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Scale")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("constructor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("cfg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("undefined")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("parse")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("raw"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("LinearScale")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("prototype"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("parse")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apply")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("raw"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFinite")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("determineDataLimits")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMinMax")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFinite")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("max")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFinite")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("max")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildTicks")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ticks "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" power "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("floor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" maxPower "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("ceil")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("while")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("power "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<=")]),t._v(" maxPower"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" power"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n power "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/**\n * @protected\n */")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("configure")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" start "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("configure")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("start"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("start"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPixelForValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("undefined")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPixelForDecimal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("pixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" decimal "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDecimalForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pixel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" decimal "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nLog2Axis"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'log2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nLog2Axis"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The derived axis is registered like this:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chart.register(Log2Axis);")]),t._v("\n")])])]),s("h2",{attrs:{id:"docs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),s("ul",[s("li",[s("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),s("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),s("li",[s("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),s("li",[s("RouterLink",{attrs:{to:"/developers/axes.html"}},[t._v("New Axes")])],1)])],1)}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[189],{525:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"derived-axis-type"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#derived-axis-type"}},[t._v("#")]),t._v(" Derived Axis Type")]),t._v(" "),s("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 12;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 1000};\nconst labels = Utils.months({count: DATA_COUNT});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'My First dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n fill: false,\n }\n ],\n};\n// \n\n// \nconst config = {\n type: 'line',\n data,\n options: {\n responsive: true,\n scales: {\n x: {\n display: true,\n },\n y: {\n display: true,\n type: 'log2',\n }\n }\n }\n};\n\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),s("h2",{attrs:{id:"log2-axis-implementation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#log2-axis-implementation"}},[t._v("#")]),t._v(" Log2 axis implementation")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("Scale"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" LinearScale"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("default")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Log2Axis")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Scale")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("constructor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("cfg")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("undefined")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("parse")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("raw"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("LinearScale")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("prototype"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("parse")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("apply")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("raw"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" index"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFinite")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("&&")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("determineDataLimits")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMinMax")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFinite")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("max")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("isFinite")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("max")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("buildTicks")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ticks "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" power "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("floor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("let")]),t._v(" maxPower "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("ceil")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("while")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("power "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<=")]),t._v(" maxPower"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("value")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" power"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n power "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" ticks"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("/**\n * @protected\n */")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("configure")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" start "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("configure")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("start"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("start"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPixelForValue")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("undefined")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getPixelForDecimal")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getValueForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("pixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" decimal "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getDecimalForPixel")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("pixel"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_startValue "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" decimal "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("_valueRange"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\nLog2Axis"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'log2'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nLog2Axis"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// The derived axis is registered like this:")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Chart.register(Log2Axis);")]),t._v("\n")])])]),s("h2",{attrs:{id:"docs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),s("ul",[s("li",[s("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),s("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),s("li",[s("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),s("li",[s("RouterLink",{attrs:{to:"/developers/axes.html"}},[t._v("New Axes")])],1)])],1)}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/19.239d4da8.js b/docs/master/assets/js/19.6be7ec61.js similarity index 94% rename from docs/master/assets/js/19.239d4da8.js rename to docs/master/assets/js/19.6be7ec61.js index 7ec6d64036..9a63153d69 100644 --- a/docs/master/assets/js/19.239d4da8.js +++ b/docs/master/assets/js/19.6be7ec61.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{352:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-chart-ttype-tdata-tlabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-chart-ttype-tdata-tlabel"}},[t._v("#")]),t._v(" Class: Chart")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#defaultdatapoint"}},[e("code",[t._v("DefaultDataPoint")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TLabel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Chart")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">("),e("code",[t._v("item")]),t._v(", "),e("code",[t._v("config")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v(" = keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TLabel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartitem"}},[e("code",[t._v("ChartItem")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v("> | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L509",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:509"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"aspectratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aspectratio"}},[t._v("#")]),t._v(" aspectRatio")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("aspectRatio")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L496",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:496"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"attached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#attached"}},[t._v("#")]),t._v(" attached")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("attached")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L501",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:501"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxes"}},[t._v("#")]),t._v(" boxes")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("boxes")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L497",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:497"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"canvas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#canvas"}},[t._v("#")]),t._v(" canvas")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("canvas")]),t._v(": "),e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L491",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:491"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartarea"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartarea"}},[t._v("#")]),t._v(" chartArea")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chartArea")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L499",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:499"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"config"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#config"}},[t._v("#")]),t._v(" config")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("config")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v("> | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L493",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:493"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L492",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:492"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"currentdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#currentdevicepixelratio"}},[t._v("#")]),t._v(" currentDevicePixelRatio")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("currentDevicePixelRatio")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L498",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:498"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data"}},[t._v("#")]),t._v(" data")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("data")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L506",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:506"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L495",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:495"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L490",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:490"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"legend"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend"}},[t._v("#")]),t._v(" legend")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("legend")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LegendElement.html"}},[e("code",[t._v("LegendElement")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L503",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:503"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("DeepPartial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreChartOptions.html"}},[e("code",[t._v("CoreChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#elementchartoptions"}},[e("code",[t._v("ElementChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/PluginChartOptions.html"}},[e("code",[t._v("PluginChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#datasetchartoptions"}},[e("code",[t._v("DatasetChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#scalechartoptions"}},[e("code",[t._v("ScaleChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"chartOptions"')]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L507",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:507"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"platform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#platform"}},[t._v("#")]),t._v(" platform")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("platform")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[e("code",[t._v("BasePlatform")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L489",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:489"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scales"}},[t._v("#")]),t._v(" scales")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("scales")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"index-signature"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [key: "),e("code",[t._v("string")]),t._v("]: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L500",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:500"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" tooltip")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("tooltip")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L504",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:504"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L494",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:494"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Defaults.html"}},[e("code",[t._v("Defaults")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L551",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:551"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"instances"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#instances"}},[t._v("#")]),t._v(" instances")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("instances")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"index-signature-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature-2"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [key: "),e("code",[t._v("string")]),t._v("]: "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L554",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:554"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" overrides")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("overrides")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#overrides"}},[e("code",[t._v("Overrides")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L552",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:552"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"registry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registry"}},[t._v("#")]),t._v(" registry")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("registry")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Registry.html"}},[e("code",[t._v("Registry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L555",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:555"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"version"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#version"}},[t._v("#")]),t._v(" version")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("version")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L553",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:553"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"bindevents"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bindevents"}},[t._v("#")]),t._v(" bindEvents")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("bindEvents")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L541",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:541"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdatecontrollers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdatecontrollers"}},[t._v("#")]),t._v(" buildOrUpdateControllers")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateControllers")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L517",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:517"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdatescales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdatescales"}},[t._v("#")]),t._v(" buildOrUpdateScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateScales")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L516",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:516"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"clear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clear"}},[t._v("#")]),t._v(" clear")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("clear")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L511",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:511"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"destroy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#destroy"}},[t._v("#")]),t._v(" destroy")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("destroy")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L539",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:539"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L521",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:521"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ensurescaleshaveids"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ensurescaleshaveids"}},[t._v("#")]),t._v(" ensureScalesHaveIDs")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("ensureScalesHaveIDs")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L515",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:515"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getactiveelements"}},[t._v("#")]),t._v(" getActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getActiveElements")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L536",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:536"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcontext"}},[t._v("#")]),t._v(" getContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getContext")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L549",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:549"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdatavisibility"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdatavisibility"}},[t._v("#")]),t._v(" getDataVisibility")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataVisibility")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L532",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:532"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdatasetmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdatasetmeta"}},[t._v("#")]),t._v(" getDatasetMeta")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDatasetMeta")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L527",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:527"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getelementsateventformode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getelementsateventformode"}},[t._v("#")]),t._v(" getElementsAtEventForMode")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getElementsAtEventForMode")]),t._v("("),e("code",[t._v("e")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("options")]),t._v(", "),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("e")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Event")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[e("code",[t._v("InteractionOptions")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L524",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:524"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getsortedvisibledatasetmetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getsortedvisibledatasetmetas"}},[t._v("#")]),t._v(" getSortedVisibleDatasetMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getSortedVisibleDatasetMetas")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L526",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:526"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvisibledatasetcount"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvisibledatasetcount"}},[t._v("#")]),t._v(" getVisibleDatasetCount")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getVisibleDatasetCount")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L528",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:528"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hide"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hide"}},[t._v("#")]),t._v(" hide")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hide")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("dataIndex?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("dataIndex?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L533",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:533"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isdatasetvisible"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isdatasetvisible"}},[t._v("#")]),t._v(" isDatasetVisible")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isDatasetVisible")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L529",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:529"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ispluginenabled"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ispluginenabled"}},[t._v("#")]),t._v(" isPluginEnabled")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isPluginEnabled")]),t._v("("),e("code",[t._v("pluginId")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pluginId")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L547",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:547"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ispointinarea"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ispointinarea"}},[t._v("#")]),t._v(" isPointInArea")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isPointInArea")]),t._v("("),e("code",[t._v("point")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("point")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L523",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:523"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"notifyplugins"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#notifyplugins"}},[t._v("#")]),t._v(" notifyPlugins")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("notifyPlugins")]),t._v("("),e("code",[t._v("hook")]),t._v(", "),e("code",[t._v("args?")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hook")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L545",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:545"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"render"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#render"}},[t._v("#")]),t._v(" render")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("render")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L520",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:520"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("reset")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L518",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:518"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resize"}},[t._v("#")]),t._v(" resize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("resize")]),t._v("("),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L514",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:514"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setactiveelements"}},[t._v("#")]),t._v(" setActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setActiveElements")]),t._v("("),e("code",[t._v("active")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[e("code",[t._v("ActiveDataPoint")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L537",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:537"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdatasetvisibility"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdatasetvisibility"}},[t._v("#")]),t._v(" setDatasetVisibility")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDatasetVisibility")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("visible")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("visible")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L530",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:530"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"show"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#show"}},[t._v("#")]),t._v(" show")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("show")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("dataIndex?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("dataIndex?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L534",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:534"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("stop")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L512",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:512"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tobase64image"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tobase64image"}},[t._v("#")]),t._v(" toBase64Image")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("toBase64Image")]),t._v("("),e("code",[t._v("type?")]),t._v(", "),e("code",[t._v("quality?")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("quality?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L540",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:540"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"toggledatavisibility"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#toggledatavisibility"}},[t._v("#")]),t._v(" toggleDataVisibility")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("toggleDataVisibility")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L531",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:531"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"unbindevents"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unbindevents"}},[t._v("#")]),t._v(" unbindEvents")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("unbindEvents")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L542",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:542"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("mode?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')]),t._v(" | ("),e("code",[t._v("ctx")]),t._v(": { "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(" }) => "),e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L519",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:519"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatehoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatehoverstyle"}},[t._v("#")]),t._v(" updateHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateHoverStyle")]),t._v("("),e("code",[t._v("items")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("enabled")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"dataset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("enabled")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L543",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:543"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getchart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getchart"}},[t._v("#")]),t._v(" getChart")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("getChart")]),t._v("("),e("code",[t._v("key")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("key")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")]),t._v(" | "),e("code",[t._v("CanvasRenderingContext2D")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L556",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:556"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"register"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#register"}},[t._v("#")]),t._v(" register")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("register")]),t._v("("),e("code",[t._v("...items")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L557",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:557"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"unregister"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unregister"}},[t._v("#")]),t._v(" unregister")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("unregister")]),t._v("("),e("code",[t._v("...items")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L558",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:558"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{350:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-chart-ttype-tdata-tlabel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-chart-ttype-tdata-tlabel"}},[t._v("#")]),t._v(" Class: Chart")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#defaultdatapoint"}},[e("code",[t._v("DefaultDataPoint")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TLabel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Chart")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">("),e("code",[t._v("item")]),t._v(", "),e("code",[t._v("config")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v(" = keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("DistributiveArray")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"defaultDataPoint"')]),t._v("]>")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TLabel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("item")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartitem"}},[e("code",[t._v("ChartItem")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v("> | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L509",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:509"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"aspectratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aspectratio"}},[t._v("#")]),t._v(" aspectRatio")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("aspectRatio")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L496",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:496"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"attached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#attached"}},[t._v("#")]),t._v(" attached")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("attached")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L501",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:501"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"boxes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#boxes"}},[t._v("#")]),t._v(" boxes")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("boxes")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L497",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:497"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"canvas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#canvas"}},[t._v("#")]),t._v(" canvas")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("canvas")]),t._v(": "),e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L491",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:491"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chartarea"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chartarea"}},[t._v("#")]),t._v(" chartArea")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chartArea")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L499",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:499"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"config"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#config"}},[t._v("#")]),t._v(" config")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("config")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v("> | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L493",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:493"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L492",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:492"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"currentdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#currentdevicepixelratio"}},[t._v("#")]),t._v(" currentDevicePixelRatio")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("currentDevicePixelRatio")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L498",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:498"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"data"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#data"}},[t._v("#")]),t._v(" data")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("data")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartData.html"}},[e("code",[t._v("ChartData")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L506",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:506"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L495",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:495"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L490",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:490"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"legend"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#legend"}},[t._v("#")]),t._v(" legend")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("legend")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/LegendElement.html"}},[e("code",[t._v("LegendElement")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L503",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:503"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("DeepPartial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreChartOptions.html"}},[e("code",[t._v("CoreChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#elementchartoptions"}},[e("code",[t._v("ElementChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/PluginChartOptions.html"}},[e("code",[t._v("PluginChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#datasetchartoptions"}},[e("code",[t._v("DatasetChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/#scalechartoptions"}},[e("code",[t._v("ScaleChartOptions")])]),t._v("<"),e("code",[t._v("TType")]),t._v("> & "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v("["),e("code",[t._v("TType")]),t._v("]["),e("code",[t._v('"chartOptions"')]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L507",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:507"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"platform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#platform"}},[t._v("#")]),t._v(" platform")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("platform")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[e("code",[t._v("BasePlatform")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L489",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:489"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"scales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#scales"}},[t._v("#")]),t._v(" scales")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("scales")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"index-signature"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [key: "),e("code",[t._v("string")]),t._v("]: "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L500",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:500"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltip"}},[t._v("#")]),t._v(" tooltip")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("tooltip")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/TooltipModel.html"}},[e("code",[t._v("TooltipModel")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L504",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:504"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L494",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:494"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Defaults.html"}},[e("code",[t._v("Defaults")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L551",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:551"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"instances"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#instances"}},[t._v("#")]),t._v(" instances")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("instances")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"index-signature-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index-signature-2"}},[t._v("#")]),t._v(" Index signature")]),t._v(" "),e("p",[t._v("▪ [key: "),e("code",[t._v("string")]),t._v("]: "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L554",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:554"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" overrides")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("overrides")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#overrides"}},[e("code",[t._v("Overrides")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L552",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:552"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"registry"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#registry"}},[t._v("#")]),t._v(" registry")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("registry")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Registry.html"}},[e("code",[t._v("Registry")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L555",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:555"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"version"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#version"}},[t._v("#")]),t._v(" version")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("version")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L553",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:553"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"bindevents"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bindevents"}},[t._v("#")]),t._v(" bindEvents")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("bindEvents")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L541",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:541"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdatecontrollers"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdatecontrollers"}},[t._v("#")]),t._v(" buildOrUpdateControllers")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateControllers")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L517",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:517"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdatescales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdatescales"}},[t._v("#")]),t._v(" buildOrUpdateScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateScales")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L516",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:516"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"clear"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clear"}},[t._v("#")]),t._v(" clear")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("clear")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L511",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:511"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"destroy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#destroy"}},[t._v("#")]),t._v(" destroy")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("destroy")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L539",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:539"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L521",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:521"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ensurescaleshaveids"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ensurescaleshaveids"}},[t._v("#")]),t._v(" ensureScalesHaveIDs")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("ensureScalesHaveIDs")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L515",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:515"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getactiveelements"}},[t._v("#")]),t._v(" getActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getActiveElements")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L536",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:536"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcontext"}},[t._v("#")]),t._v(" getContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getContext")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L549",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:549"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdatavisibility"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdatavisibility"}},[t._v("#")]),t._v(" getDataVisibility")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataVisibility")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L532",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:532"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdatasetmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdatasetmeta"}},[t._v("#")]),t._v(" getDatasetMeta")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDatasetMeta")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L527",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:527"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getelementsateventformode"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getelementsateventformode"}},[t._v("#")]),t._v(" getElementsAtEventForMode")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getElementsAtEventForMode")]),t._v("("),e("code",[t._v("e")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("options")]),t._v(", "),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("e")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Event")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionOptions.html"}},[e("code",[t._v("InteractionOptions")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L524",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:524"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getsortedvisibledatasetmetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getsortedvisibledatasetmetas"}},[t._v("#")]),t._v(" getSortedVisibleDatasetMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getSortedVisibleDatasetMetas")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L526",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:526"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvisibledatasetcount"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvisibledatasetcount"}},[t._v("#")]),t._v(" getVisibleDatasetCount")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getVisibleDatasetCount")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L528",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:528"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hide"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hide"}},[t._v("#")]),t._v(" hide")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hide")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("dataIndex?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("dataIndex?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L533",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:533"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isdatasetvisible"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isdatasetvisible"}},[t._v("#")]),t._v(" isDatasetVisible")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isDatasetVisible")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L529",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:529"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ispluginenabled"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ispluginenabled"}},[t._v("#")]),t._v(" isPluginEnabled")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isPluginEnabled")]),t._v("("),e("code",[t._v("pluginId")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pluginId")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L547",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:547"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ispointinarea"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ispointinarea"}},[t._v("#")]),t._v(" isPointInArea")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isPointInArea")]),t._v("("),e("code",[t._v("point")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("point")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L523",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:523"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"notifyplugins"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#notifyplugins"}},[t._v("#")]),t._v(" notifyPlugins")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("notifyPlugins")]),t._v("("),e("code",[t._v("hook")]),t._v(", "),e("code",[t._v("args?")]),t._v("): "),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hook")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("args?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L545",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:545"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"render"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#render"}},[t._v("#")]),t._v(" render")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("render")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L520",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:520"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("reset")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L518",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:518"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resize"}},[t._v("#")]),t._v(" resize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("resize")]),t._v("("),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L514",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:514"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setactiveelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setactiveelements"}},[t._v("#")]),t._v(" setActiveElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setActiveElements")]),t._v("("),e("code",[t._v("active")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[e("code",[t._v("ActiveDataPoint")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L537",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:537"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdatasetvisibility"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdatasetvisibility"}},[t._v("#")]),t._v(" setDatasetVisibility")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDatasetVisibility")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("visible")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("visible")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L530",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:530"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"show"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#show"}},[t._v("#")]),t._v(" show")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("show")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("dataIndex?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("dataIndex?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L534",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:534"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("stop")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TData")]),t._v(", "),e("code",[t._v("TLabel")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L512",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:512"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tobase64image"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tobase64image"}},[t._v("#")]),t._v(" toBase64Image")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("toBase64Image")]),t._v("("),e("code",[t._v("type?")]),t._v(", "),e("code",[t._v("quality?")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("quality?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L540",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:540"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"toggledatavisibility"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#toggledatavisibility"}},[t._v("#")]),t._v(" toggleDataVisibility")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("toggleDataVisibility")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L531",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:531"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"unbindevents"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unbindevents"}},[t._v("#")]),t._v(" unbindEvents")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("unbindEvents")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L542",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:542"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("mode?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')]),t._v(" | ("),e("code",[t._v("ctx")]),t._v(": { "),e("code",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")]),t._v(" }) => "),e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L519",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:519"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatehoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatehoverstyle"}},[t._v("#")]),t._v(" updateHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateHoverStyle")]),t._v("("),e("code",[t._v("items")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("enabled")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/InteractionItem.html"}},[e("code",[t._v("InteractionItem")])]),t._v("[]")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"dataset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("enabled")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L543",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:543"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getchart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getchart"}},[t._v("#")]),t._v(" getChart")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("getChart")]),t._v("("),e("code",[t._v("key")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("key")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("HTMLCanvasElement")]),t._v(" | "),e("code",[t._v("CanvasRenderingContext2D")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L556",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:556"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"register"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#register"}},[t._v("#")]),t._v(" register")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("register")]),t._v("("),e("code",[t._v("...items")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L557",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:557"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"unregister"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#unregister"}},[t._v("#")]),t._v(" unregister")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("unregister")]),t._v("("),e("code",[t._v("...items")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("...items")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartcomponentlike"}},[e("code",[t._v("ChartComponentLike")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L558",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:558"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/190.23894560.js b/docs/master/assets/js/190.52502351.js similarity index 99% rename from docs/master/assets/js/190.23894560.js rename to docs/master/assets/js/190.52502351.js index ed3f068ea8..05ce716b20 100644 --- a/docs/master/assets/js/190.23894560.js +++ b/docs/master/assets/js/190.52502351.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[190],{524:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"derived-chart-type"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#derived-chart-type"}},[t._v("#")]),t._v(" Derived Chart Type")]),t._v(" "),s("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100, rmin: 1, rmax: 20};\nconst data = {\n datasets: [\n {\n label: 'My First dataset',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderColor: Utils.CHART_COLORS.blue,\n borderWidth: 1,\n boxStrokeStyle: 'red',\n data: Utils.bubbles(NUMBER_CFG)\n }\n ],\n};\n// \n\n// \nconst config = {\n type: 'derivedBubble',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Derived Chart Type'\n },\n }\n }\n};\n\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),s("h2",{attrs:{id:"derivedbubble-implementation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#derivedbubble-implementation"}},[t._v("#")]),t._v(" DerivedBubble Implementation")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" BubbleController"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Custom")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BubbleController")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Call bubble controller method to draw all the points")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("arguments"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can do some custom drawing for this dataset.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Here we'll draw a box around the first point in each dataset,")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// using `boxStrokeStyle` dataset option for color")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" meta "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMeta")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" pt0 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getProps")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("strokeStyle "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("boxStrokeStyle"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("lineWidth "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("strokeRect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("x "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("restore")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'derivedBubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom defaults. Bubble defaults are inherited.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("boxStrokeStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Overrides are only inherited, but not merged if defined")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom.overrides = Chart.overrides.bubble;")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stores the controller so that the chart initialization routine can look it up")]),t._v("\nChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Custom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"docs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),s("ul",[s("li",[s("RouterLink",{attrs:{to:"/charts/bubble.html"}},[t._v("Bubble Chart")])],1),t._v(" "),s("li",[s("RouterLink",{attrs:{to:"/developers/charts.html"}},[t._v("New Charts")])],1)])],1)}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[190],{526:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"derived-chart-type"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#derived-chart-type"}},[t._v("#")]),t._v(" Derived Chart Type")]),t._v(" "),s("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100, rmin: 1, rmax: 20};\nconst data = {\n datasets: [\n {\n label: 'My First dataset',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderColor: Utils.CHART_COLORS.blue,\n borderWidth: 1,\n boxStrokeStyle: 'red',\n data: Utils.bubbles(NUMBER_CFG)\n }\n ],\n};\n// \n\n// \nconst config = {\n type: 'derivedBubble',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Derived Chart Type'\n },\n }\n }\n};\n\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),s("h2",{attrs:{id:"derivedbubble-implementation"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#derivedbubble-implementation"}},[t._v("#")]),t._v(" DerivedBubble Implementation")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("Chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" BubbleController"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("class")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("Custom")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("extends")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token class-name"}},[t._v("BubbleController")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Call bubble controller method to draw all the points")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("super")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("draw")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("arguments"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Now we can do some custom drawing for this dataset.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Here we'll draw a box around the first point in each dataset,")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// using `boxStrokeStyle` dataset option for color")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" meta "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMeta")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" pt0 "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" meta"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("getProps")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'x'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'y'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" pt0"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" ctx "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("chart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("save")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("strokeStyle "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("options"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("boxStrokeStyle"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("lineWidth "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("strokeRect")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("x "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" y "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" radius"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n ctx"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("restore")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("id "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'derivedBubble'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\nCustom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("defaults "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom defaults. Bubble defaults are inherited.")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("boxStrokeStyle")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'red'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Overrides are only inherited, but not merged if defined")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Custom.overrides = Chart.overrides.bubble;")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Stores the controller so that the chart initialization routine can look it up")]),t._v("\nChart"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("register")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Custom"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("h2",{attrs:{id:"docs"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),s("ul",[s("li",[s("RouterLink",{attrs:{to:"/charts/bubble.html"}},[t._v("Bubble Chart")])],1),t._v(" "),s("li",[s("RouterLink",{attrs:{to:"/developers/charts.html"}},[t._v("New Charts")])],1)])],1)}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/191.e8907b95.js b/docs/master/assets/js/191.1e4cc205.js similarity index 98% rename from docs/master/assets/js/191.e8907b95.js rename to docs/master/assets/js/191.1e4cc205.js index 309b04e105..cc5b1b249d 100644 --- a/docs/master/assets/js/191.e8907b95.js +++ b/docs/master/assets/js/191.1e4cc205.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[191],{526:function(t,n,a){"use strict";a.r(n);var e=a(3),r=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"linear-gradient"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#linear-gradient"}},[t._v("#")]),t._v(" Linear Gradient")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nlet width, height, gradient;\nfunction getGradient(ctx, chartArea) {\n const chartWidth = chartArea.right - chartArea.left;\n const chartHeight = chartArea.bottom - chartArea.top;\n if (!gradient || width !== chartWidth || height !== chartHeight) {\n // Create the gradient because this is either the first render\n // or the size of the chart has changed\n width = chartWidth;\n height = chartHeight;\n gradient = ctx.createLinearGradient(0, chartArea.bottom, 0, chartArea.top);\n gradient.addColorStop(0, Utils.CHART_COLORS.blue);\n gradient.addColorStop(0.5, Utils.CHART_COLORS.yellow);\n gradient.addColorStop(1, Utils.CHART_COLORS.red);\n }\n\n return gradient;\n}\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst labels = Utils.months({count: 7});\n\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: function(context) {\n const chart = context.chart;\n const {ctx, chartArea} = chart;\n\n if (!chartArea) {\n // This case happens on initial chart load\n return;\n }\n return getGradient(ctx, chartArea);\n },\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/colors.html"}},[t._v("Colors")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/colors.html#patterns-and-gradients"}},[t._v("Patterns and Gradients")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1)])],1)}),[],!1,null,null,null);n.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[191],{527:function(t,n,a){"use strict";a.r(n);var e=a(3),r=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"linear-gradient"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#linear-gradient"}},[t._v("#")]),t._v(" Linear Gradient")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nlet width, height, gradient;\nfunction getGradient(ctx, chartArea) {\n const chartWidth = chartArea.right - chartArea.left;\n const chartHeight = chartArea.bottom - chartArea.top;\n if (!gradient || width !== chartWidth || height !== chartHeight) {\n // Create the gradient because this is either the first render\n // or the size of the chart has changed\n width = chartWidth;\n height = chartHeight;\n gradient = ctx.createLinearGradient(0, chartArea.bottom, 0, chartArea.top);\n gradient.addColorStop(0, Utils.CHART_COLORS.blue);\n gradient.addColorStop(0.5, Utils.CHART_COLORS.yellow);\n gradient.addColorStop(1, Utils.CHART_COLORS.red);\n }\n\n return gradient;\n}\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst labels = Utils.months({count: 7});\n\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: function(context) {\n const chart = context.chart;\n const {ctx, chartArea} = chart;\n\n if (!chartArea) {\n // This case happens on initial chart load\n return;\n }\n return getGradient(ctx, chartArea);\n },\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/colors.html"}},[t._v("Colors")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/colors.html#patterns-and-gradients"}},[t._v("Patterns and Gradients")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1)])],1)}),[],!1,null,null,null);n.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/193.742c342b.js b/docs/master/assets/js/193.bbeb72db.js similarity index 98% rename from docs/master/assets/js/193.742c342b.js rename to docs/master/assets/js/193.bbeb72db.js index c6982d0d13..af4dff706e 100644 --- a/docs/master/assets/js/193.742c342b.js +++ b/docs/master/assets/js/193.bbeb72db.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[193],{527:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"animation-progress-bar"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#animation-progress-bar"}},[t._v("#")]),t._v(" Animation Progress Bar")]),t._v(" "),n("h2",{attrs:{id:"initial-animation"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#initial-animation"}},[t._v("#")]),t._v(" Initial animation")]),t._v(" "),n("p",[n("progress",{staticStyle:{width:"100%"},attrs:{id:"initialProgress",max:"1",value:"0"}})]),t._v(" "),n("h2",{attrs:{id:"other-animations"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#other-animations"}},[t._v("#")]),t._v(" Other animations")]),t._v(" "),n("p",[n("progress",{staticStyle:{width:"100%"},attrs:{id:"animationProgress",max:"1",value:"0"}})]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst initProgress = document.getElementById('initialProgress');\nconst progress = document.getElementById('animationProgress');\n\nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animation: {\n duration: 2000,\n onProgress: function(context) {\n if (context.initial) {\n initProgress.value = context.currentStep / context.numSteps;\n } else {\n progress.value = context.currentStep / context.numSteps;\n }\n },\n onComplete: function(context) {\n if (context.initial) {\n console.log('Initial animation finished');\n } else {\n console.log('animation finished');\n }\n }\n },\n interaction: {\n mode: 'nearest',\n axis: 'x',\n intersect: false\n },\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Animation Progress Bar'\n }\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n output: 'console.log output is displayed here'\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation-callbacks"}},[t._v("Animation Callbacks")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[193],{529:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"animation-progress-bar"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#animation-progress-bar"}},[t._v("#")]),t._v(" Animation Progress Bar")]),t._v(" "),n("h2",{attrs:{id:"initial-animation"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#initial-animation"}},[t._v("#")]),t._v(" Initial animation")]),t._v(" "),n("p",[n("progress",{staticStyle:{width:"100%"},attrs:{id:"initialProgress",max:"1",value:"0"}})]),t._v(" "),n("h2",{attrs:{id:"other-animations"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#other-animations"}},[t._v("#")]),t._v(" Other animations")]),t._v(" "),n("p",[n("progress",{staticStyle:{width:"100%"},attrs:{id:"animationProgress",max:"1",value:"0"}})]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst initProgress = document.getElementById('initialProgress');\nconst progress = document.getElementById('animationProgress');\n\nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animation: {\n duration: 2000,\n onProgress: function(context) {\n if (context.initial) {\n initProgress.value = context.currentStep / context.numSteps;\n } else {\n progress.value = context.currentStep / context.numSteps;\n }\n },\n onComplete: function(context) {\n if (context.initial) {\n console.log('Initial animation finished');\n } else {\n console.log('animation finished');\n }\n }\n },\n interaction: {\n mode: 'nearest',\n axis: 'x',\n intersect: false\n },\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Animation Progress Bar'\n }\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n output: 'console.log output is displayed here'\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation-callbacks"}},[t._v("Animation Callbacks")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/194.242844bc.js b/docs/master/assets/js/194.e3f280b5.js similarity index 98% rename from docs/master/assets/js/194.242844bc.js rename to docs/master/assets/js/194.e3f280b5.js index 874839592d..83ac6352fe 100644 --- a/docs/master/assets/js/194.242844bc.js +++ b/docs/master/assets/js/194.e3f280b5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[194],{529:function(t,n,a){"use strict";a.r(n);var e=a(3),r=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"radial-gradient"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#radial-gradient"}},[t._v("#")]),t._v(" Radial Gradient")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 5;\nUtils.srand(110);\n\nconst chartColors = Utils.CHART_COLORS;\nconst colors = [chartColors.red, chartColors.orange, chartColors.yellow, chartColors.green, chartColors.blue];\n\nconst cache = new Map();\nlet width = null;\nlet height = null;\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction createRadialGradient3(context, c1, c2, c3) {\n const chartArea = context.chart.chartArea;\n if (!chartArea) {\n // This case happens on initial chart load\n return;\n }\n\n const chartWidth = chartArea.right - chartArea.left;\n const chartHeight = chartArea.bottom - chartArea.top;\n if (width !== chartWidth || height !== chartHeight) {\n cache.clear();\n }\n let gradient = cache.get(c1 + c2 + c3);\n if (!gradient) {\n // Create the gradient because this is either the first render\n // or the size of the chart has changed\n width = chartWidth;\n height = chartHeight;\n const centerX = (chartArea.left + chartArea.right) / 2;\n const centerY = (chartArea.top + chartArea.bottom) / 2;\n const r = Math.min(\n (chartArea.right - chartArea.left) / 2,\n (chartArea.bottom - chartArea.top) / 2\n );\n const ctx = context.chart.ctx;\n gradient = ctx.createRadialGradient(centerX, centerY, 0, centerX, centerY, r);\n gradient.addColorStop(0, c1);\n gradient.addColorStop(0.5, c2);\n gradient.addColorStop(1, c3);\n cache.set(c1 + c2 + c3, gradient);\n }\n\n return gradient;\n}\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n arc: {\n backgroundColor: function(context) {\n let c = colors[context.dataIndex];\n if (!c) {\n return;\n }\n if (context.active) {\n c = helpers.getHoverColor(c);\n }\n const mid = helpers.color(c).desaturate(0.2).darken(0.2).rgbString();\n const start = helpers.color(c).lighten(0.2).rotate(270).rgbString();\n const end = helpers.color(c).lighten(0.1).rgbString();\n return createRadialGradient3(context, start, mid, end);\n },\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/polar.html"}},[t._v("Polar Area Chart")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/polar.html#styling"}},[t._v("Styling")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[194],{531:function(t,n,a){"use strict";a.r(n);var e=a(3),r=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"radial-gradient"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#radial-gradient"}},[t._v("#")]),t._v(" Radial Gradient")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 5;\nUtils.srand(110);\n\nconst chartColors = Utils.CHART_COLORS;\nconst colors = [chartColors.red, chartColors.orange, chartColors.yellow, chartColors.green, chartColors.blue];\n\nconst cache = new Map();\nlet width = null;\nlet height = null;\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction createRadialGradient3(context, c1, c2, c3) {\n const chartArea = context.chart.chartArea;\n if (!chartArea) {\n // This case happens on initial chart load\n return;\n }\n\n const chartWidth = chartArea.right - chartArea.left;\n const chartHeight = chartArea.bottom - chartArea.top;\n if (width !== chartWidth || height !== chartHeight) {\n cache.clear();\n }\n let gradient = cache.get(c1 + c2 + c3);\n if (!gradient) {\n // Create the gradient because this is either the first render\n // or the size of the chart has changed\n width = chartWidth;\n height = chartHeight;\n const centerX = (chartArea.left + chartArea.right) / 2;\n const centerY = (chartArea.top + chartArea.bottom) / 2;\n const r = Math.min(\n (chartArea.right - chartArea.left) / 2,\n (chartArea.bottom - chartArea.top) / 2\n );\n const ctx = context.chart.ctx;\n gradient = ctx.createRadialGradient(centerX, centerY, 0, centerX, centerY, r);\n gradient.addColorStop(0, c1);\n gradient.addColorStop(0.5, c2);\n gradient.addColorStop(1, c3);\n cache.set(c1 + c2 + c3, gradient);\n }\n\n return gradient;\n}\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n arc: {\n backgroundColor: function(context) {\n let c = colors[context.dataIndex];\n if (!c) {\n return;\n }\n if (context.active) {\n c = helpers.getHoverColor(c);\n }\n const mid = helpers.color(c).desaturate(0.2).darken(0.2).rgbString();\n const start = helpers.color(c).lighten(0.2).rotate(270).rgbString();\n const end = helpers.color(c).lighten(0.1).rgbString();\n return createRadialGradient3(context, start, mid, end);\n },\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/polar.html"}},[t._v("Polar Area Chart")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/polar.html#styling"}},[t._v("Styling")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/196.6bfcb485.js b/docs/master/assets/js/196.75095b09.js similarity index 98% rename from docs/master/assets/js/196.6bfcb485.js rename to docs/master/assets/js/196.75095b09.js index 8aaf10ab1e..31dc97d2e9 100644 --- a/docs/master/assets/js/196.6bfcb485.js +++ b/docs/master/assets/js/196.75095b09.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[196],{532:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop"}},[t._v("#")]),t._v(" Drop")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n animations: {\n y: {\n duration: 2000,\n delay: 500\n }\n },\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n fill: 1,\n tension: 0.5\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animations: {\n y: {\n easing: 'easeInOutElastic',\n from: (ctx) => {\n if (ctx.type === 'data') {\n if (ctx.mode === 'default' && !ctx.dropped) {\n ctx.dropped = true;\n return 0;\n }\n }\n }\n }\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("Area")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation"}},[t._v("animation ("),n("code",[t._v("easing")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animations-2"}},[t._v("animations ("),n("code",[t._v("from")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[t._v("Line Styling")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("fill")])]),t._v(" "),n("li",[n("code",[t._v("tension")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[196],{533:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"drop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#drop"}},[t._v("#")]),t._v(" Drop")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n animations: {\n y: {\n duration: 2000,\n delay: 500\n }\n },\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n fill: 1,\n tension: 0.5\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animations: {\n y: {\n easing: 'easeInOutElastic',\n from: (ctx) => {\n if (ctx.type === 'data') {\n if (ctx.mode === 'default' && !ctx.dropped) {\n ctx.dropped = true;\n return 0;\n }\n }\n }\n }\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("Area")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation"}},[t._v("animation ("),n("code",[t._v("easing")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animations-2"}},[t._v("animations ("),n("code",[t._v("from")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[t._v("Line Styling")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("fill")])]),t._v(" "),n("li",[n("code",[t._v("tension")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/197.5783622e.js b/docs/master/assets/js/197.30e5f6c5.js similarity index 98% rename from docs/master/assets/js/197.5783622e.js rename to docs/master/assets/js/197.30e5f6c5.js index 64d313d9f0..a67aca7ac9 100644 --- a/docs/master/assets/js/197.5783622e.js +++ b/docs/master/assets/js/197.30e5f6c5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[197],{531:function(t,n,a){"use strict";a.r(n);var o=a(3),e=Object(o.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"loop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#loop"}},[t._v("#")]),t._v(" Loop")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: DATA_COUNT});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n tension: 0.4,\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n tension: 0.2,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animations: {\n radius: {\n duration: 400,\n easing: 'linear',\n loop: (context) => context.active\n }\n },\n hoverRadius: 12,\n hoverBackgroundColor: 'yellow',\n interaction: {\n mode: 'nearest',\n intersect: false,\n axis: 'x'\n },\n plugins: {\n tooltip: {\n enabled: false\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation"}},[t._v("animation")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("duration")])]),t._v(" "),n("li",[n("code",[t._v("easing")])]),t._v(" "),n("li",[n("strong",[n("code",[t._v("loop")])])])])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#default-animations"}},[t._v("Default animations ("),n("code",[t._v("radius")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html"}},[t._v("Elements")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[t._v("Point Configuration")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("hoverRadius")])]),t._v(" "),n("li",[n("code",[t._v("hoverBackgroundColor")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip ("),n("code",[t._v("enabled")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[197],{532:function(t,n,a){"use strict";a.r(n);var o=a(3),e=Object(o.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"loop"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#loop"}},[t._v("#")]),t._v(" Loop")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: DATA_COUNT});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n tension: 0.4,\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n tension: 0.2,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n animations: {\n radius: {\n duration: 400,\n easing: 'linear',\n loop: (context) => context.active\n }\n },\n hoverRadius: 12,\n hoverBackgroundColor: 'yellow',\n interaction: {\n mode: 'nearest',\n intersect: false,\n axis: 'x'\n },\n plugins: {\n tooltip: {\n enabled: false\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation"}},[t._v("animation")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("duration")])]),t._v(" "),n("li",[n("code",[t._v("easing")])]),t._v(" "),n("li",[n("strong",[n("code",[t._v("loop")])])])])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#default-animations"}},[t._v("Default animations ("),n("code",[t._v("radius")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html"}},[t._v("Elements")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[t._v("Point Configuration")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("hoverRadius")])]),t._v(" "),n("li",[n("code",[t._v("hoverBackgroundColor")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip ("),n("code",[t._v("enabled")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/199.46ae797c.js b/docs/master/assets/js/199.83ca8eb9.js similarity index 98% rename from docs/master/assets/js/199.46ae797c.js rename to docs/master/assets/js/199.83ca8eb9.js index 98679b4021..8ac0e04517 100644 --- a/docs/master/assets/js/199.46ae797c.js +++ b/docs/master/assets/js/199.83ca8eb9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[199],{533:function(t,n,a){"use strict";a.r(n);var e=a(3),i=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"progressive-line"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#progressive-line"}},[t._v("#")]),t._v(" Progressive Line")]),t._v(" "),n("chart-editor",{attrs:{code:"\n// \nconst data = [];\nconst data2 = [];\nlet prev = 100;\nlet prev2 = 80;\nfor (let i = 0; i < 1000; i++) {\n prev += 5 - Math.random() * 10;\n data.push({x: i, y: prev});\n prev2 += 5 - Math.random() * 10;\n data2.push({x: i, y: prev2});\n}\n// \n\n// \nconst totalDuration = 10000;\nconst delayBetweenPoints = totalDuration / data.length;\nconst previousY = (ctx) => ctx.index === 0 ? ctx.chart.scales.y.getPixelForValue(100) : ctx.chart.getDatasetMeta(ctx.datasetIndex).data[ctx.index - 1].getProps(['y'], true).y;\nconst animation = {\n x: {\n type: 'number',\n easing: 'linear',\n duration: delayBetweenPoints,\n from: NaN, // the point is initially skipped\n delay(ctx) {\n if (ctx.type !== 'data' || ctx.xStarted) {\n return 0;\n }\n ctx.xStarted = true;\n return ctx.index * delayBetweenPoints;\n }\n },\n y: {\n type: 'number',\n easing: 'linear',\n duration: delayBetweenPoints,\n from: previousY,\n delay(ctx) {\n if (ctx.type !== 'data' || ctx.yStarted) {\n return 0;\n }\n ctx.yStarted = true;\n return ctx.index * delayBetweenPoints;\n }\n }\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: {\n datasets: [{\n borderColor: Utils.CHART_COLORS.red,\n borderWidth: 1,\n radius: 0,\n data: data,\n },\n {\n borderColor: Utils.CHART_COLORS.blue,\n borderWidth: 1,\n radius: 0,\n data: data2,\n }]\n },\n options: {\n animation,\n interaction: {\n intersect: false\n },\n plugins: {\n legend: false\n },\n scales: {\n x: {\n type: 'linear'\n }\n }\n }\n};\n// \n\nmodule.exports = {\n config\n};\n\n"}}),n("h2",{attrs:{id:"api"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#api"}},[t._v("#")]),t._v(" Api")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[t._v("Chart")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/api/classes/Chart.html#getdatasetmeta"}},[n("code",[t._v("getDatasetMeta")])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelforvalue"}},[n("code",[t._v("getPixelForValue")])])],1)])],1)]),t._v(" "),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation"}},[t._v("animation")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("delay")])]),t._v(" "),n("li",[n("code",[t._v("duration")])]),t._v(" "),n("li",[n("code",[t._v("easing")])]),t._v(" "),n("li",[n("code",[t._v("loop")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#data"}},[t._v("Data Context")])],1)])],1)])],1)])],1)}),[],!1,null,null,null);n.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[199],{534:function(t,n,a){"use strict";a.r(n);var e=a(3),i=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"progressive-line"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#progressive-line"}},[t._v("#")]),t._v(" Progressive Line")]),t._v(" "),n("chart-editor",{attrs:{code:"\n// \nconst data = [];\nconst data2 = [];\nlet prev = 100;\nlet prev2 = 80;\nfor (let i = 0; i < 1000; i++) {\n prev += 5 - Math.random() * 10;\n data.push({x: i, y: prev});\n prev2 += 5 - Math.random() * 10;\n data2.push({x: i, y: prev2});\n}\n// \n\n// \nconst totalDuration = 10000;\nconst delayBetweenPoints = totalDuration / data.length;\nconst previousY = (ctx) => ctx.index === 0 ? ctx.chart.scales.y.getPixelForValue(100) : ctx.chart.getDatasetMeta(ctx.datasetIndex).data[ctx.index - 1].getProps(['y'], true).y;\nconst animation = {\n x: {\n type: 'number',\n easing: 'linear',\n duration: delayBetweenPoints,\n from: NaN, // the point is initially skipped\n delay(ctx) {\n if (ctx.type !== 'data' || ctx.xStarted) {\n return 0;\n }\n ctx.xStarted = true;\n return ctx.index * delayBetweenPoints;\n }\n },\n y: {\n type: 'number',\n easing: 'linear',\n duration: delayBetweenPoints,\n from: previousY,\n delay(ctx) {\n if (ctx.type !== 'data' || ctx.yStarted) {\n return 0;\n }\n ctx.yStarted = true;\n return ctx.index * delayBetweenPoints;\n }\n }\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: {\n datasets: [{\n borderColor: Utils.CHART_COLORS.red,\n borderWidth: 1,\n radius: 0,\n data: data,\n },\n {\n borderColor: Utils.CHART_COLORS.blue,\n borderWidth: 1,\n radius: 0,\n data: data2,\n }]\n },\n options: {\n animation,\n interaction: {\n intersect: false\n },\n plugins: {\n legend: false\n },\n scales: {\n x: {\n type: 'linear'\n }\n }\n }\n};\n// \n\nmodule.exports = {\n config\n};\n\n"}}),n("h2",{attrs:{id:"api"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#api"}},[t._v("#")]),t._v(" Api")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[t._v("Chart")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/api/classes/Chart.html#getdatasetmeta"}},[n("code",[t._v("getDatasetMeta")])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[t._v("Scale")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/api/classes/Scale.html#getpixelforvalue"}},[n("code",[t._v("getPixelForValue")])])],1)])],1)]),t._v(" "),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html"}},[t._v("Animations")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/animations.html#animation"}},[t._v("animation")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("delay")])]),t._v(" "),n("li",[n("code",[t._v("duration")])]),t._v(" "),n("li",[n("code",[t._v("easing")])]),t._v(" "),n("li",[n("code",[t._v("loop")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#data"}},[t._v("Data Context")])],1)])],1)])],1)])],1)}),[],!1,null,null,null);n.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/20.7179af44.js b/docs/master/assets/js/20.751911f1.js similarity index 95% rename from docs/master/assets/js/20.7179af44.js rename to docs/master/assets/js/20.751911f1.js index a87941c567..fef77a2ba9 100644 --- a/docs/master/assets/js/20.7179af44.js +++ b/docs/master/assets/js/20.751911f1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{353:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-datasetcontroller-ttype-telement-tdatasetelement-tparseddata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-datasetcontroller-ttype-telement-tdatasetelement-tparseddata"}},[t._v("#")]),t._v(" Class: DatasetController")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TDatasetElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TParsedData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("DatasetController")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutController.html"}},[e("code",[t._v("DoughnutController")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new DatasetController")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(", "),e("code",[t._v("TParsedData")]),t._v(">("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v(" = keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("TElement")]),t._v("> = "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TDatasetElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v("> = "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TParsedData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L588",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:588"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"cachedmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cachedmeta"}},[t._v("#")]),t._v(" _cachedMeta")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("_cachedMeta")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L592",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:592"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L590",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:590"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"enableoptionsharing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enableoptionsharing"}},[t._v("#")]),t._v(" enableOptionSharing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("enableOptionSharing")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"supportsdecimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#supportsdecimation"}},[t._v("#")]),t._v(" supportsDecimation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("supportsDecimation")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L597",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:597"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"addelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addelements"}},[t._v("#")]),t._v(" addElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addElements")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L613",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:613"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"applystack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#applystack"}},[t._v("#")]),t._v(" applyStack")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("applyStack")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L649",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:649"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdateelements"}},[t._v("#")]),t._v(" buildOrUpdateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateElements")]),t._v("("),e("code",[t._v("resetNewElements?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("resetNewElements?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L614",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:614"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L611",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:611"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L606",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:606"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getallparsedvalues"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getallparsedvalues"}},[t._v("#")]),t._v(" getAllParsedValues")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getAllParsedValues")]),t._v("("),e("code",[t._v("scale")]),t._v("): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L600",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:600"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdataset"}},[t._v("#")]),t._v(" getDataset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataset")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L608",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:608"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelandvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelandvalue"}},[t._v("#")]),t._v(" getLabelAndValue")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getLabelAndValue")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("label")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L601",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:601"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaxoverflow"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaxoverflow"}},[t._v("#")]),t._v(" getMaxOverflow")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMaxOverflow")]),t._v("(): "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmeta"}},[t._v("#")]),t._v(" getMeta")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMeta")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L609",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:609"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("canStack?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L656",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:656"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getparsed"}},[t._v("#")]),t._v(" getParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getParsed")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("TParsedData")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("TParsedData")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L648",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:648"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getscaleforid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getscaleforid"}},[t._v("#")]),t._v(" getScaleForId")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getScaleForId")]),t._v("("),e("code",[t._v("scaleID")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scaleID")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L610",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:610"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getsharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getsharedoptions"}},[t._v("#")]),t._v(" getSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getSharedOptions")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("p",[t._v("Utility for checking if the options are shared and should be animated separately.")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L623",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:623"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getstyle"}},[t._v("#")]),t._v(" getStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getStyle")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("active")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L616",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:616"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"includeoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#includeoptions"}},[t._v("#")]),t._v(" includeOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("includeOptions")]),t._v("("),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("sharedOptions")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Utility for determining if "),e("code",[t._v("options")]),t._v(" should be included in the updated properties")]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L628",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:628"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"initialize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#initialize"}},[t._v("#")]),t._v(" initialize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("initialize")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L612",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:612"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linkscales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linkscales"}},[t._v("#")]),t._v(" linkScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("linkScales")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L599",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:599"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L644",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:644"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsearraydata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsearraydata"}},[t._v("#")]),t._v(" parseArrayData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseArrayData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L646",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:646"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseobjectdata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseobjectdata"}},[t._v("#")]),t._v(" parseObjectData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseObjectData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L647",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:647"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseprimitivedata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseprimitivedata"}},[t._v("#")]),t._v(" parsePrimitiveData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parsePrimitiveData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L645",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:645"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removehoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removehoverstyle"}},[t._v("#")]),t._v(" removeHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L641",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:641"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("reset")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L607",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:607"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedataelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedataelementoptions"}},[t._v("#")]),t._v(" resolveDataElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDataElementOptions")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L618",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:618"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedatasetelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedatasetelementoptions"}},[t._v("#")]),t._v(" resolveDatasetElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDatasetElementOptions")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"sethoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sethoverstyle"}},[t._v("#")]),t._v(" setHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L642",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:642"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L603",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:603"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelement"}},[t._v("#")]),t._v(" updateElement")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateElement")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("properties")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility for updating an element with new properties, using animations when appropriate.")]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")]),t._v(" | "),e("code",[t._v("TDatasetElement")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("properties")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L634",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:634"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelements"}},[t._v("#")]),t._v(" updateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateElements")]),t._v("("),e("code",[t._v("elements")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("elements")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L602",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:602"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateindex"}},[t._v("#")]),t._v(" updateIndex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateIndex")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L604",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:604"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updaterangefromparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updaterangefromparsed"}},[t._v("#")]),t._v(" updateRangeFromParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateRangeFromParsed")]),t._v("("),e("code",[t._v("range")]),t._v(", "),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v(", "),e("code",[t._v("stack")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("stack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L650",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:650"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatesharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatesharedoptions"}},[t._v("#")]),t._v(" updateSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateSharedOptions")]),t._v("("),e("code",[t._v("sharedOptions")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("newOptions")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility to animate the shared options, that are potentially affecting multiple elements.")]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("newOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L640",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:640"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{351:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-datasetcontroller-ttype-telement-tdatasetelement-tparseddata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-datasetcontroller-ttype-telement-tdatasetelement-tparseddata"}},[t._v("#")]),t._v(" Class: DatasetController")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/#charttype"}},[e("code",[t._v("ChartType")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TDatasetElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("Element")]),t._v(" = "),e("code",[t._v("Element")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TParsedData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("DatasetController")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/DoughnutController.html"}},[e("code",[t._v("DoughnutController")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new DatasetController")]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(", "),e("code",[t._v("TParsedData")]),t._v(">("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TType")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])]),t._v(" = keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartTypeRegistry.html"}},[e("code",[t._v("ChartTypeRegistry")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("TElement")]),t._v("> = "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TDatasetElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v("> = "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TParsedData")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#parseddatatype"}},[e("code",[t._v("ParsedDataType")])]),t._v("<"),e("code",[t._v("TType")]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L588",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:588"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"cachedmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#cachedmeta"}},[t._v("#")]),t._v(" _cachedMeta")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("_cachedMeta")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L592",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:592"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L590",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:590"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"enableoptionsharing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enableoptionsharing"}},[t._v("#")]),t._v(" enableOptionSharing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("enableOptionSharing")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L593",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:593"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L591",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:591"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"supportsdecimation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#supportsdecimation"}},[t._v("#")]),t._v(" supportsDecimation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("supportsDecimation")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L597",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:597"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"addelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addelements"}},[t._v("#")]),t._v(" addElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addElements")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L613",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:613"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"applystack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#applystack"}},[t._v("#")]),t._v(" applyStack")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("applyStack")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L649",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:649"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildorupdateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildorupdateelements"}},[t._v("#")]),t._v(" buildOrUpdateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildOrUpdateElements")]),t._v("("),e("code",[t._v("resetNewElements?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("resetNewElements?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L614",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:614"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L611",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:611"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L606",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:606"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getallparsedvalues"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getallparsedvalues"}},[t._v("#")]),t._v(" getAllParsedValues")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getAllParsedValues")]),t._v("("),e("code",[t._v("scale")]),t._v("): "),e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L600",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:600"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdataset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdataset"}},[t._v("#")]),t._v(" getDataset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDataset")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartdataset"}},[e("code",[t._v("ChartDataset")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L608",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:608"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelandvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelandvalue"}},[t._v("#")]),t._v(" getLabelAndValue")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getLabelAndValue")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("label")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L601",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:601"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaxoverflow"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaxoverflow"}},[t._v("#")]),t._v(" getMaxOverflow")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMaxOverflow")]),t._v("(): "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L605",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:605"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmeta"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmeta"}},[t._v("#")]),t._v(" getMeta")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMeta")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L609",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:609"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("canStack?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L656",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:656"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getparsed"}},[t._v("#")]),t._v(" getParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getParsed")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("TParsedData")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("TParsedData")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L648",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:648"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getscaleforid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getscaleforid"}},[t._v("#")]),t._v(" getScaleForId")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getScaleForId")]),t._v("("),e("code",[t._v("scaleID")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scaleID")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L610",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:610"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getsharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getsharedoptions"}},[t._v("#")]),t._v(" getSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("getSharedOptions")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("p",[t._v("Utility for checking if the options are shared and should be animated separately.")]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L623",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:623"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getstyle"}},[t._v("#")]),t._v(" getStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getStyle")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("active")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("active")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L616",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:616"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"includeoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#includeoptions"}},[t._v("#")]),t._v(" includeOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("includeOptions")]),t._v("("),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("sharedOptions")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Utility for determining if "),e("code",[t._v("options")]),t._v(" should be included in the updated properties")]),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L628",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:628"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"initialize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#initialize"}},[t._v("#")]),t._v(" initialize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("initialize")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L612",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:612"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"linkscales"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#linkscales"}},[t._v("#")]),t._v(" linkScales")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("linkScales")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L599",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:599"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L644",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:644"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsearraydata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsearraydata"}},[t._v("#")]),t._v(" parseArrayData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseArrayData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L646",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:646"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseobjectdata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseobjectdata"}},[t._v("#")]),t._v(" parseObjectData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parseObjectData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L647",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:647"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parseprimitivedata"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parseprimitivedata"}},[t._v("#")]),t._v(" parsePrimitiveData")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("parsePrimitiveData")]),t._v("("),e("code",[t._v("meta")]),t._v(", "),e("code",[t._v("data")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v("): "),e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("meta")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v("<"),e("code",[t._v("TType")]),t._v(", "),e("code",[t._v("TElement")]),t._v(", "),e("code",[t._v("TDatasetElement")]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("data")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L645",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:645"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removehoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removehoverstyle"}},[t._v("#")]),t._v(" removeHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L641",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:641"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"reset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[t._v("#")]),t._v(" reset")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("reset")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L607",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:607"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedataelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedataelementoptions"}},[t._v("#")]),t._v(" resolveDataElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDataElementOptions")]),t._v("("),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L618",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:618"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"resolvedatasetelementoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#resolvedatasetelementoptions"}},[t._v("#")]),t._v(" resolveDatasetElementOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("resolveDatasetElementOptions")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("AnyObject")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L617",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:617"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"sethoverstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#sethoverstyle"}},[t._v("#")]),t._v(" setHoverStyle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setHoverStyle")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("datasetIndex")]),t._v(", "),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L642",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:642"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L603",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:603"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelement"}},[t._v("#")]),t._v(" updateElement")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateElement")]),t._v("("),e("code",[t._v("element")]),t._v(", "),e("code",[t._v("index")]),t._v(", "),e("code",[t._v("properties")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility for updating an element with new properties, using animations when appropriate.")]),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("element")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")]),t._v(" | "),e("code",[t._v("TDatasetElement")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("properties")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L634",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:634"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateelements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateelements"}},[t._v("#")]),t._v(" updateElements")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateElements")]),t._v("("),e("code",[t._v("elements")]),t._v(", "),e("code",[t._v("start")]),t._v(", "),e("code",[t._v("count")]),t._v(", "),e("code",[t._v("mode")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("elements")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("TElement")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("start")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("count")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L602",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:602"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateindex"}},[t._v("#")]),t._v(" updateIndex")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateIndex")]),t._v("("),e("code",[t._v("datasetIndex")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-23"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("datasetIndex")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L604",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:604"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updaterangefromparsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updaterangefromparsed"}},[t._v("#")]),t._v(" updateRangeFromParsed")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateRangeFromParsed")]),t._v("("),e("code",[t._v("range")]),t._v(", "),e("code",[t._v("scale")]),t._v(", "),e("code",[t._v("parsed")]),t._v(", "),e("code",[t._v("stack")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-24"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("range.min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("scale")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Scale.html"}},[e("code",[t._v("Scale")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(">")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("parsed")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("stack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")]),t._v(" | "),e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L650",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:650"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updatesharedoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updatesharedoptions"}},[t._v("#")]),t._v(" updateSharedOptions")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Protected")]),t._v(" "),e("strong",[t._v("updateSharedOptions")]),t._v("("),e("code",[t._v("sharedOptions")]),t._v(", "),e("code",[t._v("mode")]),t._v(", "),e("code",[t._v("newOptions")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Utility to animate the shared options, that are potentially affecting multiple elements.")]),t._v(" "),e("h4",{attrs:{id:"parameters-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-25"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("sharedOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mode")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"none"')]),t._v(" | "),e("code",[t._v('"hide"')]),t._v(" | "),e("code",[t._v('"show"')]),t._v(" | "),e("code",[t._v('"default"')]),t._v(" | "),e("code",[t._v('"active"')]),t._v(" | "),e("code",[t._v('"resize"')]),t._v(" | "),e("code",[t._v('"reset"')])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("newOptions")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("AnyObject")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L640",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:640"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/201.261c94bb.js b/docs/master/assets/js/201.69f3a477.js similarity index 98% rename from docs/master/assets/js/201.261c94bb.js rename to docs/master/assets/js/201.69f3a477.js index 07c8e4121f..3734592b30 100644 --- a/docs/master/assets/js/201.261c94bb.js +++ b/docs/master/assets/js/201.69f3a477.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{534:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"line-chart-datasets"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-chart-datasets"}},[n._v("#")]),n._v(" Line Chart Datasets")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst inputs = {\n min: 20,\n max: 80,\n count: 8,\n decimals: 2,\n continuity: 1\n};\n\nconst generateLabels = () => {\n return Utils.months({count: inputs.count});\n};\n\nconst generateData = () => (Utils.numbers(inputs));\n\nUtils.srand(42);\n// \n\n// \nconst data = {\n labels: generateLabels(),\n datasets: [\n {\n label: 'D0',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red),\n hidden: true\n },\n {\n label: 'D1',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange),\n fill: '-1'\n },\n {\n label: 'D2',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.yellow),\n hidden: true,\n fill: 1\n },\n {\n label: 'D3',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green),\n fill: '-1'\n },\n {\n label: 'D4',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue),\n fill: '-1'\n },\n {\n label: 'D5',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.grey,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.grey),\n fill: '+2'\n },\n {\n label: 'D6',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.purple,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.purple),\n fill: false\n },\n {\n label: 'D7',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red),\n fill: 8\n },\n {\n label: 'D8',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange),\n fill: 'end',\n hidden: true\n },\n {\n label: 'D9',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.yellow),\n fill: {above: 'blue', below: 'red', target: {value: 350}}\n }\n ]\n};\n// \n\n// \nlet smooth = false;\nlet propagate = false;\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Propagate',\n handler(chart) {\n propagate = !propagate;\n chart.options.plugins.filler.propagate = propagate;\n chart.update();\n }\n },\n {\n name: 'Smooth',\n handler(chart) {\n smooth = !smooth;\n chart.options.elements.line.tension = smooth ? 0.4 : 0;\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n scales: {\n y: {\n stacked: true\n }\n },\n plugins: {\n filler: {\n propagate: false\n },\n 'samples-filler-analyser': {\n target: 'chart-analyser'\n }\n },\n interaction: {\n intersect: false,\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("div",{staticClass:"analyser",attrs:{id:"chart-analyser"}}),n._v(" "),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html"}},[n._v("Area")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[n._v("Filling modes")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/"}},[n._v("Axes scales")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[n._v("Common options to all axes ("),t("code",[n._v("stacked")]),n._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[201],{537:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"line-chart-datasets"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-chart-datasets"}},[n._v("#")]),n._v(" Line Chart Datasets")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst inputs = {\n min: 20,\n max: 80,\n count: 8,\n decimals: 2,\n continuity: 1\n};\n\nconst generateLabels = () => {\n return Utils.months({count: inputs.count});\n};\n\nconst generateData = () => (Utils.numbers(inputs));\n\nUtils.srand(42);\n// \n\n// \nconst data = {\n labels: generateLabels(),\n datasets: [\n {\n label: 'D0',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red),\n hidden: true\n },\n {\n label: 'D1',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange),\n fill: '-1'\n },\n {\n label: 'D2',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.yellow),\n hidden: true,\n fill: 1\n },\n {\n label: 'D3',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green),\n fill: '-1'\n },\n {\n label: 'D4',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue),\n fill: '-1'\n },\n {\n label: 'D5',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.grey,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.grey),\n fill: '+2'\n },\n {\n label: 'D6',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.purple,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.purple),\n fill: false\n },\n {\n label: 'D7',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red),\n fill: 8\n },\n {\n label: 'D8',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange),\n fill: 'end',\n hidden: true\n },\n {\n label: 'D9',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.yellow),\n fill: {above: 'blue', below: 'red', target: {value: 350}}\n }\n ]\n};\n// \n\n// \nlet smooth = false;\nlet propagate = false;\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Propagate',\n handler(chart) {\n propagate = !propagate;\n chart.options.plugins.filler.propagate = propagate;\n chart.update();\n }\n },\n {\n name: 'Smooth',\n handler(chart) {\n smooth = !smooth;\n chart.options.elements.line.tension = smooth ? 0.4 : 0;\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n scales: {\n y: {\n stacked: true\n }\n },\n plugins: {\n filler: {\n propagate: false\n },\n 'samples-filler-analyser': {\n target: 'chart-analyser'\n }\n },\n interaction: {\n intersect: false,\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("div",{staticClass:"analyser",attrs:{id:"chart-analyser"}}),n._v(" "),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html"}},[n._v("Area")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[n._v("Filling modes")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/"}},[n._v("Axes scales")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[n._v("Common options to all axes ("),t("code",[n._v("stacked")]),n._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/202.633e2dfd.js b/docs/master/assets/js/202.dc2b13b3.js similarity index 98% rename from docs/master/assets/js/202.633e2dfd.js rename to docs/master/assets/js/202.dc2b13b3.js index 16051a6e24..5f12b852b7 100644 --- a/docs/master/assets/js/202.633e2dfd.js +++ b/docs/master/assets/js/202.dc2b13b3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[202],{537:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"line-chart-drawtime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-chart-drawtime"}},[n._v("#")]),n._v(" Line Chart drawTime")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst inputs = {\n min: -100,\n max: 100,\n count: 8,\n decimals: 2,\n continuity: 1\n};\n\nconst generateLabels = () => {\n return Utils.months({count: inputs.count});\n};\n\nUtils.srand(3);\nconst generateData = () => (Utils.numbers(inputs));\n// \n\n// \nconst data = {\n labels: generateLabels(),\n datasets: [\n {\n label: 'Dataset 1',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n fill: true\n },\n {\n label: 'Dataset 2',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue),\n fill: true\n }\n ]\n};\n// \n\n// \nlet smooth = false;\n\nconst actions = [\n {\n name: 'drawTime: beforeDatasetDraw (default)',\n handler: (chart) => {\n chart.options.plugins.filler.drawTime = 'beforeDatasetDraw';\n chart.update();\n }\n },\n {\n name: 'drawTime: beforeDatasetsDraw',\n handler: (chart) => {\n chart.options.plugins.filler.drawTime = 'beforeDatasetsDraw';\n chart.update();\n }\n },\n {\n name: 'drawTime: beforeDraw',\n handler: (chart) => {\n chart.options.plugins.filler.drawTime = 'beforeDraw';\n chart.update();\n }\n },\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Smooth',\n handler(chart) {\n smooth = !smooth;\n chart.options.elements.line.tension = smooth ? 0.4 : 0;\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n filler: {\n propagate: false,\n },\n title: {\n display: true,\n text: (ctx) => 'drawTime: ' + ctx.chart.options.plugins.filler.drawTime\n }\n },\n pointBackgroundColor: '#fff',\n radius: 10,\n interaction: {\n intersect: false,\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html"}},[n._v("Area")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#configuration"}},[n._v("Configuration ("),t("code",[n._v("drawTime")]),n._v(")")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[n._v("Line Styling ("),t("code",[n._v("tension")]),n._v(")")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[202],{538:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"line-chart-drawtime"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-chart-drawtime"}},[n._v("#")]),n._v(" Line Chart drawTime")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst inputs = {\n min: -100,\n max: 100,\n count: 8,\n decimals: 2,\n continuity: 1\n};\n\nconst generateLabels = () => {\n return Utils.months({count: inputs.count});\n};\n\nUtils.srand(3);\nconst generateData = () => (Utils.numbers(inputs));\n// \n\n// \nconst data = {\n labels: generateLabels(),\n datasets: [\n {\n label: 'Dataset 1',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n fill: true\n },\n {\n label: 'Dataset 2',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue),\n fill: true\n }\n ]\n};\n// \n\n// \nlet smooth = false;\n\nconst actions = [\n {\n name: 'drawTime: beforeDatasetDraw (default)',\n handler: (chart) => {\n chart.options.plugins.filler.drawTime = 'beforeDatasetDraw';\n chart.update();\n }\n },\n {\n name: 'drawTime: beforeDatasetsDraw',\n handler: (chart) => {\n chart.options.plugins.filler.drawTime = 'beforeDatasetsDraw';\n chart.update();\n }\n },\n {\n name: 'drawTime: beforeDraw',\n handler: (chart) => {\n chart.options.plugins.filler.drawTime = 'beforeDraw';\n chart.update();\n }\n },\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Smooth',\n handler(chart) {\n smooth = !smooth;\n chart.options.elements.line.tension = smooth ? 0.4 : 0;\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n filler: {\n propagate: false,\n },\n title: {\n display: true,\n text: (ctx) => 'drawTime: ' + ctx.chart.options.plugins.filler.drawTime\n }\n },\n pointBackgroundColor: '#fff',\n radius: 10,\n interaction: {\n intersect: false,\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html"}},[n._v("Area")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#configuration"}},[n._v("Configuration ("),t("code",[n._v("drawTime")]),n._v(")")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[n._v("Line Styling ("),t("code",[n._v("tension")]),n._v(")")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/203.56d0d648.js b/docs/master/assets/js/203.0d54eca4.js similarity index 98% rename from docs/master/assets/js/203.56d0d648.js rename to docs/master/assets/js/203.0d54eca4.js index 83d73283bf..e268e95602 100644 --- a/docs/master/assets/js/203.56d0d648.js +++ b/docs/master/assets/js/203.0d54eca4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[203],{538:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"line-chart-stacked"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#line-chart-stacked"}},[t._v("#")]),t._v(" Line Chart Stacked")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Stacked: true',\n handler: (chart) => {\n chart.options.scales.y.stacked = true;\n chart.update();\n }\n },\n {\n name: 'Stacked: false (default)',\n handler: (chart) => {\n chart.options.scales.y.stacked = false;\n chart.update();\n }\n },\n {\n name: 'Stacked Single',\n handler: (chart) => {\n chart.options.scales.y.stacked = 'single';\n chart.update();\n }\n },\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: dsColor,\n borderColor: dsColor,\n fill: true,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'My First dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n fill: true\n },\n {\n label: 'My Second dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n fill: true\n },\n {\n label: 'My Third dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.CHART_COLORS.green,\n fill: true\n },\n {\n label: 'My Fourth dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.CHART_COLORS.yellow,\n fill: true\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Chart.js Line Chart - stacked=' + ctx.chart.options.scales.y.stacked\n },\n tooltip: {\n mode: 'index'\n },\n },\n interaction: {\n mode: 'nearest',\n axis: 'x',\n intersect: false\n },\n scales: {\n x: {\n title: {\n display: true,\n text: 'Month'\n }\n },\n y: {\n stacked: true,\n title: {\n display: true,\n text: 'Value'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("Area")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[t._v("Filling modes")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes ("),n("code",[t._v("stacked")]),t._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[203],{539:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"line-chart-stacked"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#line-chart-stacked"}},[t._v("#")]),t._v(" Line Chart Stacked")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Stacked: true',\n handler: (chart) => {\n chart.options.scales.y.stacked = true;\n chart.update();\n }\n },\n {\n name: 'Stacked: false (default)',\n handler: (chart) => {\n chart.options.scales.y.stacked = false;\n chart.update();\n }\n },\n {\n name: 'Stacked Single',\n handler: (chart) => {\n chart.options.scales.y.stacked = 'single';\n chart.update();\n }\n },\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: dsColor,\n borderColor: dsColor,\n fill: true,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'My First dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n fill: true\n },\n {\n label: 'My Second dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n fill: true\n },\n {\n label: 'My Third dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.CHART_COLORS.green,\n fill: true\n },\n {\n label: 'My Fourth dataset',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.CHART_COLORS.yellow,\n fill: true\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Chart.js Line Chart - stacked=' + ctx.chart.options.scales.y.stacked\n },\n tooltip: {\n mode: 'index'\n },\n },\n interaction: {\n mode: 'nearest',\n axis: 'x',\n intersect: false\n },\n scales: {\n x: {\n title: {\n display: true,\n text: 'Month'\n }\n },\n y: {\n stacked: true,\n title: {\n display: true,\n text: 'Value'\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/area.html"}},[t._v("Area")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[t._v("Filling modes")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes ("),n("code",[t._v("stacked")]),t._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/204.76da8b66.js b/docs/master/assets/js/204.343bddc4.js similarity index 98% rename from docs/master/assets/js/204.76da8b66.js rename to docs/master/assets/js/204.343bddc4.js index f1f1d03a6d..e87ec0047c 100644 --- a/docs/master/assets/js/204.76da8b66.js +++ b/docs/master/assets/js/204.343bddc4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[204],{539:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"radar-chart-stacked"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#radar-chart-stacked"}},[n._v("#")]),n._v(" Radar Chart Stacked")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst inputs = {\n min: 8,\n max: 16,\n count: 8,\n decimals: 2,\n continuity: 1\n};\n\nconst generateLabels = () => {\n return Utils.months({count: inputs.count});\n};\n\nconst generateData = () => {\n const values = Utils.numbers(inputs);\n inputs.from = values;\n return values;\n};\n\nconst labels = Utils.months({count: 8});\nconst data = {\n labels: generateLabels(),\n datasets: [\n {\n label: 'D0',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red),\n },\n {\n label: 'D1',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.orange,\n hidden: true,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange),\n fill: '-1'\n },\n {\n label: 'D2',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.yellow),\n fill: 1\n },\n {\n label: 'D3',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green),\n fill: false\n },\n {\n label: 'D4',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue),\n fill: '-1'\n },\n {\n label: 'D5',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.purple,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.purple),\n fill: '-1'\n },\n {\n label: 'D6',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.grey,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.grey),\n fill: {value: 85}\n }\n ]\n};\n// \n\n// \nlet smooth = false;\nlet propagate = false;\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n inputs.from = [];\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Propagate',\n handler(chart) {\n propagate = !propagate;\n chart.options.plugins.filler.propagate = propagate;\n chart.update();\n\n }\n },\n {\n name: 'Smooth',\n handler(chart) {\n smooth = !smooth;\n chart.options.elements.line.tension = smooth ? 0.4 : 0;\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'radar',\n data: data,\n options: {\n plugins: {\n filler: {\n propagate: false\n },\n 'samples-filler-analyser': {\n target: 'chart-analyser'\n }\n },\n interaction: {\n intersect: false\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config\n};\n"}}),t("div",{staticClass:"analyser",attrs:{id:"chart-analyser"}}),n._v(" "),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html"}},[n._v("Area")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[n._v("Filling modes")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#propagate"}},[t("code",[n._v("propagate")])])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/radar.html"}},[n._v("Radar")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[204],{540:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"radar-chart-stacked"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#radar-chart-stacked"}},[n._v("#")]),n._v(" Radar Chart Stacked")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst inputs = {\n min: 8,\n max: 16,\n count: 8,\n decimals: 2,\n continuity: 1\n};\n\nconst generateLabels = () => {\n return Utils.months({count: inputs.count});\n};\n\nconst generateData = () => {\n const values = Utils.numbers(inputs);\n inputs.from = values;\n return values;\n};\n\nconst labels = Utils.months({count: 8});\nconst data = {\n labels: generateLabels(),\n datasets: [\n {\n label: 'D0',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red),\n },\n {\n label: 'D1',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.orange,\n hidden: true,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange),\n fill: '-1'\n },\n {\n label: 'D2',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.yellow,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.yellow),\n fill: 1\n },\n {\n label: 'D3',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green),\n fill: false\n },\n {\n label: 'D4',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue),\n fill: '-1'\n },\n {\n label: 'D5',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.purple,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.purple),\n fill: '-1'\n },\n {\n label: 'D6',\n data: generateData(),\n borderColor: Utils.CHART_COLORS.grey,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.grey),\n fill: {value: 85}\n }\n ]\n};\n// \n\n// \nlet smooth = false;\nlet propagate = false;\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n inputs.from = [];\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Propagate',\n handler(chart) {\n propagate = !propagate;\n chart.options.plugins.filler.propagate = propagate;\n chart.update();\n\n }\n },\n {\n name: 'Smooth',\n handler(chart) {\n smooth = !smooth;\n chart.options.elements.line.tension = smooth ? 0.4 : 0;\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'radar',\n data: data,\n options: {\n plugins: {\n filler: {\n propagate: false\n },\n 'samples-filler-analyser': {\n target: 'chart-analyser'\n }\n },\n interaction: {\n intersect: false\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config\n};\n"}}),t("div",{staticClass:"analyser",attrs:{id:"chart-analyser"}}),n._v(" "),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html"}},[n._v("Area")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#filling-modes"}},[n._v("Filling modes")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/area.html#propagate"}},[t("code",[n._v("propagate")])])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/radar.html"}},[n._v("Radar")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/205.dacac113.js b/docs/master/assets/js/205.a455ae4b.js similarity index 97% rename from docs/master/assets/js/205.dacac113.js rename to docs/master/assets/js/205.a455ae4b.js index 9019c6626b..b1104da137 100644 --- a/docs/master/assets/js/205.dacac113.js +++ b/docs/master/assets/js/205.a455ae4b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[205],{540:function(n,t,a){"use strict";a.r(t);var r=a(3),s=Object(r.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"bar-chart-border-radius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bar-chart-border-radius"}},[n._v("#")]),n._v(" Bar Chart Border Radius")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Fully Rounded',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderWidth: 2,\n borderRadius: Number.MAX_VALUE,\n borderSkipped: false,\n },\n {\n label: 'Small Radius',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderWidth: 2,\n borderRadius: 5,\n borderSkipped: false,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Bar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bar.html"}},[n._v("Bar")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bar.html#borderradius"}},[t("code",[n._v("borderRadius")])])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[205],{541:function(n,t,a){"use strict";a.r(t);var r=a(3),s=Object(r.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"bar-chart-border-radius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bar-chart-border-radius"}},[n._v("#")]),n._v(" Bar Chart Border Radius")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Fully Rounded',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderWidth: 2,\n borderRadius: Number.MAX_VALUE,\n borderSkipped: false,\n },\n {\n label: 'Small Radius',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderWidth: 2,\n borderRadius: 5,\n borderSkipped: false,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Bar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bar.html"}},[n._v("Bar")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bar.html#borderradius"}},[t("code",[n._v("borderRadius")])])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/206.10ce8275.js b/docs/master/assets/js/206.fa1aa288.js similarity index 97% rename from docs/master/assets/js/206.10ce8275.js rename to docs/master/assets/js/206.fa1aa288.js index b7a097fa4f..9196e50ab5 100644 --- a/docs/master/assets/js/206.10ce8275.js +++ b/docs/master/assets/js/206.fa1aa288.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[206],{541:function(n,t,a){"use strict";a.r(t);var s=a(3),e=Object(s.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"floating-bars"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#floating-bars"}},[n._v("#")]),n._v(" Floating Bars")]),n._v(" "),t("p",[n._v("Using "),t("code",[n._v("[number, number][]")]),n._v(" as the type for "),t("code",[n._v("data")]),n._v(" to define the beginning and end value for each bar. This is instead of having every bar start at 0.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = chart.data.labels.map(() => {\n return [Utils.rand(-100, 100), Utils.rand(-100, 100)];\n });\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: labels.map(() => {\n return [Utils.rand(-100, 100), Utils.rand(-100, 100)];\n }),\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: labels.map(() => {\n return [Utils.rand(-100, 100), Utils.rand(-100, 100)];\n }),\n backgroundColor: Utils.CHART_COLORS.blue,\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Floating Bar Chart'\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bar.html"}},[n._v("Bar")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[206],{543:function(n,t,a){"use strict";a.r(t);var s=a(3),e=Object(s.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"floating-bars"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#floating-bars"}},[n._v("#")]),n._v(" Floating Bars")]),n._v(" "),t("p",[n._v("Using "),t("code",[n._v("[number, number][]")]),n._v(" as the type for "),t("code",[n._v("data")]),n._v(" to define the beginning and end value for each bar. This is instead of having every bar start at 0.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = chart.data.labels.map(() => {\n return [Utils.rand(-100, 100), Utils.rand(-100, 100)];\n });\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: labels.map(() => {\n return [Utils.rand(-100, 100), Utils.rand(-100, 100)];\n }),\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: labels.map(() => {\n return [Utils.rand(-100, 100), Utils.rand(-100, 100)];\n }),\n backgroundColor: Utils.CHART_COLORS.blue,\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Floating Bar Chart'\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bar.html"}},[n._v("Bar")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/208.2b1333be.js b/docs/master/assets/js/208.2a10194c.js similarity index 97% rename from docs/master/assets/js/208.2b1333be.js rename to docs/master/assets/js/208.2a10194c.js index 0d63d27e79..e1be02c0d7 100644 --- a/docs/master/assets/js/208.2b1333be.js +++ b/docs/master/assets/js/208.2a10194c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[208],{543:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"stacked-bar-chart-with-groups"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#stacked-bar-chart-with-groups"}},[t._v("#")]),t._v(" Stacked Bar Chart with Groups")]),t._v(" "),n("p",[t._v("Using the "),n("code",[t._v("stack")]),t._v(" property to divide datasets into multiple stacks.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Utils.CHART_COLORS.red,\n stack: 'Stack 0',\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Utils.CHART_COLORS.blue,\n stack: 'Stack 0',\n },\n {\n label: 'Dataset 3',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Utils.CHART_COLORS.green,\n stack: 'Stack 1',\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Bar Chart - Stacked'\n },\n },\n responsive: true,\n interaction: {\n intersect: false,\n },\n scales: {\n x: {\n stacked: true,\n },\n y: {\n stacked: true\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html#stacked-bar-chart"}},[t._v("Stacked Bar Chart")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[t._v("Dataset Configuration ("),n("code",[t._v("stack")]),t._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[208],{545:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"stacked-bar-chart-with-groups"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#stacked-bar-chart-with-groups"}},[t._v("#")]),t._v(" Stacked Bar Chart with Groups")]),t._v(" "),n("p",[t._v("Using the "),n("code",[t._v("stack")]),t._v(" property to divide datasets into multiple stacks.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Utils.CHART_COLORS.red,\n stack: 'Stack 0',\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Utils.CHART_COLORS.blue,\n stack: 'Stack 0',\n },\n {\n label: 'Dataset 3',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Utils.CHART_COLORS.green,\n stack: 'Stack 1',\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Bar Chart - Stacked'\n },\n },\n responsive: true,\n interaction: {\n intersect: false,\n },\n scales: {\n x: {\n stacked: true,\n },\n y: {\n stacked: true\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html#stacked-bar-chart"}},[t._v("Stacked Bar Chart")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[t._v("Dataset Configuration ("),n("code",[t._v("stack")]),t._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/21.14889f4b.js b/docs/master/assets/js/21.db99e216.js similarity index 96% rename from docs/master/assets/js/21.14889f4b.js rename to docs/master/assets/js/21.db99e216.js index 7b6d874a6e..f907292331 100644 --- a/docs/master/assets/js/21.14889f4b.js +++ b/docs/master/assets/js/21.db99e216.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{354:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-domplatform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-domplatform"}},[t._v("#")]),t._v(" Class: DomPlatform")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[e("code",[t._v("BasePlatform")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("DomPlatform")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new DomPlatform")]),t._v("()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#constructor"}},[t._v("constructor")])],1),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"acquirecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#acquirecontext"}},[t._v("#")]),t._v(" acquireContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("acquireContext")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("p",[t._v("Called at chart construction time, returns a context2d instance implementing\nthe [W3C Canvas 2D Context API standard]"),e("a",{attrs:{href:"https://www.w3.org/TR/2dcontext/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.w3.org/TR/2dcontext/"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas from which to acquire context (platform specific)")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2DSettings")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart options")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#acquirecontext"}},[t._v("acquireContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addeventlistener"}},[t._v("#")]),t._v(" addEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Registers the specified listener on the given chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to listen for event")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to listen for")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Receives a notification (an object that implements the "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(" interface) when an event of the specified type occurs.")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#addeventlistener"}},[t._v("addEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2165"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevicepixelratio"}},[t._v("#")]),t._v(" getDevicePixelRatio")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDevicePixelRatio")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("the current devicePixelRatio of the device this platform is connected to.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getdevicepixelratio"}},[t._v("getDevicePixelRatio")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2176",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2176"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaximumsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaximumsize"}},[t._v("#")]),t._v(" getMaximumSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMaximumSize")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v(", "),e("code",[t._v("aspectRatio?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas for which to calculate the maximum size")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content width")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content height")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("aspectRatio?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The aspect ratio to maintain")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("p",[t._v("the maximum size available.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getmaximumsize"}},[t._v("getMaximumSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isattached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isattached"}},[t._v("#")]),t._v(" isAttached")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isAttached")]),t._v("("),e("code",[t._v("canvas")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the canvas is attached to the platform, false if not.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#isattached"}},[t._v("isAttached")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2189",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2189"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"releasecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#releasecontext"}},[t._v("#")]),t._v(" releaseContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("releaseContext")]),t._v("("),e("code",[t._v("context")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Called at chart destruction time, releases any resources associated to the context\npreviously returned by the acquireContext() method.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("context")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The context2d instance")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the method succeeded, else false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#releasecontext"}},[t._v("releaseContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removeeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removeeventlistener"}},[t._v("#")]),t._v(" removeEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Removes the specified listener previously registered with addEventListener.")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to remove the listener")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to remove")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The listener function to remove from the event target.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#removeeventlistener"}},[t._v("removeEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2172",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2172"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateconfig"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateConfig")]),t._v("("),e("code",[t._v("config")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Updates config with platform specific requirements")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#updateconfig"}},[t._v("updateConfig")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2194",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2194"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{353:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-domplatform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-domplatform"}},[t._v("#")]),t._v(" Class: DomPlatform")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[e("code",[t._v("BasePlatform")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("DomPlatform")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new DomPlatform")]),t._v("()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#constructor"}},[t._v("constructor")])],1),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"acquirecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#acquirecontext"}},[t._v("#")]),t._v(" acquireContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("acquireContext")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("p",[t._v("Called at chart construction time, returns a context2d instance implementing\nthe [W3C Canvas 2D Context API standard]"),e("a",{attrs:{href:"https://www.w3.org/TR/2dcontext/",target:"_blank",rel:"noopener noreferrer"}},[t._v("https://www.w3.org/TR/2dcontext/"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas from which to acquire context (platform specific)")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2DSettings")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The chart options")])])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#acquirecontext"}},[t._v("acquireContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2147",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2147"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"addeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#addeventlistener"}},[t._v("#")]),t._v(" addEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("addEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Registers the specified listener on the given chart.")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to listen for event")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to listen for")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Receives a notification (an object that implements the "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(" interface) when an event of the specified type occurs.")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#addeventlistener"}},[t._v("addEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2165",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2165"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdevicepixelratio"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdevicepixelratio"}},[t._v("#")]),t._v(" getDevicePixelRatio")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDevicePixelRatio")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("the current devicePixelRatio of the device this platform is connected to.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getdevicepixelratio"}},[t._v("getDevicePixelRatio")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2176",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2176"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmaximumsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmaximumsize"}},[t._v("#")]),t._v(" getMaximumSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMaximumSize")]),t._v("("),e("code",[t._v("canvas")]),t._v(", "),e("code",[t._v("width?")]),t._v(", "),e("code",[t._v("height?")]),t._v(", "),e("code",[t._v("aspectRatio?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The canvas for which to calculate the maximum size")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content width")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Parent element's content height")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("aspectRatio?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The aspect ratio to maintain")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("p",[t._v("the maximum size available.")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#getmaximumsize"}},[t._v("getMaximumSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2184",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2184"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isattached"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isattached"}},[t._v("#")]),t._v(" isAttached")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isAttached")]),t._v("("),e("code",[t._v("canvas")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canvas")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("HTMLCanvasElement")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the canvas is attached to the platform, false if not.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#isattached"}},[t._v("isAttached")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2189",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2189"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"releasecontext"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#releasecontext"}},[t._v("#")]),t._v(" releaseContext")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("releaseContext")]),t._v("("),e("code",[t._v("context")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Called at chart destruction time, releases any resources associated to the context\npreviously returned by the acquireContext() method.")]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("context")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The context2d instance")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("true if the method succeeded, else false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#releasecontext"}},[t._v("releaseContext")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2157",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2157"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"removeeventlistener"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#removeeventlistener"}},[t._v("#")]),t._v(" removeEventListener")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("removeEventListener")]),t._v("("),e("code",[t._v("chart")]),t._v(", "),e("code",[t._v("type")]),t._v(", "),e("code",[t._v("listener")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Removes the specified listener previously registered with addEventListener.")]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("Chart from which to remove the listener")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The ("),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[t._v("ChartEvent")]),t._v(") type to remove")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("listener")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("("),e("code",[t._v("e")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartEvent.html"}},[e("code",[t._v("ChartEvent")])]),t._v(") => "),e("code",[t._v("void")])],1),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("The listener function to remove from the event target.")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#removeeventlistener"}},[t._v("removeEventListener")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2172",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2172"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"updateconfig"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#updateconfig"}},[t._v("#")]),t._v(" updateConfig")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("updateConfig")]),t._v("("),e("code",[t._v("config")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Updates config with platform specific requirements")]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("config")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfiguration.html"}},[e("code",[t._v("ChartConfiguration")])]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartConfigurationCustomTypesPerDataset.html"}},[e("code",[t._v("ChartConfigurationCustomTypesPerDataset")])]),t._v("")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html"}},[t._v("BasePlatform")]),t._v("."),e("RouterLink",{attrs:{to:"/api/classes/BasePlatform.html#updateconfig"}},[t._v("updateConfig")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2194",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2194"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/210.e2a145d2.js b/docs/master/assets/js/210.55c94f0b.js similarity index 98% rename from docs/master/assets/js/210.e2a145d2.js rename to docs/master/assets/js/210.55c94f0b.js index 6cd4767450..8dde715b32 100644 --- a/docs/master/assets/js/210.e2a145d2.js +++ b/docs/master/assets/js/210.55c94f0b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[210],{545:function(t,a,n){"use strict";n.r(a);var e=n(3),s=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"vertical-bar-chart"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#vertical-bar-chart"}},[t._v("#")]),t._v(" Vertical Bar Chart")]),t._v(" "),a("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n borderWidth: 1,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Bar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),a("h2",{attrs:{id:"docs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),a("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[210],{548:function(t,a,n){"use strict";n.r(a);var e=n(3),s=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"vertical-bar-chart"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#vertical-bar-chart"}},[t._v("#")]),t._v(" Vertical Bar Chart")]),t._v(" "),a("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n borderWidth: 1,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Bar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),a("h2",{attrs:{id:"docs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),a("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/212.f57abbd6.js b/docs/master/assets/js/212.0b0e479a.js similarity index 97% rename from docs/master/assets/js/212.f57abbd6.js rename to docs/master/assets/js/212.0b0e479a.js index 566dc86418..a7a9782838 100644 --- a/docs/master/assets/js/212.f57abbd6.js +++ b/docs/master/assets/js/212.0b0e479a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[212],{553:function(n,e,o){"use strict";o.r(e);var t=o(3),a=Object(t.a)({},(function(){var n=this,e=n._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[e("h1",{attrs:{id:"events"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[n._v("#")]),n._v(" Events")]),n._v(" "),e("p",[n._v("This sample demonstrates how to use the event hooks to highlight chart elements.")]),n._v(" "),e("chart-editor",{attrs:{code:"\n// \nconst data = {\n labels: ['Red', 'Blue', 'Yellow', 'Green', 'Purple', 'Orange'],\n datasets: [{\n label: '# of Votes',\n data: [12, 19, 3, 5, 2, 3],\n borderWidth: 1,\n backgroundColor: ['#CB4335', '#1F618D', '#F1C40F', '#27AE60', '#884EA0', '#D35400'],\n }]\n};\n// \n\n// \n// Append '4d' to the colors (alpha channel), except for the hovered index\nfunction handleHover(evt, item, legend) {\n legend.chart.data.datasets[0].backgroundColor.forEach((color, index, colors) => {\n colors[index] = index === item.index || color.length === 9 ? color : color + '4D';\n });\n legend.chart.update();\n}\n// \n\n// \n// Removes the alpha channel from background colors\nfunction handleLeave(evt, item, legend) {\n legend.chart.data.datasets[0].backgroundColor.forEach((color, index, colors) => {\n colors[index] = color.length === 9 ? color.slice(0, -2) : color;\n });\n legend.chart.update();\n}\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n options: {\n plugins: {\n legend: {\n onHover: handleHover,\n onLeave: handleLeave\n }\n }\n }\n};\n// \n\nmodule.exports = {\n config\n};\n"}}),e("h2",{attrs:{id:"docs"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[n._v("Doughnut and Pie Charts")])],1),n._v(" "),e("li",[e("RouterLink",{attrs:{to:"/configuration/legend.html"}},[n._v("Legend")]),n._v(" "),e("ul",[e("li",[e("code",[n._v("onHover")])]),n._v(" "),e("li",[e("code",[n._v("onLeave")])])])],1)])],1)}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[212],{549:function(n,e,o){"use strict";o.r(e);var t=o(3),a=Object(t.a)({},(function(){var n=this,e=n._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[e("h1",{attrs:{id:"events"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#events"}},[n._v("#")]),n._v(" Events")]),n._v(" "),e("p",[n._v("This sample demonstrates how to use the event hooks to highlight chart elements.")]),n._v(" "),e("chart-editor",{attrs:{code:"\n// \nconst data = {\n labels: ['Red', 'Blue', 'Yellow', 'Green', 'Purple', 'Orange'],\n datasets: [{\n label: '# of Votes',\n data: [12, 19, 3, 5, 2, 3],\n borderWidth: 1,\n backgroundColor: ['#CB4335', '#1F618D', '#F1C40F', '#27AE60', '#884EA0', '#D35400'],\n }]\n};\n// \n\n// \n// Append '4d' to the colors (alpha channel), except for the hovered index\nfunction handleHover(evt, item, legend) {\n legend.chart.data.datasets[0].backgroundColor.forEach((color, index, colors) => {\n colors[index] = index === item.index || color.length === 9 ? color : color + '4D';\n });\n legend.chart.update();\n}\n// \n\n// \n// Removes the alpha channel from background colors\nfunction handleLeave(evt, item, legend) {\n legend.chart.data.datasets[0].backgroundColor.forEach((color, index, colors) => {\n colors[index] = color.length === 9 ? color.slice(0, -2) : color;\n });\n legend.chart.update();\n}\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n options: {\n plugins: {\n legend: {\n onHover: handleHover,\n onLeave: handleLeave\n }\n }\n }\n};\n// \n\nmodule.exports = {\n config\n};\n"}}),e("h2",{attrs:{id:"docs"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[n._v("Doughnut and Pie Charts")])],1),n._v(" "),e("li",[e("RouterLink",{attrs:{to:"/configuration/legend.html"}},[n._v("Legend")]),n._v(" "),e("ul",[e("li",[e("code",[n._v("onHover")])]),n._v(" "),e("li",[e("code",[n._v("onLeave")])])])],1)])],1)}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/214.8a6724ad.js b/docs/master/assets/js/214.64744f00.js similarity index 97% rename from docs/master/assets/js/214.8a6724ad.js rename to docs/master/assets/js/214.64744f00.js index a959fd89ec..1088d3c7c5 100644 --- a/docs/master/assets/js/214.8a6724ad.js +++ b/docs/master/assets/js/214.64744f00.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[214],{548:function(t,n,e){"use strict";e.r(n);var o=e(3),l=Object(o.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"point-style"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#point-style"}},[t._v("#")]),t._v(" Point Style")]),t._v(" "),n("p",[t._v("This sample show how to use the dataset point style in the legend instead of a rectangle to identify each dataset..")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Toggle Point Style',\n handler(chart) {\n chart.options.plugins.legend.labels.usePointStyle = !chart.options.plugins.legend.labels.usePointStyle;\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderWidth: 1,\n pointStyle: 'rectRot',\n pointRadius: 5,\n pointBorderColor: 'rgb(0, 0, 0)'\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n legend: {\n labels: {\n usePointStyle: true,\n },\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/legend.html"}},[t._v("Legend")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/legend.html#legend-label-configuration"}},[t._v("Legend Label Configuration")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("usePointStyle")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html"}},[t._v("Elements")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[t._v("Point Configuration")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("Point Styles")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[214],{551:function(t,n,e){"use strict";e.r(n);var o=e(3),l=Object(o.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"point-style"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#point-style"}},[t._v("#")]),t._v(" Point Style")]),t._v(" "),n("p",[t._v("This sample show how to use the dataset point style in the legend instead of a rectangle to identify each dataset..")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Toggle Point Style',\n handler(chart) {\n chart.options.plugins.legend.labels.usePointStyle = !chart.options.plugins.legend.labels.usePointStyle;\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderWidth: 1,\n pointStyle: 'rectRot',\n pointRadius: 5,\n pointBorderColor: 'rgb(0, 0, 0)'\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n legend: {\n labels: {\n usePointStyle: true,\n },\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/legend.html"}},[t._v("Legend")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/legend.html#legend-label-configuration"}},[t._v("Legend Label Configuration")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("usePointStyle")])])])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html"}},[t._v("Elements")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-configuration"}},[t._v("Point Configuration")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("Point Styles")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/215.c4e7e9cb.js b/docs/master/assets/js/215.cbef0d8c.js similarity index 97% rename from docs/master/assets/js/215.c4e7e9cb.js rename to docs/master/assets/js/215.cbef0d8c.js index 33a3251129..c381b8497a 100644 --- a/docs/master/assets/js/215.c4e7e9cb.js +++ b/docs/master/assets/js/215.cbef0d8c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[215],{549:function(n,t,o){"use strict";o.r(t);var a=o(3),s=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"position"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[n._v("#")]),n._v(" Position")]),n._v(" "),t("p",[n._v("This sample show how to change the position of the chart legend.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Position: top',\n handler(chart) {\n chart.options.plugins.legend.position = 'top';\n chart.update();\n }\n },\n {\n name: 'Position: right',\n handler(chart) {\n chart.options.plugins.legend.position = 'right';\n chart.update();\n }\n },\n {\n name: 'Position: bottom',\n handler(chart) {\n chart.options.plugins.legend.position = 'bottom';\n chart.update();\n }\n },\n {\n name: 'Position: left',\n handler(chart) {\n chart.options.plugins.legend.position = 'left';\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/legend.html"}},[n._v("Legend")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/configuration/legend.html#position"}},[n._v("Position")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[215],{550:function(n,t,o){"use strict";o.r(t);var a=o(3),s=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"position"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[n._v("#")]),n._v(" Position")]),n._v(" "),t("p",[n._v("This sample show how to change the position of the chart legend.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Position: top',\n handler(chart) {\n chart.options.plugins.legend.position = 'top';\n chart.update();\n }\n },\n {\n name: 'Position: right',\n handler(chart) {\n chart.options.plugins.legend.position = 'right';\n chart.update();\n }\n },\n {\n name: 'Position: bottom',\n handler(chart) {\n chart.options.plugins.legend.position = 'bottom';\n chart.update();\n }\n },\n {\n name: 'Position: left',\n handler(chart) {\n chart.options.plugins.legend.position = 'left';\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/legend.html"}},[n._v("Legend")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/configuration/legend.html#position"}},[n._v("Position")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/216.9a850184.js b/docs/master/assets/js/216.f0ba6c6f.js similarity index 97% rename from docs/master/assets/js/216.9a850184.js rename to docs/master/assets/js/216.f0ba6c6f.js index 223a33160e..9879321e21 100644 --- a/docs/master/assets/js/216.9a850184.js +++ b/docs/master/assets/js/216.f0ba6c6f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[216],{550:function(n,t,e){"use strict";e.r(t);var o=e(3),i=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"alignment-and-title-position"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#alignment-and-title-position"}},[n._v("#")]),n._v(" Alignment and Title Position")]),n._v(" "),t("p",[n._v("This sample show how to configure the alignment and title position of the chart legend.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Title Position: start',\n handler(chart) {\n chart.options.plugins.legend.align = 'start';\n chart.options.plugins.legend.title.position = 'start';\n chart.update();\n }\n },\n {\n name: 'Title Position: center (default)',\n handler(chart) {\n chart.options.plugins.legend.align = 'center';\n chart.options.plugins.legend.title.position = 'center';\n chart.update();\n }\n },\n {\n name: 'Title Position: end',\n handler(chart) {\n chart.options.plugins.legend.align = 'end';\n chart.options.plugins.legend.title.position = 'end';\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n legend: {\n title: {\n display: true,\n text: 'Legend Title',\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/legend.html"}},[n._v("Legend")])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[216],{552:function(n,t,e){"use strict";e.r(t);var o=e(3),i=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"alignment-and-title-position"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#alignment-and-title-position"}},[n._v("#")]),n._v(" Alignment and Title Position")]),n._v(" "),t("p",[n._v("This sample show how to configure the alignment and title position of the chart legend.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Title Position: start',\n handler(chart) {\n chart.options.plugins.legend.align = 'start';\n chart.options.plugins.legend.title.position = 'start';\n chart.update();\n }\n },\n {\n name: 'Title Position: center (default)',\n handler(chart) {\n chart.options.plugins.legend.align = 'center';\n chart.options.plugins.legend.title.position = 'center';\n chart.update();\n }\n },\n {\n name: 'Title Position: end',\n handler(chart) {\n chart.options.plugins.legend.align = 'end';\n chart.options.plugins.legend.title.position = 'end';\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n legend: {\n title: {\n display: true,\n text: 'Legend Title',\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/legend.html"}},[n._v("Legend")])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/217.7b6e451b.js b/docs/master/assets/js/217.0dc79be0.js similarity index 97% rename from docs/master/assets/js/217.7b6e451b.js rename to docs/master/assets/js/217.0dc79be0.js index f578b67512..690f80aa24 100644 --- a/docs/master/assets/js/217.7b6e451b.js +++ b/docs/master/assets/js/217.0dc79be0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[217],{551:function(n,t,e){"use strict";e.r(t);var o=e(3),i=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"interpolation-modes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interpolation-modes"}},[n._v("#")]),n._v(" Interpolation Modes")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 12;\nconst labels = [];\nfor (let i = 0; i < DATA_COUNT; ++i) {\n labels.push(i.toString());\n}\nconst datapoints = [0, 20, 20, 60, 60, 120, NaN, 180, 120, 125, 105, 110, 170];\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Cubic interpolation (monotone)',\n data: datapoints,\n borderColor: Utils.CHART_COLORS.red,\n fill: false,\n cubicInterpolationMode: 'monotone',\n tension: 0.4\n }, {\n label: 'Cubic interpolation',\n data: datapoints,\n borderColor: Utils.CHART_COLORS.blue,\n fill: false,\n tension: 0.4\n }, {\n label: 'Linear interpolation (default)',\n data: datapoints,\n borderColor: Utils.CHART_COLORS.green,\n fill: false\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Cubic interpolation mode'\n },\n },\n interaction: {\n intersect: false,\n },\n scales: {\n x: {\n display: true,\n title: {\n display: true\n }\n },\n y: {\n display: true,\n title: {\n display: true,\n text: 'Value'\n },\n suggestedMin: -10,\n suggestedMax: 200\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#cubicinterpolationmode"}},[t("code",[n._v("cubicInterpolationMode")])])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[n._v("Line Styling ("),t("code",[n._v("tension")]),n._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[217],{553:function(n,t,e){"use strict";e.r(t);var o=e(3),i=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"interpolation-modes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interpolation-modes"}},[n._v("#")]),n._v(" Interpolation Modes")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 12;\nconst labels = [];\nfor (let i = 0; i < DATA_COUNT; ++i) {\n labels.push(i.toString());\n}\nconst datapoints = [0, 20, 20, 60, 60, 120, NaN, 180, 120, 125, 105, 110, 170];\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Cubic interpolation (monotone)',\n data: datapoints,\n borderColor: Utils.CHART_COLORS.red,\n fill: false,\n cubicInterpolationMode: 'monotone',\n tension: 0.4\n }, {\n label: 'Cubic interpolation',\n data: datapoints,\n borderColor: Utils.CHART_COLORS.blue,\n fill: false,\n tension: 0.4\n }, {\n label: 'Linear interpolation (default)',\n data: datapoints,\n borderColor: Utils.CHART_COLORS.green,\n fill: false\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Cubic interpolation mode'\n },\n },\n interaction: {\n intersect: false,\n },\n scales: {\n x: {\n display: true,\n title: {\n display: true\n }\n },\n y: {\n display: true,\n title: {\n display: true,\n text: 'Value'\n },\n suggestedMin: -10,\n suggestedMax: 200\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#cubicinterpolationmode"}},[t("code",[n._v("cubicInterpolationMode")])])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[n._v("Line Styling ("),t("code",[n._v("tension")]),n._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/218.4f775721.js b/docs/master/assets/js/218.706830b9.js similarity index 98% rename from docs/master/assets/js/218.4f775721.js rename to docs/master/assets/js/218.706830b9.js index f527ee4183..8a2f4b8a3d 100644 --- a/docs/master/assets/js/218.4f775721.js +++ b/docs/master/assets/js/218.706830b9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[218],{552:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"line-chart"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#line-chart"}},[t._v("#")]),t._v(" Line Chart")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Line Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[218],{554:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"line-chart"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#line-chart"}},[t._v("#")]),t._v(" Line Chart")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Line Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/219.d17ad0bb.js b/docs/master/assets/js/219.fc351a10.js similarity index 97% rename from docs/master/assets/js/219.d17ad0bb.js rename to docs/master/assets/js/219.fc351a10.js index 690a82c29e..6ead9b6e9e 100644 --- a/docs/master/assets/js/219.d17ad0bb.js +++ b/docs/master/assets/js/219.fc351a10.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[219],{554:function(n,t,a){"use strict";a.r(t);var s=a(3),e=Object(s.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"multi-axis-line-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#multi-axis-line-chart"}},[n._v("#")]),n._v(" Multi Axis Line Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n yAxisID: 'y',\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n yAxisID: 'y1',\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n interaction: {\n mode: 'index',\n intersect: false,\n },\n stacked: false,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Multi Axis'\n }\n },\n scales: {\n y: {\n type: 'linear',\n display: true,\n position: 'left',\n },\n y1: {\n type: 'linear',\n display: true,\n position: 'right',\n\n // grid line settings\n grid: {\n drawOnChartArea: false, // only want the grid lines for one axis to show up\n },\n },\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/"}},[n._v("Axes scales")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/"}},[n._v("Cartesian Axes")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[n._v("Axis Position")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[219],{556:function(n,t,a){"use strict";a.r(t);var s=a(3),e=Object(s.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"multi-axis-line-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#multi-axis-line-chart"}},[n._v("#")]),n._v(" Multi Axis Line Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n yAxisID: 'y',\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n yAxisID: 'y1',\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n interaction: {\n mode: 'index',\n intersect: false,\n },\n stacked: false,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Multi Axis'\n }\n },\n scales: {\n y: {\n type: 'linear',\n display: true,\n position: 'left',\n },\n y1: {\n type: 'linear',\n display: true,\n position: 'right',\n\n // grid line settings\n grid: {\n drawOnChartArea: false, // only want the grid lines for one axis to show up\n },\n },\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/"}},[n._v("Axes scales")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/"}},[n._v("Cartesian Axes")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[n._v("Axis Position")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/22.e26e4894.js b/docs/master/assets/js/22.db17b610.js similarity index 95% rename from docs/master/assets/js/22.e26e4894.js rename to docs/master/assets/js/22.db17b610.js index b325078b92..c79e5c5ac6 100644 --- a/docs/master/assets/js/22.e26e4894.js +++ b/docs/master/assets/js/22.db17b610.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{355:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-pointelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-pointelement"}},[t._v("#")]),t._v(" Class: PointElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#pointprops"}},[e("code",[t._v("PointProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[e("code",[t._v("PointOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[e("code",[t._v("PointHoverOptions")])]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("PointElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new PointElement")]),t._v("("),e("code",[t._v("cfg")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[e("code",[t._v("PointOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[e("code",[t._v("PointHoverOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsed"}},[t._v("#")]),t._v(" parsed")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsed")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:24"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"skip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#skip"}},[t._v("#")]),t._v(" skip")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("skip")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("stop")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:26"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaultroutes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaultroutes"}},[t._v("#")]),t._v(" defaultRoutes")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaultRoutes")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-2"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaultRoutes")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:44"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hitRadius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hoverRadius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pointStyle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("radius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("rotation")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-3"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaults")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")]),t._v(" = "),e("code",[t._v("'point'")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v(", "),e("code",[t._v("area")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("area")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L89",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:89"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:76"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getrange"}},[t._v("#")]),t._v(" getRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getRange")]),t._v("(): "),e("code",[t._v("any")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("any")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:102"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:62"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inxrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inxrange"}},[t._v("#")]),t._v(" inXRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inXRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:68"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inyrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inyrange"}},[t._v("#")]),t._v(" inYRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inYRange")]),t._v("("),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:72"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"size"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#size"}},[t._v("#")]),t._v(" size")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("size")]),t._v("("),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[e("code",[t._v("PointOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[e("code",[t._v("PointHoverOptions")])]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.point.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:81"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{354:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-pointelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-pointelement"}},[t._v("#")]),t._v(" Class: PointElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#pointprops"}},[e("code",[t._v("PointProps")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[e("code",[t._v("PointOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[e("code",[t._v("PointHoverOptions")])]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("PointElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new PointElement")]),t._v("("),e("code",[t._v("cfg")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("any")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[e("code",[t._v("PointOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[e("code",[t._v("PointHoverOptions")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsed"}},[t._v("#")]),t._v(" parsed")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsed")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/CartesianParsedData.html"}},[e("code",[t._v("CartesianParsedData")])])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L24",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:24"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"skip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#skip"}},[t._v("#")]),t._v(" skip")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("skip")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stop"}},[t._v("#")]),t._v(" stop")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("stop")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L26",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:26"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaultroutes"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaultroutes"}},[t._v("#")]),t._v(" defaultRoutes")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaultRoutes")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("backgroundColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderColor")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-2"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaultRoutes")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L44",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:44"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"defaults"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defaults"}},[t._v("#")]),t._v(" defaults")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("defaults")]),t._v(": "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"type-declaration-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-declaration-2"}},[t._v("#")]),t._v(" Type declaration")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("borderWidth")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hitRadius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hoverBorderWidth")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("hoverRadius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pointStyle")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("radius")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("rotation")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"overrides-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#overrides-3"}},[t._v("#")]),t._v(" Overrides")]),t._v(" "),e("p",[t._v("Element.defaults")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("▪ "),e("code",[t._v("Static")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")]),t._v(" = "),e("code",[t._v("'point'")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v(", "),e("code",[t._v("area")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("area")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L89",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:89"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("x")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("y")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L76",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:76"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getrange"}},[t._v("#")]),t._v(" getRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getRange")]),t._v("(): "),e("code",[t._v("any")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("any")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L102",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:102"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L62",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:62"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inxrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inxrange"}},[t._v("#")]),t._v(" inXRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inXRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L68",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:68"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inyrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inyrange"}},[t._v("#")]),t._v(" inYRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inYRange")]),t._v("("),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L72",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:72"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"size"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#size"}},[t._v("#")]),t._v(" size")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("size")]),t._v("("),e("code",[t._v("options?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Partial")]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/PointOptions.html"}},[e("code",[t._v("PointOptions")])]),t._v(" & "),e("RouterLink",{attrs:{to:"/api/interfaces/PointHoverOptions.html"}},[e("code",[t._v("PointHoverOptions")])]),t._v(">")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.point.ts#L81",target:"_blank",rel:"noopener noreferrer"}},[t._v("elements/element.point.ts:81"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/220.7bb9f54c.js b/docs/master/assets/js/220.9f5f6f14.js similarity index 98% rename from docs/master/assets/js/220.7bb9f54c.js rename to docs/master/assets/js/220.9f5f6f14.js index 0403981795..bd56de3569 100644 --- a/docs/master/assets/js/220.7bb9f54c.js +++ b/docs/master/assets/js/220.9f5f6f14.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[220],{555:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"point-styling"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#point-styling"}},[t._v("#")]),t._v(" Point Styling")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'pointStyle: circle (default)',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'circle';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: cross',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'cross';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: crossRot',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'crossRot';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: dash',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'dash';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: line',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'line';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: rect',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'rect';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: rectRounded',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'rectRounded';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: rectRot',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'rectRot';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: star',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'star';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: triangle',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'triangle';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: false',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = false;\n });\n chart.update();\n }\n }\n];\n// \n\n// \nconst data = {\n labels: ['Day 1', 'Day 2', 'Day 3', 'Day 4', 'Day 5', 'Day 6'],\n datasets: [\n {\n label: 'Dataset',\n data: Utils.numbers({count: 6, min: -100, max: 100}),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n pointStyle: 'circle',\n pointRadius: 10,\n pointHoverRadius: 15\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Point Style: ' + ctx.chart.data.datasets[0].pointStyle,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#point-styling"}},[t._v("Point Styling")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[220],{558:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"point-styling"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#point-styling"}},[t._v("#")]),t._v(" Point Styling")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'pointStyle: circle (default)',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'circle';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: cross',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'cross';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: crossRot',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'crossRot';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: dash',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'dash';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: line',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'line';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: rect',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'rect';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: rectRounded',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'rectRounded';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: rectRot',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'rectRot';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: star',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'star';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: triangle',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = 'triangle';\n });\n chart.update();\n }\n },\n {\n name: 'pointStyle: false',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.pointStyle = false;\n });\n chart.update();\n }\n }\n];\n// \n\n// \nconst data = {\n labels: ['Day 1', 'Day 2', 'Day 3', 'Day 4', 'Day 5', 'Day 6'],\n datasets: [\n {\n label: 'Dataset',\n data: Utils.numbers({count: 6, min: -100, max: 100}),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n pointStyle: 'circle',\n pointRadius: 10,\n pointHoverRadius: 15\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Point Style: ' + ctx.chart.data.datasets[0].pointStyle,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#point-styling"}},[t._v("Point Styling")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/221.91facae7.js b/docs/master/assets/js/221.c7971a2a.js similarity index 97% rename from docs/master/assets/js/221.91facae7.js rename to docs/master/assets/js/221.c7971a2a.js index 8c93ef57d1..aeaf034a45 100644 --- a/docs/master/assets/js/221.91facae7.js +++ b/docs/master/assets/js/221.c7971a2a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[221],{556:function(t,n,e){"use strict";e.r(n);var s=e(3),i=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"line-segment-styling"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#line-segment-styling"}},[t._v("#")]),t._v(" Line Segment Styling")]),t._v(" "),n("p",[t._v("Using helper functions to style each segment. Gaps in the data ('skipped') are set to dashed lines and segments with values going 'down' are set to a different color.")]),t._v(" "),n("chart-editor",{attrs:{code:"\n// \nconst skipped = (ctx, value) => ctx.p0.skip || ctx.p1.skip ? value : undefined;\nconst down = (ctx, value) => ctx.p0.parsed.y > ctx.p1.parsed.y ? value : undefined;\n// \n\n// \nconst genericOptions = {\n fill: false,\n interaction: {\n intersect: false\n },\n radius: 0,\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: {\n labels: Utils.months({count: 7}),\n datasets: [{\n label: 'My First Dataset',\n data: [65, 59, NaN, 48, 56, 57, 40],\n borderColor: 'rgb(75, 192, 192)',\n segment: {\n borderColor: ctx => skipped(ctx, 'rgb(0,0,0,0.2)') || down(ctx, 'rgb(192,75,75)'),\n borderDash: ctx => skipped(ctx, [6, 6]),\n },\n spanGaps: true\n }]\n },\n options: genericOptions\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[t._v("Line Styling")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#segment"}},[t._v("Segment")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[221],{555:function(t,n,e){"use strict";e.r(n);var s=e(3),i=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"line-segment-styling"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#line-segment-styling"}},[t._v("#")]),t._v(" Line Segment Styling")]),t._v(" "),n("p",[t._v("Using helper functions to style each segment. Gaps in the data ('skipped') are set to dashed lines and segments with values going 'down' are set to a different color.")]),t._v(" "),n("chart-editor",{attrs:{code:"\n// \nconst skipped = (ctx, value) => ctx.p0.skip || ctx.p1.skip ? value : undefined;\nconst down = (ctx, value) => ctx.p0.parsed.y > ctx.p1.parsed.y ? value : undefined;\n// \n\n// \nconst genericOptions = {\n fill: false,\n interaction: {\n intersect: false\n },\n radius: 0,\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: {\n labels: Utils.months({count: 7}),\n datasets: [{\n label: 'My First Dataset',\n data: [65, 59, NaN, 48, 56, 57, 40],\n borderColor: 'rgb(75, 192, 192)',\n segment: {\n borderColor: ctx => skipped(ctx, 'rgb(0,0,0,0.2)') || down(ctx, 'rgb(192,75,75)'),\n borderDash: ctx => skipped(ctx, [6, 6]),\n },\n spanGaps: true\n }]\n },\n options: genericOptions\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#line-styling"}},[t._v("Line Styling")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html#segment"}},[t._v("Segment")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/222.86ed3f93.js b/docs/master/assets/js/222.894c19f5.js similarity index 97% rename from docs/master/assets/js/222.86ed3f93.js rename to docs/master/assets/js/222.894c19f5.js index af5d50db9c..74c4d3d037 100644 --- a/docs/master/assets/js/222.86ed3f93.js +++ b/docs/master/assets/js/222.894c19f5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[222],{558:function(t,a,n){"use strict";n.r(a);var e=n(3),s=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"stepped-line-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#stepped-line-charts"}},[t._v("#")]),t._v(" Stepped Line Charts")]),t._v(" "),a("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Step: false (default)',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = false;\n });\n chart.update();\n }\n },\n {\n name: 'Step: true',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = true;\n });\n chart.update();\n }\n },\n {\n name: 'Step: before',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = 'before';\n });\n chart.update();\n }\n },\n {\n name: 'Step: after',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = 'after';\n });\n chart.update();\n }\n },\n {\n name: 'Step: middle',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = 'middle';\n });\n chart.update();\n }\n }\n];\n// \n\n// \nconst data = {\n labels: ['Day 1', 'Day 2', 'Day 3', 'Day 4', 'Day 5', 'Day 6'],\n datasets: [\n {\n label: 'Dataset',\n data: Utils.numbers({count: 6, min: -100, max: 100}),\n borderColor: Utils.CHART_COLORS.red,\n fill: false,\n stepped: true,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n interaction: {\n intersect: false,\n axis: 'x'\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Step ' + ctx.chart.data.datasets[0].stepped + ' Interpolation',\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),a("h2",{attrs:{id:"docs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),a("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/charts/line.html#stepped"}},[t._v("Stepped")])],1)])],1)])],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[222],{557:function(t,a,n){"use strict";n.r(a);var e=n(3),s=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"stepped-line-charts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#stepped-line-charts"}},[t._v("#")]),t._v(" Stepped Line Charts")]),t._v(" "),a("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Step: false (default)',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = false;\n });\n chart.update();\n }\n },\n {\n name: 'Step: true',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = true;\n });\n chart.update();\n }\n },\n {\n name: 'Step: before',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = 'before';\n });\n chart.update();\n }\n },\n {\n name: 'Step: after',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = 'after';\n });\n chart.update();\n }\n },\n {\n name: 'Step: middle',\n handler: (chart) => {\n chart.data.datasets.forEach(dataset => {\n dataset.stepped = 'middle';\n });\n chart.update();\n }\n }\n];\n// \n\n// \nconst data = {\n labels: ['Day 1', 'Day 2', 'Day 3', 'Day 4', 'Day 5', 'Day 6'],\n datasets: [\n {\n label: 'Dataset',\n data: Utils.numbers({count: 6, min: -100, max: 100}),\n borderColor: Utils.CHART_COLORS.red,\n fill: false,\n stepped: true,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n interaction: {\n intersect: false,\n axis: 'x'\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Step ' + ctx.chart.data.datasets[0].stepped + ' Interpolation',\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),a("h2",{attrs:{id:"docs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),a("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/charts/line.html#stepped"}},[t._v("Stepped")])],1)])],1)])],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/224.57ff1281.js b/docs/master/assets/js/224.93c0614b.js similarity index 97% rename from docs/master/assets/js/224.57ff1281.js rename to docs/master/assets/js/224.93c0614b.js index d4a3142f9b..1bbbe8090a 100644 --- a/docs/master/assets/js/224.57ff1281.js +++ b/docs/master/assets/js/224.93c0614b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[224],{557:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"bubble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bubble"}},[this._v("#")]),this._v(" Bubble")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, rmin: 5, rmax: 15, min: 0, max: 100};\n\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n }\n ]\n};\n// \n\n// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.bubbles({count: DATA_COUNT, rmin: 5, rmax: 15, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const chartData = chart.data;\n const dsColor = Utils.namedColor(chartData.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (chartData.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.bubbles({count: DATA_COUNT, rmin: 5, rmax: 15, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const chartData = chart.data;\n if (chartData.datasets.length > 0) {\n\n for (let index = 0; index < chartData.datasets.length; ++index) {\n chartData.datasets[index].data.push(Utils.bubbles({count: 1, rmin: 5, rmax: 15, min: 0, max: 100})[0]);\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'bubble',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Bubble Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bubble.html"}},[this._v("Bubble")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[224],{560:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"bubble"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bubble"}},[this._v("#")]),this._v(" Bubble")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, rmin: 5, rmax: 15, min: 0, max: 100};\n\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n }\n ]\n};\n// \n\n// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.bubbles({count: DATA_COUNT, rmin: 5, rmax: 15, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const chartData = chart.data;\n const dsColor = Utils.namedColor(chartData.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (chartData.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.bubbles({count: DATA_COUNT, rmin: 5, rmax: 15, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const chartData = chart.data;\n if (chartData.datasets.length > 0) {\n\n for (let index = 0; index < chartData.datasets.length; ++index) {\n chartData.datasets[index].data.push(Utils.bubbles({count: 1, rmin: 5, rmax: 15, min: 0, max: 100})[0]);\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'bubble',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Bubble Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bubble.html"}},[this._v("Bubble")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/225.3ea1304d.js b/docs/master/assets/js/225.bc003c86.js similarity index 98% rename from docs/master/assets/js/225.3ea1304d.js rename to docs/master/assets/js/225.bc003c86.js index a883ffde22..25fd04b79c 100644 --- a/docs/master/assets/js/225.3ea1304d.js +++ b/docs/master/assets/js/225.bc003c86.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[225],{561:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"combo-bar-line"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#combo-bar-line"}},[t._v("#")]),t._v(" Combo bar/line")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n borderWidth: 1,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n order: 1\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n type: 'line',\n order: 0\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Combined Line/Bar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[225],{566:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"combo-bar-line"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#combo-bar-line"}},[t._v("#")]),t._v(" Combo bar/line")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n borderWidth: 1,\n data: Utils.numbers({count: data.labels.length, min: -100, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(-100, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n order: 1\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n type: 'line',\n order: 0\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'bar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Combined Line/Bar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/226.3b8dc66b.js b/docs/master/assets/js/226.a89be2cc.js similarity index 98% rename from docs/master/assets/js/226.3b8dc66b.js rename to docs/master/assets/js/226.a89be2cc.js index cb6a839942..d74f97527b 100644 --- a/docs/master/assets/js/226.3b8dc66b.js +++ b/docs/master/assets/js/226.a89be2cc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[226],{566:function(n,t,a){"use strict";a.r(t);var e=a(3),s=Object(e.a)({},(function(){var n=this._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[n("h1",{attrs:{id:"doughnut"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#doughnut"}},[this._v("#")]),this._v(" Doughnut")]),this._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: [],\n data: [],\n };\n\n for (let i = 0; i < data.labels.length; i++) {\n newDataset.data.push(Utils.numbers({count: 1, min: 0, max: 100}));\n\n const colorIndex = i % Object.keys(Utils.CHART_COLORS).length;\n newDataset.backgroundColor.push(Object.values(Utils.CHART_COLORS)[colorIndex]);\n }\n\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Hide(0)',\n handler(chart) {\n chart.hide(0);\n }\n },\n {\n name: 'Show(0)',\n handler(chart) {\n chart.show(0);\n }\n },\n {\n name: 'Hide (0, 1)',\n handler(chart) {\n chart.hide(0, 1);\n }\n },\n {\n name: 'Show (0, 1)',\n handler(chart) {\n chart.show(0, 1);\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst data = {\n labels: ['Red', 'Orange', 'Yellow', 'Green', 'Blue'],\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Object.values(Utils.CHART_COLORS),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Doughnut Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[this._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[226],{561:function(n,t,a){"use strict";a.r(t);var e=a(3),s=Object(e.a)({},(function(){var n=this._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[n("h1",{attrs:{id:"doughnut"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#doughnut"}},[this._v("#")]),this._v(" Doughnut")]),this._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: [],\n data: [],\n };\n\n for (let i = 0; i < data.labels.length; i++) {\n newDataset.data.push(Utils.numbers({count: 1, min: 0, max: 100}));\n\n const colorIndex = i % Object.keys(Utils.CHART_COLORS).length;\n newDataset.backgroundColor.push(Object.values(Utils.CHART_COLORS)[colorIndex]);\n }\n\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Hide(0)',\n handler(chart) {\n chart.hide(0);\n }\n },\n {\n name: 'Show(0)',\n handler(chart) {\n chart.show(0);\n }\n },\n {\n name: 'Hide (0, 1)',\n handler(chart) {\n chart.hide(0, 1);\n }\n },\n {\n name: 'Show (0, 1)',\n handler(chart) {\n chart.show(0, 1);\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst data = {\n labels: ['Red', 'Orange', 'Yellow', 'Green', 'Blue'],\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Object.values(Utils.CHART_COLORS),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Doughnut Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[this._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/227.151dfac5.js b/docs/master/assets/js/227.beeb0b59.js similarity index 98% rename from docs/master/assets/js/227.151dfac5.js rename to docs/master/assets/js/227.beeb0b59.js index 536df0cd05..9719db45f0 100644 --- a/docs/master/assets/js/227.151dfac5.js +++ b/docs/master/assets/js/227.beeb0b59.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[227],{560:function(t,n,e){"use strict";e.r(n);var a=e(3),l=Object(a.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"multi-series-pie"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#multi-series-pie"}},[t._v("#")]),t._v(" Multi Series Pie")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: ['Overall Yay', 'Overall Nay', 'Group A Yay', 'Group A Nay', 'Group B Yay', 'Group B Nay', 'Group C Yay', 'Group C Nay'],\n datasets: [\n {\n backgroundColor: ['#AAA', '#777'],\n data: [21, 79]\n },\n {\n backgroundColor: ['hsl(0, 100%, 60%)', 'hsl(0, 100%, 35%)'],\n data: [33, 67]\n },\n {\n backgroundColor: ['hsl(100, 100%, 60%)', 'hsl(100, 100%, 35%)'],\n data: [20, 80]\n },\n {\n backgroundColor: ['hsl(180, 100%, 60%)', 'hsl(180, 100%, 35%)'],\n data: [10, 90]\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n labels: {\n generateLabels: function(chart) {\n // Get the default label list\n const original = Chart.overrides.pie.plugins.legend.labels.generateLabels;\n const labelsOriginal = original.call(this, chart);\n\n // Build an array of colors used in the datasets of the chart\n let datasetColors = chart.data.datasets.map(function(e) {\n return e.backgroundColor;\n });\n datasetColors = datasetColors.flat();\n\n // Modify the color and hide state of each label\n labelsOriginal.forEach(label => {\n // There are twice as many labels as there are datasets. This converts the label index into the corresponding dataset index\n label.datasetIndex = (label.index - label.index % 2) / 2;\n\n // The hidden state must match the dataset's hidden state\n label.hidden = !chart.isDatasetVisible(label.datasetIndex);\n\n // Change the color to match the dataset\n label.fillStyle = datasetColors[label.index];\n });\n\n return labelsOriginal;\n }\n },\n onClick: function(mouseEvent, legendItem, legend) {\n // toggle the visibility of the dataset from what it currently is\n legend.chart.getDatasetMeta(\n legendItem.datasetIndex\n ).hidden = legend.chart.isDatasetVisible(legendItem.datasetIndex);\n legend.chart.update();\n }\n },\n tooltip: {\n callbacks: {\n label: function(context) {\n const labelIndex = (context.datasetIndex * 2) + context.dataIndex;\n return context.chart.data.labels[labelIndex] + ': ' + context.formattedValue;\n }\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[t._v("Doughnut and Pie Charts")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[227],{562:function(t,n,e){"use strict";e.r(n);var a=e(3),l=Object(a.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"multi-series-pie"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#multi-series-pie"}},[t._v("#")]),t._v(" Multi Series Pie")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: ['Overall Yay', 'Overall Nay', 'Group A Yay', 'Group A Nay', 'Group B Yay', 'Group B Nay', 'Group C Yay', 'Group C Nay'],\n datasets: [\n {\n backgroundColor: ['#AAA', '#777'],\n data: [21, 79]\n },\n {\n backgroundColor: ['hsl(0, 100%, 60%)', 'hsl(0, 100%, 35%)'],\n data: [33, 67]\n },\n {\n backgroundColor: ['hsl(100, 100%, 60%)', 'hsl(100, 100%, 35%)'],\n data: [20, 80]\n },\n {\n backgroundColor: ['hsl(180, 100%, 60%)', 'hsl(180, 100%, 35%)'],\n data: [10, 90]\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n labels: {\n generateLabels: function(chart) {\n // Get the default label list\n const original = Chart.overrides.pie.plugins.legend.labels.generateLabels;\n const labelsOriginal = original.call(this, chart);\n\n // Build an array of colors used in the datasets of the chart\n let datasetColors = chart.data.datasets.map(function(e) {\n return e.backgroundColor;\n });\n datasetColors = datasetColors.flat();\n\n // Modify the color and hide state of each label\n labelsOriginal.forEach(label => {\n // There are twice as many labels as there are datasets. This converts the label index into the corresponding dataset index\n label.datasetIndex = (label.index - label.index % 2) / 2;\n\n // The hidden state must match the dataset's hidden state\n label.hidden = !chart.isDatasetVisible(label.datasetIndex);\n\n // Change the color to match the dataset\n label.fillStyle = datasetColors[label.index];\n });\n\n return labelsOriginal;\n }\n },\n onClick: function(mouseEvent, legendItem, legend) {\n // toggle the visibility of the dataset from what it currently is\n legend.chart.getDatasetMeta(\n legendItem.datasetIndex\n ).hidden = legend.chart.isDatasetVisible(legendItem.datasetIndex);\n legend.chart.update();\n }\n },\n tooltip: {\n callbacks: {\n label: function(context) {\n const labelIndex = (context.datasetIndex * 2) + context.dataIndex;\n return context.chart.data.labels[labelIndex] + ': ' + context.formattedValue;\n }\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[t._v("Doughnut and Pie Charts")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/228.221c5e1a.js b/docs/master/assets/js/228.db39a480.js similarity index 97% rename from docs/master/assets/js/228.221c5e1a.js rename to docs/master/assets/js/228.db39a480.js index 0e870d9c65..fd0107d3b6 100644 --- a/docs/master/assets/js/228.221c5e1a.js +++ b/docs/master/assets/js/228.db39a480.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[228],{562:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"pie"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pie"}},[this._v("#")]),this._v(" Pie")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: [],\n data: [],\n };\n\n for (let i = 0; i < data.labels.length; i++) {\n newDataset.data.push(Utils.numbers({count: 1, min: 0, max: 100}));\n\n const colorIndex = i % Object.keys(Utils.CHART_COLORS).length;\n newDataset.backgroundColor.push(Object.values(Utils.CHART_COLORS)[colorIndex]);\n }\n\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst data = {\n labels: ['Red', 'Orange', 'Yellow', 'Green', 'Blue'],\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Object.values(Utils.CHART_COLORS),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Pie Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[this._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[228],{564:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"pie"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pie"}},[this._v("#")]),this._v(" Pie")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: [],\n data: [],\n };\n\n for (let i = 0; i < data.labels.length; i++) {\n newDataset.data.push(Utils.numbers({count: 1, min: 0, max: 100}));\n\n const colorIndex = i % Object.keys(Utils.CHART_COLORS).length;\n newDataset.backgroundColor.push(Object.values(Utils.CHART_COLORS)[colorIndex]);\n }\n\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst data = {\n labels: ['Red', 'Orange', 'Yellow', 'Green', 'Blue'],\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: Object.values(Utils.CHART_COLORS),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'pie',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Pie Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[this._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/229.4f964bcf.js b/docs/master/assets/js/229.f7e874f0.js similarity index 98% rename from docs/master/assets/js/229.4f964bcf.js rename to docs/master/assets/js/229.f7e874f0.js index 9df149209f..a587b4ff75 100644 --- a/docs/master/assets/js/229.4f964bcf.js +++ b/docs/master/assets/js/229.f7e874f0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[229],{564:function(n,t,a){"use strict";a.r(t);var e=a(3),s=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"polar-area-centered-point-labels"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#polar-area-centered-point-labels"}},[n._v("#")]),n._v(" Polar area centered point labels")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = ['Red', 'Orange', 'Yellow', 'Green', 'Blue'];\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: [\n Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.yellow, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n ]\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n responsive: true,\n scales: {\n r: {\n pointLabels: {\n display: true,\n centerPointLabels: true,\n font: {\n size: 18\n }\n }\n }\n },\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Polar Area Chart With Centered Point Labels'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/polar.html"}},[n._v("Polar Area Chart")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[n._v("Linear Radial Axis")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/radial/linear.html#point-label-options"}},[n._v("Point Label Options ("),t("code",[n._v("centerPointLabels")]),n._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[229],{563:function(n,t,a){"use strict";a.r(t);var e=a(3),s=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"polar-area-centered-point-labels"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#polar-area-centered-point-labels"}},[n._v("#")]),n._v(" Polar area centered point labels")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = ['Red', 'Orange', 'Yellow', 'Green', 'Blue'];\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: [\n Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.yellow, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n ]\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n responsive: true,\n scales: {\n r: {\n pointLabels: {\n display: true,\n centerPointLabels: true,\n font: {\n size: 18\n }\n }\n }\n },\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Polar Area Chart With Centered Point Labels'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/polar.html"}},[n._v("Polar Area Chart")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/radial/linear.html"}},[n._v("Linear Radial Axis")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/radial/linear.html#point-label-options"}},[n._v("Point Label Options ("),t("code",[n._v("centerPointLabels")]),n._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/23.388a719e.js b/docs/master/assets/js/23.e0daa42d.js similarity index 93% rename from docs/master/assets/js/23.388a719e.js rename to docs/master/assets/js/23.e0daa42d.js index eb23f886f9..c0908e4f2e 100644 --- a/docs/master/assets/js/23.388a719e.js +++ b/docs/master/assets/js/23.e0daa42d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{356:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-scale-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-scale-o"}},[t._v("#")]),t._v(" Class: Scale")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("O")]),t._v(">")])]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("Scale")])])]),t._v(" "),e("p",[t._v("↳↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/TimeScale.html"}},[e("code",[t._v("TimeScale")])])],1),t._v(" "),e("p",[t._v("↳↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/RadialLinearScale.html"}},[e("code",[t._v("RadialLinearScale")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Scale")]),t._v("<"),e("code",[t._v("O")]),t._v(">("),e("code",[t._v("cfg")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.constructor")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1375",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1375"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("never")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1276",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1276"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bottom"}},[t._v("#")]),t._v(" bottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Bottom edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#bottom"}},[t._v("bottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1266",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1266"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1265",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1265"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, and the item is horizontal, then push vertical boxes down")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#fullsize"}},[t._v("fullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#height"}},[t._v("height")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelrotation"}},[t._v("#")]),t._v(" labelRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1277",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1277"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#left"}},[t._v("left")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:29"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"max"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#max"}},[t._v("#")]),t._v(" max")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("max")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1279",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1279"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxheight"}},[t._v("#")]),t._v(" maxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxHeight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1269",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1269"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"min"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min"}},[t._v("#")]),t._v(" min")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("min")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1278",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1278"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingbottom"}},[t._v("#")]),t._v(" paddingBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingBottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1272",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1272"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingleft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingleft"}},[t._v("#")]),t._v(" paddingLeft")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingLeft")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1273",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1273"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingright"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingright"}},[t._v("#")]),t._v(" paddingRight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingRight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1274"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingtop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingtop"}},[t._v("#")]),t._v(" paddingTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingTop")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1271",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1271"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])])],1),t._v(" "),e("p",[t._v("The position of the item in the chart layout. Possible values are")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#position"}},[t._v("position")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"right"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#right"}},[t._v("#")]),t._v(" right")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("right")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Right edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#right"}},[t._v("right")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" ticks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1280",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1280"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#top"}},[t._v("top")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:33"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1264",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1264"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The weight used to sort the item. Higher weights are further away from the chart area")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#width"}},[t._v("width")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftercalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftercalculatelabelrotation"}},[t._v("#")]),t._v(" afterCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1358"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfit"}},[t._v("#")]),t._v(" afterFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1370",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1370"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftersetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftersetdimensions"}},[t._v("#")]),t._v(" afterSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1355",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterticktolabelconversion"}},[t._v("#")]),t._v(" afterTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1352",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1352"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforecalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforecalculatelabelrotation"}},[t._v("#")]),t._v(" beforeCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1365",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1365"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1356",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1356"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefit"}},[t._v("#")]),t._v(" beforeFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1368",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1368"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the layout process starts")]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforesetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforesetdimensions"}},[t._v("#")]),t._v(" beforeSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1353",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1353"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeticktolabelconversion"}},[t._v("#")]),t._v(" beforeTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1362",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1362"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildticks"}},[t._v("#")]),t._v(" buildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatelabelrotation"}},[t._v("#")]),t._v(" calculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1366"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1351",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1351"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"determinedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#determinedatalimits"}},[t._v("#")]),t._v(" determineDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("determineDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1357",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1357"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Draws the element")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:50"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawgrid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawgrid"}},[t._v("#")]),t._v(" drawGrid")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawGrid")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1285",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawlabels"}},[t._v("#")]),t._v(" drawLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawLabels")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1284",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1284"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawtitle"}},[t._v("#")]),t._v(" drawTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawTitle")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1283",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1283"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fit"}},[t._v("#")]),t._v(" fit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1369",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1369"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"generateticklabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#generateticklabels"}},[t._v("#")]),t._v(" generateTickLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("generateTickLabels")]),t._v("("),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasepixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasepixel"}},[t._v("#")]),t._v(" getBasePixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePixel")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the pixel for the minimum chart value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasevalue"}},[t._v("#")]),t._v(" getBaseValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBaseValue")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1335",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1335"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdecimalforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdecimalforpixel"}},[t._v("#")]),t._v(" getDecimalForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDecimalForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1291",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelforvalue"}},[t._v("#")]),t._v(" getLabelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Used to get the label to display in the tooltip for the given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1311",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1311"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelitems"}},[t._v("#")]),t._v(" getLabelItems")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelItems")]),t._v("("),e("code",[t._v("chartArea?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1349",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1349"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabels"}},[t._v("#")]),t._v(" getLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabels")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1348",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1348"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlinewidthforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlinewidthforvalue"}},[t._v("#")]),t._v(" getLineWidthForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLineWidthForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the grid line width at given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1316",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1316"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmatchingvisiblemetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmatchingvisiblemetas"}},[t._v("#")]),t._v(" getMatchingVisibleMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMatchingVisibleMetas")]),t._v("("),e("code",[t._v("type?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("canStack")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpadding"}},[t._v("#")]),t._v(" getPadding")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getPadding")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Returns an object with padding on the edges")]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#getpadding"}},[t._v("getPadding")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfordecimal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfordecimal"}},[t._v("#")]),t._v(" getPixelForDecimal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForDecimal")]),t._v("("),e("code",[t._v("decimal")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Utility for getting the pixel location of a percentage of scale\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("decimal")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1298",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1298"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfortick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfortick"}},[t._v("#")]),t._v(" getPixelForTick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForTick")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the tick at the given index\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-37"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1305",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1305"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelforvalue"}},[t._v("#")]),t._v(" getPixelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForValue")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the given data point. Value can either be an index or a numerical value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-38"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1325",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1325"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("never")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-39"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-4"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-40"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getticks"}},[t._v("#")]),t._v(" getTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-41"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getuserbounds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getuserbounds"}},[t._v("#")]),t._v(" getUserBounds")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getUserBounds")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-42"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("maxDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1345",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1345"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvalueforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvalueforpixel"}},[t._v("#")]),t._v(" getValueForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Used to get the data value from a given pixel. This is the inverse of getPixelForValue\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-43"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1333",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-44"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"init"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#init"}},[t._v("#")]),t._v(" init")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("init")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-45"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isfullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isfullsize"}},[t._v("#")]),t._v(" isFullSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isFullSize")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-46"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1372",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1372"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ishorizontal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ishorizontal"}},[t._v("#")]),t._v(" isHorizontal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isHorizontal")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("returns true if the layout item is horizontal (ie. top or bottom)")]),t._v(" "),e("h4",{attrs:{id:"returns-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-47"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#ishorizontal"}},[t._v("isHorizontal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:58"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("raw")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("raw")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-48"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdimensions"}},[t._v("#")]),t._v(" setDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-49"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1354",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1354"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-50"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("width")]),t._v(", "),e("code",[t._v("height")]),t._v(", "),e("code",[t._v("margins?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Takes two parameters: width and height.")]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("margins?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-51"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#update"}},[t._v("update")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/layout.d.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:64"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{355:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"class-scale-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#class-scale-o"}},[t._v("#")]),t._v(" Class: Scale")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("O")]),t._v(">")])]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[e("code",[t._v("LayoutItem")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("Scale")])])]),t._v(" "),e("p",[t._v("↳↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/TimeScale.html"}},[e("code",[t._v("TimeScale")])])],1),t._v(" "),e("p",[t._v("↳↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/RadialLinearScale.html"}},[e("code",[t._v("RadialLinearScale")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"constructors"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructors"}},[t._v("#")]),t._v(" Constructors")]),t._v(" "),e("h3",{attrs:{id:"constructor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#constructor"}},[t._v("#")]),t._v(" constructor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("new Scale")]),t._v("<"),e("code",[t._v("O")]),t._v(">("),e("code",[t._v("cfg")]),t._v(")")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/CoreScaleOptions.html"}},[e("code",[t._v("CoreScaleOptions")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("Object")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.chart")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.id")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("cfg.type")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.constructor")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1375",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1375"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("never")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/classes/Animation.html"}},[e("code",[t._v("Animation")])]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"axis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#axis"}},[t._v("#")]),t._v(" axis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("axis")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1276",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1276"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bottom"}},[t._v("#")]),t._v(" bottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("bottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Bottom edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#bottom"}},[t._v("bottom")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L41",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:41"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1266",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1266"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ctx"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ctx"}},[t._v("#")]),t._v(" ctx")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("ctx")]),t._v(": "),e("code",[t._v("CanvasRenderingContext2D")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1265",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1265"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fullsize"}},[t._v("#")]),t._v(" fullSize")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("fullSize")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("if true, and the item is horizontal, then push vertical boxes down")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#fullsize"}},[t._v("fullSize")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#height"}},[t._v("height")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L25",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:25"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"id"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#id"}},[t._v("#")]),t._v(" id")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("id")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1263",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1263"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"labelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#labelrotation"}},[t._v("#")]),t._v(" labelRotation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("labelRotation")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1277",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1277"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#left"}},[t._v("left")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L29",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:29"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"max"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#max"}},[t._v("#")]),t._v(" max")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("max")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1279",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1279"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxheight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxheight"}},[t._v("#")]),t._v(" maxHeight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxHeight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1269",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1269"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxwidth"}},[t._v("#")]),t._v(" maxWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxWidth")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1268",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1268"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"min"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#min"}},[t._v("#")]),t._v(" min")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("min")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1278",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1278"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingbottom"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingbottom"}},[t._v("#")]),t._v(" paddingBottom")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingBottom")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1272",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1272"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingleft"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingleft"}},[t._v("#")]),t._v(" paddingLeft")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingLeft")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1273",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1273"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingright"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingright"}},[t._v("#")]),t._v(" paddingRight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingRight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1274",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1274"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"paddingtop"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paddingtop"}},[t._v("#")]),t._v(" paddingTop")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("paddingTop")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1271",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1271"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"position"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" position")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("position")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#layoutposition"}},[e("code",[t._v("LayoutPosition")])])],1),t._v(" "),e("p",[t._v("The position of the item in the chart layout. Possible values are")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#position"}},[t._v("position")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L9",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:9"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"right"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#right"}},[t._v("#")]),t._v(" right")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("right")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Right edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#right"}},[t._v("right")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L37",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:37"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ticks"}},[t._v("#")]),t._v(" ticks")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("ticks")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1280",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1280"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top edge of the item. Set by layout system and cannot be used in update")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#top"}},[t._v("top")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L33",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:33"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"type"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type"}},[t._v("#")]),t._v(" type")]),t._v(" "),e("p",[t._v("• "),e("code",[t._v("Readonly")]),t._v(" "),e("strong",[t._v("type")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1264",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1264"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"weight"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#weight"}},[t._v("#")]),t._v(" weight")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("weight")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The weight used to sort the item. Higher weights are further away from the chart area")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#weight"}},[t._v("weight")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of item. Must be valid after update()")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#width"}},[t._v("width")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L21",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:21"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"afterbuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterbuildticks"}},[t._v("#")]),t._v(" afterBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-31"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1361",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1361"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftercalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftercalculatelabelrotation"}},[t._v("#")]),t._v(" afterCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-32"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1367",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1367"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterdatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterdatalimits"}},[t._v("#")]),t._v(" afterDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-33"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1358",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1358"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterfit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterfit"}},[t._v("#")]),t._v(" afterFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-34"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1370",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1370"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"aftersetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#aftersetdimensions"}},[t._v("#")]),t._v(" afterSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-35"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1355",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1355"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterticktolabelconversion"}},[t._v("#")]),t._v(" afterTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-36"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1364",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1364"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"afterupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#afterupdate"}},[t._v("#")]),t._v(" afterUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("afterUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-37"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1352",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1352"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforebuildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforebuildticks"}},[t._v("#")]),t._v(" beforeBuildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeBuildTicks")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-38"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1359",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1359"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforecalculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforecalculatelabelrotation"}},[t._v("#")]),t._v(" beforeCalculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeCalculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-39"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1365",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1365"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforedatalimits"}},[t._v("#")]),t._v(" beforeDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-40"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1356",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1356"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforefit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforefit"}},[t._v("#")]),t._v(" beforeFit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeFit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-11"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-41"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1368",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1368"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforelayout"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforelayout"}},[t._v("#")]),t._v(" beforeLayout")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("beforeLayout")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Called before the layout process starts")]),t._v(" "),e("h4",{attrs:{id:"returns-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-12"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#beforelayout"}},[t._v("beforeLayout")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-42"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L46",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:46"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforesetdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforesetdimensions"}},[t._v("#")]),t._v(" beforeSetDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeSetDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-13"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-43"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1353",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1353"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeticktolabelconversion"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeticktolabelconversion"}},[t._v("#")]),t._v(" beforeTickToLabelConversion")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeTickToLabelConversion")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-14"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-44"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1362",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1362"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"beforeupdate"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#beforeupdate"}},[t._v("#")]),t._v(" beforeUpdate")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("beforeUpdate")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-15"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-45"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1350",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1350"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"buildticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#buildticks"}},[t._v("#")]),t._v(" buildTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("buildTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-16"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-46"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1360",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1360"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"calculatelabelrotation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#calculatelabelrotation"}},[t._v("#")]),t._v(" calculateLabelRotation")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("calculateLabelRotation")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-17"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-47"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1366",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1366"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"configure"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#configure"}},[t._v("#")]),t._v(" configure")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("configure")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-18"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-48"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1351",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1351"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"determinedatalimits"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#determinedatalimits"}},[t._v("#")]),t._v(" determineDataLimits")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("determineDataLimits")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-19"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-49"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1357",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1357"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Draws the element")]),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-20"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-50"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L50",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:50"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawgrid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawgrid"}},[t._v("#")]),t._v(" drawGrid")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawGrid")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-21"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-51"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1285",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1285"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawlabels"}},[t._v("#")]),t._v(" drawLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawLabels")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-22"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-52"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-52"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1284",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1284"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"drawtitle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#drawtitle"}},[t._v("#")]),t._v(" drawTitle")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("drawTitle")]),t._v("("),e("code",[t._v("chartArea")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-23"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-53"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-53"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1283",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1283"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"fit"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#fit"}},[t._v("#")]),t._v(" fit")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("fit")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-24"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-54"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-54"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1369",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1369"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"generateticklabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#generateticklabels"}},[t._v("#")]),t._v(" generateTickLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("generateTickLabels")]),t._v("("),e("code",[t._v("ticks")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ticks")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-25"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-55"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-55"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1363",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1363"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasepixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasepixel"}},[t._v("#")]),t._v(" getBasePixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBasePixel")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the pixel for the minimum chart value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"returns-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-26"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-56"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-56"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1341",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1341"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getbasevalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getbasevalue"}},[t._v("#")]),t._v(" getBaseValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getBaseValue")]),t._v("(): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"returns-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-27"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-57"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-57"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1335",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1335"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getdecimalforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getdecimalforpixel"}},[t._v("#")]),t._v(" getDecimalForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getDecimalForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-28"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-58"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-58"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1291",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1291"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelforvalue"}},[t._v("#")]),t._v(" getLabelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("Used to get the label to display in the tooltip for the given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-29"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-59"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-59"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1311",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1311"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabelitems"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabelitems"}},[t._v("#")]),t._v(" getLabelItems")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabelItems")]),t._v("("),e("code",[t._v("chartArea?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("chartArea?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-30"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LabelItem.html"}},[e("code",[t._v("LabelItem")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-60"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-60"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1349",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1349"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlabels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlabels"}},[t._v("#")]),t._v(" getLabels")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLabels")]),t._v("(): "),e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"returns-31"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-31"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("string")]),t._v("[]")]),t._v(" "),e("h4",{attrs:{id:"defined-in-61"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-61"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1348",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1348"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getlinewidthforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getlinewidthforvalue"}},[t._v("#")]),t._v(" getLineWidthForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getLineWidthForValue")]),t._v("("),e("code",[t._v("value")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the grid line width at given value")]),t._v(" "),e("h4",{attrs:{id:"parameters-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-10"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-32"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-32"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-62"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-62"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1316",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1316"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getmatchingvisiblemetas"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getmatchingvisiblemetas"}},[t._v("#")]),t._v(" getMatchingVisibleMetas")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMatchingVisibleMetas")]),t._v("("),e("code",[t._v("type?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"parameters-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-11"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("type?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-33"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-33"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/#chartmeta"}},[e("code",[t._v("ChartMeta")])]),t._v(", "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">>[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-63"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-63"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1281",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1281"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getminmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getminmax"}},[t._v("#")]),t._v(" getMinMax")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getMinMax")]),t._v("("),e("code",[t._v("canStack")]),t._v("): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"parameters-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-12"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("canStack")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-34"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-34"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-64"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-64"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1346",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1346"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpadding"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpadding"}},[t._v("#")]),t._v(" getPadding")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getPadding")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("Returns an object with padding on the edges")]),t._v(" "),e("h4",{attrs:{id:"returns-35"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-35"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#getpadding"}},[t._v("getPadding")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-65"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-65"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfordecimal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfordecimal"}},[t._v("#")]),t._v(" getPixelForDecimal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForDecimal")]),t._v("("),e("code",[t._v("decimal")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Utility for getting the pixel location of a percentage of scale\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-13"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("decimal")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-36"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-36"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-66"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-66"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1298",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1298"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelfortick"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelfortick"}},[t._v("#")]),t._v(" getPixelForTick")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForTick")]),t._v("("),e("code",[t._v("index")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the tick at the given index\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-14"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-37"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-37"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-67"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-67"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1305",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1305"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getpixelforvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getpixelforvalue"}},[t._v("#")]),t._v(" getPixelForValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getPixelForValue")]),t._v("("),e("code",[t._v("value")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Returns the location of the given data point. Value can either be an index or a numerical value\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-15"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("value")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-38"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-38"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-68"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-68"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1325",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1325"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("never")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-16"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-39"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-39"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("unknown")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-69"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-69"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-4"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-17"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-40"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-40"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-70"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-70"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getticks"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getticks"}},[t._v("#")]),t._v(" getTicks")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getTicks")]),t._v("(): "),e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"returns-41"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-41"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Tick.html"}},[e("code",[t._v("Tick")])]),t._v("[]")],1),t._v(" "),e("h4",{attrs:{id:"defined-in-71"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-71"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1347",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1347"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getuserbounds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getuserbounds"}},[t._v("#")]),t._v(" getUserBounds")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getUserBounds")]),t._v("(): "),e("code",[t._v("Object")])]),t._v(" "),e("h4",{attrs:{id:"returns-42"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-42"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Object")])]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("max")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("maxDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("min")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("minDefined")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"defined-in-72"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-72"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1345",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1345"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getvalueforpixel"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getvalueforpixel"}},[t._v("#")]),t._v(" getValueForPixel")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getValueForPixel")]),t._v("("),e("code",[t._v("pixel")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Used to get the data value from a given pixel. This is the inverse of getPixelForValue\nThe coordinate (0, 0) is at the upper-left corner of the canvas")]),t._v(" "),e("h4",{attrs:{id:"parameters-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-18"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("pixel")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-43"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-43"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-73"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-73"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1333",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1333"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-44"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-44"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-74"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-74"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"init"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#init"}},[t._v("#")]),t._v(" init")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("init")]),t._v("("),e("code",[t._v("options")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-19"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("options")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-45"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-45"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-75"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-75"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1343",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1343"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"isfullsize"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#isfullsize"}},[t._v("#")]),t._v(" isFullSize")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isFullSize")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-46"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-46"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-76"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-76"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1372",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1372"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"ishorizontal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ishorizontal"}},[t._v("#")]),t._v(" isHorizontal")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("isHorizontal")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("returns true if the layout item is horizontal (ie. top or bottom)")]),t._v(" "),e("h4",{attrs:{id:"returns-47"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-47"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-22"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#ishorizontal"}},[t._v("isHorizontal")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-77"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-77"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L58",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:58"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parse"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parse"}},[t._v("#")]),t._v(" parse")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("parse")]),t._v("("),e("code",[t._v("raw")]),t._v(", "),e("code",[t._v("index?")]),t._v("): "),e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"parameters-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-20"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("raw")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("unknown")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("index?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-48"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-48"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("unknown")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-78"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-78"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1344",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1344"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"setdimensions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#setdimensions"}},[t._v("#")]),t._v(" setDimensions")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("setDimensions")]),t._v("(): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"returns-49"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-49"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-79"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-79"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1354",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1354"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-21"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-50"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-50"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-23"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-80"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-80"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"update"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#update"}},[t._v("#")]),t._v(" update")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("update")]),t._v("("),e("code",[t._v("width")]),t._v(", "),e("code",[t._v("height")]),t._v(", "),e("code",[t._v("margins?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("p",[t._v("Takes two parameters: width and height.")]),t._v(" "),e("h4",{attrs:{id:"parameters-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-22"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("width")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("height")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("margins?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns-51"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-51"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-24"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html"}},[t._v("LayoutItem")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/LayoutItem.html#update"}},[t._v("update")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-81"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-81"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/layout.d.ts#L64",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/layout.d.ts:64"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/230.958000c5.js b/docs/master/assets/js/230.5030c0bd.js similarity index 97% rename from docs/master/assets/js/230.958000c5.js rename to docs/master/assets/js/230.5030c0bd.js index efc7c0532e..84e9ce0aef 100644 --- a/docs/master/assets/js/230.958000c5.js +++ b/docs/master/assets/js/230.5030c0bd.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[230],{567:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"polar-area"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#polar-area"}},[this._v("#")]),this._v(" Polar area")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = ['Red', 'Orange', 'Yellow', 'Green', 'Blue'];\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: [\n Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.yellow, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n ]\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Polar Area Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/polar.html"}},[this._v("Polar Area Chart")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[230],{565:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"polar-area"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#polar-area"}},[this._v("#")]),this._v(" Polar area")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels.push('data #' + (data.labels.length + 1));\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 5;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = ['Red', 'Orange', 'Yellow', 'Green', 'Blue'];\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n backgroundColor: [\n Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.yellow, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n ]\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Polar Area Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/polar.html"}},[this._v("Polar Area Chart")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/231.b66e70f4.js b/docs/master/assets/js/231.3e60eb73.js similarity index 97% rename from docs/master/assets/js/231.b66e70f4.js rename to docs/master/assets/js/231.3e60eb73.js index 140e5ab003..04d235b210 100644 --- a/docs/master/assets/js/231.b66e70f4.js +++ b/docs/master/assets/js/231.3e60eb73.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[231],{563:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"radar-skip-points"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#radar-skip-points"}},[t._v("#")]),t._v(" Radar skip points")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach((dataset, i) => {\n const data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n\n if (i === 0) {\n data[0] = null;\n } else if (i === 1) {\n data[Number.parseInt(data.length / 2, 10)] = null;\n } else {\n data[data.length - 1] = null;\n }\n\n dataset.data = data;\n });\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst dataFirstSkip = Utils.numbers(NUMBER_CFG);\nconst dataMiddleSkip = Utils.numbers(NUMBER_CFG);\nconst dataLastSkip = Utils.numbers(NUMBER_CFG);\n\ndataFirstSkip[0] = null;\ndataMiddleSkip[Number.parseInt(dataMiddleSkip.length / 2, 10)] = null;\ndataLastSkip[dataLastSkip.length - 1] = null;\n\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Skip first dataset',\n data: dataFirstSkip,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Skip mid dataset',\n data: dataMiddleSkip,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n {\n label: 'Skip last dataset',\n data: dataLastSkip,\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Radar Skip Points Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/radar.html"}},[t._v("Radar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[231],{567:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"radar-skip-points"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#radar-skip-points"}},[t._v("#")]),t._v(" Radar skip points")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach((dataset, i) => {\n const data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n\n if (i === 0) {\n data[0] = null;\n } else if (i === 1) {\n data[Number.parseInt(data.length / 2, 10)] = null;\n } else {\n data[data.length - 1] = null;\n }\n\n dataset.data = data;\n });\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst dataFirstSkip = Utils.numbers(NUMBER_CFG);\nconst dataMiddleSkip = Utils.numbers(NUMBER_CFG);\nconst dataLastSkip = Utils.numbers(NUMBER_CFG);\n\ndataFirstSkip[0] = null;\ndataMiddleSkip[Number.parseInt(dataMiddleSkip.length / 2, 10)] = null;\ndataLastSkip[dataLastSkip.length - 1] = null;\n\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Skip first dataset',\n data: dataFirstSkip,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Skip mid dataset',\n data: dataMiddleSkip,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n {\n label: 'Skip last dataset',\n data: dataLastSkip,\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Radar Skip Points Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/radar.html"}},[t._v("Radar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/232.8c9580ef.js b/docs/master/assets/js/232.e7b32a9a.js similarity index 98% rename from docs/master/assets/js/232.8c9580ef.js rename to docs/master/assets/js/232.e7b32a9a.js index 80cb0a8abc..54ff739ec3 100644 --- a/docs/master/assets/js/232.8c9580ef.js +++ b/docs/master/assets/js/232.e7b32a9a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[232],{565:function(a,t,n){"use strict";n.r(t);var s=n(3),e=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"radar"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#radar"}},[a._v("#")]),a._v(" Radar")]),a._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Radar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[a._v("#")]),a._v(" Docs")]),a._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/radar.html"}},[a._v("Radar")])],1),a._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[a._v("Data structures ("),t("code",[a._v("labels")]),a._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[232],{568:function(a,t,n){"use strict";n.r(t);var s=n(3),e=Object(s.a)({},(function(){var a=this,t=a._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[t("h1",{attrs:{id:"radar"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#radar"}},[a._v("#")]),a._v(" Radar")]),a._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'radar',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Radar Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[a._v("#")]),a._v(" Docs")]),a._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/radar.html"}},[a._v("Radar")])],1),a._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[a._v("Data structures ("),t("code",[a._v("labels")]),a._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/234.72689698.js b/docs/master/assets/js/234.b19f2400.js similarity index 97% rename from docs/master/assets/js/234.72689698.js rename to docs/master/assets/js/234.b19f2400.js index 9b3855dfb4..3b6c3feb47 100644 --- a/docs/master/assets/js/234.72689698.js +++ b/docs/master/assets/js/234.b19f2400.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[234],{568:function(t,a,n){"use strict";n.r(a);var s=n(3),e=Object(s.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"scatter"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#scatter"}},[this._v("#")]),this._v(" Scatter")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, rmin: 1, rmax: 1, min: 0, max: 100};\n\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n }\n ]\n};\n// \n\n// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.bubbles({count: DATA_COUNT, rmin: 1, rmax: 1, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const chartData = chart.data;\n const dsColor = Utils.namedColor(chartData.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (chartData.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.bubbles({count: DATA_COUNT, rmin: 1, rmax: 1, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const chartData = chart.data;\n if (chartData.datasets.length > 0) {\n\n for (let index = 0; index < chartData.datasets.length; ++index) {\n chartData.datasets[index].data.push(Utils.bubbles({count: 1, rmin: 1, rmax: 1, min: 0, max: 100})[0]);\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'scatter',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Scatter Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/scatter.html"}},[this._v("Scatter")])],1)])],1)}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[234],{570:function(t,a,n){"use strict";n.r(a);var s=n(3),e=Object(s.a)({},(function(){var t=this._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":this.$parent.slotKey}},[t("h1",{attrs:{id:"scatter"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#scatter"}},[this._v("#")]),this._v(" Scatter")]),this._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, rmin: 1, rmax: 1, min: 0, max: 100};\n\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.bubbles(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.orange,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.orange, 0.5),\n }\n ]\n};\n// \n\n// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.bubbles({count: DATA_COUNT, rmin: 1, rmax: 1, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const chartData = chart.data;\n const dsColor = Utils.namedColor(chartData.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (chartData.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n data: Utils.bubbles({count: DATA_COUNT, rmin: 1, rmax: 1, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const chartData = chart.data;\n if (chartData.datasets.length > 0) {\n\n for (let index = 0; index < chartData.datasets.length; ++index) {\n chartData.datasets[index].data.push(Utils.bubbles({count: 1, rmin: 1, rmax: 1, min: 0, max: 100})[0]);\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst config = {\n type: 'scatter',\n data: data,\n options: {\n responsive: true,\n plugins: {\n legend: {\n position: 'top',\n },\n title: {\n display: true,\n text: 'Chart.js Scatter Chart'\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[this._v("#")]),this._v(" Docs")]),this._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/scatter.html"}},[this._v("Scatter")])],1)])],1)}),[],!1,null,null,null);a.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/235.83069c16.js b/docs/master/assets/js/235.083f4e7f.js similarity index 98% rename from docs/master/assets/js/235.83069c16.js rename to docs/master/assets/js/235.083f4e7f.js index 58103f1232..af18aff840 100644 --- a/docs/master/assets/js/235.83069c16.js +++ b/docs/master/assets/js/235.083f4e7f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[235],{570:function(t,a,n){"use strict";n.r(a);var e=n(3),s=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"stacked-bar-line"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#stacked-bar-line"}},[t._v("#")]),t._v(" Stacked bar/line")]),t._v(" "),a("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n borderWidth: 1,\n stack: 'combined',\n data: Utils.numbers({count: data.labels.length, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n stack: 'combined',\n type: 'bar'\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n stack: 'combined'\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Stacked Line/Bar Chart'\n }\n },\n scales: {\n y: {\n stacked: true\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),a("h2",{attrs:{id:"docs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes ("),a("code",[t._v("stacked")]),t._v(")")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("Stacking")])],1)])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),a("code",[t._v("labels")]),t._v(")")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[t._v("Dataset Configuration ("),a("code",[t._v("stack")]),t._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[235],{571:function(t,a,n){"use strict";n.r(a);var e=n(3),s=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"stacked-bar-line"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#stacked-bar-line"}},[t._v("#")]),t._v(" Stacked bar/line")]),t._v(" "),a("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: Utils.transparentize(dsColor, 0.5),\n borderColor: dsColor,\n borderWidth: 1,\n stack: 'combined',\n data: Utils.numbers({count: data.labels.length, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n stack: 'combined',\n type: 'bar'\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n stack: 'combined'\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Stacked Line/Bar Chart'\n }\n },\n scales: {\n y: {\n stacked: true\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),a("h2",{attrs:{id:"docs"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes ("),a("code",[t._v("stacked")]),t._v(")")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("Stacking")])],1)])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),a("code",[t._v("labels")]),t._v(")")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[t._v("Dataset Configuration ("),a("code",[t._v("stack")]),t._v(")")])],1)])],1)])],1)}),[],!1,null,null,null);a.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/236.73ace086.js b/docs/master/assets/js/236.74dffa07.js similarity index 97% rename from docs/master/assets/js/236.73ace086.js rename to docs/master/assets/js/236.74dffa07.js index 8a9cc897bb..3c310419b0 100644 --- a/docs/master/assets/js/236.73ace086.js +++ b/docs/master/assets/js/236.74dffa07.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[236],{571:function(t,n,r){"use strict";r.r(n);var e=r(3),o=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"chart-area-border"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#chart-area-border"}},[t._v("#")]),t._v(" Chart Area Border")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst chartAreaBorder = {\n id: 'chartAreaBorder',\n beforeDraw(chart, args, options) {\n const {ctx, chartArea: {left, top, width, height}} = chart;\n ctx.save();\n ctx.strokeStyle = options.borderColor;\n ctx.lineWidth = options.borderWidth;\n ctx.setLineDash(options.borderDash || []);\n ctx.lineDashOffset = options.borderDashOffset;\n ctx.strokeRect(left, top, width, height);\n ctx.restore();\n }\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n chartAreaBorder: {\n borderColor: 'red',\n borderWidth: 2,\n borderDash: [5, 5],\n borderDashOffset: 2,\n }\n }\n },\n plugins: [chartAreaBorder]\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1)])],1)}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[236],{572:function(t,n,r){"use strict";r.r(n);var e=r(3),o=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"chart-area-border"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#chart-area-border"}},[t._v("#")]),t._v(" Chart Area Border")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst chartAreaBorder = {\n id: 'chartAreaBorder',\n beforeDraw(chart, args, options) {\n const {ctx, chartArea: {left, top, width, height}} = chart;\n ctx.save();\n ctx.strokeStyle = options.borderColor;\n ctx.lineWidth = options.borderWidth;\n ctx.setLineDash(options.borderDash || []);\n ctx.lineDashOffset = options.borderDashOffset;\n ctx.strokeRect(left, top, width, height);\n ctx.restore();\n }\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n chartAreaBorder: {\n borderColor: 'red',\n borderWidth: 2,\n borderDash: [5, 5],\n borderDashOffset: 2,\n }\n }\n },\n plugins: [chartAreaBorder]\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1)])],1)}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/237.eb665bd9.js b/docs/master/assets/js/237.7857eb25.js similarity index 97% rename from docs/master/assets/js/237.eb665bd9.js rename to docs/master/assets/js/237.7857eb25.js index 06a3c0005e..3474e3386a 100644 --- a/docs/master/assets/js/237.eb665bd9.js +++ b/docs/master/assets/js/237.7857eb25.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[237],{573:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"doughnut-empty-state"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#doughnut-empty-state"}},[t._v("#")]),t._v(" Doughnut Empty State")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [],\n datasets: [\n {\n label: 'Dataset 1',\n data: []\n }\n ]\n};\n// \n\n// \nconst plugin = {\n id: 'emptyDoughnut',\n afterDraw(chart, args, options) {\n const {datasets} = chart.data;\n const {color, width, radiusDecrease} = options;\n let hasData = false;\n\n for (let i = 0; i < datasets.length; i += 1) {\n const dataset = datasets[i];\n hasData |= dataset.data.length > 0;\n }\n\n if (!hasData) {\n const {chartArea: {left, top, right, bottom}, ctx} = chart;\n const centerX = (left + right) / 2;\n const centerY = (top + bottom) / 2;\n const r = Math.min(right - left, bottom - top) / 2;\n\n ctx.beginPath();\n ctx.lineWidth = width || 2;\n ctx.strokeStyle = color || 'rgba(255, 128, 0, 0.5)';\n ctx.arc(centerX, centerY, (r - radiusDecrease || 0), 0, 2 * Math.PI);\n ctx.stroke();\n }\n }\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n options: {\n plugins: {\n emptyDoughnut: {\n color: 'rgba(255, 128, 0, 0.5)',\n width: 2,\n radiusDecrease: 20\n }\n }\n },\n plugins: [plugin]\n};\n// \n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.points(NUMBER_CFG);\n });\n chart.update();\n }\n },\n];\n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[t._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[237],{575:function(t,n,a){"use strict";a.r(n);var s=a(3),e=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"doughnut-empty-state"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#doughnut-empty-state"}},[t._v("#")]),t._v(" Doughnut Empty State")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst data = {\n labels: [],\n datasets: [\n {\n label: 'Dataset 1',\n data: []\n }\n ]\n};\n// \n\n// \nconst plugin = {\n id: 'emptyDoughnut',\n afterDraw(chart, args, options) {\n const {datasets} = chart.data;\n const {color, width, radiusDecrease} = options;\n let hasData = false;\n\n for (let i = 0; i < datasets.length; i += 1) {\n const dataset = datasets[i];\n hasData |= dataset.data.length > 0;\n }\n\n if (!hasData) {\n const {chartArea: {left, top, right, bottom}, ctx} = chart;\n const centerX = (left + right) / 2;\n const centerY = (top + bottom) / 2;\n const r = Math.min(right - left, bottom - top) / 2;\n\n ctx.beginPath();\n ctx.lineWidth = width || 2;\n ctx.strokeStyle = color || 'rgba(255, 128, 0, 0.5)';\n ctx.arc(centerX, centerY, (r - radiusDecrease || 0), 0, 2 * Math.PI);\n ctx.stroke();\n }\n }\n};\n// \n\n// \nconst config = {\n type: 'doughnut',\n data: data,\n options: {\n plugins: {\n emptyDoughnut: {\n color: 'rgba(255, 128, 0, 0.5)',\n width: 2,\n radiusDecrease: 20\n }\n }\n },\n plugins: [plugin]\n};\n// \n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.points(NUMBER_CFG);\n });\n chart.update();\n }\n },\n];\n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[t._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/238.a14e1453.js b/docs/master/assets/js/238.ca9b70dd.js similarity index 97% rename from docs/master/assets/js/238.a14e1453.js rename to docs/master/assets/js/238.ca9b70dd.js index 9e2158a1c4..7e59f17265 100644 --- a/docs/master/assets/js/238.a14e1453.js +++ b/docs/master/assets/js/238.ca9b70dd.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[238],{572:function(t,n,a){"use strict";a.r(n);var o=a(3),s=Object(o.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"quadrants"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#quadrants"}},[t._v("#")]),t._v(" Quadrants")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.points(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.points(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst quadrants = {\n id: 'quadrants',\n beforeDraw(chart, args, options) {\n const {ctx, chartArea: {left, top, right, bottom}, scales: {x, y}} = chart;\n const midX = x.getPixelForValue(0);\n const midY = y.getPixelForValue(0);\n ctx.save();\n ctx.fillStyle = options.topLeft;\n ctx.fillRect(left, top, midX - left, midY - top);\n ctx.fillStyle = options.topRight;\n ctx.fillRect(midX, top, right - midX, midY - top);\n ctx.fillStyle = options.bottomRight;\n ctx.fillRect(midX, midY, right - midX, bottom - midY);\n ctx.fillStyle = options.bottomLeft;\n ctx.fillRect(left, midY, midX - left, bottom - midY);\n ctx.restore();\n }\n};\n// \n\n// \nconst config = {\n type: 'scatter',\n data: data,\n options: {\n plugins: {\n quadrants: {\n topLeft: Utils.CHART_COLORS.red,\n topRight: Utils.CHART_COLORS.blue,\n bottomRight: Utils.CHART_COLORS.green,\n bottomLeft: Utils.CHART_COLORS.yellow,\n }\n }\n },\n plugins: [quadrants]\n};\n// \n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.points(NUMBER_CFG);\n });\n chart.update();\n }\n },\n];\n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/scatter.html"}},[t._v("Scatter")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[238],{574:function(t,n,a){"use strict";a.r(n);var o=a(3),s=Object(o.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"quadrants"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#quadrants"}},[t._v("#")]),t._v(" Quadrants")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.points(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.points(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst quadrants = {\n id: 'quadrants',\n beforeDraw(chart, args, options) {\n const {ctx, chartArea: {left, top, right, bottom}, scales: {x, y}} = chart;\n const midX = x.getPixelForValue(0);\n const midY = y.getPixelForValue(0);\n ctx.save();\n ctx.fillStyle = options.topLeft;\n ctx.fillRect(left, top, midX - left, midY - top);\n ctx.fillStyle = options.topRight;\n ctx.fillRect(midX, top, right - midX, midY - top);\n ctx.fillStyle = options.bottomRight;\n ctx.fillRect(midX, midY, right - midX, bottom - midY);\n ctx.fillStyle = options.bottomLeft;\n ctx.fillRect(left, midY, midX - left, bottom - midY);\n ctx.restore();\n }\n};\n// \n\n// \nconst config = {\n type: 'scatter',\n data: data,\n options: {\n plugins: {\n quadrants: {\n topLeft: Utils.CHART_COLORS.red,\n topRight: Utils.CHART_COLORS.blue,\n bottomRight: Utils.CHART_COLORS.green,\n bottomLeft: Utils.CHART_COLORS.yellow,\n }\n }\n },\n plugins: [quadrants]\n};\n// \n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.points(NUMBER_CFG);\n });\n chart.update();\n }\n },\n];\n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/developers/plugins.html"}},[t._v("Plugins")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/scatter.html"}},[t._v("Scatter")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/239.ce971201.js b/docs/master/assets/js/239.b83ac5be.js similarity index 97% rename from docs/master/assets/js/239.ce971201.js rename to docs/master/assets/js/239.b83ac5be.js index afdb18ee18..4318da577d 100644 --- a/docs/master/assets/js/239.ce971201.js +++ b/docs/master/assets/js/239.b83ac5be.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[239],{574:function(n,t,s){"use strict";s.r(t);var o=s(3),a=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"center-positioning"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#center-positioning"}},[n._v("#")]),n._v(" Center Positioning")]),n._v(" "),t("p",[n._v("This sample show how to place the axis in the center of the chart area, instead of at the edges.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Default Positions',\n handler(chart) {\n chart.options.scales.x.position = 'bottom';\n chart.options.scales.y.position = 'left';\n chart.update();\n }\n },\n {\n name: 'Position: center',\n handler(chart) {\n chart.options.scales.x.position = 'center';\n chart.options.scales.y.position = 'center';\n chart.update();\n }\n },\n {\n name: 'Position: Vertical: x=-60, Horizontal: y=30',\n handler(chart) {\n chart.options.scales.x.position = {y: 30};\n chart.options.scales.y.position = {x: -60};\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 6;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.points(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.points(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'scatter',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Axis Center Positioning'\n }\n },\n scales: {\n x: {\n min: -100,\n max: 100,\n },\n y: {\n min: -100,\n max: 100,\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/scatter.html"}},[n._v("Scatter")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/"}},[n._v("Cartesian Axes")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[n._v("Axis Position")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[239],{573:function(n,t,s){"use strict";s.r(t);var o=s(3),a=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"center-positioning"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#center-positioning"}},[n._v("#")]),n._v(" Center Positioning")]),n._v(" "),t("p",[n._v("This sample show how to place the axis in the center of the chart area, instead of at the edges.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Default Positions',\n handler(chart) {\n chart.options.scales.x.position = 'bottom';\n chart.options.scales.y.position = 'left';\n chart.update();\n }\n },\n {\n name: 'Position: center',\n handler(chart) {\n chart.options.scales.x.position = 'center';\n chart.options.scales.y.position = 'center';\n chart.update();\n }\n },\n {\n name: 'Position: Vertical: x=-60, Horizontal: y=30',\n handler(chart) {\n chart.options.scales.x.position = {y: 30};\n chart.options.scales.y.position = {x: -60};\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 6;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.points(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.points(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'scatter',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Axis Center Positioning'\n }\n },\n scales: {\n x: {\n min: -100,\n max: 100,\n },\n y: {\n min: -100,\n max: 100,\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/scatter.html"}},[n._v("Scatter")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/"}},[n._v("Cartesian Axes")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/#axis-position"}},[n._v("Axis Position")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/24.e88c69ec.js b/docs/master/assets/js/24.1efc6fbe.js similarity index 89% rename from docs/master/assets/js/24.e88c69ec.js rename to docs/master/assets/js/24.1efc6fbe.js index ba14805295..ce4d232ce2 100644 --- a/docs/master/assets/js/24.e88c69ec.js +++ b/docs/master/assets/js/24.1efc6fbe.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{357:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"enumeration-decimationalgorithm"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-decimationalgorithm"}},[t._v("#")]),t._v(" Enumeration: DecimationAlgorithm")]),t._v(" "),e("h2",{attrs:{id:"enumeration-members"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members"}},[t._v("#")]),t._v(" Enumeration Members")]),t._v(" "),e("h3",{attrs:{id:"lttb"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lttb"}},[t._v("#")]),t._v(" lttb")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("lttb")]),t._v(" = "),e("code",[t._v('"lttb"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2203",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2203"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"minmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#minmax"}},[t._v("#")]),t._v(" minmax")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("minmax")]),t._v(" = "),e("code",[t._v('"min-max"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2204",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2204"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{356:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"enumeration-decimationalgorithm"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-decimationalgorithm"}},[t._v("#")]),t._v(" Enumeration: DecimationAlgorithm")]),t._v(" "),e("h2",{attrs:{id:"enumeration-members"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members"}},[t._v("#")]),t._v(" Enumeration Members")]),t._v(" "),e("h3",{attrs:{id:"lttb"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lttb"}},[t._v("#")]),t._v(" lttb")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("lttb")]),t._v(" = "),e("code",[t._v('"lttb"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2203",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2203"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"minmax"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#minmax"}},[t._v("#")]),t._v(" minmax")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("minmax")]),t._v(" = "),e("code",[t._v('"min-max"')])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2204",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2204"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/240.c0aa2f4c.js b/docs/master/assets/js/240.ba13e9f7.js similarity index 98% rename from docs/master/assets/js/240.c0aa2f4c.js rename to docs/master/assets/js/240.ba13e9f7.js index e32779cff6..baccf6ed31 100644 --- a/docs/master/assets/js/240.c0aa2f4c.js +++ b/docs/master/assets/js/240.ba13e9f7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[240],{575:function(n,t,e){"use strict";e.r(t);var a=e(3),i=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"grid-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#grid-configuration"}},[n._v("#")]),n._v(" Grid Configuration")]),n._v(" "),t("p",[n._v("This sample shows how to use scriptable grid options for an axis to control styling. In this case, the Y axis grid lines are colored based on their value. In addition, booleans are provided to toggle different parts of the X axis grid visibility.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: [10, 30, 39, 20, 25, 34, -10],\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: [18, 33, 22, 19, 11, -39, 30],\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \n// Change these settings to change the display for different parts of the X axis\n// grid configuration\nconst DISPLAY = true;\nconst BORDER = true;\nconst CHART_AREA = true;\nconst TICKS = true;\n\nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Grid Line Settings'\n }\n },\n scales: {\n x: {\n border: {\n display: BORDER\n },\n grid: {\n display: DISPLAY,\n drawOnChartArea: CHART_AREA,\n drawTicks: TICKS,\n }\n },\n y: {\n border: {\n display: false\n },\n grid: {\n color: function(context) {\n if (context.tick.value > 0) {\n return Utils.CHART_COLORS.green;\n } else if (context.tick.value < 0) {\n return Utils.CHART_COLORS.red;\n }\n\n return '#000000';\n },\n },\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#tick"}},[n._v("Tick Context")])],1)])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html"}},[n._v("Axes Styling")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[n._v("Grid Line Configuration")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[240],{576:function(n,t,e){"use strict";e.r(t);var a=e(3),i=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"grid-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#grid-configuration"}},[n._v("#")]),n._v(" Grid Configuration")]),n._v(" "),t("p",[n._v("This sample shows how to use scriptable grid options for an axis to control styling. In this case, the Y axis grid lines are colored based on their value. In addition, booleans are provided to toggle different parts of the X axis grid visibility.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: -100, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: [10, 30, 39, 20, 25, 34, -10],\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: [18, 33, 22, 19, 11, -39, 30],\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \n// Change these settings to change the display for different parts of the X axis\n// grid configuration\nconst DISPLAY = true;\nconst BORDER = true;\nconst CHART_AREA = true;\nconst TICKS = true;\n\nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Grid Line Settings'\n }\n },\n scales: {\n x: {\n border: {\n display: BORDER\n },\n grid: {\n display: DISPLAY,\n drawOnChartArea: CHART_AREA,\n drawTicks: TICKS,\n }\n },\n y: {\n border: {\n display: false\n },\n grid: {\n color: function(context) {\n if (context.tick.value > 0) {\n return Utils.CHART_COLORS.green;\n } else if (context.tick.value < 0) {\n return Utils.CHART_COLORS.red;\n }\n\n return '#000000';\n },\n },\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#tick"}},[n._v("Tick Context")])],1)])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html"}},[n._v("Axes Styling")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html#grid-line-configuration"}},[n._v("Grid Line Configuration")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/241.a5775b49.js b/docs/master/assets/js/241.83071afa.js similarity index 98% rename from docs/master/assets/js/241.a5775b49.js rename to docs/master/assets/js/241.83071afa.js index 197fd89493..4af629e0b3 100644 --- a/docs/master/assets/js/241.a5775b49.js +++ b/docs/master/assets/js/241.83071afa.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[241],{577:function(n,t,e){"use strict";e.r(t);var a=e(3),i=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"tick-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[n._v("#")]),n._v(" Tick Configuration")]),n._v(" "),t("p",[n._v("This sample shows how to use different tick features to control how tick labels are shown on the X axis. These features include:")]),n._v(" "),t("ul",[t("li",[n._v("Multi-line labels")]),n._v(" "),t("li",[n._v("Filtering labels")]),n._v(" "),t("li",[n._v("Changing the tick color")]),n._v(" "),t("li",[n._v("Changing the tick alignment for the X axis")])]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Alignment: start',\n handler(chart) {\n chart.options.scales.x.ticks.align = 'start';\n chart.update();\n }\n },\n {\n name: 'Alignment: center (default)',\n handler(chart) {\n chart.options.scales.x.ticks.align = 'center';\n chart.update();\n }\n },\n {\n name: 'Alignment: end',\n handler(chart) {\n chart.options.scales.x.ticks.align = 'end';\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 12;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\nconst data = {\n labels: [['June', '2015'], 'July', 'August', 'September', 'October', 'November', 'December', ['January', '2016'], 'February', 'March', 'April', 'May'],\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart with Tick Configuration'\n }\n },\n scales: {\n x: {\n ticks: {\n // For a category axis, the val is the index so the lookup via getLabelForValue is needed\n callback: function(val, index) {\n // Hide every 2nd tick label\n return index % 2 === 0 ? this.getLabelForValue(val) : '';\n },\n color: 'red',\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#tick"}},[n._v("Tick Context")])],1)])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html"}},[n._v("Axes Styling")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html#tick-configuration"}},[n._v("Tick Configuration")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[241],{579:function(n,t,e){"use strict";e.r(t);var a=e(3),i=Object(a.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"tick-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tick-configuration"}},[n._v("#")]),n._v(" Tick Configuration")]),n._v(" "),t("p",[n._v("This sample shows how to use different tick features to control how tick labels are shown on the X axis. These features include:")]),n._v(" "),t("ul",[t("li",[n._v("Multi-line labels")]),n._v(" "),t("li",[n._v("Filtering labels")]),n._v(" "),t("li",[n._v("Changing the tick color")]),n._v(" "),t("li",[n._v("Changing the tick alignment for the X axis")])]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Alignment: start',\n handler(chart) {\n chart.options.scales.x.ticks.align = 'start';\n chart.update();\n }\n },\n {\n name: 'Alignment: center (default)',\n handler(chart) {\n chart.options.scales.x.ticks.align = 'center';\n chart.update();\n }\n },\n {\n name: 'Alignment: end',\n handler(chart) {\n chart.options.scales.x.ticks.align = 'end';\n chart.update();\n }\n },\n];\n// \n\n\n// \nconst DATA_COUNT = 12;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\nconst data = {\n labels: [['June', '2015'], 'July', 'August', 'September', 'October', 'November', 'December', ['January', '2016'], 'February', 'March', 'April', 'May'],\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart with Tick Configuration'\n }\n },\n scales: {\n x: {\n ticks: {\n // For a category axis, the val is the index so the lookup via getLabelForValue is needed\n callback: function(val, index) {\n // Hide every 2nd tick label\n return index % 2 === 0 ? this.getLabelForValue(val) : '';\n },\n color: 'red',\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#tick"}},[n._v("Tick Context")])],1)])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html"}},[n._v("Axes Styling")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/axes/styling.html#tick-configuration"}},[n._v("Tick Configuration")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/242.7cb3afd3.js b/docs/master/assets/js/242.fb5ae4f5.js similarity index 97% rename from docs/master/assets/js/242.7cb3afd3.js rename to docs/master/assets/js/242.fb5ae4f5.js index ef02e1a49b..32f8afe70d 100644 --- a/docs/master/assets/js/242.7cb3afd3.js +++ b/docs/master/assets/js/242.fb5ae4f5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[242],{582:function(t,n,e){"use strict";e.r(n);var a=e(3),o=Object(a.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"title-configuration"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#title-configuration"}},[t._v("#")]),t._v(" Title Configuration")]),t._v(" "),n("p",[t._v("This sample shows how to configure the title of an axis including alignment, font, and color.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n scales: {\n x: {\n display: true,\n title: {\n display: true,\n text: 'Month',\n color: '#911',\n font: {\n family: 'Comic Sans MS',\n size: 20,\n weight: 'bold',\n lineHeight: 1.2,\n },\n padding: {top: 20, left: 0, right: 0, bottom: 0}\n }\n },\n y: {\n display: true,\n title: {\n display: true,\n text: 'Value',\n color: '#191',\n font: {\n family: 'Times',\n size: 20,\n style: 'normal',\n lineHeight: 1.2\n },\n padding: {top: 30, left: 0, right: 0, bottom: 0}\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/styling.html"}},[t._v("Axes Styling")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/"}},[t._v("Cartesian Axes")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/#common-options-to-all-cartesian-axes"}},[t._v("Common options to all cartesian axes")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/labelling.html"}},[t._v("Labeling Axes")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("Scale Title Configuration")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[242],{577:function(t,n,e){"use strict";e.r(n);var a=e(3),o=Object(a.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"title-configuration"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#title-configuration"}},[t._v("#")]),t._v(" Title Configuration")]),t._v(" "),n("p",[t._v("This sample shows how to configure the title of an axis including alignment, font, and color.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n scales: {\n x: {\n display: true,\n title: {\n display: true,\n text: 'Month',\n color: '#911',\n font: {\n family: 'Comic Sans MS',\n size: 20,\n weight: 'bold',\n lineHeight: 1.2,\n },\n padding: {top: 20, left: 0, right: 0, bottom: 0}\n }\n },\n y: {\n display: true,\n title: {\n display: true,\n text: 'Value',\n color: '#191',\n font: {\n family: 'Times',\n size: 20,\n style: 'normal',\n lineHeight: 1.2\n },\n padding: {top: 30, left: 0, right: 0, bottom: 0}\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/styling.html"}},[t._v("Axes Styling")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/"}},[t._v("Cartesian Axes")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/#common-options-to-all-cartesian-axes"}},[t._v("Common options to all cartesian axes")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/labelling.html"}},[t._v("Labeling Axes")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/labelling.html#scale-title-configuration"}},[t._v("Scale Title Configuration")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/243.fe5393cc.js b/docs/master/assets/js/243.8cd4bbb6.js similarity index 97% rename from docs/master/assets/js/243.fe5393cc.js rename to docs/master/assets/js/243.8cd4bbb6.js index 3f0a50d08b..51d8a6bc16 100644 --- a/docs/master/assets/js/243.fe5393cc.js +++ b/docs/master/assets/js/243.8cd4bbb6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[243],{590:function(t,n,e){"use strict";e.r(n);var s=e(3),a=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"linear-scale-suggested-min-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#linear-scale-suggested-min-max"}},[t._v("#")]),t._v(" Linear Scale - Suggested Min-Max")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: [10, 30, 39, 20, 25, 34, -10],\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: [18, 33, 22, 19, 11, 39, 30],\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Suggested Min and Max Settings'\n }\n },\n scales: {\n y: {\n // the data minimum used for determining the ticks is Math.min(dataMin, suggestedMin)\n suggestedMin: 30,\n\n // the data maximum used for determining the ticks is Math.max(dataMax, suggestedMax)\n suggestedMax: 50,\n }\n }\n },\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("Axis Range Settings")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[243],{601:function(t,n,e){"use strict";e.r(n);var s=e(3),a=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"linear-scale-suggested-min-max"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#linear-scale-suggested-min-max"}},[t._v("#")]),t._v(" Linear Scale - Suggested Min-Max")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: [10, 30, 39, 20, 25, 34, -10],\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: [18, 33, 22, 19, 11, 39, 30],\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Suggested Min and Max Settings'\n }\n },\n scales: {\n y: {\n // the data minimum used for determining the ticks is Math.min(dataMin, suggestedMin)\n suggestedMin: 30,\n\n // the data maximum used for determining the ticks is Math.max(dataMax, suggestedMax)\n suggestedMax: 50,\n }\n }\n },\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/#axis-range-settings"}},[t._v("Axis Range Settings")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/245.d81efb50.js b/docs/master/assets/js/245.2b7e493c.js similarity index 98% rename from docs/master/assets/js/245.d81efb50.js rename to docs/master/assets/js/245.2b7e493c.js index 1235f366ff..8ba1f90b83 100644 --- a/docs/master/assets/js/245.d81efb50.js +++ b/docs/master/assets/js/245.2b7e493c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[245],{579:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"linear-scale-step-size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#linear-scale-step-size"}},[t._v("#")]),t._v(" Linear Scale - Step Size")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: dsColor,\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n tooltip: {\n mode: 'index',\n intersect: false\n },\n title: {\n display: true,\n text: 'Chart.js Line Chart'\n }\n },\n hover: {\n mode: 'index',\n intersec: false\n },\n scales: {\n x: {\n title: {\n display: true,\n text: 'Month'\n }\n },\n y: {\n title: {\n display: true,\n text: 'Value'\n },\n min: 0,\n max: 100,\n ticks: {\n // forces step size to be 50 units\n stepSize: 50\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes ("),n("code",[t._v("min")]),t._v(","),n("code",[t._v("max")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/linear.html"}},[t._v("Linear Axis")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/linear.html#linear-axis-specific-tick-options"}},[t._v("Linear Axis specific tick options ("),n("code",[t._v("stepSize")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/linear.html#step-size"}},[t._v("Step Size")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[245],{588:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"linear-scale-step-size"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#linear-scale-step-size"}},[t._v("#")]),t._v(" Linear Scale - Step Size")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n {\n name: 'Add Dataset',\n handler(chart) {\n const data = chart.data;\n const dsColor = Utils.namedColor(chart.data.datasets.length);\n const newDataset = {\n label: 'Dataset ' + (data.datasets.length + 1),\n backgroundColor: dsColor,\n borderColor: dsColor,\n data: Utils.numbers({count: data.labels.length, min: 0, max: 100}),\n };\n chart.data.datasets.push(newDataset);\n chart.update();\n }\n },\n {\n name: 'Add Data',\n handler(chart) {\n const data = chart.data;\n if (data.datasets.length > 0) {\n data.labels = Utils.months({count: data.labels.length + 1});\n\n for (let index = 0; index < data.datasets.length; ++index) {\n data.datasets[index].data.push(Utils.rand(0, 100));\n }\n\n chart.update();\n }\n }\n },\n {\n name: 'Remove Dataset',\n handler(chart) {\n chart.data.datasets.pop();\n chart.update();\n }\n },\n {\n name: 'Remove Data',\n handler(chart) {\n chart.data.labels.splice(-1, 1); // remove the label first\n\n chart.data.datasets.forEach(dataset => {\n dataset.data.pop();\n });\n\n chart.update();\n }\n }\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n tooltip: {\n mode: 'index',\n intersect: false\n },\n title: {\n display: true,\n text: 'Chart.js Line Chart'\n }\n },\n hover: {\n mode: 'index',\n intersec: false\n },\n scales: {\n x: {\n title: {\n display: true,\n text: 'Month'\n }\n },\n y: {\n title: {\n display: true,\n text: 'Value'\n },\n min: 0,\n max: 100,\n ticks: {\n // forces step size to be 50 units\n stepSize: 50\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#common-options-to-all-axes"}},[t._v("Common options to all axes ("),n("code",[t._v("min")]),t._v(","),n("code",[t._v("max")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/linear.html"}},[t._v("Linear Axis")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/linear.html#linear-axis-specific-tick-options"}},[t._v("Linear Axis specific tick options ("),n("code",[t._v("stepSize")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/linear.html#step-size"}},[t._v("Step Size")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/246.7c297e9d.js b/docs/master/assets/js/246.187d8ae4.js similarity index 97% rename from docs/master/assets/js/246.7c297e9d.js rename to docs/master/assets/js/246.187d8ae4.js index ef023d732a..252951e8cf 100644 --- a/docs/master/assets/js/246.7c297e9d.js +++ b/docs/master/assets/js/246.187d8ae4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[246],{581:function(n,t,a){"use strict";a.r(t);var s=a(3),o=Object(s.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"log-scale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#log-scale"}},[n._v("#")]),n._v(" Log Scale")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst logNumbers = (num) => {\n const data = [];\n\n for (let i = 0; i < num; ++i) {\n data.push(Math.ceil(Math.random() * 10.0) * Math.pow(10, Math.ceil(Math.random() * 5)));\n }\n\n return data;\n};\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = logNumbers(chart.data.labels.length);\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: logNumbers(DATA_COUNT),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n fill: false,\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Logarithmic'\n }\n },\n scales: {\n x: {\n display: true,\n },\n y: {\n display: true,\n type: 'logarithmic',\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/logarithmic.html"}},[n._v("Logarithmic Axis")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[246],{580:function(n,t,a){"use strict";a.r(t);var s=a(3),o=Object(s.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"log-scale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#log-scale"}},[n._v("#")]),n._v(" Log Scale")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst logNumbers = (num) => {\n const data = [];\n\n for (let i = 0; i < num; ++i) {\n data.push(Math.ceil(Math.random() * 10.0) * Math.pow(10, Math.ceil(Math.random() * 5)));\n }\n\n return data;\n};\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = logNumbers(chart.data.labels.length);\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: logNumbers(DATA_COUNT),\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n fill: false,\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - Logarithmic'\n }\n },\n scales: {\n x: {\n display: true,\n },\n y: {\n display: true,\n type: 'logarithmic',\n }\n }\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/logarithmic.html"}},[n._v("Logarithmic Axis")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/247.34695db2.js b/docs/master/assets/js/247.1c521022.js similarity index 97% rename from docs/master/assets/js/247.34695db2.js rename to docs/master/assets/js/247.1c521022.js index cfb5deca01..0682970a69 100644 --- a/docs/master/assets/js/247.34695db2.js +++ b/docs/master/assets/js/247.1c521022.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[247],{580:function(t,n,e){"use strict";e.r(n);var s=e(3),a=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"stacked-linear-category"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#stacked-linear-category"}},[t._v("#")]),t._v(" Stacked Linear / Category")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: [10, 30, 50, 20, 25, 44, -10],\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: ['ON', 'ON', 'OFF', 'ON', 'OFF', 'OFF', 'ON'],\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n stepped: true,\n yAxisID: 'y2',\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Stacked scales',\n },\n },\n scales: {\n y: {\n type: 'linear',\n position: 'left',\n stack: 'demo',\n stackWeight: 2,\n border: {\n color: Utils.CHART_COLORS.red\n }\n },\n y2: {\n type: 'category',\n labels: ['ON', 'OFF'],\n offset: true,\n position: 'left',\n stack: 'demo',\n stackWeight: 1,\n border: {\n color: Utils.CHART_COLORS.blue\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("Stacking")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[247],{581:function(t,n,e){"use strict";e.r(n);var s=e(3),a=Object(s.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"stacked-linear-category"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#stacked-linear-category"}},[t._v("#")]),t._v(" Stacked Linear / Category")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = Utils.months({count: 7});\nconst data = {\n labels: labels,\n datasets: [\n {\n label: 'Dataset 1',\n data: [10, 30, 50, 20, 25, 44, -10],\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.CHART_COLORS.red,\n },\n {\n label: 'Dataset 2',\n data: ['ON', 'ON', 'OFF', 'ON', 'OFF', 'OFF', 'ON'],\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.CHART_COLORS.blue,\n stepped: true,\n yAxisID: 'y2',\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n responsive: true,\n plugins: {\n title: {\n display: true,\n text: 'Stacked scales',\n },\n },\n scales: {\n y: {\n type: 'linear',\n position: 'left',\n stack: 'demo',\n stackWeight: 2,\n border: {\n color: Utils.CHART_COLORS.red\n }\n },\n y2: {\n type: 'category',\n labels: ['ON', 'OFF'],\n offset: true,\n position: 'left',\n stack: 'demo',\n stackWeight: 1,\n border: {\n color: Utils.CHART_COLORS.blue\n }\n }\n }\n },\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/"}},[t._v("Axes scales")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/axes/#stacking"}},[t._v("Stacking")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1)])],1)}),[],!1,null,null,null);n.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/248.4719e0c2.js b/docs/master/assets/js/248.7189371a.js similarity index 97% rename from docs/master/assets/js/248.4719e0c2.js rename to docs/master/assets/js/248.7189371a.js index fb8eb73ad5..922304a15b 100644 --- a/docs/master/assets/js/248.4719e0c2.js +++ b/docs/master/assets/js/248.7189371a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[248],{583:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"time-scale-combo-chart"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#time-scale-combo-chart"}},[t._v("#")]),t._v(" Time Scale - Combo Chart")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = [];\n\nfor (let i = 0; i < DATA_COUNT; ++i) {\n labels.push(Utils.newDate(i));\n}\n\nconst data = {\n labels: labels,\n datasets: [{\n type: 'bar',\n label: 'Dataset 1',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderColor: Utils.CHART_COLORS.red,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n type: 'bar',\n label: 'Dataset 2',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderColor: Utils.CHART_COLORS.blue,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n type: 'line',\n label: 'Dataset 3',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n borderColor: Utils.CHART_COLORS.green,\n fill: false,\n data: Utils.numbers(NUMBER_CFG),\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n text: 'Chart.js Combo Time Scale',\n display: true\n }\n },\n scales: {\n x: {\n type: 'time',\n display: true,\n offset: true,\n ticks: {\n source: 'data'\n },\n time: {\n unit: 'day'\n },\n },\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[t._v("Time Scale")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[248],{582:function(t,n,a){"use strict";a.r(n);var e=a(3),s=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"time-scale-combo-chart"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#time-scale-combo-chart"}},[t._v("#")]),t._v(" Time Scale - Combo Chart")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = Utils.numbers({count: chart.data.labels.length, min: 0, max: 100});\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst labels = [];\n\nfor (let i = 0; i < DATA_COUNT; ++i) {\n labels.push(Utils.newDate(i));\n}\n\nconst data = {\n labels: labels,\n datasets: [{\n type: 'bar',\n label: 'Dataset 1',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderColor: Utils.CHART_COLORS.red,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n type: 'bar',\n label: 'Dataset 2',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderColor: Utils.CHART_COLORS.blue,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n type: 'line',\n label: 'Dataset 3',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n borderColor: Utils.CHART_COLORS.green,\n fill: false,\n data: Utils.numbers(NUMBER_CFG),\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n text: 'Chart.js Combo Time Scale',\n display: true\n }\n },\n scales: {\n x: {\n type: 'time',\n display: true,\n offset: true,\n ticks: {\n source: 'data'\n },\n time: {\n unit: 'day'\n },\n },\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[t._v("Time Scale")])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/249.89b31537.js b/docs/master/assets/js/249.163eb8b8.js similarity index 97% rename from docs/master/assets/js/249.89b31537.js rename to docs/master/assets/js/249.163eb8b8.js index 1dcaf76d6c..964dc1cdae 100644 --- a/docs/master/assets/js/249.89b31537.js +++ b/docs/master/assets/js/249.163eb8b8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[249],{585:function(n,t,a){"use strict";a.r(t);var e=a(3),s=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"time-scale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#time-scale"}},[n._v("#")]),n._v(" Time Scale")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data.forEach(function(dataObj, j) {\n const newVal = Utils.rand(0, 100);\n\n if (typeof dataObj === 'object') {\n dataObj.y = newVal;\n } else {\n dataset.data[j] = newVal;\n }\n });\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst data = {\n labels: [ // Date Objects\n Utils.newDate(0),\n Utils.newDate(1),\n Utils.newDate(2),\n Utils.newDate(3),\n Utils.newDate(4),\n Utils.newDate(5),\n Utils.newDate(6)\n ],\n datasets: [{\n label: 'My First dataset',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderColor: Utils.CHART_COLORS.red,\n fill: false,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n label: 'My Second dataset',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderColor: Utils.CHART_COLORS.blue,\n fill: false,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n label: 'Dataset with point data',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n borderColor: Utils.CHART_COLORS.green,\n fill: false,\n data: [{\n x: Utils.newDateString(0),\n y: Utils.rand(0, 100)\n }, {\n x: Utils.newDateString(5),\n y: Utils.rand(0, 100)\n }, {\n x: Utils.newDateString(7),\n y: Utils.rand(0, 100)\n }, {\n x: Utils.newDateString(15),\n y: Utils.rand(0, 100)\n }],\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n text: 'Chart.js Time Scale',\n display: true\n }\n },\n scales: {\n x: {\n type: 'time',\n time: {\n // Luxon format string\n tooltipFormat: 'DD T'\n },\n title: {\n display: true,\n text: 'Date'\n }\n },\n y: {\n title: {\n display: true,\n text: 'value'\n }\n }\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[n._v("Time Cartesian Axis")])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[249],{583:function(n,t,a){"use strict";a.r(t);var e=a(3),s=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"time-scale"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#time-scale"}},[n._v("#")]),n._v(" Time Scale")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data.forEach(function(dataObj, j) {\n const newVal = Utils.rand(0, 100);\n\n if (typeof dataObj === 'object') {\n dataObj.y = newVal;\n } else {\n dataset.data[j] = newVal;\n }\n });\n });\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: 0, max: 100};\n\nconst data = {\n labels: [ // Date Objects\n Utils.newDate(0),\n Utils.newDate(1),\n Utils.newDate(2),\n Utils.newDate(3),\n Utils.newDate(4),\n Utils.newDate(5),\n Utils.newDate(6)\n ],\n datasets: [{\n label: 'My First dataset',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n borderColor: Utils.CHART_COLORS.red,\n fill: false,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n label: 'My Second dataset',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n borderColor: Utils.CHART_COLORS.blue,\n fill: false,\n data: Utils.numbers(NUMBER_CFG),\n }, {\n label: 'Dataset with point data',\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n borderColor: Utils.CHART_COLORS.green,\n fill: false,\n data: [{\n x: Utils.newDateString(0),\n y: Utils.rand(0, 100)\n }, {\n x: Utils.newDateString(5),\n y: Utils.rand(0, 100)\n }, {\n x: Utils.newDateString(7),\n y: Utils.rand(0, 100)\n }, {\n x: Utils.newDateString(15),\n y: Utils.rand(0, 100)\n }],\n }]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n text: 'Chart.js Time Scale',\n display: true\n }\n },\n scales: {\n x: {\n type: 'time',\n time: {\n // Luxon format string\n tooltipFormat: 'DD T'\n },\n title: {\n display: true,\n text: 'Date'\n }\n },\n y: {\n title: {\n display: true,\n text: 'value'\n }\n }\n },\n },\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/axes/cartesian/time.html"}},[n._v("Time Cartesian Axis")])],1)])],1)}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/25.c078688b.js b/docs/master/assets/js/25.aa721a11.js similarity index 89% rename from docs/master/assets/js/25.c078688b.js rename to docs/master/assets/js/25.aa721a11.js index 9de52c0f9c..7dbc6d1b26 100644 --- a/docs/master/assets/js/25.c078688b.js +++ b/docs/master/assets/js/25.aa721a11.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{358:function(e,t,r){"use strict";r.r(t);var a=r(3),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"enumeration-updatemodeenum"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-updatemodeenum"}},[e._v("#")]),e._v(" Enumeration: UpdateModeEnum")]),e._v(" "),t("h2",{attrs:{id:"enumeration-members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members"}},[e._v("#")]),e._v(" Enumeration Members")]),e._v(" "),t("h3",{attrs:{id:"active"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[e._v("#")]),e._v(" active")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("active")]),e._v(" = "),t("code",[e._v('"active"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L577",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:577"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"default"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#default"}},[e._v("#")]),e._v(" default")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("default")]),e._v(" = "),t("code",[e._v('"default"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L576",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:576"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"hide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hide"}},[e._v("#")]),e._v(" hide")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("hide")]),e._v(" = "),t("code",[e._v('"hide"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L574",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:574"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"none"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#none"}},[e._v("#")]),e._v(" none")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("none")]),e._v(" = "),t("code",[e._v('"none"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L573",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:573"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"reset"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[e._v("#")]),e._v(" reset")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("reset")]),e._v(" = "),t("code",[e._v('"reset"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-5"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L572",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:572"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"resize"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#resize"}},[e._v("#")]),e._v(" resize")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("resize")]),e._v(" = "),t("code",[e._v('"resize"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-6"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L571",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:571"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"show"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#show"}},[e._v("#")]),e._v(" show")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("show")]),e._v(" = "),t("code",[e._v('"show"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L575",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:575"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{357:function(e,t,r){"use strict";r.r(t);var a=r(3),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"enumeration-updatemodeenum"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-updatemodeenum"}},[e._v("#")]),e._v(" Enumeration: UpdateModeEnum")]),e._v(" "),t("h2",{attrs:{id:"enumeration-members"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#enumeration-members"}},[e._v("#")]),e._v(" Enumeration Members")]),e._v(" "),t("h3",{attrs:{id:"active"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[e._v("#")]),e._v(" active")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("active")]),e._v(" = "),t("code",[e._v('"active"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L577",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:577"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"default"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#default"}},[e._v("#")]),e._v(" default")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("default")]),e._v(" = "),t("code",[e._v('"default"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L576",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:576"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"hide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hide"}},[e._v("#")]),e._v(" hide")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("hide")]),e._v(" = "),t("code",[e._v('"hide"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L574",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:574"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"none"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#none"}},[e._v("#")]),e._v(" none")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("none")]),e._v(" = "),t("code",[e._v('"none"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L573",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:573"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"reset"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reset"}},[e._v("#")]),e._v(" reset")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("reset")]),e._v(" = "),t("code",[e._v('"reset"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-5"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L572",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:572"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"resize"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#resize"}},[e._v("#")]),e._v(" resize")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("resize")]),e._v(" = "),t("code",[e._v('"resize"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-6"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L571",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:571"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"show"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#show"}},[e._v("#")]),e._v(" show")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("show")]),e._v(" = "),t("code",[e._v('"show"')])]),e._v(" "),t("h4",{attrs:{id:"defined-in-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L575",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:575"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/251.6dfdd139.js b/docs/master/assets/js/251.42276b03.js similarity index 97% rename from docs/master/assets/js/251.6dfdd139.js rename to docs/master/assets/js/251.42276b03.js index c41c5c13c9..a2b6ca62e0 100644 --- a/docs/master/assets/js/251.6dfdd139.js +++ b/docs/master/assets/js/251.42276b03.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[251],{586:function(t,n,a){"use strict";a.r(n);var e=a(3),o=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"bar-chart"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#bar-chart"}},[t._v("#")]),t._v(" Bar Chart")]),t._v(" "),n("p",[t._v("Demo selecting bar color based on the bar's y value.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 16;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: -100,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData(),\n }]\n};\n// \n\n// \nfunction colorize(opaque) {\n return (ctx) => {\n const v = ctx.parsed.y;\n const c = v < -50 ? '#D60000'\n : v < 0 ? '#F46300'\n : v < 50 ? '#0358B6'\n : '#44DE28';\n\n return opaque ? c : Utils.transparentize(c, 1 - Math.abs(v / 150));\n };\n}\n\nconst config = {\n type: 'bar',\n data: data,\n options: {\n plugins: {\n legend: false,\n },\n elements: {\n bar: {\n backgroundColor: colorize(false),\n borderColor: colorize(true),\n borderWidth: 2\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[t._v("Dataset Configuration ("),n("code",[t._v("stack")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[251],{585:function(t,n,a){"use strict";a.r(n);var e=a(3),o=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"bar-chart"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#bar-chart"}},[t._v("#")]),t._v(" Bar Chart")]),t._v(" "),n("p",[t._v("Demo selecting bar color based on the bar's y value.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 16;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: -100,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData(),\n }]\n};\n// \n\n// \nfunction colorize(opaque) {\n return (ctx) => {\n const v = ctx.parsed.y;\n const c = v < -50 ? '#D60000'\n : v < 0 ? '#F46300'\n : v < 50 ? '#0358B6'\n : '#44DE28';\n\n return opaque ? c : Utils.transparentize(c, 1 - Math.abs(v / 150));\n };\n}\n\nconst config = {\n type: 'bar',\n data: data,\n options: {\n plugins: {\n legend: false,\n },\n elements: {\n bar: {\n backgroundColor: colorize(false),\n borderColor: colorize(true),\n borderWidth: 2\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/charts/bar.html"}},[t._v("Bar")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html#dataset-configuration"}},[t._v("Dataset Configuration ("),n("code",[t._v("stack")]),t._v(")")])],1)])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/general/options.html"}},[t._v("Options")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[t._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/252.6b733f3e.js b/docs/master/assets/js/252.c1e51be0.js similarity index 97% rename from docs/master/assets/js/252.6b733f3e.js rename to docs/master/assets/js/252.c1e51be0.js index c7ef67b6e0..fa797d74be 100644 --- a/docs/master/assets/js/252.6b733f3e.js +++ b/docs/master/assets/js/252.c1e51be0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[252],{589:function(n,t,a){"use strict";a.r(t);var e=a(3),o=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"bubble-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bubble-chart"}},[n._v("#")]),n._v(" Bubble Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 16;\nconst MIN_XY = -150;\nconst MAX_XY = 100;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n const data = [];\n let i;\n\n for (i = 0; i < DATA_COUNT; ++i) {\n data.push({\n x: Utils.rand(MIN_XY, MAX_XY),\n y: Utils.rand(MIN_XY, MAX_XY),\n v: Utils.rand(0, 1000)\n });\n }\n\n return data;\n}\n\nconst data = {\n datasets: [{\n data: generateData()\n }, {\n data: generateData()\n }]\n};\n// \n\n// \nfunction channelValue(x, y, values) {\n return x < 0 && y < 0 ? values[0] : x < 0 ? values[1] : y < 0 ? values[2] : values[3];\n}\n\nfunction colorize(opaque, context) {\n const value = context.raw;\n const x = value.x / 100;\n const y = value.y / 100;\n const r = channelValue(x, y, [250, 150, 50, 0]);\n const g = channelValue(x, y, [0, 50, 150, 250]);\n const b = channelValue(x, y, [0, 150, 150, 250]);\n const a = opaque ? 1 : 0.5 * value.v / 1000;\n\n return 'rgba(' + r + ',' + g + ',' + b + ',' + a + ')';\n}\n\nconst config = {\n type: 'bubble',\n data: data,\n options: {\n aspectRatio: 1,\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n point: {\n backgroundColor: colorize.bind(null, false),\n\n borderColor: colorize.bind(null, true),\n\n borderWidth: function(context) {\n return Math.min(Math.max(1, context.datasetIndex + 1), 8);\n },\n\n hoverBackgroundColor: 'transparent',\n\n hoverBorderColor: function(context) {\n return Utils.color(context.datasetIndex);\n },\n\n hoverBorderWidth: function(context) {\n return Math.round(8 * context.raw.v / 1000);\n },\n\n radius: function(context) {\n const size = context.chart.width;\n const base = Math.abs(context.raw.v) / 1000;\n return (size / 24) * base;\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bubble.html"}},[n._v("Bubble")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[252],{586:function(n,t,a){"use strict";a.r(t);var e=a(3),o=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"bubble-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bubble-chart"}},[n._v("#")]),n._v(" Bubble Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 16;\nconst MIN_XY = -150;\nconst MAX_XY = 100;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n const data = [];\n let i;\n\n for (i = 0; i < DATA_COUNT; ++i) {\n data.push({\n x: Utils.rand(MIN_XY, MAX_XY),\n y: Utils.rand(MIN_XY, MAX_XY),\n v: Utils.rand(0, 1000)\n });\n }\n\n return data;\n}\n\nconst data = {\n datasets: [{\n data: generateData()\n }, {\n data: generateData()\n }]\n};\n// \n\n// \nfunction channelValue(x, y, values) {\n return x < 0 && y < 0 ? values[0] : x < 0 ? values[1] : y < 0 ? values[2] : values[3];\n}\n\nfunction colorize(opaque, context) {\n const value = context.raw;\n const x = value.x / 100;\n const y = value.y / 100;\n const r = channelValue(x, y, [250, 150, 50, 0]);\n const g = channelValue(x, y, [0, 50, 150, 250]);\n const b = channelValue(x, y, [0, 150, 150, 250]);\n const a = opaque ? 1 : 0.5 * value.v / 1000;\n\n return 'rgba(' + r + ',' + g + ',' + b + ',' + a + ')';\n}\n\nconst config = {\n type: 'bubble',\n data: data,\n options: {\n aspectRatio: 1,\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n point: {\n backgroundColor: colorize.bind(null, false),\n\n borderColor: colorize.bind(null, true),\n\n borderWidth: function(context) {\n return Math.min(Math.max(1, context.datasetIndex + 1), 8);\n },\n\n hoverBackgroundColor: 'transparent',\n\n hoverBorderColor: function(context) {\n return Utils.color(context.datasetIndex);\n },\n\n hoverBorderWidth: function(context) {\n return Math.round(8 * context.raw.v / 1000);\n },\n\n radius: function(context) {\n const size = context.chart.width;\n const base = Math.abs(context.raw.v) / 1000;\n return (size / 24) * base;\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/bubble.html"}},[n._v("Bubble")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/253.950bea0a.js b/docs/master/assets/js/253.dd6fb0f1.js similarity index 97% rename from docs/master/assets/js/253.950bea0a.js rename to docs/master/assets/js/253.dd6fb0f1.js index bd58e89347..c304c04e2e 100644 --- a/docs/master/assets/js/253.950bea0a.js +++ b/docs/master/assets/js/253.dd6fb0f1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[253],{588:function(n,t,a){"use strict";a.r(t);var e=a(3),o=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"line-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-chart"}},[n._v("#")]),n._v(" Line Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 12;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction getLineColor(ctx) {\n return Utils.color(ctx.datasetIndex);\n}\n\nfunction alternatePointStyles(ctx) {\n const index = ctx.dataIndex;\n return index % 2 === 0 ? 'circle' : 'rect';\n}\n\nfunction makeHalfAsOpaque(ctx) {\n return Utils.transparentize(getLineColor(ctx));\n}\n\nfunction adjustRadiusBasedOnData(ctx) {\n const v = ctx.parsed.y;\n return v < 10 ? 5\n : v < 25 ? 7\n : v < 50 ? 9\n : v < 75 ? 11\n : 15;\n}\n\nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: true,\n },\n elements: {\n line: {\n fill: false,\n backgroundColor: getLineColor,\n borderColor: getLineColor,\n },\n point: {\n backgroundColor: getLineColor,\n hoverBackgroundColor: makeHalfAsOpaque,\n radius: adjustRadiusBasedOnData,\n pointStyle: alternatePointStyles,\n hoverRadius: 15,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#point-styling"}},[n._v("Point Styling")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[253],{587:function(n,t,a){"use strict";a.r(t);var e=a(3),o=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"line-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#line-chart"}},[n._v("#")]),n._v(" Line Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 12;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction getLineColor(ctx) {\n return Utils.color(ctx.datasetIndex);\n}\n\nfunction alternatePointStyles(ctx) {\n const index = ctx.dataIndex;\n return index % 2 === 0 ? 'circle' : 'rect';\n}\n\nfunction makeHalfAsOpaque(ctx) {\n return Utils.transparentize(getLineColor(ctx));\n}\n\nfunction adjustRadiusBasedOnData(ctx) {\n const v = ctx.parsed.y;\n return v < 10 ? 5\n : v < 25 ? 7\n : v < 50 ? 9\n : v < 75 ? 11\n : 15;\n}\n\nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: true,\n },\n elements: {\n line: {\n fill: false,\n backgroundColor: getLineColor,\n borderColor: getLineColor,\n },\n point: {\n backgroundColor: getLineColor,\n hoverBackgroundColor: makeHalfAsOpaque,\n radius: adjustRadiusBasedOnData,\n pointStyle: alternatePointStyles,\n hoverRadius: 15,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/charts/line.html#point-styling"}},[n._v("Point Styling")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/254.c730cbaf.js b/docs/master/assets/js/254.6de4da6d.js similarity index 97% rename from docs/master/assets/js/254.c730cbaf.js rename to docs/master/assets/js/254.6de4da6d.js index 7e31cb9b16..d4ebbe2e29 100644 --- a/docs/master/assets/js/254.c730cbaf.js +++ b/docs/master/assets/js/254.6de4da6d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[254],{587:function(n,t,a){"use strict";a.r(t);var o=a(3),e=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"pie-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pie-chart"}},[n._v("#")]),n._v(" Pie Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 5;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Toggle Doughnut View',\n handler(chart) {\n if (chart.options.cutout) {\n chart.options.cutout = 0;\n } else {\n chart.options.cutout = '50%';\n }\n chart.update();\n }\n }\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: -100,\n max: 100\n });\n}\n\nconst data = {\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction colorize(opaque, hover, ctx) {\n const v = ctx.parsed;\n const c = v < -50 ? '#D60000'\n : v < 0 ? '#F46300'\n : v < 50 ? '#0358B6'\n : '#44DE28';\n\n const opacity = hover ? 1 - Math.abs(v / 150) - 0.2 : 1 - Math.abs(v / 150);\n\n return opaque ? c : Utils.transparentize(c, opacity);\n}\n\nfunction hoverColorize(ctx) {\n return colorize(false, true, ctx);\n}\n\nconst config = {\n type: 'pie',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n arc: {\n backgroundColor: colorize.bind(null, false, false),\n hoverBackgroundColor: hoverColorize\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[n._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[254],{589:function(n,t,a){"use strict";a.r(t);var o=a(3),e=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"pie-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pie-chart"}},[n._v("#")]),n._v(" Pie Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 5;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n {\n name: 'Toggle Doughnut View',\n handler(chart) {\n if (chart.options.cutout) {\n chart.options.cutout = 0;\n } else {\n chart.options.cutout = '50%';\n }\n chart.update();\n }\n }\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: -100,\n max: 100\n });\n}\n\nconst data = {\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction colorize(opaque, hover, ctx) {\n const v = ctx.parsed;\n const c = v < -50 ? '#D60000'\n : v < 0 ? '#F46300'\n : v < 50 ? '#0358B6'\n : '#44DE28';\n\n const opacity = hover ? 1 - Math.abs(v / 150) - 0.2 : 1 - Math.abs(v / 150);\n\n return opaque ? c : Utils.transparentize(c, opacity);\n}\n\nfunction hoverColorize(ctx) {\n return colorize(false, true, ctx);\n}\n\nconst config = {\n type: 'pie',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n arc: {\n backgroundColor: colorize.bind(null, false, false),\n hoverBackgroundColor: hoverColorize\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/doughnut.html"}},[n._v("Doughnut and Pie Charts")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/255.91d7709b.js b/docs/master/assets/js/255.ac399c07.js similarity index 97% rename from docs/master/assets/js/255.91d7709b.js rename to docs/master/assets/js/255.ac399c07.js index 5e62b736ac..71c2c9bfa7 100644 --- a/docs/master/assets/js/255.91d7709b.js +++ b/docs/master/assets/js/255.ac399c07.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[255],{591:function(n,t,a){"use strict";a.r(t);var o=a(3),e=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"polar-area-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#polar-area-chart"}},[n._v("#")]),n._v(" Polar Area Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction colorize(opaque, hover, ctx) {\n const v = ctx.raw;\n const c = v < 35 ? '#D60000'\n : v < 55 ? '#F46300'\n : v < 75 ? '#0358B6'\n : '#44DE28';\n\n const opacity = hover ? 1 - Math.abs(v / 150) - 0.2 : 1 - Math.abs(v / 150);\n\n return opaque ? c : Utils.transparentize(c, opacity);\n}\n\nfunction hoverColorize(ctx) {\n return colorize(false, true, ctx);\n}\n\nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n arc: {\n backgroundColor: colorize.bind(null, false, false),\n hoverBackgroundColor: hoverColorize\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/polar.html"}},[n._v("Polar Area Chart")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[255],{590:function(n,t,a){"use strict";a.r(t);var o=a(3),e=Object(o.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"polar-area-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#polar-area-chart"}},[n._v("#")]),n._v(" Polar Area Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction colorize(opaque, hover, ctx) {\n const v = ctx.raw;\n const c = v < 35 ? '#D60000'\n : v < 55 ? '#F46300'\n : v < 75 ? '#0358B6'\n : '#44DE28';\n\n const opacity = hover ? 1 - Math.abs(v / 150) - 0.2 : 1 - Math.abs(v / 150);\n\n return opaque ? c : Utils.transparentize(c, opacity);\n}\n\nfunction hoverColorize(ctx) {\n return colorize(false, true, ctx);\n}\n\nconst config = {\n type: 'polarArea',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n arc: {\n backgroundColor: colorize.bind(null, false, false),\n hoverBackgroundColor: hoverColorize\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/polar.html"}},[n._v("Polar Area Chart")])],1)])],1)}),[],!1,null,null,null);t.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/256.565d0658.js b/docs/master/assets/js/256.b676d2c8.js similarity index 97% rename from docs/master/assets/js/256.565d0658.js rename to docs/master/assets/js/256.b676d2c8.js index e9f04a9caa..d299375cde 100644 --- a/docs/master/assets/js/256.565d0658.js +++ b/docs/master/assets/js/256.b676d2c8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[256],{592:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"radar-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#radar-chart"}},[n._v("#")]),n._v(" Radar Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: [['Eating', 'Dinner'], ['Drinking', 'Water'], 'Sleeping', ['Designing', 'Graphics'], 'Coding', 'Cycling', 'Running'],\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction getLineColor(ctx) {\n return Utils.color(ctx.datasetIndex);\n}\n\nfunction alternatePointStyles(ctx) {\n const index = ctx.dataIndex;\n return index % 2 === 0 ? 'circle' : 'rect';\n}\n\nfunction makeHalfAsOpaque(ctx) {\n return Utils.transparentize(getLineColor(ctx));\n}\n\nfunction make20PercentOpaque(ctx) {\n return Utils.transparentize(getLineColor(ctx), 0.8);\n}\n\nfunction adjustRadiusBasedOnData(ctx) {\n const v = ctx.parsed.y;\n return v < 10 ? 5\n : v < 25 ? 7\n : v < 50 ? 9\n : v < 75 ? 11\n : 15;\n}\n\nconst config = {\n type: 'radar',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n line: {\n backgroundColor: make20PercentOpaque,\n borderColor: getLineColor,\n },\n point: {\n backgroundColor: getLineColor,\n hoverBackgroundColor: makeHalfAsOpaque,\n radius: adjustRadiusBasedOnData,\n pointStyle: alternatePointStyles,\n hoverRadius: 15,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/radar.html"}},[n._v("Radar")])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[256],{591:function(n,t,a){"use strict";a.r(t);var e=a(3),r=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"radar-chart"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#radar-chart"}},[n._v("#")]),n._v(" Radar Chart")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nUtils.srand(110);\n\nconst actions = [\n {\n name: 'Randomize',\n handler(chart) {\n chart.data.datasets.forEach(dataset => {\n dataset.data = generateData();\n });\n chart.update();\n }\n },\n];\n// \n\n// \nfunction generateData() {\n return Utils.numbers({\n count: DATA_COUNT,\n min: 0,\n max: 100\n });\n}\n\nconst data = {\n labels: [['Eating', 'Dinner'], ['Drinking', 'Water'], 'Sleeping', ['Designing', 'Graphics'], 'Coding', 'Cycling', 'Running'],\n datasets: [{\n data: generateData()\n }]\n};\n// \n\n// \nfunction getLineColor(ctx) {\n return Utils.color(ctx.datasetIndex);\n}\n\nfunction alternatePointStyles(ctx) {\n const index = ctx.dataIndex;\n return index % 2 === 0 ? 'circle' : 'rect';\n}\n\nfunction makeHalfAsOpaque(ctx) {\n return Utils.transparentize(getLineColor(ctx));\n}\n\nfunction make20PercentOpaque(ctx) {\n return Utils.transparentize(getLineColor(ctx), 0.8);\n}\n\nfunction adjustRadiusBasedOnData(ctx) {\n const v = ctx.parsed.y;\n return v < 10 ? 5\n : v < 25 ? 7\n : v < 50 ? 9\n : v < 75 ? 11\n : 15;\n}\n\nconst config = {\n type: 'radar',\n data: data,\n options: {\n plugins: {\n legend: false,\n tooltip: false,\n },\n elements: {\n line: {\n backgroundColor: make20PercentOpaque,\n borderColor: getLineColor,\n },\n point: {\n backgroundColor: getLineColor,\n hoverBackgroundColor: makeHalfAsOpaque,\n radius: adjustRadiusBasedOnData,\n pointStyle: alternatePointStyles,\n hoverRadius: 15,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions,\n config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html"}},[n._v("Options")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/options.html#scriptable-options"}},[n._v("Scriptable Options")])],1)])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/radar.html"}},[n._v("Radar")])],1)])],1)}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/257.b79ed2f4.js b/docs/master/assets/js/257.30e258c3.js similarity index 96% rename from docs/master/assets/js/257.b79ed2f4.js rename to docs/master/assets/js/257.30e258c3.js index 2bb0552929..ba76fa7aa6 100644 --- a/docs/master/assets/js/257.b79ed2f4.js +++ b/docs/master/assets/js/257.30e258c3.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[257],{594:function(t,n,s){"use strict";s.r(n);var a=s(3),e=Object(a.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"basic"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#basic"}},[t._v("#")]),t._v(" Basic")]),t._v(" "),n("p",[t._v("This sample shows basic usage of subtitle.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Chart Title',\n },\n subtitle: {\n display: true,\n text: 'Chart Subtitle',\n color: 'blue',\n font: {\n size: 12,\n family: 'tahoma',\n weight: 'normal',\n style: 'italic'\n },\n padding: {\n bottom: 10\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/title.html"}},[t._v("Title")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/subtitle.html"}},[t._v("Subtitle")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[257],{592:function(t,n,s){"use strict";s.r(n);var a=s(3),e=Object(a.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"basic"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#basic"}},[t._v("#")]),t._v(" Basic")]),t._v(" "),n("p",[t._v("This sample shows basic usage of subtitle.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n plugins: {\n title: {\n display: true,\n text: 'Chart Title',\n },\n subtitle: {\n display: true,\n text: 'Chart Subtitle',\n color: 'blue',\n font: {\n size: 12,\n family: 'tahoma',\n weight: 'normal',\n style: 'italic'\n },\n padding: {\n bottom: 10\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/title.html"}},[t._v("Title")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/subtitle.html"}},[t._v("Subtitle")])],1)])],1)}),[],!1,null,null,null);n.default=e.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/259.faa71c1d.js b/docs/master/assets/js/259.ea3f8782.js similarity index 97% rename from docs/master/assets/js/259.faa71c1d.js rename to docs/master/assets/js/259.ea3f8782.js index 89e62bb28a..35dbc62d7b 100644 --- a/docs/master/assets/js/259.faa71c1d.js +++ b/docs/master/assets/js/259.ea3f8782.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[259],{595:function(t,n,o){"use strict";o.r(n);var l=o(3),s=Object(l.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"custom-tooltip-content"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#custom-tooltip-content"}},[t._v("#")]),t._v(" Custom Tooltip Content")]),t._v(" "),n("p",[t._v("This sample shows how to use the tooltip callbacks to add additional content to the tooltip.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst footer = (tooltipItems) => {\n let sum = 0;\n\n tooltipItems.forEach(function(tooltipItem) {\n sum += tooltipItem.parsed.y;\n });\n return 'Sum: ' + sum;\n};\n\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100, decimals: 0};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n intersect: false,\n mode: 'index',\n },\n plugins: {\n tooltip: {\n callbacks: {\n footer: footer,\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#tooltip-callbacks"}},[t._v("Tooltip Callbacks")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[259],{594:function(t,n,o){"use strict";o.r(n);var l=o(3),s=Object(l.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"custom-tooltip-content"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#custom-tooltip-content"}},[t._v("#")]),t._v(" Custom Tooltip Content")]),t._v(" "),n("p",[t._v("This sample shows how to use the tooltip callbacks to add additional content to the tooltip.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst footer = (tooltipItems) => {\n let sum = 0;\n\n tooltipItems.forEach(function(tooltipItem) {\n sum += tooltipItem.parsed.y;\n });\n return 'Sum: ' + sum;\n};\n\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100, decimals: 0};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n intersect: false,\n mode: 'index',\n },\n plugins: {\n tooltip: {\n callbacks: {\n footer: footer,\n }\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#tooltip-callbacks"}},[t._v("Tooltip Callbacks")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/26.4d28e79a.js b/docs/master/assets/js/26.3150d57b.js similarity index 91% rename from docs/master/assets/js/26.4d28e79a.js rename to docs/master/assets/js/26.3150d57b.js index 0f972f2038..072e4bc339 100644 --- a/docs/master/assets/js/26.4d28e79a.js +++ b/docs/master/assets/js/26.3150d57b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{359:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-activedatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-activedatapoint"}},[t._v("#")]),t._v(" Interface: ActiveDataPoint")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("ActiveDataPoint")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L476",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:476"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L477",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:477"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{358:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-activedatapoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-activedatapoint"}},[t._v("#")]),t._v(" Interface: ActiveDataPoint")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("strong",[e("code",[t._v("ActiveDataPoint")])])]),t._v(" "),e("p",[t._v("↳ "),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveElement.html"}},[e("code",[t._v("ActiveElement")])])],1)])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L476",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:476"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L477",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:477"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/260.1b96550a.js b/docs/master/assets/js/260.f91dc1d0.js similarity index 98% rename from docs/master/assets/js/260.1b96550a.js rename to docs/master/assets/js/260.f91dc1d0.js index 01a7a6d584..00ba60d2bc 100644 --- a/docs/master/assets/js/260.1b96550a.js +++ b/docs/master/assets/js/260.f91dc1d0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[260],{596:function(t,n,o){"use strict";o.r(n);var e=o(3),l=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"external-html-tooltip"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#external-html-tooltip"}},[t._v("#")]),t._v(" External HTML Tooltip")]),t._v(" "),n("p",[t._v("This sample shows how to use the external tooltip functionality to generate an HTML tooltip.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst getOrCreateTooltip = (chart) => {\n let tooltipEl = chart.canvas.parentNode.querySelector('div');\n\n if (!tooltipEl) {\n tooltipEl = document.createElement('div');\n tooltipEl.style.background = 'rgba(0, 0, 0, 0.7)';\n tooltipEl.style.borderRadius = '3px';\n tooltipEl.style.color = 'white';\n tooltipEl.style.opacity = 1;\n tooltipEl.style.pointerEvents = 'none';\n tooltipEl.style.position = 'absolute';\n tooltipEl.style.transform = 'translate(-50%, 0)';\n tooltipEl.style.transition = 'all .1s ease';\n\n const table = document.createElement('table');\n table.style.margin = '0px';\n\n tooltipEl.appendChild(table);\n chart.canvas.parentNode.appendChild(tooltipEl);\n }\n\n return tooltipEl;\n};\n\nconst externalTooltipHandler = (context) => {\n // Tooltip Element\n const {chart, tooltip} = context;\n const tooltipEl = getOrCreateTooltip(chart);\n\n // Hide if no tooltip\n if (tooltip.opacity === 0) {\n tooltipEl.style.opacity = 0;\n return;\n }\n\n // Set Text\n if (tooltip.body) {\n const titleLines = tooltip.title || [];\n const bodyLines = tooltip.body.map(b => b.lines);\n\n const tableHead = document.createElement('thead');\n\n titleLines.forEach(title => {\n const tr = document.createElement('tr');\n tr.style.borderWidth = 0;\n\n const th = document.createElement('th');\n th.style.borderWidth = 0;\n const text = document.createTextNode(title);\n\n th.appendChild(text);\n tr.appendChild(th);\n tableHead.appendChild(tr);\n });\n\n const tableBody = document.createElement('tbody');\n bodyLines.forEach((body, i) => {\n const colors = tooltip.labelColors[i];\n\n const span = document.createElement('span');\n span.style.background = colors.backgroundColor;\n span.style.borderColor = colors.borderColor;\n span.style.borderWidth = '2px';\n span.style.marginRight = '10px';\n span.style.height = '10px';\n span.style.width = '10px';\n span.style.display = 'inline-block';\n\n const tr = document.createElement('tr');\n tr.style.backgroundColor = 'inherit';\n tr.style.borderWidth = 0;\n\n const td = document.createElement('td');\n td.style.borderWidth = 0;\n\n const text = document.createTextNode(body);\n\n td.appendChild(span);\n td.appendChild(text);\n tr.appendChild(td);\n tableBody.appendChild(tr);\n });\n\n const tableRoot = tooltipEl.querySelector('table');\n\n // Remove old children\n while (tableRoot.firstChild) {\n tableRoot.firstChild.remove();\n }\n\n // Add new children\n tableRoot.appendChild(tableHead);\n tableRoot.appendChild(tableBody);\n }\n\n const {offsetLeft: positionX, offsetTop: positionY} = chart.canvas;\n\n // Display, position, and set styles for font\n tooltipEl.style.opacity = 1;\n tooltipEl.style.left = positionX + tooltip.caretX + 'px';\n tooltipEl.style.top = positionY + tooltip.caretY + 'px';\n tooltipEl.style.font = tooltip.options.bodyFont.string;\n tooltipEl.style.padding = tooltip.options.padding + 'px ' + tooltip.options.padding + 'px';\n};\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100, decimals: 0};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'index',\n intersect: false,\n },\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - External Tooltips'\n },\n tooltip: {\n enabled: false,\n position: 'nearest',\n external: externalTooltipHandler\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#external-custom-tooltips"}},[t._v("External (Custom) Tooltips")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[260],{595:function(t,n,o){"use strict";o.r(n);var e=o(3),l=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"external-html-tooltip"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#external-html-tooltip"}},[t._v("#")]),t._v(" External HTML Tooltip")]),t._v(" "),n("p",[t._v("This sample shows how to use the external tooltip functionality to generate an HTML tooltip.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst getOrCreateTooltip = (chart) => {\n let tooltipEl = chart.canvas.parentNode.querySelector('div');\n\n if (!tooltipEl) {\n tooltipEl = document.createElement('div');\n tooltipEl.style.background = 'rgba(0, 0, 0, 0.7)';\n tooltipEl.style.borderRadius = '3px';\n tooltipEl.style.color = 'white';\n tooltipEl.style.opacity = 1;\n tooltipEl.style.pointerEvents = 'none';\n tooltipEl.style.position = 'absolute';\n tooltipEl.style.transform = 'translate(-50%, 0)';\n tooltipEl.style.transition = 'all .1s ease';\n\n const table = document.createElement('table');\n table.style.margin = '0px';\n\n tooltipEl.appendChild(table);\n chart.canvas.parentNode.appendChild(tooltipEl);\n }\n\n return tooltipEl;\n};\n\nconst externalTooltipHandler = (context) => {\n // Tooltip Element\n const {chart, tooltip} = context;\n const tooltipEl = getOrCreateTooltip(chart);\n\n // Hide if no tooltip\n if (tooltip.opacity === 0) {\n tooltipEl.style.opacity = 0;\n return;\n }\n\n // Set Text\n if (tooltip.body) {\n const titleLines = tooltip.title || [];\n const bodyLines = tooltip.body.map(b => b.lines);\n\n const tableHead = document.createElement('thead');\n\n titleLines.forEach(title => {\n const tr = document.createElement('tr');\n tr.style.borderWidth = 0;\n\n const th = document.createElement('th');\n th.style.borderWidth = 0;\n const text = document.createTextNode(title);\n\n th.appendChild(text);\n tr.appendChild(th);\n tableHead.appendChild(tr);\n });\n\n const tableBody = document.createElement('tbody');\n bodyLines.forEach((body, i) => {\n const colors = tooltip.labelColors[i];\n\n const span = document.createElement('span');\n span.style.background = colors.backgroundColor;\n span.style.borderColor = colors.borderColor;\n span.style.borderWidth = '2px';\n span.style.marginRight = '10px';\n span.style.height = '10px';\n span.style.width = '10px';\n span.style.display = 'inline-block';\n\n const tr = document.createElement('tr');\n tr.style.backgroundColor = 'inherit';\n tr.style.borderWidth = 0;\n\n const td = document.createElement('td');\n td.style.borderWidth = 0;\n\n const text = document.createTextNode(body);\n\n td.appendChild(span);\n td.appendChild(text);\n tr.appendChild(td);\n tableBody.appendChild(tr);\n });\n\n const tableRoot = tooltipEl.querySelector('table');\n\n // Remove old children\n while (tableRoot.firstChild) {\n tableRoot.firstChild.remove();\n }\n\n // Add new children\n tableRoot.appendChild(tableHead);\n tableRoot.appendChild(tableBody);\n }\n\n const {offsetLeft: positionX, offsetTop: positionY} = chart.canvas;\n\n // Display, position, and set styles for font\n tooltipEl.style.opacity = 1;\n tooltipEl.style.left = positionX + tooltip.caretX + 'px';\n tooltipEl.style.top = positionY + tooltip.caretY + 'px';\n tooltipEl.style.font = tooltip.options.bodyFont.string;\n tooltipEl.style.padding = tooltip.options.padding + 'px ' + tooltip.options.padding + 'px';\n};\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100, decimals: 0};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'index',\n intersect: false,\n },\n plugins: {\n title: {\n display: true,\n text: 'Chart.js Line Chart - External Tooltips'\n },\n tooltip: {\n enabled: false,\n position: 'nearest',\n external: externalTooltipHandler\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: [],\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#external-custom-tooltips"}},[t._v("External (Custom) Tooltips")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/261.1ff316ff.js b/docs/master/assets/js/261.5c2b1f6d.js similarity index 98% rename from docs/master/assets/js/261.1ff316ff.js rename to docs/master/assets/js/261.5c2b1f6d.js index 7e749f0c3d..4d1121a05f 100644 --- a/docs/master/assets/js/261.1ff316ff.js +++ b/docs/master/assets/js/261.5c2b1f6d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[261],{597:function(n,t,a){"use strict";a.r(t);var e=a(3),o=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"interaction-modes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interaction-modes"}},[n._v("#")]),n._v(" Interaction Modes")]),n._v(" "),t("p",[n._v("This sample shows how to use the tooltip position mode setting.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Mode: index',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'index';\n chart.update();\n }\n },\n {\n name: 'Mode: dataset',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'dataset';\n chart.update();\n }\n },\n {\n name: 'Mode: point',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'point';\n chart.update();\n }\n },\n {\n name: 'Mode: nearest, axis: xy',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Mode: nearest, axis: x',\n handler(chart) {\n chart.options.interaction.axis = 'x';\n chart.options.interaction.mode = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Mode: nearest, axis: y',\n handler(chart) {\n chart.options.interaction.axis = 'y';\n chart.options.interaction.mode = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Mode: x',\n handler(chart) {\n chart.options.interaction.mode = 'x';\n chart.update();\n }\n },\n {\n name: 'Mode: y',\n handler(chart) {\n chart.options.interaction.mode = 'y';\n chart.update();\n }\n },\n {\n name: 'Toggle Intersect',\n handler(chart) {\n chart.options.interaction.intersect = !chart.options.interaction.intersect;\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n intersect: false,\n mode: 'index',\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => {\n const {axis = 'xy', intersect, mode} = ctx.chart.options.interaction;\n return 'Mode: ' + mode + ', axis: ' + axis + ', intersect: ' + intersect;\n }\n },\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[n._v("Tooltip")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/interactions.html"}},[n._v("Interactions")])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[261],{596:function(n,t,a){"use strict";a.r(t);var e=a(3),o=Object(e.a)({},(function(){var n=this,t=n._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":n.$parent.slotKey}},[t("h1",{attrs:{id:"interaction-modes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interaction-modes"}},[n._v("#")]),n._v(" Interaction Modes")]),n._v(" "),t("p",[n._v("This sample shows how to use the tooltip position mode setting.")]),n._v(" "),t("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Mode: index',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'index';\n chart.update();\n }\n },\n {\n name: 'Mode: dataset',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'dataset';\n chart.update();\n }\n },\n {\n name: 'Mode: point',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'point';\n chart.update();\n }\n },\n {\n name: 'Mode: nearest, axis: xy',\n handler(chart) {\n chart.options.interaction.axis = 'xy';\n chart.options.interaction.mode = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Mode: nearest, axis: x',\n handler(chart) {\n chart.options.interaction.axis = 'x';\n chart.options.interaction.mode = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Mode: nearest, axis: y',\n handler(chart) {\n chart.options.interaction.axis = 'y';\n chart.options.interaction.mode = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Mode: x',\n handler(chart) {\n chart.options.interaction.mode = 'x';\n chart.update();\n }\n },\n {\n name: 'Mode: y',\n handler(chart) {\n chart.options.interaction.mode = 'y';\n chart.update();\n }\n },\n {\n name: 'Toggle Intersect',\n handler(chart) {\n chart.options.interaction.intersect = !chart.options.interaction.intersect;\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n intersect: false,\n mode: 'index',\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => {\n const {axis = 'xy', intersect, mode} = ctx.chart.options.interaction;\n return 'Mode: ' + mode + ', axis: ' + axis + ', intersect: ' + intersect;\n }\n },\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),t("h2",{attrs:{id:"docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[n._v("#")]),n._v(" Docs")]),n._v(" "),t("ul",[t("li",[t("RouterLink",{attrs:{to:"/general/data-structures.html"}},[n._v("Data structures ("),t("code",[n._v("labels")]),n._v(")")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/charts/line.html"}},[n._v("Line")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[n._v("Tooltip")])],1),n._v(" "),t("li",[t("RouterLink",{attrs:{to:"/configuration/interactions.html"}},[n._v("Interactions")])],1)])],1)}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/262.24cb7602.js b/docs/master/assets/js/262.28451428.js similarity index 97% rename from docs/master/assets/js/262.24cb7602.js rename to docs/master/assets/js/262.28451428.js index 6cb3144bb8..21daf91ee0 100644 --- a/docs/master/assets/js/262.24cb7602.js +++ b/docs/master/assets/js/262.28451428.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[262],{598:function(t,n,o){"use strict";o.r(n);var e=o(3),l=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"point-style"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#point-style"}},[t._v("#")]),t._v(" Point Style")]),t._v(" "),n("p",[t._v("This sample shows how to use the dataset point style in the tooltip instead of a rectangle to identify each dataset.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Toggle Tooltip Point Style',\n handler(chart) {\n chart.options.plugins.tooltip.usePointStyle = !chart.options.plugins.tooltip.usePointStyle;\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Triangles',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n pointStyle: 'triangle',\n pointRadius: 6,\n },\n {\n label: 'Circles',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n pointStyle: 'circle',\n pointRadius: 6,\n },\n {\n label: 'Stars',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n pointStyle: 'star',\n pointRadius: 6,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'index',\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Tooltip point style: ' + ctx.chart.options.plugins.tooltip.usePointStyle,\n },\n tooltip: {\n usePointStyle: true,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("usePointStyle")])])])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html"}},[t._v("Elements")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("Point Styles")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[262],{600:function(t,n,o){"use strict";o.r(n);var e=o(3),l=Object(e.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"point-style"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#point-style"}},[t._v("#")]),t._v(" Point Style")]),t._v(" "),n("p",[t._v("This sample shows how to use the dataset point style in the tooltip instead of a rectangle to identify each dataset.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Toggle Tooltip Point Style',\n handler(chart) {\n chart.options.plugins.tooltip.usePointStyle = !chart.options.plugins.tooltip.usePointStyle;\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Triangles',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n pointStyle: 'triangle',\n pointRadius: 6,\n },\n {\n label: 'Circles',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n pointStyle: 'circle',\n pointRadius: 6,\n },\n {\n label: 'Stars',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.green,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.green, 0.5),\n pointStyle: 'star',\n pointRadius: 6,\n }\n ]\n};\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n mode: 'index',\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Tooltip point style: ' + ctx.chart.options.plugins.tooltip.usePointStyle,\n },\n tooltip: {\n usePointStyle: true,\n }\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("code",[t._v("usePointStyle")])])])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html"}},[t._v("Elements")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/elements.html#point-styles"}},[t._v("Point Styles")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=l.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/263.a40a0bba.js b/docs/master/assets/js/263.df220066.js similarity index 98% rename from docs/master/assets/js/263.a40a0bba.js rename to docs/master/assets/js/263.df220066.js index 8a67b01844..65c81cc17c 100644 --- a/docs/master/assets/js/263.a40a0bba.js +++ b/docs/master/assets/js/263.df220066.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[263],{600:function(t,n,o){"use strict";o.r(n);var i=o(3),s=Object(i.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"position"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" Position")]),t._v(" "),n("p",[t._v("This sample shows how to use the tooltip position mode setting.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Position: average',\n handler(chart) {\n chart.options.plugins.tooltip.position = 'average';\n chart.update();\n }\n },\n {\n name: 'Position: nearest',\n handler(chart) {\n chart.options.plugins.tooltip.position = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Position: bottom (custom)',\n handler(chart) {\n chart.options.plugins.tooltip.position = 'bottom';\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \n// Create a custom tooltip positioner to put at the bottom of the chart area\ncomponents.Tooltip.positioners.bottom = function(items) {\n const pos = components.Tooltip.positioners.average(items);\n\n // Happens when nothing is found\n if (pos === false) {\n return false;\n }\n\n const chart = this.chart;\n\n return {\n x: pos.x,\n y: chart.chartArea.bottom,\n xAlign: 'center',\n yAlign: 'bottom',\n };\n};\n\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n intersect: false,\n mode: 'index',\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Tooltip position mode: ' + ctx.chart.options.plugins.tooltip.position,\n },\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#position-modes"}},[t._v("Position Modes")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#custom-position-modes"}},[t._v("Custom Position Modes")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[263],{597:function(t,n,o){"use strict";o.r(n);var i=o(3),s=Object(i.a)({},(function(){var t=this,n=t._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[n("h1",{attrs:{id:"position"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#position"}},[t._v("#")]),t._v(" Position")]),t._v(" "),n("p",[t._v("This sample shows how to use the tooltip position mode setting.")]),t._v(" "),n("chart-editor",{attrs:{code:"// \nconst actions = [\n {\n name: 'Position: average',\n handler(chart) {\n chart.options.plugins.tooltip.position = 'average';\n chart.update();\n }\n },\n {\n name: 'Position: nearest',\n handler(chart) {\n chart.options.plugins.tooltip.position = 'nearest';\n chart.update();\n }\n },\n {\n name: 'Position: bottom (custom)',\n handler(chart) {\n chart.options.plugins.tooltip.position = 'bottom';\n chart.update();\n }\n },\n];\n// \n\n// \nconst DATA_COUNT = 7;\nconst NUMBER_CFG = {count: DATA_COUNT, min: -100, max: 100};\nconst data = {\n labels: Utils.months({count: DATA_COUNT}),\n datasets: [\n {\n label: 'Dataset 1',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.red,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5),\n },\n {\n label: 'Dataset 2',\n data: Utils.numbers(NUMBER_CFG),\n fill: false,\n borderColor: Utils.CHART_COLORS.blue,\n backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5),\n },\n ]\n};\n// \n\n// \n// Create a custom tooltip positioner to put at the bottom of the chart area\ncomponents.Tooltip.positioners.bottom = function(items) {\n const pos = components.Tooltip.positioners.average(items);\n\n // Happens when nothing is found\n if (pos === false) {\n return false;\n }\n\n const chart = this.chart;\n\n return {\n x: pos.x,\n y: chart.chartArea.bottom,\n xAlign: 'center',\n yAlign: 'bottom',\n };\n};\n\n// \n\n// \nconst config = {\n type: 'line',\n data: data,\n options: {\n interaction: {\n intersect: false,\n mode: 'index',\n },\n plugins: {\n title: {\n display: true,\n text: (ctx) => 'Tooltip position mode: ' + ctx.chart.options.plugins.tooltip.position,\n },\n }\n }\n};\n// \n\nmodule.exports = {\n actions: actions,\n config: config,\n};\n"}}),n("h2",{attrs:{id:"docs"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#docs"}},[t._v("#")]),t._v(" Docs")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/general/data-structures.html"}},[t._v("Data structures ("),n("code",[t._v("labels")]),t._v(")")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/charts/line.html"}},[t._v("Line")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html"}},[t._v("Tooltip")]),t._v(" "),n("ul",[n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#position-modes"}},[t._v("Position Modes")])],1),t._v(" "),n("li",[n("RouterLink",{attrs:{to:"/configuration/tooltip.html#custom-position-modes"}},[t._v("Custom Position Modes")])],1)])],1)])],1)}),[],!1,null,null,null);n.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/264.aab5fb55.js b/docs/master/assets/js/264.c7935e29.js similarity index 99% rename from docs/master/assets/js/264.aab5fb55.js rename to docs/master/assets/js/264.c7935e29.js index 39cfe15cb5..d99d10e851 100644 --- a/docs/master/assets/js/264.aab5fb55.js +++ b/docs/master/assets/js/264.c7935e29.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[264],{599:function(t,s,a){"use strict";a.r(s);var n=a(3),r=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"utils"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#utils"}},[t._v("#")]),t._v(" Utils")]),t._v(" "),s("h2",{attrs:{id:"disclaimer"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#disclaimer"}},[t._v("#")]),t._v(" Disclaimer")]),t._v(" "),s("p",[t._v("The Utils file contains multiple helper functions that the chart.js sample pages use to generate charts.\nThese functions are subject to change, including but not limited to breaking changes without prior notice.")]),t._v(" "),s("p",[t._v("Because of this please don't rely on this file in production environments.")]),t._v(" "),s("h2",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" colorLib "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@kurkle/color'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'luxon'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-adapter-luxon'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("valueOrDefault"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'../../dist/helpers.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Adapted from http://indiegamr.com/generate-repeatable-random-numbers-in-js/")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" _seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Date"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("srand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("seed")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n _seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" seed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n _seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("9301")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("49297")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("233280")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("233280")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numbers")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" cfg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" config "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" from "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("from"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" decimals "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("decimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" continuity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("continuity"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" decimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" data "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("++")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("from"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<=")]),t._v(" continuity"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("round")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" dfactor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("points")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" xs "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numbers")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ys "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numbers")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" xs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" i")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" ys"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bubbles")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("points")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("pt")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n pt"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("r "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rmin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rmax"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" pt"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" cfg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" config "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" step "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" decimals "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("decimals "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" decimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" prefix "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("prefix "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" values "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" step"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("prefix "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("round")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" dfactor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("MONTHS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'July'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'August'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'September'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'October'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'November'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'December'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("months")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" cfg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" config "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" section "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("section"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" values "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("++")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("MONTHS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("ceil")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("substring")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" section"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("COLORS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#4dc9f6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#f67019'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#f53794'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#537bc4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#acc236'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#166a8f'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#00a950'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#58595b'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#8549ba'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("color")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("transparentize")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" opacity")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" alpha "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("undefined")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" opacity"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("colorLib")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("alpha")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("alpha"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rgbString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("red")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 99, 132)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("orange")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 159, 64)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yellow")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 205, 86)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("green")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(75, 192, 192)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("blue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(54, 162, 235)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("purple")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(153, 102, 255)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("grey")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(201, 203, 207)'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("NAMED_COLORS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("orange"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("yellow"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("green"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("purple"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("grey"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("namedColor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("NAMED_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("NAMED_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("newDate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("days")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("plus")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("days"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toJSDate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("newDateString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("days")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("plus")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("days"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toISO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("parseISODate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("str")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fromISO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("str"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[s("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/docs/scripts/utils.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("File on github"),s("OutboundLink")],1)]),t._v(" "),s("h2",{attrs:{id:"components"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#components"}},[t._v("#")]),t._v(" Components")]),t._v(" "),s("p",[t._v("Some of the samples make reference to a "),s("code",[t._v("components")]),t._v(" object. This is an artifact of using a module bundler to build the samples. The creation of that components object is shown below. If chart.js is included as a browser script, these items are accessible via the "),s("code",[t._v("Chart")]),t._v(" object, i.e "),s("code",[t._v("Chart.Tooltip")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Add Chart components needed in samples here.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Usable through `components[name]`.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("Tooltip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'../../dist/chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/docs/scripts/components.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("File on github"),s("OutboundLink")],1)])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[264],{598:function(t,s,a){"use strict";a.r(s);var n=a(3),r=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"utils"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#utils"}},[t._v("#")]),t._v(" Utils")]),t._v(" "),s("h2",{attrs:{id:"disclaimer"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#disclaimer"}},[t._v("#")]),t._v(" Disclaimer")]),t._v(" "),s("p",[t._v("The Utils file contains multiple helper functions that the chart.js sample pages use to generate charts.\nThese functions are subject to change, including but not limited to breaking changes without prior notice.")]),t._v(" "),s("p",[t._v("Because of this please don't rely on this file in production environments.")]),t._v(" "),s("h2",{attrs:{id:"functions"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#functions"}},[t._v("#")]),t._v(" Functions")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" colorLib "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'@kurkle/color'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'luxon'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'chartjs-adapter-luxon'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("import")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("valueOrDefault"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'../../dist/helpers.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Adapted from http://indiegamr.com/generate-repeatable-random-numbers-in-js/")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" _seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Date"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("srand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("seed")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n _seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" seed"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n _seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("9301")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("49297")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("233280")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("_seed "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("233280")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numbers")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" cfg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" config "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" from "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("from"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" decimals "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("decimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" continuity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("valueOrDefault")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("continuity"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" decimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" data "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("++")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("from"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<=")]),t._v(" continuity"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("round")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" dfactor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("null")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("points")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" xs "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numbers")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" ys "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("numbers")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" xs"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" i")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("x"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("y")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" ys"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("bubbles")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("points")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("map")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("pt")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n pt"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("r "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("this")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rand")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rmin"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" config"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rmax"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" pt"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("labels")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" cfg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" config "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("min "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" step "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("max "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" decimals "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("decimals "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("8")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("pow")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" decimals"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" prefix "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("prefix "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" values "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" min"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" max"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+=")]),t._v(" step"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("prefix "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("round")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("dfactor "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("*")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("/")]),t._v(" dfactor"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("MONTHS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'January'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'February'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'March'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'April'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'May'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'June'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'July'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'August'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'September'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'October'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'November'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'December'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("months")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("config")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" cfg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" config "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("count "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" section "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" cfg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("section"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" values "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("for")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" i "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v(" count"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("++")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n value "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("MONTHS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("Math"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("ceil")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("i"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("12")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("push")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("substring")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" section"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" values"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("COLORS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#4dc9f6'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#f67019'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#f53794'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#537bc4'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#acc236'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#166a8f'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#00a950'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#58595b'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'#8549ba'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("color")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("transparentize")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" opacity")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("var")]),t._v(" alpha "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" opacity "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("undefined")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("?")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.5")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("-")]),t._v(" opacity"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("colorLib")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("value"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("alpha")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("alpha"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("rgbString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("red")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 99, 132)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("orange")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 159, 64)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("yellow")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(255, 205, 86)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("green")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(75, 192, 192)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("blue")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(54, 162, 235)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("purple")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(153, 102, 255)'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("grey")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'rgb(201, 203, 207)'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("NAMED_COLORS")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("red"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("orange"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("yellow"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("green"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("blue"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("purple"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("CHART_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("grey"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("namedColor")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("index")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("NAMED_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("index "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("%")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("NAMED_COLORS")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("newDate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("days")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("plus")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("days"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toJSDate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("newDateString")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("days")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("now")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("plus")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("days"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("toISO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("function")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("parseISODate")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("str")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" DateTime"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fromISO")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("str"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[s("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/docs/scripts/utils.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("File on github"),s("OutboundLink")],1)]),t._v(" "),s("h2",{attrs:{id:"components"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#components"}},[t._v("#")]),t._v(" Components")]),t._v(" "),s("p",[t._v("Some of the samples make reference to a "),s("code",[t._v("components")]),t._v(" object. This is an artifact of using a module bundler to build the samples. The creation of that components object is shown below. If chart.js is included as a browser script, these items are accessible via the "),s("code",[t._v("Chart")]),t._v(" object, i.e "),s("code",[t._v("Chart.Tooltip")]),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Add Chart components needed in samples here.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Usable through `components[name]`.")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("export")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("Tooltip"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("from")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'../../dist/chart.js'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),s("p",[s("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/master/docs/scripts/components.js",target:"_blank",rel:"noopener noreferrer"}},[t._v("File on github"),s("OutboundLink")],1)])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/27.d4482885.js b/docs/master/assets/js/27.89630bad.js similarity index 92% rename from docs/master/assets/js/27.d4482885.js rename to docs/master/assets/js/27.89630bad.js index 7ea994fe1a..ecb89c2a1e 100644 --- a/docs/master/assets/js/27.d4482885.js +++ b/docs/master/assets/js/27.89630bad.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{363:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-activeelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-activeelement"}},[t._v("#")]),t._v(" Interface: ActiveElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[e("code",[t._v("ActiveDataPoint")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("ActiveElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[t._v("ActiveDataPoint")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html#datasetindex"}},[t._v("datasetIndex")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L476",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:476"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"element"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#element"}},[t._v("#")]),t._v(" element")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("element")]),t._v(": "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L481",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:481"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[t._v("ActiveDataPoint")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html#index"}},[t._v("index")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L477",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:477"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{360:function(t,e,a){"use strict";a.r(e);var r=a(3),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-activeelement"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-activeelement"}},[t._v("#")]),t._v(" Interface: ActiveElement")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[e("code",[t._v("ActiveDataPoint")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("ActiveElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"datasetindex"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#datasetindex"}},[t._v("#")]),t._v(" datasetIndex")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("datasetIndex")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[t._v("ActiveDataPoint")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html#datasetindex"}},[t._v("datasetIndex")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L476",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:476"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"element"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#element"}},[t._v("#")]),t._v(" element")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("element")]),t._v(": "),e("code",[t._v("default")]),t._v("<"),e("code",[t._v("AnyObject")]),t._v(", "),e("code",[t._v("AnyObject")]),t._v(">")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L481",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:481"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"index"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#index"}},[t._v("#")]),t._v(" index")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("index")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html"}},[t._v("ActiveDataPoint")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ActiveDataPoint.html#index"}},[t._v("index")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L477",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:477"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/28.3a670186.js b/docs/master/assets/js/28.2ef566bc.js similarity index 89% rename from docs/master/assets/js/28.3a670186.js rename to docs/master/assets/js/28.2ef566bc.js index 8e83ef02ad..5f4f51bac5 100644 --- a/docs/master/assets/js/28.3a670186.js +++ b/docs/master/assets/js/28.2ef566bc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{360:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-animationevent"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-animationevent"}},[t._v("#")]),t._v(" Interface: AnimationEvent")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"currentstep"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#currentstep"}},[t._v("#")]),t._v(" currentStep")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("currentStep")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"initial"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#initial"}},[t._v("#")]),t._v(" initial")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("initial")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:16"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"numsteps"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#numsteps"}},[t._v("#")]),t._v(" numSteps")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("numSteps")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/animation.d.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:15"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[28],{359:function(t,e,r){"use strict";r.r(e);var a=r(3),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-animationevent"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-animationevent"}},[t._v("#")]),t._v(" Interface: AnimationEvent")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"chart"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#chart"}},[t._v("#")]),t._v(" chart")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("chart")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"currentstep"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#currentstep"}},[t._v("#")]),t._v(" currentStep")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("currentStep")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:17"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"initial"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#initial"}},[t._v("#")]),t._v(" initial")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("initial")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L16",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:16"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"numsteps"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#numsteps"}},[t._v("#")]),t._v(" numSteps")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("numSteps")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/animation.d.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/animation.d.ts:15"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/29.616494c8.js b/docs/master/assets/js/29.39182bf0.js similarity index 91% rename from docs/master/assets/js/29.616494c8.js rename to docs/master/assets/js/29.39182bf0.js index 93c56aa6a4..4e7510973c 100644 --- a/docs/master/assets/js/29.616494c8.js +++ b/docs/master/assets/js/29.39182bf0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{361:function(t,r,e){"use strict";e.r(r);var a=e(3),n=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"interface-arcborderradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-arcborderradius"}},[t._v("#")]),t._v(" Interface: ArcBorderRadius")]),t._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("h3",{attrs:{id:"innerend"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#innerend"}},[t._v("#")]),t._v(" innerEnd")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("innerEnd")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1826",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1826"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"innerstart"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#innerstart"}},[t._v("#")]),t._v(" innerStart")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("innerStart")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1825",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1825"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"outerend"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#outerend"}},[t._v("#")]),t._v(" outerEnd")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("outerEnd")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1824",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1824"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"outerstart"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#outerstart"}},[t._v("#")]),t._v(" outerStart")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("outerStart")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1823",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1823"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[29],{361:function(t,r,e){"use strict";e.r(r);var a=e(3),n=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"interface-arcborderradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-arcborderradius"}},[t._v("#")]),t._v(" Interface: ArcBorderRadius")]),t._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("h3",{attrs:{id:"innerend"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#innerend"}},[t._v("#")]),t._v(" innerEnd")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("innerEnd")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1826",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1826"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"innerstart"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#innerstart"}},[t._v("#")]),t._v(" innerStart")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("innerStart")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1825",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1825"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"outerend"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#outerend"}},[t._v("#")]),t._v(" outerEnd")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("outerEnd")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1824",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1824"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"outerstart"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#outerstart"}},[t._v("#")]),t._v(" outerStart")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("outerStart")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1823",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1823"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=n.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/30.950687bc.js b/docs/master/assets/js/30.bfb0a9ae.js similarity index 93% rename from docs/master/assets/js/30.950687bc.js rename to docs/master/assets/js/30.bfb0a9ae.js index e4dcebc5e4..499839c55c 100644 --- a/docs/master/assets/js/30.950687bc.js +++ b/docs/master/assets/js/30.bfb0a9ae.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{362:function(r,e,t){"use strict";t.r(e);var o=t(3),a=Object(o.a)({},(function(){var r=this,e=r._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"interface-archoveroptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-archoveroptions"}},[r._v("#")]),r._v(" Interface: ArcHoverOptions")]),r._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[e("code",[r._v("CommonHoverOptions")])])],1),r._v(" "),e("p",[r._v("↳ "),e("strong",[e("code",[r._v("ArcHoverOptions")])])])])]),r._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),e("h3",{attrs:{id:"hoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[r._v("#")]),r._v(" hoverBackgroundColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBackgroundColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbackgroundcolor"}},[r._v("hoverBackgroundColor")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1813"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[r._v("#")]),r._v(" hoverBorderColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbordercolor"}},[r._v("hoverBorderColor")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1812"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverborderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdash"}},[r._v("#")]),r._v(" hoverBorderDash")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderDash")]),r._v(": "),e("code",[r._v("number")]),r._v("[]")]),r._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1873",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1873"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverborderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdashoffset"}},[r._v("#")]),r._v(" hoverBorderDashOffset")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderDashOffset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1874",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1874"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[r._v("#")]),r._v(" hoverBorderWidth")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderWidth")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverborderwidth"}},[r._v("hoverBorderWidth")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1811"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoveroffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoveroffset"}},[r._v("#")]),r._v(" hoverOffset")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverOffset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1875",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1875"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[30],{362:function(r,e,t){"use strict";t.r(e);var o=t(3),a=Object(o.a)({},(function(){var r=this,e=r._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"interface-archoveroptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-archoveroptions"}},[r._v("#")]),r._v(" Interface: ArcHoverOptions")]),r._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[e("code",[r._v("CommonHoverOptions")])])],1),r._v(" "),e("p",[r._v("↳ "),e("strong",[e("code",[r._v("ArcHoverOptions")])])])])]),r._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),e("h3",{attrs:{id:"hoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[r._v("#")]),r._v(" hoverBackgroundColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBackgroundColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbackgroundcolor"}},[r._v("hoverBackgroundColor")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1813"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[r._v("#")]),r._v(" hoverBorderColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbordercolor"}},[r._v("hoverBorderColor")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1812"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverborderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdash"}},[r._v("#")]),r._v(" hoverBorderDash")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderDash")]),r._v(": "),e("code",[r._v("number")]),r._v("[]")]),r._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1873",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1873"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverborderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderdashoffset"}},[r._v("#")]),r._v(" hoverBorderDashOffset")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderDashOffset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1874",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1874"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[r._v("#")]),r._v(" hoverBorderWidth")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverBorderWidth")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverborderwidth"}},[r._v("hoverBorderWidth")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1811"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"hoveroffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoveroffset"}},[r._v("#")]),r._v(" hoverOffset")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("hoverOffset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1875",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1875"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/31.020dad5d.js b/docs/master/assets/js/31.020dad5d.js new file mode 100644 index 0000000000..f648a5c995 --- /dev/null +++ b/docs/master/assets/js/31.020dad5d.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{365:function(r,e,t){"use strict";t.r(e);var a=t(3),s=Object(a.a)({},(function(){var r=this,e=r._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[e("h1",{attrs:{id:"interface-arcoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-arcoptions"}},[r._v("#")]),r._v(" Interface: ArcOptions")]),r._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[e("code",[r._v("CommonElementOptions")])])],1),r._v(" "),e("p",[r._v("↳ "),e("strong",[e("code",[r._v("ArcOptions")])])])])]),r._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[r._v("#")]),r._v(" backgroundColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("backgroundColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[r._v("CommonElementOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html#backgroundcolor"}},[r._v("backgroundColor")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1807"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderalign"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderalign"}},[r._v("#")]),r._v(" borderAlign")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderAlign")]),r._v(": "),e("code",[r._v('"center"')]),r._v(" | "),e("code",[r._v('"inner"')])]),r._v(" "),e("p",[r._v("Arc stroke alignment.")]),r._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1833",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1833"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[r._v("#")]),r._v(" borderColor")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderColor")]),r._v(": "),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[r._v("Color")])])],1),r._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[r._v("CommonElementOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html#bordercolor"}},[r._v("borderColor")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1806"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderdash"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[r._v("#")]),r._v(" borderDash")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderDash")]),r._v(": "),e("code",[r._v("number")]),r._v("[]")]),r._v(" "),e("p",[r._v("Line dash. See MDN.")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Default")])])]),r._v(" "),e("p",[r._v("[]")]),r._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1838",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1838"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderdashoffset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[r._v("#")]),r._v(" borderDashOffset")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderDashOffset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("p",[r._v("Line dash offset. See MDN.")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Default")])])]),r._v(" "),e("p",[r._v("0.0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1843",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1843"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderjoinstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderjoinstyle"}},[r._v("#")]),r._v(" borderJoinStyle")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderJoinStyle")]),r._v(": "),e("code",[r._v("CanvasLineJoin")])]),r._v(" "),e("p",[r._v("Line join style. See MDN. Default is 'round' when "),e("code",[r._v("borderAlign")]),r._v(" is 'inner', else 'bevel'.")]),r._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1847",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1847"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[r._v("#")]),r._v(" borderRadius")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderRadius")]),r._v(": "),e("code",[r._v("number")]),r._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ArcBorderRadius.html"}},[e("code",[r._v("ArcBorderRadius")])])],1),r._v(" "),e("p",[r._v("Sets the border radius for arcs")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Default")])])]),r._v(" "),e("p",[r._v("0")]),r._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1853",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1853"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[r._v("#")]),r._v(" borderWidth")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("borderWidth")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[r._v("CommonElementOptions")]),r._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html#borderwidth"}},[r._v("borderWidth")])],1),r._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1805",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1805"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"circular"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#circular"}},[r._v("#")]),r._v(" circular")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("circular")]),r._v(": "),e("code",[r._v("boolean")])]),r._v(" "),e("p",[r._v("If false, Arc will be flat.")]),r._v(" "),e("p",[e("strong",[e("code",[r._v("Default")])])]),r._v(" "),e("p",[r._v("true")]),r._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1864",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1864"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"offset"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#offset"}},[r._v("#")]),r._v(" offset")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("offset")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("p",[r._v("Arc offset (in pixels).")]),r._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1858",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1858"),e("OutboundLink")],1)]),r._v(" "),e("hr"),r._v(" "),e("h3",{attrs:{id:"spacing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spacing"}},[r._v("#")]),r._v(" spacing")]),r._v(" "),e("p",[r._v("• "),e("strong",[r._v("spacing")]),r._v(": "),e("code",[r._v("number")])]),r._v(" "),e("p",[r._v("Spacing between arcs")]),r._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1869",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1869"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/31.d5c51487.js b/docs/master/assets/js/31.d5c51487.js deleted file mode 100644 index 29deed9cd6..0000000000 --- a/docs/master/assets/js/31.d5c51487.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[31],{364:function(e,r,t){"use strict";t.r(r);var a=t(3),s=Object(a.a)({},(function(){var e=this,r=e._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[r("h1",{attrs:{id:"interface-arcoptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-arcoptions"}},[e._v("#")]),e._v(" Interface: ArcOptions")]),e._v(" "),r("h2",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),r("ul",[r("li",[r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[r("code",[e._v("CommonElementOptions")])])],1),e._v(" "),r("p",[e._v("↳ "),r("strong",[r("code",[e._v("ArcOptions")])])])])]),e._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),r("h3",{attrs:{id:"backgroundcolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[e._v("#")]),e._v(" backgroundColor")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("backgroundColor")]),e._v(": "),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[e._v("Color")])])],1),e._v(" "),r("h4",{attrs:{id:"inherited-from"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[e._v("CommonElementOptions")]),e._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html#backgroundcolor"}},[e._v("backgroundColor")])],1),e._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1807"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"borderalign"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderalign"}},[e._v("#")]),e._v(" borderAlign")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("borderAlign")]),e._v(": "),r("code",[e._v('"center"')]),e._v(" | "),r("code",[e._v('"inner"')])]),e._v(" "),r("p",[e._v("Arc stroke alignment.")]),e._v(" "),r("h4",{attrs:{id:"defined-in-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1833",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1833"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"bordercolor"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[e._v("#")]),e._v(" borderColor")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("borderColor")]),e._v(": "),r("RouterLink",{attrs:{to:"/api/#color"}},[r("code",[e._v("Color")])])],1),e._v(" "),r("h4",{attrs:{id:"inherited-from-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[e._v("CommonElementOptions")]),e._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html#bordercolor"}},[e._v("borderColor")])],1),e._v(" "),r("h4",{attrs:{id:"defined-in-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1806"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"borderdash"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderdash"}},[e._v("#")]),e._v(" borderDash")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("borderDash")]),e._v(": "),r("code",[e._v("number")]),e._v("[]")]),e._v(" "),r("p",[e._v("Line dash. See MDN.")]),e._v(" "),r("p",[r("strong",[r("code",[e._v("Default")])])]),e._v(" "),r("p",[e._v("[]")]),e._v(" "),r("h4",{attrs:{id:"defined-in-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1838",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1838"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"borderdashoffset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderdashoffset"}},[e._v("#")]),e._v(" borderDashOffset")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("borderDashOffset")]),e._v(": "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("Line dash offset. See MDN.")]),e._v(" "),r("p",[r("strong",[r("code",[e._v("Default")])])]),e._v(" "),r("p",[e._v("0.0")]),e._v(" "),r("h4",{attrs:{id:"defined-in-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1843",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1843"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"borderjoinstyle"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderjoinstyle"}},[e._v("#")]),e._v(" borderJoinStyle")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("borderJoinStyle")]),e._v(": "),r("code",[e._v("CanvasLineJoin")])]),e._v(" "),r("p",[e._v("Line join style. See MDN. Default is 'round' when "),r("code",[e._v("borderAlign")]),e._v(" is 'inner', else 'bevel'.")]),e._v(" "),r("h4",{attrs:{id:"defined-in-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1847",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1847"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"borderradius"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[e._v("#")]),e._v(" borderRadius")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("borderRadius")]),e._v(": "),r("code",[e._v("number")]),e._v(" | "),r("RouterLink",{attrs:{to:"/api/interfaces/ArcBorderRadius.html"}},[r("code",[e._v("ArcBorderRadius")])])],1),e._v(" "),r("p",[e._v("Sets the border radius for arcs")]),e._v(" "),r("p",[r("strong",[r("code",[e._v("Default")])])]),e._v(" "),r("p",[e._v("0")]),e._v(" "),r("h4",{attrs:{id:"defined-in-7"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1853",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1853"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"borderwidth"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[e._v("#")]),e._v(" borderWidth")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("borderWidth")]),e._v(": "),r("code",[e._v("number")])]),e._v(" "),r("h4",{attrs:{id:"inherited-from-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[e._v("CommonElementOptions")]),e._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html#borderwidth"}},[e._v("borderWidth")])],1),e._v(" "),r("h4",{attrs:{id:"defined-in-8"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1805",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1805"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"circular"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#circular"}},[e._v("#")]),e._v(" circular")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("circular")]),e._v(": "),r("code",[e._v("boolean")])]),e._v(" "),r("p",[e._v("If false, Arc will be flat.")]),e._v(" "),r("p",[r("strong",[r("code",[e._v("Default")])])]),e._v(" "),r("p",[e._v("true")]),e._v(" "),r("h4",{attrs:{id:"defined-in-9"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1864",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1864"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"offset"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#offset"}},[e._v("#")]),e._v(" offset")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("offset")]),e._v(": "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("Arc offset (in pixels).")]),e._v(" "),r("h4",{attrs:{id:"defined-in-10"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1858",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1858"),r("OutboundLink")],1)]),e._v(" "),r("hr"),e._v(" "),r("h3",{attrs:{id:"spacing"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#spacing"}},[e._v("#")]),e._v(" spacing")]),e._v(" "),r("p",[e._v("• "),r("strong",[e._v("spacing")]),e._v(": "),r("code",[e._v("number")])]),e._v(" "),r("p",[e._v("Spacing between arcs")]),e._v(" "),r("h4",{attrs:{id:"defined-in-11"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1869",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1869"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/32.c7c0e9d5.js b/docs/master/assets/js/32.d4f0df6f.js similarity index 89% rename from docs/master/assets/js/32.c7c0e9d5.js rename to docs/master/assets/js/32.d4f0df6f.js index 5cbdc1ab24..532699ede5 100644 --- a/docs/master/assets/js/32.c7c0e9d5.js +++ b/docs/master/assets/js/32.d4f0df6f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{365:function(e,t,r){"use strict";r.r(t);var a=r(3),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"interface-arcprops"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interface-arcprops"}},[e._v("#")]),e._v(" Interface: ArcProps")]),e._v(" "),t("h2",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),t("ul",[t("li",[t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t("code",[e._v("Point")])])],1),e._v(" "),t("p",[e._v("↳ "),t("strong",[t("code",[e._v("ArcProps")])])])])]),e._v(" "),t("h2",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),t("h3",{attrs:{id:"circumference"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#circumference"}},[e._v("#")]),e._v(" circumference")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("circumference")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L260",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:260"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"endangle"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#endangle"}},[e._v("#")]),e._v(" endAngle")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("endAngle")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L257",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:257"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"innerradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#innerradius"}},[e._v("#")]),e._v(" innerRadius")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("innerRadius")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L258",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:258"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"outerradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#outerradius"}},[e._v("#")]),e._v(" outerRadius")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("outerRadius")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L259",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:259"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"startangle"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#startangle"}},[e._v("#")]),e._v(" startAngle")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("startAngle")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-5"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/elements/element.arc.ts#L256",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:256"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"x"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[e._v("#")]),e._v(" x")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("x")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"inherited-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e._v("Point")]),e._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/Point.html#x"}},[e._v("x")])],1),e._v(" "),t("h4",{attrs:{id:"defined-in-6"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/geometric.d.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/geometric.d.ts:11"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"y"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[e._v("#")]),e._v(" y")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("y")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"inherited-from-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e._v("Point")]),e._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/Point.html#y"}},[e._v("y")])],1),e._v(" "),t("h4",{attrs:{id:"defined-in-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/geometric.d.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/geometric.d.ts:12"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[32],{363:function(e,t,r){"use strict";r.r(t);var a=r(3),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"interface-arcprops"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interface-arcprops"}},[e._v("#")]),e._v(" Interface: ArcProps")]),e._v(" "),t("h2",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),t("ul",[t("li",[t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t("code",[e._v("Point")])])],1),e._v(" "),t("p",[e._v("↳ "),t("strong",[t("code",[e._v("ArcProps")])])])])]),e._v(" "),t("h2",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),t("h3",{attrs:{id:"circumference"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#circumference"}},[e._v("#")]),e._v(" circumference")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("circumference")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L260",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:260"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"endangle"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#endangle"}},[e._v("#")]),e._v(" endAngle")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("endAngle")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L257",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:257"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"innerradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#innerradius"}},[e._v("#")]),e._v(" innerRadius")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("innerRadius")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L258",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:258"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"outerradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#outerradius"}},[e._v("#")]),e._v(" outerRadius")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("outerRadius")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L259",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:259"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"startangle"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#startangle"}},[e._v("#")]),e._v(" startAngle")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("startAngle")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"defined-in-5"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/elements/element.arc.ts#L256",target:"_blank",rel:"noopener noreferrer"}},[e._v("elements/element.arc.ts:256"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"x"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[e._v("#")]),e._v(" x")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("x")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"inherited-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e._v("Point")]),e._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/Point.html#x"}},[e._v("x")])],1),e._v(" "),t("h4",{attrs:{id:"defined-in-6"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/geometric.d.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/geometric.d.ts:11"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"y"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[e._v("#")]),e._v(" y")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("y")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("h4",{attrs:{id:"inherited-from-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e._v("Point")]),e._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/Point.html#y"}},[e._v("y")])],1),e._v(" "),t("h4",{attrs:{id:"defined-in-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/geometric.d.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/geometric.d.ts:12"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/33.cfe937d5.js b/docs/master/assets/js/33.a60f392b.js similarity index 89% rename from docs/master/assets/js/33.cfe937d5.js rename to docs/master/assets/js/33.a60f392b.js index ed78ac0da1..282da4e651 100644 --- a/docs/master/assets/js/33.cfe937d5.js +++ b/docs/master/assets/js/33.a60f392b.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{366:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-backdropoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-backdropoptions"}},[t._v("#")]),t._v(" Interface: BackdropOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Color of label backdrops.")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1486",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1486"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of backdrop in pixels")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1481",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1481"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left position of backdrop as pixel")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1466",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1466"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top position of backdrop as pixel")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1471",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1471"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of backdrop in pixels")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1476",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1476"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[33],{364:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-backdropoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-backdropoptions"}},[t._v("#")]),t._v(" Interface: BackdropOptions")]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"color"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#color"}},[t._v("#")]),t._v(" color")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("color")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptable"}},[e("code",[t._v("Scriptable")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableScaleContext.html"}},[e("code",[t._v("ScriptableScaleContext")])]),t._v(">")],1),t._v(" "),e("p",[t._v("Color of label backdrops.")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1486",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1486"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Height of backdrop in pixels")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1481",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1481"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"left"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#left"}},[t._v("#")]),t._v(" left")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("left")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Left position of backdrop as pixel")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1466",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1466"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"top"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#top"}},[t._v("#")]),t._v(" top")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("top")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Top position of backdrop as pixel")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1471",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1471"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Width of backdrop in pixels")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1476",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1476"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/34.0e0b228e.js b/docs/master/assets/js/34.8d0d5136.js similarity index 90% rename from docs/master/assets/js/34.0e0b228e.js rename to docs/master/assets/js/34.8d0d5136.js index af362219c1..1061ce9455 100644 --- a/docs/master/assets/js/34.0e0b228e.js +++ b/docs/master/assets/js/34.8d0d5136.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{367:function(t,r,e){"use strict";e.r(r);var a=e(3),s=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"interface-barcontrollerchartoptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-barcontrollerchartoptions"}},[t._v("#")]),t._v(" Interface: BarControllerChartOptions")]),t._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("h3",{attrs:{id:"skipnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#skipnull"}},[t._v("#")]),t._v(" skipNull")]),t._v(" "),r("p",[t._v("• "),r("code",[t._v("Optional")]),t._v(" "),r("strong",[t._v("skipNull")]),t._v(": "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[t._v("Should null or undefined values be omitted from drawing")]),t._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:153"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{366:function(t,r,e){"use strict";e.r(r);var a=e(3),s=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"interface-barcontrollerchartoptions"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-barcontrollerchartoptions"}},[t._v("#")]),t._v(" Interface: BarControllerChartOptions")]),t._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("h3",{attrs:{id:"skipnull"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#skipnull"}},[t._v("#")]),t._v(" skipNull")]),t._v(" "),r("p",[t._v("• "),r("code",[t._v("Optional")]),t._v(" "),r("strong",[t._v("skipNull")]),t._v(": "),r("code",[t._v("boolean")])]),t._v(" "),r("p",[t._v("Should null or undefined values be omitted from drawing")]),t._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L153",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:153"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/35.df7045c9.js b/docs/master/assets/js/35.9e73a7a2.js similarity index 94% rename from docs/master/assets/js/35.df7045c9.js rename to docs/master/assets/js/35.9e73a7a2.js index c19bfd6388..9b1950c469 100644 --- a/docs/master/assets/js/35.df7045c9.js +++ b/docs/master/assets/js/35.9e73a7a2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{369:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-barcontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-barcontrollerdatasetoptions"}},[t._v("#")]),t._v(" Interface: BarControllerDatasetOptions")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[e("code",[t._v("ControllerDatasetOptions")])])],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[e("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[e("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[e("code",[t._v("CommonHoverOptions")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#animationoptions"}},[e("code",[t._v("AnimationOptions")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("BarControllerDatasetOptions")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v("> & { "),e("code",[t._v("onComplete?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" ; "),e("code",[t._v("onProgress?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.animation")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1747"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animations")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1757",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1757"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.backgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1807"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barpercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barpercentage"}},[t._v("#")]),t._v(" barPercentage")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("barPercentage")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0.9")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:114"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barthickness"}},[t._v("#")]),t._v(" barThickness")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("barThickness")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v('"flex"')])]),t._v(" "),e("p",[t._v("Manually set width of each bar in pixels. If set to 'flex', it computes \"optimal\" sample widths that globally arrange bars side by side. If not set (default), bars are equally sized based on the smallest interval.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L124",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:124"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"base"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#base"}},[t._v("#")]),t._v(" base")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("base")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The base value for the bar in data units along the value axis.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.base")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2080",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2080"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1806"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[t._v("#")]),t._v(" borderRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[t._v("BorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Border radius")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2092",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2092"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderskipped"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderskipped"}},[t._v("#")]),t._v(" borderSkipped")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderSkipped")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v('"end"')]),t._v(" | "),e("code",[t._v('"start"')]),t._v(" | "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"bottom"')]),t._v(" | "),e("code",[t._v('"right"')]),t._v(" | "),e("code",[t._v('"middle"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'start'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderSkipped")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2086",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2086"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | { "),e("code",[t._v("bottom?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("left?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("right?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("top?")]),t._v(": "),e("code",[t._v("number")]),t._v(" }, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Width of the border, number for all sides, object to specify width for each side specifically")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2105",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2105"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categorypercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categorypercentage"}},[t._v("#")]),t._v(" categoryPercentage")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("categoryPercentage")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each category should be within the sample width.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0.8")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L119",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:119"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"clip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clip"}},[t._v("#")]),t._v(" clip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("clip")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#clip"}},[t._v("clip")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:75"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"grouped"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grouped"}},[t._v("#")]),t._v(" grouped")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("grouped")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Should the bars be grouped on index axis")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L146",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:146"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hidden"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hidden"}},[t._v("#")]),t._v(" hidden")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hidden")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#hidden"}},[t._v("hidden")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:93"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[t._v("#")]),t._v(" hoverBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBackgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1813"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[t._v("#")]),t._v(" hoverBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1812"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[t._v("#")]),t._v(" hoverBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1811"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"indexaxis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#indexaxis"}},[t._v("#")]),t._v(" indexAxis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("indexAxis")]),t._v(": "),e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])]),t._v(" "),e("p",[t._v("The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'x'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#indexaxis"}},[t._v("indexAxis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:71"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inflateamount"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inflateamount"}},[t._v("#")]),t._v(" inflateAmount")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("inflateAmount")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v('"auto"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Amount to inflate the rectangle(s). This can be used to hide artifacts between bars.\nUnit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'auto'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.inflateAmount")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2099",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2099"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The label for the dataset which appears in the legend and tooltips.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#label"}},[t._v("label")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:79"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxbarthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxbarthickness"}},[t._v("#")]),t._v(" maxBarThickness")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxBarThickness")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Set this to ensure that bars are not sized thicker than this.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:129"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"minbarlength"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#minbarlength"}},[t._v("#")]),t._v(" minBarLength")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("minBarLength")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Set this to ensure that bars have a minimum length in pixels.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L134",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:134"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"normalized"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#normalized"}},[t._v("#")]),t._v(" normalized")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("normalized")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#normalized"}},[t._v("normalized")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:63"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"order"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#order"}},[t._v("#")]),t._v(" order")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("order")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#order"}},[t._v("order")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:83"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsing")]),t._v(": "),e("code",[t._v("false")]),t._v(" | { "),e("code",[t._v("[key: string]")]),t._v(": "),e("code",[t._v("string")]),t._v("; }")]),t._v(" "),e("p",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#parsing"}},[t._v("parsing")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" pointStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])])],1),t._v(" "),e("p",[t._v("Point style for the legend")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'circle;")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:140"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("stack")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#stack"}},[t._v("stack")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:88"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("transitions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[e("code",[t._v("TransitionsSpec")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.transitions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1758"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xaxisid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xaxisid"}},[t._v("#")]),t._v(" xAxisID")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("xAxisID")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the x axis to plot this dataset on.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L104",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:104"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yaxisid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yaxisid"}},[t._v("#")]),t._v(" yAxisID")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("yAxisID")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the y axis to plot this dataset on.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L108",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:108"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[35],{369:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-barcontrollerdatasetoptions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-barcontrollerdatasetoptions"}},[t._v("#")]),t._v(" Interface: BarControllerDatasetOptions")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[e("code",[t._v("ControllerDatasetOptions")])])],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[e("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#scriptableandarrayoptions"}},[e("code",[t._v("ScriptableAndArrayOptions")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[e("code",[t._v("CommonHoverOptions")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1)]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/#animationoptions"}},[e("code",[t._v("AnimationOptions")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">")],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("BarControllerDatasetOptions")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animation"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animation"}},[t._v("#")]),t._v(" animation")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animation")]),t._v(": "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/#animationspec"}},[e("code",[t._v("AnimationSpec")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v("> & { "),e("code",[t._v("onComplete?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" ; "),e("code",[t._v("onProgress?")]),t._v(": ("),e("code",[t._v("this")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/classes/Chart.html"}},[e("code",[t._v("Chart")])]),t._v(", "),e("code",[t._v("event")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/interfaces/AnimationEvent.html"}},[e("code",[t._v("AnimationEvent")])]),t._v(") => "),e("code",[t._v("void")]),t._v(" }")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.animation")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1747",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1747"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("animations")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#animationsspec"}},[e("code",[t._v("AnimationsSpec")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1757",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1757"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"backgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[t._v("#")]),t._v(" backgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("backgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.backgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1807"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barpercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barpercentage"}},[t._v("#")]),t._v(" barPercentage")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("barPercentage")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0.9")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L114",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:114"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"barthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#barthickness"}},[t._v("#")]),t._v(" barThickness")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("barThickness")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v('"flex"')])]),t._v(" "),e("p",[t._v("Manually set width of each bar in pixels. If set to 'flex', it computes \"optimal\" sample widths that globally arrange bars side by side. If not set (default), bars are equally sized based on the smallest interval.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L124",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:124"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"base"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#base"}},[t._v("#")]),t._v(" base")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("base")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("The base value for the bar in data units along the value axis.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.base")]),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2080",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2080"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"bordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[t._v("#")]),t._v(" borderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1806"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderradius"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[t._v("#")]),t._v(" borderRadius")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderRadius")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[e("code",[t._v("BorderRadius")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Border radius")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderRadius")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2092",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2092"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderskipped"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderskipped"}},[t._v("#")]),t._v(" borderSkipped")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderSkipped")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("boolean")]),t._v(" | "),e("code",[t._v('"end"')]),t._v(" | "),e("code",[t._v('"start"')]),t._v(" | "),e("code",[t._v('"left"')]),t._v(" | "),e("code",[t._v('"top"')]),t._v(" | "),e("code",[t._v('"bottom"')]),t._v(" | "),e("code",[t._v('"right"')]),t._v(" | "),e("code",[t._v('"middle"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'start'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderSkipped")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2086",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2086"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"borderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[t._v("#")]),t._v(" borderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("borderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | { "),e("code",[t._v("bottom?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("left?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("right?")]),t._v(": "),e("code",[t._v("number")]),t._v(" ; "),e("code",[t._v("top?")]),t._v(": "),e("code",[t._v("number")]),t._v(" }, "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Width of the border, number for all sides, object to specify width for each side specifically")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.borderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2105",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2105"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"categorypercentage"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#categorypercentage"}},[t._v("#")]),t._v(" categoryPercentage")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("categoryPercentage")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Percent (0-1) of the available width each category should be within the sample width.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("0.8")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L119",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:119"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"clip"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#clip"}},[t._v("#")]),t._v(" clip")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("clip")]),t._v(": "),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v("false")]),t._v(" | "),e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1),t._v(" "),e("p",[t._v("How to clip relative to chartArea. Positive value allows overflow, negative value clips that many pixels inside chartArea. 0 = clip at chartArea. Clipping can also be configured per side: "),e("code",[t._v("clip: {left: 5, top: false, right: -2, bottom: 0}")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#clip"}},[t._v("clip")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L75",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:75"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"grouped"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#grouped"}},[t._v("#")]),t._v(" grouped")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("grouped")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Should the bars be grouped on index axis")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("true")]),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L146",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:146"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hidden"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hidden"}},[t._v("#")]),t._v(" hidden")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hidden")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Configures the visibility state of the dataset. Set it to true, to hide the dataset from the chart.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("false")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#hidden"}},[t._v("hidden")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L93",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:93"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbackgroundcolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[t._v("#")]),t._v(" hoverBackgroundColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBackgroundColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBackgroundColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1813"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverbordercolor"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[t._v("#")]),t._v(" hoverBorderColor")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderColor")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("RouterLink",{attrs:{to:"/api/#color"}},[e("code",[t._v("Color")])]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderColor")]),t._v(" "),e("h4",{attrs:{id:"defined-in-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-16"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1812"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hoverborderwidth"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[t._v("#")]),t._v(" hoverBorderWidth")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("hoverBorderWidth")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.hoverBorderWidth")]),t._v(" "),e("h4",{attrs:{id:"defined-in-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-17"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1811"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"indexaxis"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#indexaxis"}},[t._v("#")]),t._v(" indexAxis")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("indexAxis")]),t._v(": "),e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])]),t._v(" "),e("p",[t._v("The base axis of the chart. 'x' for vertical charts and 'y' for horizontal charts.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'x'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#indexaxis"}},[t._v("indexAxis")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-18"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L71",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:71"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inflateamount"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inflateamount"}},[t._v("#")]),t._v(" inflateAmount")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("inflateAmount")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#scriptableandarray"}},[e("code",[t._v("ScriptableAndArray")])]),t._v("<"),e("code",[t._v("number")]),t._v(" | "),e("code",[t._v('"auto"')]),t._v(", "),e("RouterLink",{attrs:{to:"/api/interfaces/ScriptableContext.html"}},[e("code",[t._v("ScriptableContext")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">>")],1),t._v(" "),e("p",[t._v("Amount to inflate the rectangle(s). This can be used to hide artifacts between bars.\nUnit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'auto'")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("ScriptableAndArrayOptions.inflateAmount")]),t._v(" "),e("h4",{attrs:{id:"defined-in-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-19"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2099",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2099"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"label"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#label"}},[t._v("#")]),t._v(" label")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("label")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The label for the dataset which appears in the legend and tooltips.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-16"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-16"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#label"}},[t._v("label")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-20"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L79",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:79"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"maxbarthickness"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maxbarthickness"}},[t._v("#")]),t._v(" maxBarThickness")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("maxBarThickness")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Set this to ensure that bars are not sized thicker than this.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-21"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L129",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:129"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"minbarlength"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#minbarlength"}},[t._v("#")]),t._v(" minBarLength")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("minBarLength")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("Set this to ensure that bars have a minimum length in pixels.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-22"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-22"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L134",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:134"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"normalized"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#normalized"}},[t._v("#")]),t._v(" normalized")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("normalized")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("p",[t._v("Chart.js is fastest if you provide data with indices that are unique, sorted, and consistent across datasets and provide the normalized: true option to let Chart.js know that you have done so.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-17"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-17"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#normalized"}},[t._v("normalized")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-23"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-23"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L63",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:63"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"order"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#order"}},[t._v("#")]),t._v(" order")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("order")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("p",[t._v("The drawing order of dataset. Also affects order for stacking, tooltip and legend.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-18"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-18"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#order"}},[t._v("order")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-24"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-24"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L83",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:83"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"parsing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parsing"}},[t._v("#")]),t._v(" parsing")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("parsing")]),t._v(": "),e("code",[t._v("false")]),t._v(" | { "),e("code",[t._v("[key: string]")]),t._v(": "),e("code",[t._v("string")]),t._v("; }")]),t._v(" "),e("p",[t._v("How to parse the dataset. The parsing can be disabled by specifying parsing: false at chart options or dataset. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally.")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-19"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-19"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#parsing"}},[t._v("parsing")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-25"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-25"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L54",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:54"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"pointstyle"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pointstyle"}},[t._v("#")]),t._v(" pointStyle")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("pointStyle")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#pointstyle"}},[e("code",[t._v("PointStyle")])])],1),t._v(" "),e("p",[t._v("Point style for the legend")]),t._v(" "),e("p",[e("strong",[e("code",[t._v("Default")])])]),t._v(" "),e("p",[t._v("'circle;")]),t._v(" "),e("h4",{attrs:{id:"defined-in-26"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-26"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L140",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:140"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stack"}},[t._v("#")]),t._v(" stack")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("stack")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the group to which this dataset belongs to (when stacked, each group will be a separate stack).")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-20"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-20"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html"}},[t._v("ControllerDatasetOptions")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/ControllerDatasetOptions.html#stack"}},[t._v("stack")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-27"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-27"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L88",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:88"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"transitions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transitions"}},[t._v("#")]),t._v(" transitions")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("transitions")]),t._v(": "),e("RouterLink",{attrs:{to:"/api/#transitionsspec"}},[e("code",[t._v("TransitionsSpec")])]),t._v("<"),e("code",[t._v('"bar"')]),t._v(">")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-21"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-21"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("AnimationOptions.transitions")]),t._v(" "),e("h4",{attrs:{id:"defined-in-28"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-28"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1758",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1758"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"xaxisid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#xaxisid"}},[t._v("#")]),t._v(" xAxisID")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("xAxisID")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the x axis to plot this dataset on.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-29"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-29"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L104",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:104"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"yaxisid"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#yaxisid"}},[t._v("#")]),t._v(" yAxisID")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("yAxisID")]),t._v(": "),e("code",[t._v("string")])]),t._v(" "),e("p",[t._v("The ID of the y axis to plot this dataset on.")]),t._v(" "),e("h4",{attrs:{id:"defined-in-30"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-30"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L108",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:108"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/36.1cbad30b.js b/docs/master/assets/js/36.1f97903d.js similarity index 96% rename from docs/master/assets/js/36.1cbad30b.js rename to docs/master/assets/js/36.1f97903d.js index 2df83cea77..5a0d404a90 100644 --- a/docs/master/assets/js/36.1cbad30b.js +++ b/docs/master/assets/js/36.1f97903d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{368:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-barelement-t-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-barelement-t-o"}},[t._v("#")]),t._v(" Interface: BarElement")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[e("code",[t._v("BarProps")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[e("code",[t._v("BarProps")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("O")]),t._v(">")])]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[e("code",[t._v("VisualElement")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("BarElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v(", "),e("code",[t._v("area?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("area?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1796",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1796"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#getcenterpoint"}},[t._v("getCenterPoint")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1800",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1800"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("code",[t._v("T")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getrange"}},[t._v("#")]),t._v(" getRange")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getRange")]),t._v("("),e("code",[t._v("axis")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("axis")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#getrange"}},[t._v("getRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1801",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1801"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#inrange"}},[t._v("inRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1797",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1797"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inxrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inxrange"}},[t._v("#")]),t._v(" inXRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inXRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#inxrange"}},[t._v("inXRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1798",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1798"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inyrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inyrange"}},[t._v("#")]),t._v(" inYRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inYRange")]),t._v("("),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#inyrange"}},[t._v("inYRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1799",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1799"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{367:function(t,e,a){"use strict";a.r(e);var r=a(3),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-barelement-t-o"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-barelement-t-o"}},[t._v("#")]),t._v(" Interface: BarElement")]),t._v(" "),e("h2",{attrs:{id:"type-parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("T")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[e("code",[t._v("BarProps")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/BarProps.html"}},[e("code",[t._v("BarProps")])])],1)]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("O")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])]),t._v(" = "),e("RouterLink",{attrs:{to:"/api/interfaces/BarOptions.html"}},[e("code",[t._v("BarOptions")])])],1)])])]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("code",[t._v("default")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("O")]),t._v(">")])]),t._v(" "),e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[e("code",[t._v("VisualElement")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("BarElement")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"animations"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#animations"}},[t._v("#")]),t._v(" $animations")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("$animations")]),t._v(": "),e("code",[t._v("Record")]),t._v("")],1),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.$animations")]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L15",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:15"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"active"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#active"}},[t._v("#")]),t._v(" active")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("active")]),t._v(": "),e("code",[t._v("boolean")]),t._v(" = "),e("code",[t._v("false")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.active")]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L13",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:13"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"options"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#options"}},[t._v("#")]),t._v(" options")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("options")]),t._v(": "),e("code",[t._v("O")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.options")]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L14",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:14"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-4"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.x")]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-5"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.y")]),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:12"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"methods"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#methods"}},[t._v("#")]),t._v(" Methods")]),t._v(" "),e("h3",{attrs:{id:"draw"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#draw"}},[t._v("#")]),t._v(" draw")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("draw")]),t._v("("),e("code",[t._v("ctx")]),t._v(", "),e("code",[t._v("area?")]),t._v("): "),e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"parameters"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("ctx")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("CanvasRenderingContext2D")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("area?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("RouterLink",{attrs:{to:"/api/interfaces/ChartArea.html"}},[e("code",[t._v("ChartArea")])])],1)])])]),t._v(" "),e("h4",{attrs:{id:"returns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("void")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-6"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#draw"}},[t._v("draw")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1796",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1796"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getcenterpoint"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getcenterpoint"}},[t._v("#")]),t._v(" getCenterPoint")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getCenterPoint")]),t._v("("),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-2"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-7"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#getcenterpoint"}},[t._v("getCenterPoint")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1800",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1800"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getprops"}},[t._v("#")]),t._v(" getProps")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("p",[t._v("Gets the current or final value of each prop. Can return extra properties (whole object).")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-2"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends keyof "),e("code",[t._v("T")]),t._v("[]")])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("properties to get")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("get the final value (animation target)")])])])]),t._v(" "),e("h4",{attrs:{id:"returns-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-3"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Pick")]),t._v("<"),e("code",[t._v("T")]),t._v(", "),e("code",[t._v("P")]),t._v("["),e("code",[t._v("number")]),t._v("]>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-8"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-8"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L31",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:31"),e("OutboundLink")],1)]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("getProps")]),t._v("<"),e("code",[t._v("P")]),t._v(">("),e("code",[t._v("props")]),t._v(", "),e("code",[t._v("final?")]),t._v("): "),e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"type-parameters-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#type-parameters-3"}},[t._v("#")]),t._v(" Type parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[t._v("extends "),e("code",[t._v("string")])])])])]),t._v(" "),e("h4",{attrs:{id:"parameters-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("props")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("P")]),t._v("[]")])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("final?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-4"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("Partial")]),t._v("<"),e("code",[t._v("Record")]),t._v("<"),e("code",[t._v("P")]),t._v(", "),e("code",[t._v("unknown")]),t._v(">>")]),t._v(" "),e("h4",{attrs:{id:"inherited-from-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-9"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.getProps")]),t._v(" "),e("h4",{attrs:{id:"defined-in-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-9"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L32",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:32"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"getrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getrange"}},[t._v("#")]),t._v(" getRange")]),t._v(" "),e("p",[t._v("▸ "),e("code",[t._v("Optional")]),t._v(" "),e("strong",[t._v("getRange")]),t._v("("),e("code",[t._v("axis")]),t._v("): "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"parameters-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("axis")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v('"x"')]),t._v(" | "),e("code",[t._v('"y"')])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-5"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-10"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#getrange"}},[t._v("getRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-10"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1801",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1801"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"hasvalue"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hasvalue"}},[t._v("#")]),t._v(" hasValue")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("hasValue")]),t._v("(): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"returns-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-6"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-11"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.hasValue")]),t._v(" "),e("h4",{attrs:{id:"defined-in-11"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-11"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L22",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:22"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inrange"}},[t._v("#")]),t._v(" inRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-7"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-12"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#inrange"}},[t._v("inRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-12"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-12"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1797",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1797"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inxrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inxrange"}},[t._v("#")]),t._v(" inXRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inXRange")]),t._v("("),e("code",[t._v("mouseX")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-7"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseX")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-8"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-13"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#inxrange"}},[t._v("inXRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-13"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-13"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1798",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1798"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"inyrange"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inyrange"}},[t._v("#")]),t._v(" inYRange")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("inYRange")]),t._v("("),e("code",[t._v("mouseY")]),t._v(", "),e("code",[t._v("useFinalPosition?")]),t._v("): "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"parameters-8"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("mouseY")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("number")])])]),t._v(" "),e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition?")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-9"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-14"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html"}},[t._v("VisualElement")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/VisualElement.html#inyrange"}},[t._v("inYRange")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-14"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-14"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1799",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:1799"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"tooltipposition"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#tooltipposition"}},[t._v("#")]),t._v(" tooltipPosition")]),t._v(" "),e("p",[t._v("▸ "),e("strong",[t._v("tooltipPosition")]),t._v("("),e("code",[t._v("useFinalPosition")]),t._v("): "),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"parameters-9"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#parameters-9"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",{staticStyle:{"text-align":"left"}},[t._v("Name")]),t._v(" "),e("th",{staticStyle:{"text-align":"left"}},[t._v("Type")])])]),t._v(" "),e("tbody",[e("tr",[e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("useFinalPosition")])]),t._v(" "),e("td",{staticStyle:{"text-align":"left"}},[e("code",[t._v("boolean")])])])])]),t._v(" "),e("h4",{attrs:{id:"returns-10"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#returns-10"}},[t._v("#")]),t._v(" Returns")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("h4",{attrs:{id:"inherited-from-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-15"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[t._v("Element.tooltipPosition")]),t._v(" "),e("h4",{attrs:{id:"defined-in-15"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-15"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/core/core.element.ts#L17",target:"_blank",rel:"noopener noreferrer"}},[t._v("core/core.element.ts:17"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/37.686f2682.js b/docs/master/assets/js/37.ef2ff6bb.js similarity index 93% rename from docs/master/assets/js/37.686f2682.js rename to docs/master/assets/js/37.ef2ff6bb.js index 7d2055accc..3eeea97bdf 100644 --- a/docs/master/assets/js/37.686f2682.js +++ b/docs/master/assets/js/37.ef2ff6bb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{370:function(r,t,e){"use strict";e.r(t);var o=e(3),a=Object(o.a)({},(function(){var r=this,t=r._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"interface-barhoveroptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interface-barhoveroptions"}},[r._v("#")]),r._v(" Interface: BarHoverOptions")]),r._v(" "),t("h2",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),t("ul",[t("li",[t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[t("code",[r._v("CommonHoverOptions")])])],1),r._v(" "),t("p",[r._v("↳ "),t("strong",[t("code",[r._v("BarHoverOptions")])])])])]),r._v(" "),t("h2",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),t("h3",{attrs:{id:"hoverbackgroundcolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[r._v("#")]),r._v(" hoverBackgroundColor")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBackgroundColor")]),r._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[r._v("Color")])])],1),r._v(" "),t("h4",{attrs:{id:"inherited-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbackgroundcolor"}},[r._v("hoverBackgroundColor")])],1),r._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1813"),t("OutboundLink")],1)]),r._v(" "),t("hr"),r._v(" "),t("h3",{attrs:{id:"hoverbordercolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[r._v("#")]),r._v(" hoverBorderColor")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBorderColor")]),r._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[r._v("Color")])])],1),r._v(" "),t("h4",{attrs:{id:"inherited-from-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbordercolor"}},[r._v("hoverBorderColor")])],1),r._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1812"),t("OutboundLink")],1)]),r._v(" "),t("hr"),r._v(" "),t("h3",{attrs:{id:"hoverborderradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderradius"}},[r._v("#")]),r._v(" hoverBorderRadius")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBorderRadius")]),r._v(": "),t("code",[r._v("number")]),r._v(" | "),t("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[t("code",[r._v("BorderRadius")])])],1),r._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2116",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2116"),t("OutboundLink")],1)]),r._v(" "),t("hr"),r._v(" "),t("h3",{attrs:{id:"hoverborderwidth"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[r._v("#")]),r._v(" hoverBorderWidth")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBorderWidth")]),r._v(": "),t("code",[r._v("number")])]),r._v(" "),t("h4",{attrs:{id:"inherited-from-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverborderwidth"}},[r._v("hoverBorderWidth")])],1),r._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1811"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[37],{368:function(r,t,e){"use strict";e.r(t);var o=e(3),a=Object(o.a)({},(function(){var r=this,t=r._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":r.$parent.slotKey}},[t("h1",{attrs:{id:"interface-barhoveroptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interface-barhoveroptions"}},[r._v("#")]),r._v(" Interface: BarHoverOptions")]),r._v(" "),t("h2",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[r._v("#")]),r._v(" Hierarchy")]),r._v(" "),t("ul",[t("li",[t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[t("code",[r._v("CommonHoverOptions")])])],1),r._v(" "),t("p",[r._v("↳ "),t("strong",[t("code",[r._v("BarHoverOptions")])])])])]),r._v(" "),t("h2",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[r._v("#")]),r._v(" Properties")]),r._v(" "),t("h3",{attrs:{id:"hoverbackgroundcolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverbackgroundcolor"}},[r._v("#")]),r._v(" hoverBackgroundColor")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBackgroundColor")]),r._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[r._v("Color")])])],1),r._v(" "),t("h4",{attrs:{id:"inherited-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbackgroundcolor"}},[r._v("hoverBackgroundColor")])],1),r._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1813",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1813"),t("OutboundLink")],1)]),r._v(" "),t("hr"),r._v(" "),t("h3",{attrs:{id:"hoverbordercolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverbordercolor"}},[r._v("#")]),r._v(" hoverBorderColor")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBorderColor")]),r._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[r._v("Color")])])],1),r._v(" "),t("h4",{attrs:{id:"inherited-from-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverbordercolor"}},[r._v("hoverBorderColor")])],1),r._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1812",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1812"),t("OutboundLink")],1)]),r._v(" "),t("hr"),r._v(" "),t("h3",{attrs:{id:"hoverborderradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderradius"}},[r._v("#")]),r._v(" hoverBorderRadius")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBorderRadius")]),r._v(": "),t("code",[r._v("number")]),r._v(" | "),t("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[t("code",[r._v("BorderRadius")])])],1),r._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2116",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:2116"),t("OutboundLink")],1)]),r._v(" "),t("hr"),r._v(" "),t("h3",{attrs:{id:"hoverborderwidth"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hoverborderwidth"}},[r._v("#")]),r._v(" hoverBorderWidth")]),r._v(" "),t("p",[r._v("• "),t("strong",[r._v("hoverBorderWidth")]),r._v(": "),t("code",[r._v("number")])]),r._v(" "),t("h4",{attrs:{id:"inherited-from-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-3"}},[r._v("#")]),r._v(" Inherited from")]),r._v(" "),t("p",[t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html"}},[r._v("CommonHoverOptions")]),r._v("."),t("RouterLink",{attrs:{to:"/api/interfaces/CommonHoverOptions.html#hoverborderwidth"}},[r._v("hoverBorderWidth")])],1),r._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[r._v("#")]),r._v(" Defined in")]),r._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1811",target:"_blank",rel:"noopener noreferrer"}},[r._v("types/index.d.ts:1811"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/38.c367d73d.js b/docs/master/assets/js/38.e2f00c47.js similarity index 92% rename from docs/master/assets/js/38.c367d73d.js rename to docs/master/assets/js/38.e2f00c47.js index 5eb3815891..25af8d04f4 100644 --- a/docs/master/assets/js/38.c367d73d.js +++ b/docs/master/assets/js/38.e2f00c47.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{371:function(e,t,r){"use strict";r.r(t);var a=r(3),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"interface-baroptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interface-baroptions"}},[e._v("#")]),e._v(" Interface: BarOptions")]),e._v(" "),t("h2",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),t("ul",[t("li",[t("p",[t("code",[e._v("Omit")]),e._v("<"),t("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[t("code",[e._v("CommonElementOptions")])]),e._v(", "),t("code",[e._v('"borderWidth"')]),e._v(">")],1),e._v(" "),t("p",[e._v("↳ "),t("strong",[t("code",[e._v("BarOptions")])])])])]),e._v(" "),t("h2",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),t("h3",{attrs:{id:"backgroundcolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[e._v("#")]),e._v(" backgroundColor")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("backgroundColor")]),e._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("h4",{attrs:{id:"inherited-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[e._v("Omit.backgroundColor")]),e._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1807"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"base"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#base"}},[e._v("#")]),e._v(" base")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("base")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("p",[e._v("The base value for the bar in data units along the value axis.")]),e._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2080",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2080"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"bordercolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[e._v("#")]),e._v(" borderColor")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderColor")]),e._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("h4",{attrs:{id:"inherited-from-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[e._v("Omit.borderColor")]),e._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1806"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"borderradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[e._v("#")]),e._v(" borderRadius")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderRadius")]),e._v(": "),t("code",[e._v("number")]),e._v(" | "),t("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[t("code",[e._v("BorderRadius")])])],1),e._v(" "),t("p",[e._v("Border radius")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("0")]),e._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2092",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2092"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"borderskipped"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#borderskipped"}},[e._v("#")]),e._v(" borderSkipped")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderSkipped")]),e._v(": "),t("code",[e._v("boolean")]),e._v(" | "),t("code",[e._v('"end"')]),e._v(" | "),t("code",[e._v('"start"')]),e._v(" | "),t("code",[e._v('"left"')]),e._v(" | "),t("code",[e._v('"top"')]),e._v(" | "),t("code",[e._v('"bottom"')]),e._v(" | "),t("code",[e._v('"right"')]),e._v(" | "),t("code",[e._v('"middle"')])]),e._v(" "),t("p",[e._v("Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("'start'")]),e._v(" "),t("h4",{attrs:{id:"defined-in-5"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2086"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"borderwidth"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[e._v("#")]),e._v(" borderWidth")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderWidth")]),e._v(": "),t("code",[e._v("number")]),e._v(" | { "),t("code",[e._v("bottom?")]),e._v(": "),t("code",[e._v("number")]),e._v(" ; "),t("code",[e._v("left?")]),e._v(": "),t("code",[e._v("number")]),e._v(" ; "),t("code",[e._v("right?")]),e._v(": "),t("code",[e._v("number")]),e._v(" ; "),t("code",[e._v("top?")]),e._v(": "),t("code",[e._v("number")]),e._v(" }")]),e._v(" "),t("p",[e._v("Width of the border, number for all sides, object to specify width for each side specifically")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("0")]),e._v(" "),t("h4",{attrs:{id:"defined-in-6"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2105",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2105"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"inflateamount"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inflateamount"}},[e._v("#")]),e._v(" inflateAmount")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("inflateAmount")]),e._v(": "),t("code",[e._v("number")]),e._v(" | "),t("code",[e._v('"auto"')])]),e._v(" "),t("p",[e._v("Amount to inflate the rectangle(s). This can be used to hide artifacts between bars.\nUnit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("'auto'")]),e._v(" "),t("h4",{attrs:{id:"defined-in-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2099",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2099"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[38],{370:function(e,t,r){"use strict";r.r(t);var a=r(3),s=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"interface-baroptions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#interface-baroptions"}},[e._v("#")]),e._v(" Interface: BarOptions")]),e._v(" "),t("h2",{attrs:{id:"hierarchy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[e._v("#")]),e._v(" Hierarchy")]),e._v(" "),t("ul",[t("li",[t("p",[t("code",[e._v("Omit")]),e._v("<"),t("RouterLink",{attrs:{to:"/api/interfaces/CommonElementOptions.html"}},[t("code",[e._v("CommonElementOptions")])]),e._v(", "),t("code",[e._v('"borderWidth"')]),e._v(">")],1),e._v(" "),t("p",[e._v("↳ "),t("strong",[t("code",[e._v("BarOptions")])])])])]),e._v(" "),t("h2",{attrs:{id:"properties"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[e._v("#")]),e._v(" Properties")]),e._v(" "),t("h3",{attrs:{id:"backgroundcolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#backgroundcolor"}},[e._v("#")]),e._v(" backgroundColor")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("backgroundColor")]),e._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("h4",{attrs:{id:"inherited-from"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[e._v("Omit.backgroundColor")]),e._v(" "),t("h4",{attrs:{id:"defined-in"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1807",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1807"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"base"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#base"}},[e._v("#")]),e._v(" base")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("base")]),e._v(": "),t("code",[e._v("number")])]),e._v(" "),t("p",[e._v("The base value for the bar in data units along the value axis.")]),e._v(" "),t("h4",{attrs:{id:"defined-in-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2080",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2080"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"bordercolor"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bordercolor"}},[e._v("#")]),e._v(" borderColor")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderColor")]),e._v(": "),t("RouterLink",{attrs:{to:"/api/#color"}},[t("code",[e._v("Color")])])],1),e._v(" "),t("h4",{attrs:{id:"inherited-from-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[e._v("#")]),e._v(" Inherited from")]),e._v(" "),t("p",[e._v("Omit.borderColor")]),e._v(" "),t("h4",{attrs:{id:"defined-in-3"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L1806",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:1806"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"borderradius"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#borderradius"}},[e._v("#")]),e._v(" borderRadius")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderRadius")]),e._v(": "),t("code",[e._v("number")]),e._v(" | "),t("RouterLink",{attrs:{to:"/api/interfaces/BorderRadius.html"}},[t("code",[e._v("BorderRadius")])])],1),e._v(" "),t("p",[e._v("Border radius")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("0")]),e._v(" "),t("h4",{attrs:{id:"defined-in-4"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2092",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2092"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"borderskipped"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#borderskipped"}},[e._v("#")]),e._v(" borderSkipped")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderSkipped")]),e._v(": "),t("code",[e._v("boolean")]),e._v(" | "),t("code",[e._v('"end"')]),e._v(" | "),t("code",[e._v('"start"')]),e._v(" | "),t("code",[e._v('"left"')]),e._v(" | "),t("code",[e._v('"top"')]),e._v(" | "),t("code",[e._v('"bottom"')]),e._v(" | "),t("code",[e._v('"right"')]),e._v(" | "),t("code",[e._v('"middle"')])]),e._v(" "),t("p",[e._v("Skipped (excluded) border: 'start', 'end', 'left', 'right', 'bottom', 'top', 'middle', false (none) or true (all).")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("'start'")]),e._v(" "),t("h4",{attrs:{id:"defined-in-5"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2086",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2086"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"borderwidth"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#borderwidth"}},[e._v("#")]),e._v(" borderWidth")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("borderWidth")]),e._v(": "),t("code",[e._v("number")]),e._v(" | { "),t("code",[e._v("bottom?")]),e._v(": "),t("code",[e._v("number")]),e._v(" ; "),t("code",[e._v("left?")]),e._v(": "),t("code",[e._v("number")]),e._v(" ; "),t("code",[e._v("right?")]),e._v(": "),t("code",[e._v("number")]),e._v(" ; "),t("code",[e._v("top?")]),e._v(": "),t("code",[e._v("number")]),e._v(" }")]),e._v(" "),t("p",[e._v("Width of the border, number for all sides, object to specify width for each side specifically")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("0")]),e._v(" "),t("h4",{attrs:{id:"defined-in-6"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2105",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2105"),t("OutboundLink")],1)]),e._v(" "),t("hr"),e._v(" "),t("h3",{attrs:{id:"inflateamount"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#inflateamount"}},[e._v("#")]),e._v(" inflateAmount")]),e._v(" "),t("p",[e._v("• "),t("strong",[e._v("inflateAmount")]),e._v(": "),t("code",[e._v("number")]),e._v(" | "),t("code",[e._v('"auto"')])]),e._v(" "),t("p",[e._v("Amount to inflate the rectangle(s). This can be used to hide artifacts between bars.\nUnit is pixels. 'auto' translates to 0.33 pixels when barPercentage * categoryPercentage is 1, else 0.")]),e._v(" "),t("p",[t("strong",[t("code",[e._v("Default")])])]),e._v(" "),t("p",[e._v("'auto'")]),e._v(" "),t("h4",{attrs:{id:"defined-in-7"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-7"}},[e._v("#")]),e._v(" Defined in")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2099",target:"_blank",rel:"noopener noreferrer"}},[e._v("types/index.d.ts:2099"),t("OutboundLink")],1)])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/39.6906e433.js b/docs/master/assets/js/39.6906e433.js deleted file mode 100644 index 9754bc76da..0000000000 --- a/docs/master/assets/js/39.6906e433.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{372:function(t,e,r){"use strict";r.r(e);var a=r(3),s=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"interface-barprops"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#interface-barprops"}},[t._v("#")]),t._v(" Interface: BarProps")]),t._v(" "),e("h2",{attrs:{id:"hierarchy"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),e("ul",[e("li",[e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[e("code",[t._v("Point")])])],1),t._v(" "),e("p",[t._v("↳ "),e("strong",[e("code",[t._v("BarProps")])])])])]),t._v(" "),e("h2",{attrs:{id:"properties"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),e("h3",{attrs:{id:"base"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#base"}},[t._v("#")]),t._v(" base")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("base")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2070",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2070"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"height"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("height")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2073",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2073"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"horizontal"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#horizontal"}},[t._v("#")]),t._v(" horizontal")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("horizontal")]),t._v(": "),e("code",[t._v("boolean")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2071",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2071"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"width"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("width")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"defined-in-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/index.d.ts#L2072",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2072"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"x"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("x")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html#x"}},[t._v("x")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/geometric.d.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:11"),e("OutboundLink")],1)]),t._v(" "),e("hr"),t._v(" "),e("h3",{attrs:{id:"y"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),e("p",[t._v("• "),e("strong",[t._v("y")]),t._v(": "),e("code",[t._v("number")])]),t._v(" "),e("h4",{attrs:{id:"inherited-from-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),e("RouterLink",{attrs:{to:"/api/interfaces/Point.html#y"}},[t._v("y")])],1),t._v(" "),e("h4",{attrs:{id:"defined-in-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),e("p",[e("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/fcdecf1/src/types/geometric.d.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:12"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/39.97940c56.js b/docs/master/assets/js/39.97940c56.js new file mode 100644 index 0000000000..cb1b5f500a --- /dev/null +++ b/docs/master/assets/js/39.97940c56.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[39],{371:function(t,r,e){"use strict";e.r(r);var a=e(3),s=Object(a.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("h1",{attrs:{id:"interface-barprops"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#interface-barprops"}},[t._v("#")]),t._v(" Interface: BarProps")]),t._v(" "),r("h2",{attrs:{id:"hierarchy"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#hierarchy"}},[t._v("#")]),t._v(" Hierarchy")]),t._v(" "),r("ul",[r("li",[r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[r("code",[t._v("Point")])])],1),t._v(" "),r("p",[t._v("↳ "),r("strong",[r("code",[t._v("BarProps")])])])])]),t._v(" "),r("h2",{attrs:{id:"properties"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#properties"}},[t._v("#")]),t._v(" Properties")]),t._v(" "),r("h3",{attrs:{id:"base"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#base"}},[t._v("#")]),t._v(" base")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("base")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2070",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2070"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"height"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#height"}},[t._v("#")]),t._v(" height")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("height")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-2"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2073",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2073"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"horizontal"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#horizontal"}},[t._v("#")]),t._v(" horizontal")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("horizontal")]),t._v(": "),r("code",[t._v("boolean")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-3"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-3"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2071",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2071"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"width"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#width"}},[t._v("#")]),t._v(" width")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("width")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"defined-in-4"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-4"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/index.d.ts#L2072",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/index.d.ts:2072"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"x"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#x"}},[t._v("#")]),t._v(" x")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("x")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"inherited-from"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/Point.html#x"}},[t._v("x")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-5"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-5"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/geometric.d.ts#L11",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:11"),r("OutboundLink")],1)]),t._v(" "),r("hr"),t._v(" "),r("h3",{attrs:{id:"y"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#y"}},[t._v("#")]),t._v(" y")]),t._v(" "),r("p",[t._v("• "),r("strong",[t._v("y")]),t._v(": "),r("code",[t._v("number")])]),t._v(" "),r("h4",{attrs:{id:"inherited-from-2"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#inherited-from-2"}},[t._v("#")]),t._v(" Inherited from")]),t._v(" "),r("p",[r("RouterLink",{attrs:{to:"/api/interfaces/Point.html"}},[t._v("Point")]),t._v("."),r("RouterLink",{attrs:{to:"/api/interfaces/Point.html#y"}},[t._v("y")])],1),t._v(" "),r("h4",{attrs:{id:"defined-in-6"}},[r("a",{staticClass:"header-anchor",attrs:{href:"#defined-in-6"}},[t._v("#")]),t._v(" Defined in")]),t._v(" "),r("p",[r("a",{attrs:{href:"https://github.com/chartjs/Chart.js/blob/df7f1c2/src/types/geometric.d.ts#L12",target:"_blank",rel:"noopener noreferrer"}},[t._v("types/geometric.d.ts:12"),r("OutboundLink")],1)])])}),[],!1,null,null,null);r.default=s.exports}}]); \ No newline at end of file diff --git a/docs/master/assets/js/4.c24365a6.js b/docs/master/assets/js/4.f3c6f484.js similarity index 99% rename from docs/master/assets/js/4.c24365a6.js rename to docs/master/assets/js/4.f3c6f484.js index 0621af42ce..9a7c7615fd 100644 --- a/docs/master/assets/js/4.c24365a6.js +++ b/docs/master/assets/js/4.f3c6f484.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[4],{285:function(t,s,a){t.exports=a.p+"assets/img/usage-8.edada047.png"},320:function(t,s,a){t.exports=a.p+"assets/img/usage-1.be7a12cd.png"},321:function(t,s,a){t.exports=a.p+"assets/img/usage-2.9f9eb8e8.png"},322:function(t,s,a){t.exports=a.p+"assets/img/usage-3.79b809ec.png"},323:function(t,s,a){t.exports=a.p+"assets/img/usage-4.4b71a56b.png"},324:function(t,s,a){t.exports=a.p+"assets/img/usage-5.1afc4df3.png"},325:function(t,s,a){t.exports=a.p+"assets/img/usage-6.b8ef8212.png"},326:function(t,s,a){t.exports=a.p+"assets/img/usage-7.cbe1e4ed.png"},518:function(t,s,a){"use strict";a.r(s);var n=a(3),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"step-by-step-guide"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#step-by-step-guide"}},[t._v("#")]),t._v(" Step-by-step guide")]),t._v(" "),s("p",[t._v("Follow this guide to get familiar with all major concepts of Chart.js: chart types and elements, datasets, customization, plugins, components, and tree-shaking. Don't hesitate to follow the links in the text.")]),t._v(" "),s("p",[t._v("We'll build a Chart.js data visualization with a couple of charts from scratch:")]),t._v(" "),s("p",[s("img",{attrs:{src:a(285),alt:"result"}})]),t._v(" "),s("h2",{attrs:{id:"build-a-new-application-with-chart-js"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#build-a-new-application-with-chart-js"}},[t._v("#")]),t._v(" Build a new application with Chart.js")]),t._v(" "),s("p",[t._v("In a new folder, create the "),s("code",[t._v("package.json")]),t._v(" file with the following contents:")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"chartjs-example"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"version"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.0.0"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"license"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"MIT"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scripts"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dev"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"parcel src/index.html"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"build"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"parcel build src/index.html"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"devDependencies"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"parcel"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"^2.6.2"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"dependencies"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"@cubejs-client/core"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"^0.31.0"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"chart.js"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"^4.0.0"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Modern front-end applications often use JavaScript module bundlers, so we’ve picked "),s("a",{attrs:{href:"https://parceljs.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("Parcel"),s("OutboundLink")],1),t._v(" as a nice zero-configuration build tool. We’re also installing Chart.js v4 and a JavaScript client for "),s("a",{attrs:{href:"https://cube.dev/?ref=eco-chartjs",target:"_blank",rel:"noopener noreferrer"}},[t._v("Cube"),s("OutboundLink")],1),t._v(", an open-source API for data apps we’ll use to fetch real-world data (more on that later).")]),t._v(" "),s("p",[t._v("Run "),s("code",[t._v("npm install")]),t._v(", "),s("code",[t._v("yarn install")]),t._v(", or "),s("code",[t._v("pnpm install")]),t._v(" to install the dependencies, then create the "),s("code",[t._v("src")]),t._v(" folder. Inside that folder, we’ll need a very simple "),s("code",[t._v("index.html")]),t._v(" file:")]),t._v(" "),s("div",{staticClass:"language-html extra-class"},[s("pre",{pre:!0,attrs:{class:"language-html"}},[s("code",[s("span",{pre:!0,attrs:{class:"token doctype"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("html")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("lang")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("en"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("head")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("title")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("Chart.js example"),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("body")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v('\x3c!--

--\x3e')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("div")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token special-attr"}},[s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("style")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),s("span",{pre:!0,attrs:{class:"token value css language-css"}},[s("span",{pre:!0,attrs:{class:"token property"}},[t._v("width")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(":")]),t._v(" 800px"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("<")]),t._v("canvas")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token attr-name"}},[t._v("id")]),s("span",{pre:!0,attrs:{class:"token attr-value"}},[s("span",{pre:!0,attrs:{class:"token punctuation attr-equals"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')]),t._v("acquisitions"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v('"')])]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(">")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token tag"}},[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("")])]),t._v("\n\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v('\x3c!-- + (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Common options to all axes

Namespace: options.scales[scaleId]

Name Type Default Description
type string Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.
alignToPixels boolean false Align pixel values to device pixels.
backgroundColor Color Background color of the scale area.
border object Border configuration. more...
display boolean|string true Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.
grid object Grid line configuration. more...
min number User defined minimum number for the scale, overrides minimum value from data. more...
max number User defined maximum number for the scale, overrides maximum value from data. more...
reverse boolean false Reverse the scale.
stacked boolean|string false Should the data be stacked. more...
suggestedMax number Adjustment used when calculating the maximum data value. more...
suggestedMin number Adjustment used when calculating the minimum data value. more...
ticks object Tick configuration. more...
weight number 0 The weight used to sort the axis. Higher weights are further away from the chart area.
Last Updated: 2/4/2024, 6:43:48 PM
+ diff --git a/docs/master/axes/_common_ticks.html b/docs/master/axes/_common_ticks.html index 5464dbcf2d..52b8393f4f 100644 --- a/docs/master/axes/_common_ticks.html +++ b/docs/master/axes/_common_ticks.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Common tick options to all axes

Namespace: options.scales[scaleId].ticks

Name Type Scriptable Default Description
backdropColor Color Yes 'rgba(255, 255, 255, 0.75)' Color of label backdrops.
backdropPadding Padding 2 Padding of label backdrop.
callback function Returns the string representation of the tick value as it should be displayed on the chart. See callback.
display boolean true If true, show tick labels.
color Color Yes Chart.defaults.color Color of ticks.
font Font Yes Chart.defaults.font See Fonts
major object {} Major ticks configuration.
padding number 3 Sets the offset of the tick labels from the axis
showLabelBackdrop boolean Yes true for radial scale, false otherwise If true, draw a background behind the tick labels.
textStrokeColor Color Yes `` The color of the stroke around the text.
textStrokeWidth number Yes 0 Stroke width around the text.
z number 0 z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.
Last Updated: 1/9/2024, 4:24:43 PM
- + (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Common tick options to all axes

Namespace: options.scales[scaleId].ticks

Name Type Scriptable Default Description
backdropColor Color Yes 'rgba(255, 255, 255, 0.75)' Color of label backdrops.
backdropPadding Padding 2 Padding of label backdrop.
callback function Returns the string representation of the tick value as it should be displayed on the chart. See callback.
display boolean true If true, show tick labels.
color Color Yes Chart.defaults.color Color of ticks.
font Font Yes Chart.defaults.font See Fonts
major object {} Major ticks configuration.
padding number 3 Sets the offset of the tick labels from the axis
showLabelBackdrop boolean Yes true for radial scale, false otherwise If true, draw a background behind the tick labels.
textStrokeColor Color Yes `` The color of the stroke around the text.
textStrokeWidth number Yes 0 Stroke width around the text.
z number 0 z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.
Last Updated: 2/4/2024, 6:43:48 PM
+ diff --git a/docs/master/axes/cartesian/_common.html b/docs/master/axes/cartesian/_common.html index eed8dfe00f..e7563a3e90 100644 --- a/docs/master/axes/cartesian/_common.html +++ b/docs/master/axes/cartesian/_common.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Common options to all cartesian axes

Namespace: options.scales[scaleId]

Name Type Default Description
bounds string 'ticks' Determines the scale bounds. more...
clip boolean true If true, clip the dataset drawing against the size of the scale instead of chart area
position string | object Position of the axis. more...
stack string Stack group. Axes at the same position with same stack are stacked.
stackWeight number 1 Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.
axis string Which type of axis this is. Possible values are: 'x', 'y'. If not set, this is inferred from the first character of the ID which should be 'x' or 'y'.
offset boolean false If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.
title object Scale title configuration. more...
Last Updated: 1/9/2024, 4:24:43 PM
- + (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Common options to all cartesian axes

Namespace: options.scales[scaleId]

Name Type Default Description
bounds string 'ticks' Determines the scale bounds. more...
clip boolean true If true, clip the dataset drawing against the size of the scale instead of chart area
position string | object Position of the axis. more...
stack string Stack group. Axes at the same position with same stack are stacked.
stackWeight number 1 Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.
axis string Which type of axis this is. Possible values are: 'x', 'y'. If not set, this is inferred from the first character of the ID which should be 'x' or 'y'.
offset boolean false If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.
title object Scale title configuration. more...
Last Updated: 2/4/2024, 6:43:48 PM
+ diff --git a/docs/master/axes/cartesian/_common_ticks.html b/docs/master/axes/cartesian/_common_ticks.html index 20779eb57e..fdfc28a3a3 100644 --- a/docs/master/axes/cartesian/_common_ticks.html +++ b/docs/master/axes/cartesian/_common_ticks.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Common tick options to all cartesian axes

Namespace: options.scales[scaleId].ticks

Name Type Default Description
align string 'center' The tick alignment along the axis. Can be 'start', 'center', 'end', or 'inner'. inner alignment means align start for first tick and end for the last tick of horizontal axis
crossAlign string 'near' The tick alignment perpendicular to the axis. Can be 'near', 'center', or 'far'. See Tick Alignment
sampleSize number ticks.length The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
autoSkip boolean true If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to maxRotation before skipping any. Turn autoSkip off to show all labels no matter what.
autoSkipPadding number 3 Padding between the ticks on the horizontal axis when autoSkip is enabled.
includeBounds boolean true Should the defined min and max values be presented as ticks even if they are not "nice".
labelOffset number 0 Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). Note: this can cause labels at the edges to be cropped by the edge of the canvas
maxRotation number 50 Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.
minRotation number 0 Minimum rotation for tick labels. Note: Only applicable to horizontal scales.
mirror boolean false Flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.
padding number 0 Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.
maxTicksLimit number 11 Maximum number of ticks and gridlines to show.
Last Updated: 1/9/2024, 4:24:43 PM
- + (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Common tick options to all cartesian axes

Namespace: options.scales[scaleId].ticks

Name Type Default Description
align string 'center' The tick alignment along the axis. Can be 'start', 'center', 'end', or 'inner'. inner alignment means align start for first tick and end for the last tick of horizontal axis
crossAlign string 'near' The tick alignment perpendicular to the axis. Can be 'near', 'center', or 'far'. See Tick Alignment
sampleSize number ticks.length The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
autoSkip boolean true If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to maxRotation before skipping any. Turn autoSkip off to show all labels no matter what.
autoSkipPadding number 3 Padding between the ticks on the horizontal axis when autoSkip is enabled.
includeBounds boolean true Should the defined min and max values be presented as ticks even if they are not "nice".
labelOffset number 0 Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). Note: this can cause labels at the edges to be cropped by the edge of the canvas
maxRotation number 50 Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.
minRotation number 0 Minimum rotation for tick labels. Note: Only applicable to horizontal scales.
mirror boolean false Flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.
padding number 0 Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.
maxTicksLimit number 11 Maximum number of ticks and gridlines to show.
Last Updated: 2/4/2024, 6:43:48 PM
+ diff --git a/docs/master/axes/cartesian/category.html b/docs/master/axes/cartesian/category.html index ae413feabd..e4db43b412 100644 --- a/docs/master/axes/cartesian/category.html +++ b/docs/master/axes/cartesian/category.html @@ -7,7 +7,7 @@ - + @@ -74,7 +74,7 @@ } } }); -

# Internal data format

Internally category scale uses label indices

Last Updated: 1/9/2024, 4:24:43 PM

+

# Internal data format

Internally category scale uses label indices

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/cartesian/index.html b/docs/master/axes/cartesian/index.html index 37d7fcffe0..0570c6bfa6 100644 --- a/docs/master/axes/cartesian/index.html +++ b/docs/master/axes/cartesian/index.html @@ -7,7 +7,7 @@ - + @@ -384,7 +384,7 @@ } } }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/cartesian/linear.html b/docs/master/axes/cartesian/linear.html index 1560c43b82..e96202946a 100644 --- a/docs/master/axes/cartesian/linear.html +++ b/docs/master/axes/cartesian/linear.html @@ -7,7 +7,7 @@ - + @@ -97,7 +97,7 @@ data: [100, -50], backgroundColor: 'rgb(255, 99, 132)' }], -};

# Internal data format

Internally, the linear scale uses numeric data

Last Updated: 1/9/2024, 4:24:43 PM

+};

# Internal data format

Internally, the linear scale uses numeric data

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/cartesian/logarithmic.html b/docs/master/axes/cartesian/logarithmic.html index e210a9eba1..05717ea42d 100644 --- a/docs/master/axes/cartesian/logarithmic.html +++ b/docs/master/axes/cartesian/logarithmic.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Logarithmic Axis

The logarithmic scale is used to chart numerical data. It can be placed on either the x or y-axis. As the name suggests, logarithmic interpolation is used to determine where a value lies on the axis.

# Configuration Options

# Common options to all cartesian axes

Namespace: options.scales[scaleId]

Name Type Default Description
bounds string 'ticks' Determines the scale bounds. more...
clip boolean true If true, clip the dataset drawing against the size of the scale instead of chart area
position string | object Position of the axis. more...
stack string Stack group. Axes at the same position with same stack are stacked.
stackWeight number 1 Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.
axis string Which type of axis this is. Possible values are: 'x', 'y'. If not set, this is inferred from the first character of the ID which should be 'x' or 'y'.
offset boolean false If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.
title object Scale title configuration. more...

# Common options to all axes

Namespace: options.scales[scaleId]

Name Type Default Description
type string Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.
alignToPixels boolean false Align pixel values to device pixels.
backgroundColor Color Background color of the scale area.
border object Border configuration. more...
display boolean|string true Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.
grid object Grid line configuration. more...
min number User defined minimum number for the scale, overrides minimum value from data. more...
max number User defined maximum number for the scale, overrides maximum value from data. more...
reverse boolean false Reverse the scale.
stacked boolean|string false Should the data be stacked. more...
suggestedMax number Adjustment used when calculating the maximum data value. more...
suggestedMin number Adjustment used when calculating the minimum data value. more...
ticks object Tick configuration. more...
weight number 0 The weight used to sort the axis. Higher weights are further away from the chart area.

# Tick Configuration

# Logarithmic Axis specific options

Namespace: options.scales[scaleId].ticks

Name Type Default Description
format object The Intl.NumberFormat (opens new window) options used by the default label formatter

# Common tick options to all cartesian axes

Namespace: options.scales[scaleId].ticks

Name Type Default Description
align string 'center' The tick alignment along the axis. Can be 'start', 'center', 'end', or 'inner'. inner alignment means align start for first tick and end for the last tick of horizontal axis
crossAlign string 'near' The tick alignment perpendicular to the axis. Can be 'near', 'center', or 'far'. See Tick Alignment
sampleSize number ticks.length The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
autoSkip boolean true If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to maxRotation before skipping any. Turn autoSkip off to show all labels no matter what.
autoSkipPadding number 3 Padding between the ticks on the horizontal axis when autoSkip is enabled.
includeBounds boolean true Should the defined min and max values be presented as ticks even if they are not "nice".
labelOffset number 0 Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). Note: this can cause labels at the edges to be cropped by the edge of the canvas
maxRotation number 50 Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.
minRotation number 0 Minimum rotation for tick labels. Note: Only applicable to horizontal scales.
mirror boolean false Flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.
padding number 0 Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.
maxTicksLimit number 11 Maximum number of ticks and gridlines to show.

# Common tick options to all axes

Namespace: options.scales[scaleId].ticks

Name Type Scriptable Default Description
backdropColor Color Yes 'rgba(255, 255, 255, 0.75)' Color of label backdrops.
backdropPadding Padding 2 Padding of label backdrop.
callback function Returns the string representation of the tick value as it should be displayed on the chart. See callback.
display boolean true If true, show tick labels.
color Color Yes Chart.defaults.color Color of ticks.
font Font Yes Chart.defaults.font See Fonts
major object {} Major ticks configuration.
padding number 3 Sets the offset of the tick labels from the axis
showLabelBackdrop boolean Yes true for radial scale, false otherwise If true, draw a background behind the tick labels.
textStrokeColor Color Yes `` The color of the stroke around the text.
textStrokeWidth number Yes 0 Stroke width around the text.
z number 0 z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.

# Internal data format

Internally, the logarithmic scale uses numeric data.

Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

# Logarithmic Axis

The logarithmic scale is used to chart numerical data. It can be placed on either the x or y-axis. As the name suggests, logarithmic interpolation is used to determine where a value lies on the axis.

# Configuration Options

# Common options to all cartesian axes

Namespace: options.scales[scaleId]

Name Type Default Description
bounds string 'ticks' Determines the scale bounds. more...
clip boolean true If true, clip the dataset drawing against the size of the scale instead of chart area
position string | object Position of the axis. more...
stack string Stack group. Axes at the same position with same stack are stacked.
stackWeight number 1 Weight of the scale in stack group. Used to determine the amount of allocated space for the scale within the group.
axis string Which type of axis this is. Possible values are: 'x', 'y'. If not set, this is inferred from the first character of the ID which should be 'x' or 'y'.
offset boolean false If true, extra space is added to the both edges and the axis is scaled to fit into the chart area. This is set to true for a bar chart by default.
title object Scale title configuration. more...

# Common options to all axes

Namespace: options.scales[scaleId]

Name Type Default Description
type string Type of scale being employed. Custom scales can be created and registered with a string key. This allows changing the type of an axis for a chart.
alignToPixels boolean false Align pixel values to device pixels.
backgroundColor Color Background color of the scale area.
border object Border configuration. more...
display boolean|string true Controls the axis global visibility (visible when true, hidden when false). When display: 'auto', the axis is visible only if at least one associated dataset is visible.
grid object Grid line configuration. more...
min number User defined minimum number for the scale, overrides minimum value from data. more...
max number User defined maximum number for the scale, overrides maximum value from data. more...
reverse boolean false Reverse the scale.
stacked boolean|string false Should the data be stacked. more...
suggestedMax number Adjustment used when calculating the maximum data value. more...
suggestedMin number Adjustment used when calculating the minimum data value. more...
ticks object Tick configuration. more...
weight number 0 The weight used to sort the axis. Higher weights are further away from the chart area.

# Tick Configuration

# Logarithmic Axis specific options

Namespace: options.scales[scaleId].ticks

Name Type Default Description
format object The Intl.NumberFormat (opens new window) options used by the default label formatter

# Common tick options to all cartesian axes

Namespace: options.scales[scaleId].ticks

Name Type Default Description
align string 'center' The tick alignment along the axis. Can be 'start', 'center', 'end', or 'inner'. inner alignment means align start for first tick and end for the last tick of horizontal axis
crossAlign string 'near' The tick alignment perpendicular to the axis. Can be 'near', 'center', or 'far'. See Tick Alignment
sampleSize number ticks.length The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length.
autoSkip boolean true If true, automatically calculates how many labels can be shown and hides labels accordingly. Labels will be rotated up to maxRotation before skipping any. Turn autoSkip off to show all labels no matter what.
autoSkipPadding number 3 Padding between the ticks on the horizontal axis when autoSkip is enabled.
includeBounds boolean true Should the defined min and max values be presented as ticks even if they are not "nice".
labelOffset number 0 Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis). Note: this can cause labels at the edges to be cropped by the edge of the canvas
maxRotation number 50 Maximum rotation for tick labels when rotating to condense labels. Note: Rotation doesn't occur until necessary. Note: Only applicable to horizontal scales.
minRotation number 0 Minimum rotation for tick labels. Note: Only applicable to horizontal scales.
mirror boolean false Flips tick labels around axis, displaying the labels inside the chart instead of outside. Note: Only applicable to vertical scales.
padding number 0 Padding between the tick label and the axis. When set on a vertical axis, this applies in the horizontal (X) direction. When set on a horizontal axis, this applies in the vertical (Y) direction.
maxTicksLimit number 11 Maximum number of ticks and gridlines to show.

# Common tick options to all axes

Namespace: options.scales[scaleId].ticks

Name Type Scriptable Default Description
backdropColor Color Yes 'rgba(255, 255, 255, 0.75)' Color of label backdrops.
backdropPadding Padding 2 Padding of label backdrop.
callback function Returns the string representation of the tick value as it should be displayed on the chart. See callback.
display boolean true If true, show tick labels.
color Color Yes Chart.defaults.color Color of ticks.
font Font Yes Chart.defaults.font See Fonts
major object {} Major ticks configuration.
padding number 3 Sets the offset of the tick labels from the axis
showLabelBackdrop boolean Yes true for radial scale, false otherwise If true, draw a background behind the tick labels.
textStrokeColor Color Yes `` The color of the stroke around the text.
textStrokeWidth number Yes 0 Stroke width around the text.
z number 0 z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.

# Internal data format

Internally, the logarithmic scale uses numeric data.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/cartesian/time.html b/docs/master/axes/cartesian/time.html index 25f2b94be8..f55d9e08c0 100644 --- a/docs/master/axes/cartesian/time.html +++ b/docs/master/axes/cartesian/time.html @@ -7,7 +7,7 @@ - + @@ -109,7 +109,7 @@ type: 'logarithmic', bounds: 'ticks' }; -

# Internal data format

Internally time scale uses milliseconds since epoch

Last Updated: 1/9/2024, 4:24:43 PM

+

# Internal data format

Internally time scale uses milliseconds since epoch

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/cartesian/timeseries.html b/docs/master/axes/cartesian/timeseries.html index 40a0e3804d..f6619d424f 100644 --- a/docs/master/axes/cartesian/timeseries.html +++ b/docs/master/axes/cartesian/timeseries.html @@ -7,7 +7,7 @@ - + @@ -50,7 +50,7 @@ } } }); -

# More details

Please see the time scale documentation for all other details.

Last Updated: 1/9/2024, 4:24:43 PM

+

# More details

Please see the time scale documentation for all other details.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/index.html b/docs/master/axes/index.html index 339e333928..1df1caf837 100644 --- a/docs/master/axes/index.html +++ b/docs/master/axes/index.html @@ -7,7 +7,7 @@ - + @@ -110,7 +110,7 @@ });

In contrast to the suggested* settings, the min and max settings set explicit ends to the axes. When these are set, some data points may not be visible.

# Stacking

By default, data is not stacked. If the stacked option of the value scale (y-axis on horizontal chart) is true, positive and negative values are stacked separately. Additionally, a stack option can be defined per dataset to further divide into stack groups more.... For some charts, you might want to stack positive and negative values together. That can be achieved by specifying stacked: 'single'.

# Callbacks

There are a number of config callbacks that can be used to change parameters in the scale at different points in the update process. The options are supplied at the top level of the axis options.

Namespace: options.scales[scaleId]

Name Arguments Description
beforeUpdate axis Callback called before the update process starts.
beforeSetDimensions axis Callback that runs before dimensions are set.
afterSetDimensions axis Callback that runs after dimensions are set.
beforeDataLimits axis Callback that runs before data limits are determined.
afterDataLimits axis Callback that runs after data limits are determined.
beforeBuildTicks axis Callback that runs before ticks are created.
afterBuildTicks axis Callback that runs after ticks are created. Useful for filtering ticks.
beforeTickToLabelConversion axis Callback that runs before ticks are converted into strings.
afterTickToLabelConversion axis Callback that runs after ticks are converted into strings.
beforeCalculateLabelRotation axis Callback that runs before tick rotation is determined.
afterCalculateLabelRotation axis Callback that runs after tick rotation is determined.
beforeFit axis Callback that runs before the scale fits to the canvas.
afterFit axis Callback that runs after the scale fits to the canvas.
afterUpdate axis Callback that runs at the end of the update process.

# Updating Axis Defaults

The default configuration for a scale can be easily changed. All you need to do is set the new options to Chart.defaults.scales[type].

For example, to set the minimum value of 0 for all linear scales, you would do the following. Any linear scales created after this time would now have a minimum of 0.

Chart.defaults.scales.linear.min = 0;
-

# Creating New Axes

To create a new axis, see the developer docs.

Last Updated: 1/9/2024, 4:24:43 PM

+

# Creating New Axes

To create a new axis, see the developer docs.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/labelling.html b/docs/master/axes/labelling.html index 568dc1bae6..27057c5355 100644 --- a/docs/master/axes/labelling.html +++ b/docs/master/axes/labelling.html @@ -7,7 +7,7 @@ - + @@ -58,7 +58,7 @@ });

Keep in mind that overriding ticks.callback means that you are responsible for all formatting of the label. Depending on your use case, you may want to call the default formatter and then modify its output. In the example above, that would look like:

                        // call the default formatter, forwarding `this`
                         return '$' + Chart.Ticks.formatters.numeric.apply(this, [value, index, ticks]);
-

Related samples:

Last Updated: 1/9/2024, 4:24:43 PM

+

Related samples:

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/radial/index.html b/docs/master/axes/radial/index.html index ee90be699e..c99ba5bb70 100644 --- a/docs/master/axes/radial/index.html +++ b/docs/master/axes/radial/index.html @@ -7,7 +7,7 @@ - + @@ -231,7 +231,7 @@ borderWidth: 1, data: [10, 20, 30, 40, 50, 0, 5], }] -};
Last Updated: 1/9/2024, 4:24:43 PM

+};

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/radial/linear.html b/docs/master/axes/radial/linear.html index cc39289434..ae2616bb2a 100644 --- a/docs/master/axes/radial/linear.html +++ b/docs/master/axes/radial/linear.html @@ -7,7 +7,7 @@ - + @@ -72,7 +72,7 @@ };

# Angle Line Options

The following options are used to configure angled lines that radiate from the center of the chart to the point labels. Namespace: options.scales[scaleId].angleLines

Name Type Scriptable Default Description
display boolean true If true, angle lines are shown.
color Color Yes Chart.defaults.borderColor Color of angled lines.
lineWidth number Yes 1 Width of angled lines.
borderDash number[] Yes1 [] Length and spacing of dashes on angled lines. See MDN (opens new window).
borderDashOffset number Yes 0.0 Offset for line dashes. See MDN (opens new window).
  1. the borderDash setting only accepts a static value or a function. Passing an array of arrays is not supported.

The scriptable context is described in Options section.

# Point Label Options

The following options are used to configure the point labels that are shown on the perimeter of the scale. -Namespace: options.scales[scaleId].pointLabels

Name Type Scriptable Default Description
backdropColor Color true undefined Background color of the point label.
backdropPadding Padding 2 Padding of label backdrop.
borderRadius number|object true 0 Border radius of the point label
display boolean|string true If true, point labels are shown. When display: 'auto', the label is hidden if it overlaps with another label.
callback function Callback function to transform data labels to point labels. The default implementation simply returns the current string.
color Color Yes Chart.defaults.color Color of label.
font Font Yes Chart.defaults.font See Fonts
padding number Yes 5 Padding between chart and point labels.
centerPointLabels boolean false If true, point labels are centered.

The scriptable context is described in Options section.

# Internal data format

Internally, the linear radial scale uses numeric data

Last Updated: 1/9/2024, 4:24:43 PM

+Namespace: options.scales[scaleId].pointLabels

Name Type Scriptable Default Description
backdropColor Color true undefined Background color of the point label.
backdropPadding Padding 2 Padding of label backdrop.
borderRadius number|object true 0 Border radius of the point label
display boolean|string true If true, point labels are shown. When display: 'auto', the label is hidden if it overlaps with another label.
callback function Callback function to transform data labels to point labels. The default implementation simply returns the current string.
color Color Yes Chart.defaults.color Color of label.
font Font Yes Chart.defaults.font See Fonts
padding number Yes 5 Padding between chart and point labels.
centerPointLabels boolean false If true, point labels are centered.

The scriptable context is described in Options section.

# Internal data format

Internally, the linear radial scale uses numeric data

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/axes/styling.html b/docs/master/axes/styling.html index 911b77bd3a..fd6e83569e 100644 --- a/docs/master/axes/styling.html +++ b/docs/master/axes/styling.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Styling

There are a number of options to allow styling an axis. There are settings to control grid lines and ticks.

# Grid Line Configuration

Namespace: options.scales[scaleId].grid, it defines options for the grid lines that run perpendicular to the axis.

Name Type Scriptable Indexable Default Description
circular boolean false If true, gridlines are circular (on radar and polar area charts only).
color Color Yes Yes Chart.defaults.borderColor The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.
display boolean true If false, do not display grid lines for this axis.
drawOnChartArea boolean true If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.
drawTicks boolean true If true, draw lines beside the ticks in the axis area beside the chart.
lineWidth number Yes Yes 1 Stroke width of grid lines.
offset boolean false If true, grid lines will be shifted to be between labels. This is set to true for a bar chart by default.
tickBorderDash number[] Yes Yes [] Length and spacing of the tick mark line. If not set, defaults to the grid line borderDash value.
tickBorderDashOffset number Yes Yes Offset for the line dash of the tick mark. If unset, defaults to the grid line borderDashOffset value
tickColor Color Yes Yes Color of the tick line. If unset, defaults to the grid line color.
tickLength number 8 Length in pixels that the grid lines will draw into the axis area.
tickWidth number Yes Yes Width of the tick mark in pixels. If unset, defaults to the grid line width.
z number -1 z-index of the gridline layer. Values <= 0 are drawn under datasets, > 0 on top.

The scriptable context is described in Options section.

# Tick Configuration

# Common tick options to all axes

Namespace: options.scales[scaleId].ticks

Name Type Scriptable Default Description
backdropColor Color Yes 'rgba(255, 255, 255, 0.75)' Color of label backdrops.
backdropPadding Padding 2 Padding of label backdrop.
callback function Returns the string representation of the tick value as it should be displayed on the chart. See callback.
display boolean true If true, show tick labels.
color Color Yes Chart.defaults.color Color of ticks.
font Font Yes Chart.defaults.font See Fonts
major object {} Major ticks configuration.
padding number 3 Sets the offset of the tick labels from the axis
showLabelBackdrop boolean Yes true for radial scale, false otherwise If true, draw a background behind the tick labels.
textStrokeColor Color Yes `` The color of the stroke around the text.
textStrokeWidth number Yes 0 Stroke width around the text.
z number 0 z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.

The scriptable context is described in Options section.

# Major Tick Configuration

Namespace: options.scales[scaleId].ticks.major, it defines options for the major tick marks that are generated by the axis.

Name Type Default Description
enabled boolean false If true, major ticks are generated. A major tick will affect autoskipping and major will be defined on ticks in the scriptable options context.

# Border Configuration

Namespace: options.scales[scaleId].border, it defines options for the border that run perpendicular to the axis.

Name Type Scriptable Indexable Default Description
display boolean true If true, draw a border at the edge between the axis and the chart area.
color Color Chart.defaults.borderColor The color of the border line.
width number 1 The width of the border line.
dash number[] Yes [] Length and spacing of dashes on grid lines. See MDN (opens new window).
dashOffset number Yes 0.0 Offset for line dashes. See MDN (opens new window).
z number 0 z-index of the border layer. Values <= 0 are drawn under datasets, > 0 on top.
Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

# Styling

There are a number of options to allow styling an axis. There are settings to control grid lines and ticks.

# Grid Line Configuration

Namespace: options.scales[scaleId].grid, it defines options for the grid lines that run perpendicular to the axis.

Name Type Scriptable Indexable Default Description
circular boolean false If true, gridlines are circular (on radar and polar area charts only).
color Color Yes Yes Chart.defaults.borderColor The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line, and so on.
display boolean true If false, do not display grid lines for this axis.
drawOnChartArea boolean true If true, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn.
drawTicks boolean true If true, draw lines beside the ticks in the axis area beside the chart.
lineWidth number Yes Yes 1 Stroke width of grid lines.
offset boolean false If true, grid lines will be shifted to be between labels. This is set to true for a bar chart by default.
tickBorderDash number[] Yes Yes [] Length and spacing of the tick mark line. If not set, defaults to the grid line borderDash value.
tickBorderDashOffset number Yes Yes Offset for the line dash of the tick mark. If unset, defaults to the grid line borderDashOffset value
tickColor Color Yes Yes Color of the tick line. If unset, defaults to the grid line color.
tickLength number 8 Length in pixels that the grid lines will draw into the axis area.
tickWidth number Yes Yes Width of the tick mark in pixels. If unset, defaults to the grid line width.
z number -1 z-index of the gridline layer. Values <= 0 are drawn under datasets, > 0 on top.

The scriptable context is described in Options section.

# Tick Configuration

# Common tick options to all axes

Namespace: options.scales[scaleId].ticks

Name Type Scriptable Default Description
backdropColor Color Yes 'rgba(255, 255, 255, 0.75)' Color of label backdrops.
backdropPadding Padding 2 Padding of label backdrop.
callback function Returns the string representation of the tick value as it should be displayed on the chart. See callback.
display boolean true If true, show tick labels.
color Color Yes Chart.defaults.color Color of ticks.
font Font Yes Chart.defaults.font See Fonts
major object {} Major ticks configuration.
padding number 3 Sets the offset of the tick labels from the axis
showLabelBackdrop boolean Yes true for radial scale, false otherwise If true, draw a background behind the tick labels.
textStrokeColor Color Yes `` The color of the stroke around the text.
textStrokeWidth number Yes 0 Stroke width around the text.
z number 0 z-index of tick layer. Useful when ticks are drawn on chart area. Values <= 0 are drawn under datasets, > 0 on top.

The scriptable context is described in Options section.

# Major Tick Configuration

Namespace: options.scales[scaleId].ticks.major, it defines options for the major tick marks that are generated by the axis.

Name Type Default Description
enabled boolean false If true, major ticks are generated. A major tick will affect autoskipping and major will be defined on ticks in the scriptable options context.

# Border Configuration

Namespace: options.scales[scaleId].border, it defines options for the border that run perpendicular to the axis.

Name Type Scriptable Indexable Default Description
display boolean true If true, draw a border at the edge between the axis and the chart area.
color Color Chart.defaults.borderColor The color of the border line.
width number 1 The width of the border line.
dash number[] Yes [] Length and spacing of dashes on grid lines. See MDN (opens new window).
dashOffset number Yes 0.0 Offset for line dashes. See MDN (opens new window).
z number 0 z-index of the border layer. Values <= 0 are drawn under datasets, > 0 on top.
Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/area.html b/docs/master/charts/area.html index e72052f737..c1e733b7a6 100644 --- a/docs/master/charts/area.html +++ b/docs/master/charts/area.html @@ -7,7 +7,7 @@ - + @@ -85,7 +85,7 @@

propagate: true: -if dataset 2 is hidden, dataset 4 will fill to dataset 1 -if dataset 2 and 1 are hidden, dataset 4 will fill to 'origin'

propagate: false: --if dataset 2 and/or 4 are hidden, dataset 4 will not be filled

Last Updated: 1/9/2024, 4:24:43 PM

+-if dataset 2 and/or 4 are hidden, dataset 4 will not be filled

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/bar.html b/docs/master/charts/bar.html index 267b50e04d..2468d6b169 100644 --- a/docs/master/charts/bar.html +++ b/docs/master/charts/bar.html @@ -7,7 +7,7 @@ - + @@ -241,7 +241,7 @@ ], borderWidth: 1 }] -};

# Horizontal Bar Chart config Options

The configuration options for the horizontal bar chart are the same as for the bar chart. However, any options specified on the x-axis in a bar chart, are applied to the y-axis in a horizontal bar chart.

# Internal data format

{x, y, _custom} where _custom is an optional object defining stacked bar properties: {start, end, barStart, barEnd, min, max}. start and end are the input values. Those two are repeated in barStart (closer to origin), barEnd (further from origin), min and max.

Last Updated: 1/9/2024, 4:24:43 PM

+};

# Horizontal Bar Chart config Options

The configuration options for the horizontal bar chart are the same as for the bar chart. However, any options specified on the x-axis in a bar chart, are applied to the y-axis in a horizontal bar chart.

# Internal data format

{x, y, _custom} where _custom is an optional object defining stacked bar properties: {start, end, barStart, barEnd, min, max}. start and end are the input values. Those two are repeated in barStart (closer to origin), barEnd (further from origin), min and max.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/bubble.html b/docs/master/charts/bubble.html index 17004a6f56..47bfde08e2 100644 --- a/docs/master/charts/bubble.html +++ b/docs/master/charts/bubble.html @@ -7,7 +7,7 @@ - + @@ -87,7 +87,7 @@ // Bubble radius in pixels (not scaled). r: number } -

Important: the radius property, r is not scaled by the chart, it is the raw radius in pixels of the bubble that is drawn on the canvas.

# Internal data format

{x, y, _custom} where _custom is the radius.

Last Updated: 1/9/2024, 4:24:43 PM

+

Important: the radius property, r is not scaled by the chart, it is the raw radius in pixels of the bubble that is drawn on the canvas.

# Internal data format

{x, y, _custom} where _custom is the radius.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/doughnut.html b/docs/master/charts/doughnut.html index ec1e4d08f6..4df395783b 100644 --- a/docs/master/charts/doughnut.html +++ b/docs/master/charts/doughnut.html @@ -7,7 +7,7 @@ - + @@ -134,7 +134,7 @@ 'Blue' ] }; -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/line.html b/docs/master/charts/line.html index 4070632d58..2576082607 100644 --- a/docs/master/charts/line.html +++ b/docs/master/charts/line.html @@ -7,7 +7,7 @@ - + @@ -165,7 +165,7 @@ ], borderWidth: 1 }] -};

# Config Options

The configuration options for the vertical line chart are the same as for the line chart. However, any options specified on the x-axis in a line chart, are applied to the y-axis in a vertical line chart.

# Internal data format

{x, y}

Last Updated: 1/9/2024, 4:24:43 PM

+};

# Config Options

The configuration options for the vertical line chart are the same as for the line chart. However, any options specified on the x-axis in a line chart, are applied to the y-axis in a vertical line chart.

# Internal data format

{x, y}

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/mixed.html b/docs/master/charts/mixed.html index e889da199d..853efe5ed5 100644 --- a/docs/master/charts/mixed.html +++ b/docs/master/charts/mixed.html @@ -7,7 +7,7 @@ - + @@ -137,7 +137,7 @@ }, options: options }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/polar.html b/docs/master/charts/polar.html index 3c6f2a6544..f7948239e4 100644 --- a/docs/master/charts/polar.html +++ b/docs/master/charts/polar.html @@ -7,7 +7,7 @@ - + @@ -101,7 +101,7 @@ 'Blue' ] }; -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/radar.html b/docs/master/charts/radar.html index 992c7dfaa6..d9267f458a 100644 --- a/docs/master/charts/radar.html +++ b/docs/master/charts/radar.html @@ -7,7 +7,7 @@ - + @@ -143,7 +143,7 @@ data: [20, 10, 4, 2] }] } -

# Internal data format

{x, y}

Last Updated: 1/9/2024, 4:24:43 PM

+

# Internal data format

{x, y}

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/charts/scatter.html b/docs/master/charts/scatter.html index 3aa52cd486..1a94127e86 100644 --- a/docs/master/charts/scatter.html +++ b/docs/master/charts/scatter.html @@ -7,7 +7,7 @@ - + @@ -109,7 +109,7 @@ x: 15, y: 10 }] -

# Internal data format

{x, y}

Last Updated: 1/9/2024, 4:24:43 PM

+

# Internal data format

{x, y}

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/animations.html b/docs/master/configuration/animations.html index bb72342003..a6cf50b961 100644 --- a/docs/master/configuration/animations.html +++ b/docs/master/configuration/animations.html @@ -7,7 +7,7 @@ - + @@ -202,7 +202,7 @@ } } }); -

Another example usage of these callbacks can be found in this progress bar sample, which displays a progress bar showing how far along the animation is.

Last Updated: 1/9/2024, 4:24:43 PM

+

Another example usage of these callbacks can be found in this progress bar sample, which displays a progress bar showing how far along the animation is.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/canvas-background.html b/docs/master/configuration/canvas-background.html index ff4a76ed22..ada6c04a51 100644 --- a/docs/master/configuration/canvas-background.html +++ b/docs/master/configuration/canvas-background.html @@ -7,7 +7,7 @@ - + @@ -200,7 +200,7 @@ image.onload = () => chart.draw(); } } -};
Last Updated: 1/9/2024, 4:24:43 PM

+};

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/decimation.html b/docs/master/configuration/decimation.html index 697982f29a..31690ce657 100644 --- a/docs/master/configuration/decimation.html +++ b/docs/master/configuration/decimation.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Data Decimation

The decimation plugin can be used with line charts to automatically decimate data at the start of the chart lifecycle. Before enabling this plugin, review the requirements to ensure that it will work with the chart you want to create.

# Configuration Options

Namespace: options.plugins.decimation, the global options for the plugin are defined in Chart.defaults.plugins.decimation.

Name Type Default Description
enabled boolean false Is decimation enabled?
algorithm string 'min-max' Decimation algorithm to use. See the more...
samples number If the 'lttb' algorithm is used, this is the number of samples in the output dataset. Defaults to the canvas width to pick 1 sample per pixel.
threshold number If the number of samples in the current axis range is above this value, the decimation will be triggered. Defaults to 4 times the canvas width.
The number of point after decimation can be higher than the threshold value.

# Decimation Algorithms

Decimation algorithm to use for data. Options are:

  • 'lttb'
  • 'min-max'

# Largest Triangle Three Bucket (LTTB) Decimation

LTTB (opens new window) decimation reduces the number of data points significantly. This is most useful for showing trends in data using only a few data points.

# Min/Max Decimation

Min/max (opens new window) decimation will preserve peaks in your data but could require up to 4 points for each pixel. This type of decimation would work well for a very noisy signal where you need to see data peaks.

# Requirements

To use the decimation plugin, the following requirements must be met:

  1. The dataset must have an indexAxis of 'x'
  2. The dataset must be a line
  3. The X axis for the dataset must be either a 'linear' or 'time' type axis
  4. Data must not need parsing, i.e. parsing must be false
  5. The dataset object must be mutable. The plugin stores the original data as dataset._data and then defines a new data property on the dataset.
  6. There must be more points on the chart than the threshold value. Take a look at the Configuration Options for more information.
Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

# Data Decimation

The decimation plugin can be used with line charts to automatically decimate data at the start of the chart lifecycle. Before enabling this plugin, review the requirements to ensure that it will work with the chart you want to create.

# Configuration Options

Namespace: options.plugins.decimation, the global options for the plugin are defined in Chart.defaults.plugins.decimation.

Name Type Default Description
enabled boolean false Is decimation enabled?
algorithm string 'min-max' Decimation algorithm to use. See the more...
samples number If the 'lttb' algorithm is used, this is the number of samples in the output dataset. Defaults to the canvas width to pick 1 sample per pixel.
threshold number If the number of samples in the current axis range is above this value, the decimation will be triggered. Defaults to 4 times the canvas width.
The number of point after decimation can be higher than the threshold value.

# Decimation Algorithms

Decimation algorithm to use for data. Options are:

  • 'lttb'
  • 'min-max'

# Largest Triangle Three Bucket (LTTB) Decimation

LTTB (opens new window) decimation reduces the number of data points significantly. This is most useful for showing trends in data using only a few data points.

# Min/Max Decimation

Min/max (opens new window) decimation will preserve peaks in your data but could require up to 4 points for each pixel. This type of decimation would work well for a very noisy signal where you need to see data peaks.

# Requirements

To use the decimation plugin, the following requirements must be met:

  1. The dataset must have an indexAxis of 'x'
  2. The dataset must be a line
  3. The X axis for the dataset must be either a 'linear' or 'time' type axis
  4. Data must not need parsing, i.e. parsing must be false
  5. The dataset object must be mutable. The plugin stores the original data as dataset._data and then defines a new data property on the dataset.
  6. There must be more points on the chart than the threshold value. Take a look at the Configuration Options for more information.
Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/device-pixel-ratio.html b/docs/master/configuration/device-pixel-ratio.html index ad72b4124e..c4716671d0 100644 --- a/docs/master/configuration/device-pixel-ratio.html +++ b/docs/master/configuration/device-pixel-ratio.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Device Pixel Ratio

By default, the chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g. Retina displays).

For applications where a chart will be converted to a bitmap, or printed to a higher DPI medium, it can be desirable to render the chart at a higher resolution than the default.

Setting devicePixelRatio to a value other than 1 will force the canvas size to be scaled by that amount, relative to the container size. There should be no visible difference on screen; the difference will only be visible when the image is zoomed or printed.

# Configuration Options

Namespace: options

Name Type Default Description
devicePixelRatio number window.devicePixelRatio Override the window's default devicePixelRatio.
Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

# Device Pixel Ratio

By default, the chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio (e.g. Retina displays).

For applications where a chart will be converted to a bitmap, or printed to a higher DPI medium, it can be desirable to render the chart at a higher resolution than the default.

Setting devicePixelRatio to a value other than 1 will force the canvas size to be scaled by that amount, relative to the container size. There should be no visible difference on screen; the difference will only be visible when the image is zoomed or printed.

# Configuration Options

Namespace: options

Name Type Default Description
devicePixelRatio number window.devicePixelRatio Override the window's default devicePixelRatio.
Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/elements.html b/docs/master/configuration/elements.html index 953916dbc3..e646983c30 100644 --- a/docs/master/configuration/elements.html +++ b/docs/master/configuration/elements.html @@ -7,7 +7,7 @@ - + @@ -40,7 +40,7 @@ (opens new window) GitHub (opens new window)

# Elements

While chart types provide settings to configure the styling of each dataset, you sometimes want to style all datasets the same way. A common example would be to stroke all the bars in a bar chart with the same colour but change the fill per dataset. Options can be configured for four different types of elements: arc, lines, points, and bars. When set, these options apply to all objects of that type unless specifically overridden by the configuration attached to a dataset.

# Global Configuration

The element options can be specified per chart or globally. The global options for elements are defined in Chart.defaults.elements. For example, to set the border width of all bar charts globally, you would do:

Chart.defaults.elements.bar.borderWidth = 2;
-

# Point Configuration

Point elements are used to represent the points in a line, radar or bubble chart.

Namespace: options.elements.point, global point options: Chart.defaults.elements.point.

Name Type Default Description
radius number 3 Point radius.
pointStyle pointStyle 'circle' Point style.
rotation number 0 Point rotation (in degrees).
backgroundColor Color Chart.defaults.backgroundColor Point fill color.
borderWidth number 1 Point stroke width.
borderColor Color 'Chart.defaults.borderColor Point stroke color.
hitRadius number 1 Extra radius added to point radius for hit detection.
hoverRadius number 4 Point radius when hovered.
hoverBorderWidth number 1 Stroke width when hovered.

# Point Styles

# Types

The pointStyle argument accepts the following type of inputs: string, Image and HTMLCanvasElement

# Info

When a string is provided, the following values are supported:

  • 'circle'
  • 'cross'
  • 'crossRot'
  • 'dash'
  • 'line'
  • 'rect'
  • 'rectRounded'
  • 'rectRot'
  • 'star'
  • 'triangle'
  • false

If the value is an image or a canvas element, that image or canvas element is drawn on the canvas using drawImage (opens new window).

# Line Configuration

Line elements are used to represent the line in a line chart.

Namespace: options.elements.line, global line options: Chart.defaults.elements.line.

Name Type Default Description
tension number 0 Bézier curve tension (0 for no Bézier curves).
backgroundColor Color Chart.defaults.backgroundColor Line fill color.
borderWidth number 3 Line stroke width.
borderColor Color Chart.defaults.borderColor Line stroke color.
borderCapStyle string 'butt' Line cap style. See MDN (opens new window).
borderDash number[] [] Line dash. See MDN (opens new window).
borderDashOffset number 0.0 Line dash offset. See MDN (opens new window).
borderJoinStyle 'round'|'bevel'|'miter' 'miter' Line join style. See MDN (opens new window).
capBezierPoints boolean true true to keep Bézier control inside the chart, false for no restriction.
cubicInterpolationMode string 'default' Interpolation mode to apply. See more...
fill boolean|string false How to fill the area under the line. See area charts.
stepped boolean false true to show the line as a stepped line (tension will be ignored).

# Bar Configuration

Bar elements are used to represent the bars in a bar chart.

Namespace: options.elements.bar, global bar options: Chart.defaults.elements.bar.

Name Type Default Description
backgroundColor Color Chart.defaults.backgroundColor Bar fill color.
borderWidth number 0 Bar stroke width.
borderColor Color Chart.defaults.borderColor Bar stroke color.
borderSkipped string 'start' Skipped (excluded) border: 'start', 'end', 'middle', 'bottom', 'left', 'top', 'right' or false.
borderRadius number|object 0 The bar border radius (in pixels).
inflateAmount number|'auto' 'auto' The amount of pixels to inflate the bar rectangle(s) when drawing.
pointStyle string|Image|HTMLCanvasElement 'circle' Style of the point for legend.

# Arc Configuration

Arcs are used in the polar area, doughnut and pie charts.

Namespace: options.elements.arc, global arc options: Chart.defaults.elements.arc.

Name Type Default Description
angle - for polar only number circumference / (arc count) Arc angle to cover.
backgroundColor Color Chart.defaults.backgroundColor Arc fill color.
borderAlign 'center'|'inner' 'center' Arc stroke alignment.
borderColor Color '#fff' Arc stroke color.
borderDash number[] [] Arc line dash. See MDN (opens new window).
borderDashOffset number 0.0 Arc line dash offset. See MDN (opens new window).
borderJoinStyle 'round'|'bevel'|'miter' 'bevel'|'round' Line join style. See MDN (opens new window). The default is 'round' when borderAlign is 'inner'
borderWidth number 2 Arc stroke width.
circular boolean true By default the Arc is curved. If circular: false the Arc will be flat
Last Updated: 1/9/2024, 4:24:43 PM

+

# Point Configuration

Point elements are used to represent the points in a line, radar or bubble chart.

Namespace: options.elements.point, global point options: Chart.defaults.elements.point.

Name Type Default Description
radius number 3 Point radius.
pointStyle pointStyle 'circle' Point style.
rotation number 0 Point rotation (in degrees).
backgroundColor Color Chart.defaults.backgroundColor Point fill color.
borderWidth number 1 Point stroke width.
borderColor Color 'Chart.defaults.borderColor Point stroke color.
hitRadius number 1 Extra radius added to point radius for hit detection.
hoverRadius number 4 Point radius when hovered.
hoverBorderWidth number 1 Stroke width when hovered.

# Point Styles

# Types

The pointStyle argument accepts the following type of inputs: string, Image and HTMLCanvasElement

# Info

When a string is provided, the following values are supported:

  • 'circle'
  • 'cross'
  • 'crossRot'
  • 'dash'
  • 'line'
  • 'rect'
  • 'rectRounded'
  • 'rectRot'
  • 'star'
  • 'triangle'
  • false

If the value is an image or a canvas element, that image or canvas element is drawn on the canvas using drawImage (opens new window).

# Line Configuration

Line elements are used to represent the line in a line chart.

Namespace: options.elements.line, global line options: Chart.defaults.elements.line.

Name Type Default Description
tension number 0 Bézier curve tension (0 for no Bézier curves).
backgroundColor Color Chart.defaults.backgroundColor Line fill color.
borderWidth number 3 Line stroke width.
borderColor Color Chart.defaults.borderColor Line stroke color.
borderCapStyle string 'butt' Line cap style. See MDN (opens new window).
borderDash number[] [] Line dash. See MDN (opens new window).
borderDashOffset number 0.0 Line dash offset. See MDN (opens new window).
borderJoinStyle 'round'|'bevel'|'miter' 'miter' Line join style. See MDN (opens new window).
capBezierPoints boolean true true to keep Bézier control inside the chart, false for no restriction.
cubicInterpolationMode string 'default' Interpolation mode to apply. See more...
fill boolean|string false How to fill the area under the line. See area charts.
stepped boolean false true to show the line as a stepped line (tension will be ignored).

# Bar Configuration

Bar elements are used to represent the bars in a bar chart.

Namespace: options.elements.bar, global bar options: Chart.defaults.elements.bar.

Name Type Default Description
backgroundColor Color Chart.defaults.backgroundColor Bar fill color.
borderWidth number 0 Bar stroke width.
borderColor Color Chart.defaults.borderColor Bar stroke color.
borderSkipped string 'start' Skipped (excluded) border: 'start', 'end', 'middle', 'bottom', 'left', 'top', 'right' or false.
borderRadius number|object 0 The bar border radius (in pixels).
inflateAmount number|'auto' 'auto' The amount of pixels to inflate the bar rectangle(s) when drawing.
pointStyle string|Image|HTMLCanvasElement 'circle' Style of the point for legend.

# Arc Configuration

Arcs are used in the polar area, doughnut and pie charts.

Namespace: options.elements.arc, global arc options: Chart.defaults.elements.arc.

Name Type Default Description
angle - for polar only number circumference / (arc count) Arc angle to cover.
backgroundColor Color Chart.defaults.backgroundColor Arc fill color.
borderAlign 'center'|'inner' 'center' Arc stroke alignment.
borderColor Color '#fff' Arc stroke color.
borderDash number[] [] Arc line dash. See MDN (opens new window).
borderDashOffset number 0.0 Arc line dash offset. See MDN (opens new window).
borderJoinStyle 'round'|'bevel'|'miter' 'bevel'|'round' Line join style. See MDN (opens new window). The default is 'round' when borderAlign is 'inner'
borderWidth number 2 Arc stroke width.
circular boolean true By default the Arc is curved. If circular: false the Arc will be flat
Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/index.html b/docs/master/configuration/index.html index 9e2a54e860..52e0942a09 100644 --- a/docs/master/configuration/index.html +++ b/docs/master/configuration/index.html @@ -7,7 +7,7 @@ - + @@ -82,7 +82,7 @@ }] } }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/interactions.html b/docs/master/configuration/interactions.html index 6aa0edf3bd..7f156d59ea 100644 --- a/docs/master/configuration/interactions.html +++ b/docs/master/configuration/interactions.html @@ -7,7 +7,7 @@ - + @@ -192,7 +192,7 @@ myCustomMode: InteractionModeFunction; } } -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/layout.html b/docs/master/configuration/layout.html index 9e42beb360..3c8c345181 100644 --- a/docs/master/configuration/layout.html +++ b/docs/master/configuration/layout.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Layout

Namespace: options.layout, the global options for the chart layout is defined in Chart.defaults.layout.

Name Type Default Scriptable Description
autoPadding boolean true No Apply automatic padding so visible elements are completely drawn.
padding Padding 0 Yes The padding to add inside the chart.
Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

# Layout

Namespace: options.layout, the global options for the chart layout is defined in Chart.defaults.layout.

Name Type Default Scriptable Description
autoPadding boolean true No Apply automatic padding so visible elements are completely drawn.
padding Padding 0 Yes The padding to add inside the chart.
Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/legend.html b/docs/master/configuration/legend.html index fe238f4a69..bad505f711 100644 --- a/docs/master/configuration/legend.html +++ b/docs/master/configuration/legend.html @@ -7,7 +7,7 @@ - + @@ -129,7 +129,7 @@ } } }); -

Now when you click the legend in this chart, the visibility of the first two datasets will be linked together.

Last Updated: 1/9/2024, 4:24:43 PM

+

Now when you click the legend in this chart, the visibility of the first two datasets will be linked together.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/locale.html b/docs/master/configuration/locale.html index 5856f6d1ca..40de040aa6 100644 --- a/docs/master/configuration/locale.html +++ b/docs/master/configuration/locale.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Locale

For applications where the numbers of ticks on scales must be formatted accordingly with a language sensitive number formatting, you can enable this kind of formatting by setting the locale option.

The locale is a string that is a Unicode BCP 47 locale identifier (opens new window).

A Unicode BCP 47 locale identifier consists of

  1. a language code,
  2. (optionally) a script code,
  3. (optionally) a region (or country) code,
  4. (optionally) one or more variant codes, and
  5. (optionally) one or more extension sequences,

with all present components separated by hyphens.

By default, the chart is using the default locale of the platform which is running on.

# Configuration Options

Namespace: options

Name Type Default Description
locale string undefined a string with a BCP 47 language tag, leveraging on INTL NumberFormat (opens new window).
Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

# Locale

For applications where the numbers of ticks on scales must be formatted accordingly with a language sensitive number formatting, you can enable this kind of formatting by setting the locale option.

The locale is a string that is a Unicode BCP 47 locale identifier (opens new window).

A Unicode BCP 47 locale identifier consists of

  1. a language code,
  2. (optionally) a script code,
  3. (optionally) a region (or country) code,
  4. (optionally) one or more variant codes, and
  5. (optionally) one or more extension sequences,

with all present components separated by hyphens.

By default, the chart is using the default locale of the platform which is running on.

# Configuration Options

Namespace: options

Name Type Default Description
locale string undefined a string with a BCP 47 language tag, leveraging on INTL NumberFormat (opens new window).
Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/responsive.html b/docs/master/configuration/responsive.html index 89cf9e826c..a894fe9cff 100644 --- a/docs/master/configuration/responsive.html +++ b/docs/master/configuration/responsive.html @@ -7,7 +7,7 @@ - + @@ -55,7 +55,7 @@ window.addEventListener('afterprint', () => { myChart.resize(); }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/subtitle.html b/docs/master/configuration/subtitle.html index 90df87391f..839205fb57 100644 --- a/docs/master/configuration/subtitle.html +++ b/docs/master/configuration/subtitle.html @@ -7,7 +7,7 @@ - + @@ -51,7 +51,7 @@ } } }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/title.html b/docs/master/configuration/title.html index cf494a09d9..fb7e8dbe71 100644 --- a/docs/master/configuration/title.html +++ b/docs/master/configuration/title.html @@ -7,7 +7,7 @@ - + @@ -67,7 +67,7 @@ } } }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/configuration/tooltip.html b/docs/master/configuration/tooltip.html index d56bb8ffb8..fc70ec8ece 100644 --- a/docs/master/configuration/tooltip.html +++ b/docs/master/configuration/tooltip.html @@ -7,7 +7,7 @@ - + @@ -269,7 +269,7 @@ myCustomPositioner: TooltipPositionerFunction<ChartType>; } } -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/api.html b/docs/master/developers/api.html index 193ba60684..d6727a1e20 100644 --- a/docs/master/developers/api.html +++ b/docs/master/developers/api.html @@ -7,7 +7,7 @@ - + @@ -91,7 +91,7 @@

# Static: getChart(key)

Finds the chart instance from the given key. If the key is a string, it is interpreted as the ID of the Canvas node for the Chart. The key can also be a CanvasRenderingContext2D or an HTMLDOMElement. This will return undefined if no Chart is found. To be found, the chart must have previously been created.

const chart = Chart.getChart("canvas-id");

# Static: register(chartComponentLike)

Used to register plugins, axis types or chart types globally to all your charts.

import { Chart, Tooltip, LinearScale, PointElement, BubbleController } from 'chart.js';
 Chart.register(Tooltip, LinearScale, PointElement, BubbleController);
-

# Static: unregister(chartComponentLike)

Used to unregister plugins, axis types or chart types globally from all your charts.

Last Updated: 1/9/2024, 4:24:43 PM

+

# Static: unregister(chartComponentLike)

Used to unregister plugins, axis types or chart types globally from all your charts.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/axes.html b/docs/master/developers/axes.html index b92fb35783..a140c1e7b3 100644 --- a/docs/master/developers/axes.html +++ b/docs/master/developers/axes.html @@ -7,7 +7,7 @@ - + @@ -120,7 +120,7 @@ // Returns the scale tick objects ({label, major}) getTicks: function() {} } -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/charts.html b/docs/master/developers/charts.html index 7134cb11bd..93b8b46b8c 100644 --- a/docs/master/developers/charts.html +++ b/docs/master/developers/charts.html @@ -7,7 +7,7 @@ - + @@ -114,7 +114,7 @@ derivedBubble: ChartTypeRegistry['bubble'] } } -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/contributing.html b/docs/master/developers/contributing.html index 95117ea125..a9b759334f 100644 --- a/docs/master/developers/contributing.html +++ b/docs/master/developers/contributing.html @@ -7,7 +7,7 @@ - + @@ -46,7 +46,7 @@ > pnpm run lint // perform code linting (ESLint, tsc) > pnpm test // perform code linting and run unit tests with coverage

pnpm run dev and pnpm test can be appended with a string that is used to match the spec filenames. For example: pnpm run dev plugins will start karma in watch mode for test/specs/**/*plugin*.js.

# Documentation

We use Vuepress (opens new window) to manage the docs which are contained as Markdown files in the docs directory. You can run the doc server locally using these commands:

> pnpm run docs:dev
-

# Image-Based Tests

Some display-related functionality is difficult to test via typical Jasmine units. For this reason, we introduced image-based tests (#3988 (opens new window) and #5777 (opens new window)) to assert that a chart is drawn pixel-for-pixel matching an expected image.

Generated charts in image-based tests should be as minimal as possible and focus only on the tested feature to prevent failure if another feature breaks (e.g. disable the title and legend when testing scales).

You can create a new image-based test by following the steps below:

  • Create a JS file (example (opens new window)) or JSON file (example (opens new window)) that defines chart config and generation options.
  • Add this file in test/fixtures/{spec.name}/{feature-name}.json.
  • Add a describe line (opens new window) to the beginning of test/specs/{spec.name}.tests.js if it doesn't exist yet.
  • Run pnpm run dev.
  • Click the "Debug" button (top/right): a test should fail with the associated canvas visible.
  • Right-click on the chart and "Save image as..." test/fixtures/{spec.name}/{feature-name}.png making sure not to activate the tooltip or any hover functionality
  • Refresh the browser page (CTRL+R): test should now pass
  • Verify test relevancy by changing the feature values slightly in the JSON file.

Tests should pass in both browsers. In general, we've hidden all text in image tests since it's quite difficult to get them to pass between different browsers. As a result, it is recommended to hide all scales in image-based tests. It is also recommended to disable animations. If tests still do not pass, adjust tolerance and/or threshold (opens new window) at the beginning of the JSON file keeping them as low as possible.

When a test fails, the expected and actual images are shown. If you'd like to see the images even when the tests pass, set "debug": true in the JSON file.

# Bugs and Issues

Please report these on the GitHub page - at github.com/chartjs/Chart.js. Please do not use issues for support requests. For help using Chart.js, please take a look at the chart.js (opens new window) tag on Stack Overflow.

Well-structured, detailed bug reports are hugely valuable for the project.

Guidelines for reporting bugs:

Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data.

Last Updated: 1/9/2024, 4:24:43 PM

+

# Image-Based Tests

Some display-related functionality is difficult to test via typical Jasmine units. For this reason, we introduced image-based tests (#3988 (opens new window) and #5777 (opens new window)) to assert that a chart is drawn pixel-for-pixel matching an expected image.

Generated charts in image-based tests should be as minimal as possible and focus only on the tested feature to prevent failure if another feature breaks (e.g. disable the title and legend when testing scales).

You can create a new image-based test by following the steps below:

  • Create a JS file (example (opens new window)) or JSON file (example (opens new window)) that defines chart config and generation options.
  • Add this file in test/fixtures/{spec.name}/{feature-name}.json.
  • Add a describe line (opens new window) to the beginning of test/specs/{spec.name}.tests.js if it doesn't exist yet.
  • Run pnpm run dev.
  • Click the "Debug" button (top/right): a test should fail with the associated canvas visible.
  • Right-click on the chart and "Save image as..." test/fixtures/{spec.name}/{feature-name}.png making sure not to activate the tooltip or any hover functionality
  • Refresh the browser page (CTRL+R): test should now pass
  • Verify test relevancy by changing the feature values slightly in the JSON file.

Tests should pass in both browsers. In general, we've hidden all text in image tests since it's quite difficult to get them to pass between different browsers. As a result, it is recommended to hide all scales in image-based tests. It is also recommended to disable animations. If tests still do not pass, adjust tolerance and/or threshold (opens new window) at the beginning of the JSON file keeping them as low as possible.

When a test fails, the expected and actual images are shown. If you'd like to see the images even when the tests pass, set "debug": true in the JSON file.

# Bugs and Issues

Please report these on the GitHub page - at github.com/chartjs/Chart.js. Please do not use issues for support requests. For help using Chart.js, please take a look at the chart.js (opens new window) tag on Stack Overflow.

Well-structured, detailed bug reports are hugely valuable for the project.

Guidelines for reporting bugs:

Please provide any additional details associated with the bug, if it's browser or screen density specific, or only happens with a certain configuration or data.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/index.html b/docs/master/developers/index.html index b8f9185ea2..1ca4f94264 100644 --- a/docs/master/developers/index.html +++ b/docs/master/developers/index.html @@ -7,7 +7,7 @@ - + @@ -39,7 +39,7 @@ Stack Overflow (opens new window) GitHub - (opens new window)

# Developers

Developer features allow extending and enhancing Chart.js in many different ways.

# Latest resources

The latest documentation and samples, including unreleased features, are available at:

# Development releases

Latest builds are available for testing at:

Warning

Development builds must not be used for production purposes or as replacement for a CDN. See available CDNs.

# Browser support

All modern and up-to-date browsers are supported, including, but not limited to:

  • Chrome
  • Edge
  • Firefox
  • Safari

As of version 3, we have dropped Internet Explorer 11 support.

Browser support for the canvas element is available in all modern & major mobile browsers. CanIUse (opens new window)

Run npx browserslist at the root of the codebase (opens new window) to get a list of supported browsers.

Thanks to BrowserStack (opens new window) for allowing our team to test on thousands of browsers.

# Previous versions

To migrate from version 2 to version 3, please see the v3 migration guide.

Version 3 has a largely different API than earlier versions.

Most earlier version options have current equivalents or are the same.

Please note - documentation for previous versions is available online or in the GitHub repo.

Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

# Developers

Developer features allow extending and enhancing Chart.js in many different ways.

# Latest resources

The latest documentation and samples, including unreleased features, are available at:

# Development releases

Latest builds are available for testing at:

Warning

Development builds must not be used for production purposes or as replacement for a CDN. See available CDNs.

# Browser support

All modern and up-to-date browsers are supported, including, but not limited to:

  • Chrome
  • Edge
  • Firefox
  • Safari

As of version 3, we have dropped Internet Explorer 11 support.

Browser support for the canvas element is available in all modern & major mobile browsers. CanIUse (opens new window)

Run npx browserslist at the root of the codebase (opens new window) to get a list of supported browsers.

Thanks to BrowserStack (opens new window) for allowing our team to test on thousands of browsers.

# Previous versions

To migrate from version 2 to version 3, please see the v3 migration guide.

Version 3 has a largely different API than earlier versions.

Most earlier version options have current equivalents or are the same.

Please note - documentation for previous versions is available online or in the GitHub repo.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/plugins.html b/docs/master/developers/plugins.html index 6352247638..58ed343914 100644 --- a/docs/master/developers/plugins.html +++ b/docs/master/developers/plugins.html @@ -7,7 +7,7 @@ - + @@ -113,7 +113,7 @@ } } } -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/publishing.html b/docs/master/developers/publishing.html index 8c5d77b958..57db69d89e 100644 --- a/docs/master/developers/publishing.html +++ b/docs/master/developers/publishing.html @@ -7,7 +7,7 @@ - + @@ -50,7 +50,7 @@ } } }; -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/developers/updates.html b/docs/master/developers/updates.html index da7b14fea4..74348d22c0 100644 --- a/docs/master/developers/updates.html +++ b/docs/master/developers/updates.html @@ -7,7 +7,7 @@ - + @@ -102,7 +102,7 @@ chart.update(); }

Code sample for updating options can be found in line-datasets.html (opens new window).

# Preventing Animations

Sometimes when a chart updates, you may not want an animation. To achieve this you can call update with 'none' as mode.

myChart.update('none');
-
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/general/accessibility.html b/docs/master/general/accessibility.html index 641de9ef95..e92c3246a8 100644 --- a/docs/master/general/accessibility.html +++ b/docs/master/general/accessibility.html @@ -7,7 +7,7 @@ - + @@ -45,7 +45,7 @@ </canvas>

These are some bad examples of inaccessible canvas elements.

This canvas element does not have an accessible name or role.

<canvas id="badCanvas1" width="400" height="100"></canvas>

This canvas element has inaccessible fallback content.

<canvas id="badCanvas2" width="400" height="100">Your browser does not support the canvas element.</canvas>
-
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/general/colors.html b/docs/master/general/colors.html index ba9b1115e9..27e744ee9e 100644 --- a/docs/master/general/colors.html +++ b/docs/master/general/colors.html @@ -7,7 +7,7 @@ - + @@ -103,7 +103,7 @@ }], labels: ['Red', 'Blue', 'Purple', 'Yellow'] }; -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/general/data-structures.html b/docs/master/general/data-structures.html index cda628f108..f88a2df239 100644 --- a/docs/master/general/data-structures.html +++ b/docs/master/general/data-structures.html @@ -7,7 +7,7 @@ - + @@ -161,7 +161,7 @@ } }], }; -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/general/fonts.html b/docs/master/general/fonts.html index 6a345f126f..4bf1c26c7f 100644 --- a/docs/master/general/fonts.html +++ b/docs/master/general/fonts.html @@ -7,7 +7,7 @@ - + @@ -56,7 +56,7 @@ } } }); -
Name Type Default Description
family string "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif" Default font family for all text, follows CSS font-family options.
size number 12 Default font size (in px) for text. Does not apply to radialLinear scale point labels.
style string 'normal' Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
weight normal | bold | lighter | bolder | number undefined Default font weight (boldness). (see MDN (opens new window)).
lineHeight number|string 1.2 Height of an individual line of text (see MDN (opens new window)).

# Missing Fonts

If a font is specified for a chart that does exist on the system, the browser will not apply the font when it is set. If you notice odd fonts appearing in your charts, check that the font you are applying exists on your system. See issue 3318 (opens new window) for more details.

# Loading Fonts

If a font is not cached and needs to be loaded, charts that use the font will need to be updated once the font is loaded. This can be accomplished using the Font Loading APIs (opens new window). See issue 8020 (opens new window) for more details.

Last Updated: 1/9/2024, 4:24:43 PM

+

Name Type Default Description
family string "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif" Default font family for all text, follows CSS font-family options.
size number 12 Default font size (in px) for text. Does not apply to radialLinear scale point labels.
style string 'normal' Default font style. Does not apply to tooltip title or footer. Does not apply to chart title. Follows CSS font-style options (i.e. normal, italic, oblique, initial, inherit).
weight normal | bold | lighter | bolder | number undefined Default font weight (boldness). (see MDN (opens new window)).
lineHeight number|string 1.2 Height of an individual line of text (see MDN (opens new window)).

# Missing Fonts

If a font is specified for a chart that does exist on the system, the browser will not apply the font when it is set. If you notice odd fonts appearing in your charts, check that the font you are applying exists on your system. See issue 3318 (opens new window) for more details.

# Loading Fonts

If a font is not cached and needs to be loaded, charts that use the font will need to be updated once the font is loaded. This can be accomplished using the Font Loading APIs (opens new window). See issue 8020 (opens new window) for more details.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/general/options.html b/docs/master/general/options.html index b62b04f365..b1bf9f1b42 100644 --- a/docs/master/general/options.html +++ b/docs/master/general/options.html @@ -7,7 +7,7 @@ - + @@ -59,7 +59,7 @@ //... ]

# Option Context

The option context is used to give contextual information when resolving options and currently only applies to scriptable options. -The object is preserved, so it can be used to store and pass information between calls.

There are multiple levels of context objects:

  • chart
    • dataset
      • data
    • scale
      • tick
      • pointLabel (only used in the radial linear scale)
    • tooltip

Each level inherits its parent(s) and any contextual information stored in the parent is available through the child.

The context object contains the following properties:

# chart

  • chart: the associated chart
  • type: 'chart'

# dataset

In addition to chart

  • active: true if an element is active (hovered)
  • dataset: dataset at index datasetIndex
  • datasetIndex: index of the current dataset
  • index: same as datasetIndex
  • mode: the update mode
  • type: 'dataset'

# data

In addition to dataset

  • active: true if an element is active (hovered)
  • dataIndex: index of the current data
  • parsed: the parsed data values for the given dataIndex and datasetIndex
  • raw: the raw data values for the given dataIndex and datasetIndex
  • element: the element (point, arc, bar, etc.) for this data
  • index: same as dataIndex
  • type: 'data'

# scale

In addition to chart

  • scale: the associated scale
  • type: 'scale'

# tick

In addition to scale

  • tick: the associated tick object
  • index: tick index
  • type: 'tick'

# pointLabel

In addition to scale

  • label: the associated label value
  • index: label index
  • type: 'pointLabel'

# tooltip

In addition to chart

  • tooltip: the tooltip object
  • tooltipItems: the items the tooltip is displaying
Last Updated: 1/9/2024, 4:24:43 PM

+The object is preserved, so it can be used to store and pass information between calls.

There are multiple levels of context objects:

  • chart
    • dataset
      • data
    • scale
      • tick
      • pointLabel (only used in the radial linear scale)
    • tooltip

Each level inherits its parent(s) and any contextual information stored in the parent is available through the child.

The context object contains the following properties:

# chart

  • chart: the associated chart
  • type: 'chart'

# dataset

In addition to chart

  • active: true if an element is active (hovered)
  • dataset: dataset at index datasetIndex
  • datasetIndex: index of the current dataset
  • index: same as datasetIndex
  • mode: the update mode
  • type: 'dataset'

# data

In addition to dataset

  • active: true if an element is active (hovered)
  • dataIndex: index of the current data
  • parsed: the parsed data values for the given dataIndex and datasetIndex
  • raw: the raw data values for the given dataIndex and datasetIndex
  • element: the element (point, arc, bar, etc.) for this data
  • index: same as dataIndex
  • type: 'data'

# scale

In addition to chart

  • scale: the associated scale
  • type: 'scale'

# tick

In addition to scale

  • tick: the associated tick object
  • index: tick index
  • type: 'tick'

# pointLabel

In addition to scale

  • label: the associated label value
  • index: label index
  • type: 'pointLabel'

# tooltip

In addition to chart

  • tooltip: the tooltip object
  • tooltipItems: the items the tooltip is displaying
Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/general/padding.html b/docs/master/general/padding.html index a479e2d1ca..5df9e2ba73 100644 --- a/docs/master/general/padding.html +++ b/docs/master/general/padding.html @@ -7,7 +7,7 @@ - + @@ -75,7 +75,7 @@ } } }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/general/performance.html b/docs/master/general/performance.html index 57764e4d5d..1c6bf05676 100644 --- a/docs/master/general/performance.html +++ b/docs/master/general/performance.html @@ -7,7 +7,7 @@ - + @@ -121,7 +121,7 @@ } });

# When transpiling with Babel, consider using loose mode

Babel 7.9 changed the way classes are constructed. It is slow, unless used with loose mode. -More information (opens new window)

Last Updated: 1/9/2024, 4:24:43 PM

+More information (opens new window)

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/getting-started/index.html b/docs/master/getting-started/index.html index 62841e7660..e37b29c731 100644 --- a/docs/master/getting-started/index.html +++ b/docs/master/getting-started/index.html @@ -7,7 +7,7 @@ - + @@ -89,7 +89,7 @@ } }); </script> -

You can see all the ways to use Chart.js in the step-by-step guide.

Last Updated: 1/9/2024, 4:24:43 PM

+

You can see all the ways to use Chart.js in the step-by-step guide.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/getting-started/installation.html b/docs/master/getting-started/installation.html index d8fc703455..8144eb364f 100644 --- a/docs/master/getting-started/installation.html +++ b/docs/master/getting-started/installation.html @@ -7,7 +7,7 @@ - + @@ -40,7 +40,7 @@ (opens new window) GitHub (opens new window)

# Installation

# npm

npm (opens new window) npm (opens new window)

npm install chart.js
-

# CDN

# CDNJS

cdnjs (opens new window)

Chart.js built files are available on CDNJS (opens new window):

https://cdnjs.com/libraries/Chart.js (opens new window)

# jsDelivr

jsdelivr (opens new window) jsdelivr hits (opens new window)

Chart.js built files are also available through jsDelivr (opens new window):

https://www.jsdelivr.com/package/npm/chart.js?path=dist (opens new window)

# GitHub

github (opens new window)

You can download the latest version of Chart.js on GitHub (opens new window).

If you download or clone the repository, you must build Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is strongly advised.

Last Updated: 1/9/2024, 4:24:43 PM

+

# CDN

# CDNJS

cdnjs (opens new window)

Chart.js built files are available on CDNJS (opens new window):

https://cdnjs.com/libraries/Chart.js (opens new window)

# jsDelivr

jsdelivr (opens new window) jsdelivr hits (opens new window)

Chart.js built files are also available through jsDelivr (opens new window):

https://www.jsdelivr.com/package/npm/chart.js?path=dist (opens new window)

# GitHub

github (opens new window)

You can download the latest version of Chart.js on GitHub (opens new window).

If you download or clone the repository, you must build Chart.js to generate the dist files. Chart.js no longer comes with prebuilt release versions, so an alternative option to downloading the repo is strongly advised.

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/getting-started/integration.html b/docs/master/getting-started/integration.html index 137d52923d..4150d5a994 100644 --- a/docs/master/getting-started/integration.html +++ b/docs/master/getting-started/integration.html @@ -7,7 +7,7 @@ - + @@ -77,7 +77,7 @@ }); }); }); -
Last Updated: 1/9/2024, 4:24:43 PM

+

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/getting-started/usage.html b/docs/master/getting-started/usage.html index 8e16f1ce21..5f8ac19ca5 100644 --- a/docs/master/getting-started/usage.html +++ b/docs/master/getting-started/usage.html @@ -7,7 +7,7 @@ - + @@ -381,7 +381,7 @@ dist/index.5888047.js 208.66 KB 1.23s dist/index.dcb2e865.js 932 B 58ms ✨ Done in 0.51s. -

By importing and registering only select components, we’ve removed more than 56 KB of unnecessary code. Given that other dependencies take ~50 KB in the bundle, tree-shaking helps remove ~25% of Chart.js code from the bundle for our example application.

# Next steps

Now you’re familiar with all major concepts of Chart.js: chart types and elements, datasets, customization, plugins, components, and tree-shaking.

Feel free to review many examples of charts in the documentation and check the awesome list (opens new window) of Chart.js plugins and additional chart types as well as framework integrations (opens new window) (e.g., React, Vue, Svelte, etc.). Also, don’t hesitate to join Chart.js Discord (opens new window) and follow Chart.js on Twitter (opens new window).

Have fun and good luck building with Chart.js!

Last Updated: 1/9/2024, 4:24:43 PM

+

By importing and registering only select components, we’ve removed more than 56 KB of unnecessary code. Given that other dependencies take ~50 KB in the bundle, tree-shaking helps remove ~25% of Chart.js code from the bundle for our example application.

# Next steps

Now you’re familiar with all major concepts of Chart.js: chart types and elements, datasets, customization, plugins, components, and tree-shaking.

Feel free to review many examples of charts in the documentation and check the awesome list (opens new window) of Chart.js plugins and additional chart types as well as framework integrations (opens new window) (e.g., React, Vue, Svelte, etc.). Also, don’t hesitate to join Chart.js Discord (opens new window) and follow Chart.js on Twitter (opens new window).

Have fun and good luck building with Chart.js!

Last Updated: 2/4/2024, 6:43:48 PM

← →

- + diff --git a/docs/master/index.html b/docs/master/index.html index 441fdc1e36..803ed6067a 100644 --- a/docs/master/index.html +++ b/docs/master/index.html @@ -7,7 +7,7 @@ - + @@ -39,11 +39,11 @@ Stack Overflow (opens new window) GitHub - (opens new window)
  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Chart.js

Welcome to Chart.js!

# Why Chart.js

Among many charting libraries (opens new window) for JavaScript application developers, Chart.js is currently the most popular one according to GitHub stars (opens new window) (~60,000) and npm downloads (opens new window) (~2,400,000 weekly).

Chart.js was created and announced (opens new window) in 2013 but has come a long way since then. It’s open-source, licensed under the very permissive MIT license (opens new window), and maintained by an active community.

# Features

Chart.js provides a set of frequently used chart types, plugins, and customization options. In addition to a reasonable set of built-in chart types, you can use additional community-maintained chart types (opens new window). On top of that, it’s possible to combine several chart types into a mixed chart (essentially, blending multiple chart types into one on the same canvas).

Chart.js is highly customizable with custom plugins (opens new window) to create annotations, zoom, or drag-and-drop functionalities to name a few things.

# Defaults

Chart.js comes with a sound default configuration, making it very easy to start with and get an app that is ready for production. Chances are you will get a very appealing chart even if you don’t specify any options at all. For instance, Chart.js has animations turned on by default, so you can instantly bring attention to the story you’re telling with the data.

# Integrations

Chart.js comes with built-in TypeScript typings and is compatible with all popular JavaScript frameworks (opens new window) including React (opens new window), Vue (opens new window), Svelte (opens new window), and Angular (opens new window). You can use Chart.js directly or leverage well-maintained wrapper packages that allow for a more native integration with your frameworks of choice.

# Developer experience

Chart.js has very thorough documentation (yes, you're reading it), API reference, and examples. Maintainers and community members eagerly engage in conversations on Discord (opens new window), GitHub Discussions (opens new window), and Stack Overflow (opens new window) where more than 11,000 questions are tagged with chart.js.

# Canvas rendering

Chart.js renders chart elements on an HTML5 canvas unlike several others, mostly D3.js-based, charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. At the same time, canvas rendering disallows CSS styling, so you will have to use built-in options for that, or create a custom plugin or chart type to render everything to your liking.

# Performance

Chart.js is very well suited for large datasets. Such datasets can be efficiently ingested using the internal format, so you can skip data parsing and normalization. Alternatively, data decimation can be configured to sample the dataset and reduce its size before rendering.

In the end, the canvas rendering that Chart.js uses reduces the toll on your DOM tree in comparison to SVG rendering. Also, tree-shaking support allows you to include minimal parts of Chart.js code in your bundle, reducing bundle size and page load time.

# Community

Chart.js is actively developed (opens new window) and maintained by the community. With minor releases (opens new window) on an approximately bi-monthly basis and major releases with breaking changes every couple of years, Chart.js keeps the balance between adding new features and making it a hassle to keep up with them.

Last Updated: 1/9/2024, 4:24:43 PM

+ (opens new window)

  • Chart.js

  • Getting Started

  • General

  • Configuration

  • Chart Types

  • Axes

  • Developers

  • Migration

# Chart.js

Welcome to Chart.js!

# Why Chart.js

Among many charting libraries (opens new window) for JavaScript application developers, Chart.js is currently the most popular one according to GitHub stars (opens new window) (~60,000) and npm downloads (opens new window) (~2,400,000 weekly).

Chart.js was created and announced (opens new window) in 2013 but has come a long way since then. It’s open-source, licensed under the very permissive MIT license (opens new window), and maintained by an active community.

# Features

Chart.js provides a set of frequently used chart types, plugins, and customization options. In addition to a reasonable set of built-in chart types, you can use additional community-maintained chart types (opens new window). On top of that, it’s possible to combine several chart types into a mixed chart (essentially, blending multiple chart types into one on the same canvas).

Chart.js is highly customizable with custom plugins (opens new window) to create annotations, zoom, or drag-and-drop functionalities to name a few things.

# Defaults

Chart.js comes with a sound default configuration, making it very easy to start with and get an app that is ready for production. Chances are you will get a very appealing chart even if you don’t specify any options at all. For instance, Chart.js has animations turned on by default, so you can instantly bring attention to the story you’re telling with the data.

# Integrations

Chart.js comes with built-in TypeScript typings and is compatible with all popular JavaScript frameworks (opens new window) including React (opens new window), Vue (opens new window), Svelte (opens new window), and Angular (opens new window). You can use Chart.js directly or leverage well-maintained wrapper packages that allow for a more native integration with your frameworks of choice.

# Developer experience

Chart.js has very thorough documentation (yes, you're reading it), API reference, and examples. Maintainers and community members eagerly engage in conversations on Discord (opens new window), GitHub Discussions (opens new window), and Stack Overflow (opens new window) where more than 11,000 questions are tagged with chart.js.

# Canvas rendering

Chart.js renders chart elements on an HTML5 canvas unlike several others, mostly D3.js-based, charting libraries that render as SVG. Canvas rendering makes Chart.js very performant, especially for large datasets and complex visualizations that would otherwise require thousands of SVG nodes in the DOM tree. At the same time, canvas rendering disallows CSS styling, so you will have to use built-in options for that, or create a custom plugin or chart type to render everything to your liking.

# Performance

Chart.js is very well suited for large datasets. Such datasets can be efficiently ingested using the internal format, so you can skip data parsing and normalization. Alternatively, data decimation can be configured to sample the dataset and reduce its size before rendering.

In the end, the canvas rendering that Chart.js uses reduces the toll on your DOM tree in comparison to SVG rendering. Also, tree-shaking support allows you to include minimal parts of Chart.js code in your bundle, reducing bundle size and page load time.

# Community

Chart.js is actively developed (opens new window) and maintained by the community. With minor releases (opens new window) on an approximately bi-monthly basis and major releases with breaking changes every couple of years, Chart.js keeps the balance between adding new features and making it a hassle to keep up with them.

Last Updated: 2/4/2024, 6:43:48 PM

Getting Started →

- + diff --git a/docs/master/migration/v3-migration.html b/docs/master/migration/v3-migration.html index e4b5335fac..f80b8b0a6d 100644 --- a/docs/master/migration/v3-migration.html +++ b/docs/master/migration/v3-migration.html @@ -7,7 +7,7 @@ - + @@ -130,11 +130,11 @@ }
  • The time scale option distribution: 'series' was removed and a new scale type timeseries was introduced in its place
  • In the time scale, autoSkip is now enabled by default for consistency with the other scales

# Animations

Animation system was completely rewritten in Chart.js v3. Each property can now be animated separately. Please see animations docs for details.

# Customizability

  • custom attribute of elements was removed. Please use scriptable options
  • The hover property of scriptable options context object was renamed to active to align it with the datalabels plugin.

# Interactions

  • To allow DRY configuration, a root options scope for common interaction options was added. options.hover and options.plugins.tooltip now both extend from options.interaction. Defaults are defined at defaults.interaction level, so by default hover and tooltip interactions share the same mode etc.
  • interactions are now limited to the chart area + allowed overflow
  • {mode: 'label'} was replaced with {mode: 'index'}
  • {mode: 'single'} was replaced with {mode: 'nearest', intersect: true}
  • modes['X-axis'] was replaced with {mode: 'index', intersect: false}
  • options.onClick is now limited to the chart area
  • options.onClick and options.onHover now receive the chart instance as a 3rd argument
  • options.onHover now receives a wrapped event as the first parameter. The previous first parameter value is accessible via event.native.
  • options.hover.onHover was removed, use options.onHover.

# Ticks

  • options.gridLines was renamed to options.grid
  • options.gridLines.offsetGridLines was renamed to options.grid.offset.
  • options.gridLines.tickMarkLength was renamed to options.grid.tickLength.
  • options.ticks.fixedStepSize is no longer used. Use options.ticks.stepSize.
  • options.ticks.major and options.ticks.minor were replaced with scriptable options for tick fonts.
  • Chart.Ticks.formatters.linear was renamed to Chart.Ticks.formatters.numeric.
  • options.ticks.backdropPaddingX and options.ticks.backdropPaddingY were replaced with options.ticks.backdropPadding in the radial linear scale.

# Tooltip

  • xLabel and yLabel were removed. Please use label and formattedValue
  • The filter option will now be passed additional parameters when called and should have the method signature function(tooltipItem, index, tooltipItems, data)
  • The custom callback now takes a context object that has tooltip and chart properties
  • All properties of tooltip model related to the tooltip options have been moved to reside within the options property.
  • The callbacks no longer are given a data parameter. The tooltip item parameter contains the chart and dataset instead
  • The tooltip item's index parameter was renamed to dataIndex and value was renamed to formattedValue
  • The xPadding and yPadding options were merged into a single padding object

# Developer migration

While the end-user migration for Chart.js 3 is fairly straight-forward, the developer migration can be more complicated. Please reach out for help in the #dev Discord (opens new window) channel if tips on migrating would be helpful.

Some of the biggest things that have changed:

  • There is a completely rewritten and more performant animation system.
    • Element._model and Element._view are no longer used and properties are now set directly on the elements. You will have to use the method getProps to access these properties inside most methods such as inXRange/inYRange and getCenterPoint. Please take a look at the Chart.js-provided elements (opens new window) for examples.
    • When building the elements in a controller, it's now suggested to call updateElement to provide the element properties. There are also methods such as getSharedOptions and includeOptions that have been added to skip redundant computation. Please take a look at the Chart.js-provided controllers (opens new window) for examples.
  • Scales introduced a new parsing API. This API takes user data and converts it into a more standard format. E.g. it allows users to provide numeric data as a string and converts it to a number where necessary. Previously this was done on the fly as charts were rendered. Now it's done up front with the ability to skip it for better performance if users provide data in the correct format. If you're using standard data format like x/y you may not need to do anything. If you're using a custom data format you will have to override some of the parse methods in core.datasetController.js. An example can be found in chartjs-chart-financial (opens new window), which uses an {o, h, l, c} data format.

A few changes were made to controllers that are more straight-forward, but will affect all controllers:

  • Options: -
    • global was removed from the defaults namespace as it was unnecessary and sometimes inconsistent
    • Dataset defaults are now under the chart type options instead of vice-versa. This was not able to be done when introduced in 2.x for backwards compatibility. Fixing it removes the biggest stumbling block that new chart developers encountered
    • Scale default options need to be updated as described in the end user migration section (e.g. x instead of xAxes and y instead of yAxes)
  • updateElement was changed to updateElements and has a new method signature as described below. This provides performance enhancements such as allowing easier reuse of computations that are common to all elements and reducing the number of function calls

# Removed

The following properties and methods were removed:

# Removed from Chart

  • Chart.animationService
  • Chart.active
  • Chart.borderWidth
  • Chart.chart.chart
  • Chart.Bar. New charts are created via new Chart and providing the appropriate type parameter
  • Chart.Bubble. New charts are created via new Chart and providing the appropriate type parameter
  • Chart.Chart
  • Chart.Controller
  • Chart.Doughnut. New charts are created via new Chart and providing the appropriate type parameter
  • Chart.innerRadius now lives on doughnut, pie, and polarArea controllers
  • Chart.lastActive
  • Chart.Legend was moved to Chart.plugins.legend._element and made private
  • Chart.Line. New charts are created via new Chart and providing the appropriate type parameter
  • Chart.LinearScaleBase now must be imported and cannot be accessed off the Chart object
  • Chart.offsetX
  • Chart.offsetY
  • Chart.outerRadius now lives on doughnut, pie, and polarArea controllers
  • Chart.plugins was replaced with Chart.registry. Plugin defaults are now in Chart.defaults.plugins[id].
  • Chart.plugins.register was replaced by Chart.register.
  • Chart.PolarArea. New charts are created via new Chart and providing the appropriate type parameter
  • Chart.prototype.generateLegend
  • Chart.platform. It only contained disableCSSInjection. CSS is never injected in v3.
  • Chart.PluginBase
  • Chart.Radar. New charts are created via new Chart and providing the appropriate type parameter
  • Chart.radiusLength
  • Chart.scaleService was replaced with Chart.registry. Scale defaults are now in Chart.defaults.scales[type].
  • Chart.Scatter. New charts are created via new Chart and providing the appropriate type parameter
  • Chart.types
  • Chart.Title was moved to Chart.plugins.title._element and made private
  • Chart.Tooltip is now provided by the tooltip plugin. The positioners can be accessed from tooltipPlugin.positioners
  • ILayoutItem.minSize

# Removed from Dataset Controllers

  • BarController.getDatasetMeta().bar
  • DatasetController.addElementAndReset
  • DatasetController.createMetaData
  • DatasetController.createMetaDataset
  • DoughnutController.getRingIndex

# Removed from Elements

  • Element.getArea
  • Element.height
  • Element.hidden was replaced by chart level status, usable with getDataVisibility(index) / toggleDataVisibility(index)
  • Element.initialize
  • Element.inLabelRange
  • Line.calculatePointY

# Removed from Helpers

  • helpers.addEvent
  • helpers.aliasPixel
  • helpers.arrayEquals
  • helpers.configMerge
  • helpers.findIndex
  • helpers.findNextWhere
  • helpers.findPreviousWhere
  • helpers.extend. Use Object.assign instead
  • helpers.getValueAtIndexOrDefault. Use helpers.resolve instead.
  • helpers.indexOf
  • helpers.lineTo
  • helpers.longestText was made private
  • helpers.max
  • helpers.measureText was made private
  • helpers.min
  • helpers.nextItem
  • helpers.niceNum
  • helpers.numberOfLabelLines
  • helpers.previousItem
  • helpers.removeEvent
  • helpers.roundedRect
  • helpers.scaleMerge
  • helpers.where

# Removed from Layout

  • Layout.defaults

# Removed from Scales

  • LinearScaleBase.handleDirectionalChanges
  • LogarithmicScale.minNotZero
  • Scale.getRightValue
  • Scale.longestLabelWidth
  • Scale.longestTextCache is now private
  • Scale.margins is now private
  • Scale.mergeTicksOptions
  • Scale.ticksAsNumbers
  • Scale.tickValues is now private
  • TimeScale.getLabelCapacity is now private
  • TimeScale.tickFormatFunction is now private

# Removed from Plugins (Legend, Title, and Tooltip)

  • IPlugin.afterScaleUpdate. Use afterLayout instead
  • Legend.margins is now private
  • Legend onClick, onHover, and onLeave options now receive the legend as the 3rd argument in addition to implicitly via this
  • Legend onClick, onHover, and onLeave options now receive a wrapped event as the first parameter. The previous first parameter value is accessible via event.native.
  • Title.margins is now private
  • The tooltip item's x and y attributes were replaced by element. You can use element.x and element.y or element.tooltipPosition() instead.

# Removal of Public APIs

The following public APIs were removed.

  • getElementAtEvent is replaced with chart.getElementsAtEventForMode(e, 'nearest', { intersect: true }, false)
  • getElementsAtEvent is replaced with chart.getElementsAtEventForMode(e, 'index', { intersect: true }, false)
  • getElementsAtXAxis is replaced with chart.getElementsAtEventForMode(e, 'index', { intersect: false }, false)
  • getDatasetAtEvent is replaced with chart.getElementsAtEventForMode(e, 'dataset', { intersect: true }, false)

# Removal of private APIs

The following private APIs were removed.

  • Chart._bufferedRender
  • Chart._updating
  • Chart.data.datasets[datasetIndex]._meta
  • DatasetController._getIndexScaleId
  • DatasetController._getIndexScale
  • DatasetController._getValueScaleId
  • DatasetController._getValueScale
  • Element._ctx
  • Element._model
  • Element._view
  • LogarithmicScale._valueOffset
  • TimeScale.getPixelForOffset
  • TimeScale.getLabelWidth
  • Tooltip._lastActive

# Renamed

The following properties were renamed during v3 development:

  • Chart.Animation.animationObject was renamed to Chart.Animation
  • Chart.Animation.chartInstance was renamed to Chart.Animation.chart
  • Chart.canvasHelpers was merged with Chart.helpers
  • Chart.elements.Arc was renamed to Chart.elements.ArcElement
  • Chart.elements.Line was renamed to Chart.elements.LineElement
  • Chart.elements.Point was renamed to Chart.elements.PointElement
  • Chart.elements.Rectangle was renamed to Chart.elements.BarElement
  • Chart.layoutService was renamed to Chart.layouts
  • Chart.pluginService was renamed to Chart.plugins
  • helpers.callCallback was renamed to helpers.callback
  • helpers.drawRoundedRectangle was renamed to helpers.roundedRect
  • helpers.getValueOrDefault was renamed to helpers.valueOrDefault
  • LayoutItem.fullWidth was renamed to LayoutItem.fullSize
  • Point.controlPointPreviousX was renamed to Point.cp1x
  • Point.controlPointPreviousY was renamed to Point.cp1y
  • Point.controlPointNextX was renamed to Point.cp2x
  • Point.controlPointNextY was renamed to Point.cp2y
  • Scale.calculateTickRotation was renamed to Scale.calculateLabelRotation
  • Tooltip.options.legendColorBackgroupd was renamed to Tooltip.options.multiKeyBackground

# Renamed private APIs

The private APIs listed below were renamed:

  • BarController.calculateBarIndexPixels was renamed to BarController._calculateBarIndexPixels
  • BarController.calculateBarValuePixels was renamed to BarController._calculateBarValuePixels
  • BarController.getStackCount was renamed to BarController._getStackCount
  • BarController.getStackIndex was renamed to BarController._getStackIndex
  • BarController.getRuler was renamed to BarController._getRuler
  • Chart.destroyDatasetMeta was renamed to Chart._destroyDatasetMeta
  • Chart.drawDataset was renamed to Chart._drawDataset
  • Chart.drawDatasets was renamed to Chart._drawDatasets
  • Chart.eventHandler was renamed to Chart._eventHandler
  • Chart.handleEvent was renamed to Chart._handleEvent
  • Chart.initialize was renamed to Chart._initialize
  • Chart.resetElements was renamed to Chart._resetElements
  • Chart.unbindEvents was renamed to Chart._unbindEvents
  • Chart.updateDataset was renamed to Chart._updateDataset
  • Chart.updateDatasets was renamed to Chart._updateDatasets
  • Chart.updateLayout was renamed to Chart._updateLayout
  • DatasetController.destroy was renamed to DatasetController._destroy
  • DatasetController.insertElements was renamed to DatasetController._insertElements
  • DatasetController.onDataPop was renamed to DatasetController._onDataPop
  • DatasetController.onDataPush was renamed to DatasetController._onDataPush
  • DatasetController.onDataShift was renamed to DatasetController._onDataShift
  • DatasetController.onDataSplice was renamed to DatasetController._onDataSplice
  • DatasetController.onDataUnshift was renamed to DatasetController._onDataUnshift
  • DatasetController.removeElements was renamed to DatasetController._removeElements
  • DatasetController.resyncElements was renamed to DatasetController._resyncElements
  • LayoutItem.isFullWidth was renamed to LayoutItem.isFullSize
  • RadialLinearScale.setReductions was renamed to RadialLinearScale._setReductions
  • RadialLinearScale.pointLabels was renamed to RadialLinearScale._pointLabels
  • Scale.handleMargins was renamed to Scale._handleMargins

# Changed

The APIs listed in this section have changed in signature or behaviour from version 2.

# Changed in Scales

  • Scale.getLabelForIndex was replaced by scale.getLabelForValue
  • Scale.getPixelForValue now only requires one parameter. For the TimeScale that parameter must be millis since the epoch. As a performance optimization, it may take an optional second parameter, giving the index of the data point.
# Changed in Ticks
  • Scale.afterBuildTicks now has no parameters like the other callbacks
  • Scale.buildTicks is now expected to return tick objects
  • Scale.convertTicksToLabels was renamed to generateTickLabels. It is now expected to set the label property on the ticks given as input
  • Scale.ticks now contains objects instead of strings
  • When the autoSkip option is enabled, Scale.ticks now contains only the non-skipped ticks instead of all ticks.
  • Ticks are now always generated in monotonically increasing order
# Changed in Time Scale
  • getValueForPixel now returns milliseconds since the epoch

# Changed in Controllers

# Core Controller
  • The first parameter to updateHoverStyle is now an array of objects containing the element, datasetIndex, and index
  • The signature or resize changed, the first silent parameter was removed.
# Dataset Controllers
  • updateElement was replaced with updateElements now taking the elements to update, the start index, count, and mode
  • setHoverStyle and removeHoverStyle now additionally take the datasetIndex and index

# Changed in Interactions

  • Interaction mode methods now return an array of objects containing the element, datasetIndex, and index

# Changed in Layout

  • ILayoutItem.update no longer has a return value

# Changed in Helpers

All helpers are now exposed in a flat hierarchy, e.g., Chart.helpers.canvas.clipArea -> Chart.helpers.clipArea

# Canvas Helper
  • The second parameter to drawPoint is now the full options object, so style, rotation, and radius are no longer passed explicitly
  • helpers.getMaximumHeight was replaced by helpers.dom.getMaximumSize
  • helpers.getMaximumWidth was replaced by helpers.dom.getMaximumSize
  • helpers.clear was renamed to helpers.clearCanvas and now takes canvas and optionally ctx as parameter(s).
  • helpers.retinaScale accepts optional third parameter forceStyle, which forces overriding current canvas style. forceRatio no longer falls back to window.devicePixelRatio, instead it defaults to 1.

# Changed in Platform

  • Chart.platform is no longer the platform object used by charts. Every chart instance now has a separate platform instance.
  • Chart.platforms is an object that contains two usable platform classes, BasicPlatform and DomPlatform. It also contains BasePlatform, a class that all platforms must extend from.
  • If the canvas passed in is an instance of OffscreenCanvas, the BasicPlatform is automatically used.
  • isAttached method was added to platform.

# Changed in IPlugin interface

  • All plugin hooks have unified signature with 3 arguments: chart, args and options. This means change in signature for these hooks: beforeInit, afterInit, reset, beforeLayout, afterLayout, beforeRender, afterRender, beforeDraw, afterDraw, beforeDatasetsDraw, afterDatasetsDraw, beforeEvent, afterEvent, resize, destroy.
  • afterDatasetsUpdate, afterUpdate, beforeDatasetsUpdate, and beforeUpdate now receive args object as second argument. options argument is always the last and thus was moved from 2nd to 3rd place.
  • afterEvent and beforeEvent now receive a wrapped event as the event property of the second argument. The native event is available via args.event.native.
  • Initial resize is no longer silent. Meaning that resize event can fire between beforeInit and afterInit
  • New hooks: install, start, stop, and uninstall
  • afterEvent should notify about changes that need a render by setting args.changed to true. Because the args are shared with all plugins, it should only be set to true and not false.
Last Updated: 1/9/2024, 4:24:43 PM

+

  • global was removed from the defaults namespace as it was unnecessary and sometimes inconsistent
  • Dataset defaults are now under the chart type options instead of vice-versa. This was not able to be done when introduced in 2.x for backwards compatibility. Fixing it removes the biggest stumbling block that new chart developers encountered
  • Scale default options need to be updated as described in the end user migration section (e.g. x instead of xAxes and y instead of yAxes)
  • updateElement was changed to updateElements and has a new method signature as described below. This provides performance enhancements such as allowing easier reuse of computations that are common to all elements and reducing the number of function calls

    • # Removed

    The following properties and methods were removed:

    # Removed from Chart

    • Chart.animationService
    • Chart.active
    • Chart.borderWidth
    • Chart.chart.chart
    • Chart.Bar. New charts are created via new Chart and providing the appropriate type parameter
    • Chart.Bubble. New charts are created via new Chart and providing the appropriate type parameter
    • Chart.Chart
    • Chart.Controller
    • Chart.Doughnut. New charts are created via new Chart and providing the appropriate type parameter
    • Chart.innerRadius now lives on doughnut, pie, and polarArea controllers
    • Chart.lastActive
    • Chart.Legend was moved to Chart.plugins.legend._element and made private
    • Chart.Line. New charts are created via new Chart and providing the appropriate type parameter
    • Chart.LinearScaleBase now must be imported and cannot be accessed off the Chart object
    • Chart.offsetX
    • Chart.offsetY
    • Chart.outerRadius now lives on doughnut, pie, and polarArea controllers
    • Chart.plugins was replaced with Chart.registry. Plugin defaults are now in Chart.defaults.plugins[id].
    • Chart.plugins.register was replaced by Chart.register.
    • Chart.PolarArea. New charts are created via new Chart and providing the appropriate type parameter
    • Chart.prototype.generateLegend
    • Chart.platform. It only contained disableCSSInjection. CSS is never injected in v3.
    • Chart.PluginBase
    • Chart.Radar. New charts are created via new Chart and providing the appropriate type parameter
    • Chart.radiusLength
    • Chart.scaleService was replaced with Chart.registry. Scale defaults are now in Chart.defaults.scales[type].
    • Chart.Scatter. New charts are created via new Chart and providing the appropriate type parameter
    • Chart.types
    • Chart.Title was moved to Chart.plugins.title._element and made private
    • Chart.Tooltip is now provided by the tooltip plugin. The positioners can be accessed from tooltipPlugin.positioners
    • ILayoutItem.minSize

    # Removed from Dataset Controllers

    • BarController.getDatasetMeta().bar
    • DatasetController.addElementAndReset
    • DatasetController.createMetaData
    • DatasetController.createMetaDataset
    • DoughnutController.getRingIndex

    # Removed from Elements

    • Element.getArea
    • Element.height
    • Element.hidden was replaced by chart level status, usable with getDataVisibility(index) / toggleDataVisibility(index)
    • Element.initialize
    • Element.inLabelRange
    • Line.calculatePointY

    # Removed from Helpers

    • helpers.addEvent
    • helpers.aliasPixel
    • helpers.arrayEquals
    • helpers.configMerge
    • helpers.findIndex
    • helpers.findNextWhere
    • helpers.findPreviousWhere
    • helpers.extend. Use Object.assign instead
    • helpers.getValueAtIndexOrDefault. Use helpers.resolve instead.
    • helpers.indexOf
    • helpers.lineTo
    • helpers.longestText was made private
    • helpers.max
    • helpers.measureText was made private
    • helpers.min
    • helpers.nextItem
    • helpers.niceNum
    • helpers.numberOfLabelLines
    • helpers.previousItem
    • helpers.removeEvent
    • helpers.roundedRect
    • helpers.scaleMerge
    • helpers.where

    # Removed from Layout

    • Layout.defaults

    # Removed from Scales

    • LinearScaleBase.handleDirectionalChanges
    • LogarithmicScale.minNotZero
    • Scale.getRightValue
    • Scale.longestLabelWidth
    • Scale.longestTextCache is now private
    • Scale.margins is now private
    • Scale.mergeTicksOptions
    • Scale.ticksAsNumbers
    • Scale.tickValues is now private
    • TimeScale.getLabelCapacity is now private
    • TimeScale.tickFormatFunction is now private

    # Removed from Plugins (Legend, Title, and Tooltip)

    • IPlugin.afterScaleUpdate. Use afterLayout instead
    • Legend.margins is now private
    • Legend onClick, onHover, and onLeave options now receive the legend as the 3rd argument in addition to implicitly via this
    • Legend onClick, onHover, and onLeave options now receive a wrapped event as the first parameter. The previous first parameter value is accessible via event.native.
    • Title.margins is now private
    • The tooltip item's x and y attributes were replaced by element. You can use element.x and element.y or element.tooltipPosition() instead.

    # Removal of Public APIs

    The following public APIs were removed.

    • getElementAtEvent is replaced with chart.getElementsAtEventForMode(e, 'nearest', { intersect: true }, false)
    • getElementsAtEvent is replaced with chart.getElementsAtEventForMode(e, 'index', { intersect: true }, false)
    • getElementsAtXAxis is replaced with chart.getElementsAtEventForMode(e, 'index', { intersect: false }, false)
    • getDatasetAtEvent is replaced with chart.getElementsAtEventForMode(e, 'dataset', { intersect: true }, false)

    # Removal of private APIs

    The following private APIs were removed.

    • Chart._bufferedRender
    • Chart._updating
    • Chart.data.datasets[datasetIndex]._meta
    • DatasetController._getIndexScaleId
    • DatasetController._getIndexScale
    • DatasetController._getValueScaleId
    • DatasetController._getValueScale
    • Element._ctx
    • Element._model
    • Element._view
    • LogarithmicScale._valueOffset
    • TimeScale.getPixelForOffset
    • TimeScale.getLabelWidth
    • Tooltip._lastActive

    # Renamed

    The following properties were renamed during v3 development:

    • Chart.Animation.animationObject was renamed to Chart.Animation
    • Chart.Animation.chartInstance was renamed to Chart.Animation.chart
    • Chart.canvasHelpers was merged with Chart.helpers
    • Chart.elements.Arc was renamed to Chart.elements.ArcElement
    • Chart.elements.Line was renamed to Chart.elements.LineElement
    • Chart.elements.Point was renamed to Chart.elements.PointElement
    • Chart.elements.Rectangle was renamed to Chart.elements.BarElement
    • Chart.layoutService was renamed to Chart.layouts
    • Chart.pluginService was renamed to Chart.plugins
    • helpers.callCallback was renamed to helpers.callback
    • helpers.drawRoundedRectangle was renamed to helpers.roundedRect
    • helpers.getValueOrDefault was renamed to helpers.valueOrDefault
    • LayoutItem.fullWidth was renamed to LayoutItem.fullSize
    • Point.controlPointPreviousX was renamed to Point.cp1x
    • Point.controlPointPreviousY was renamed to Point.cp1y
    • Point.controlPointNextX was renamed to Point.cp2x
    • Point.controlPointNextY was renamed to Point.cp2y
    • Scale.calculateTickRotation was renamed to Scale.calculateLabelRotation
    • Tooltip.options.legendColorBackgroupd was renamed to Tooltip.options.multiKeyBackground

    # Renamed private APIs

    The private APIs listed below were renamed:

    • BarController.calculateBarIndexPixels was renamed to BarController._calculateBarIndexPixels
    • BarController.calculateBarValuePixels was renamed to BarController._calculateBarValuePixels
    • BarController.getStackCount was renamed to BarController._getStackCount
    • BarController.getStackIndex was renamed to BarController._getStackIndex
    • BarController.getRuler was renamed to BarController._getRuler
    • Chart.destroyDatasetMeta was renamed to Chart._destroyDatasetMeta
    • Chart.drawDataset was renamed to Chart._drawDataset
    • Chart.drawDatasets was renamed to Chart._drawDatasets
    • Chart.eventHandler was renamed to Chart._eventHandler
    • Chart.handleEvent was renamed to Chart._handleEvent
    • Chart.initialize was renamed to Chart._initialize
    • Chart.resetElements was renamed to Chart._resetElements
    • Chart.unbindEvents was renamed to Chart._unbindEvents
    • Chart.updateDataset was renamed to Chart._updateDataset
    • Chart.updateDatasets was renamed to Chart._updateDatasets
    • Chart.updateLayout was renamed to Chart._updateLayout
    • DatasetController.destroy was renamed to DatasetController._destroy
    • DatasetController.insertElements was renamed to DatasetController._insertElements
    • DatasetController.onDataPop was renamed to DatasetController._onDataPop
    • DatasetController.onDataPush was renamed to DatasetController._onDataPush
    • DatasetController.onDataShift was renamed to DatasetController._onDataShift
    • DatasetController.onDataSplice was renamed to DatasetController._onDataSplice
    • DatasetController.onDataUnshift was renamed to DatasetController._onDataUnshift
    • DatasetController.removeElements was renamed to DatasetController._removeElements
    • DatasetController.resyncElements was renamed to DatasetController._resyncElements
    • LayoutItem.isFullWidth was renamed to LayoutItem.isFullSize
    • RadialLinearScale.setReductions was renamed to RadialLinearScale._setReductions
    • RadialLinearScale.pointLabels was renamed to RadialLinearScale._pointLabels
    • Scale.handleMargins was renamed to Scale._handleMargins

    # Changed

    The APIs listed in this section have changed in signature or behaviour from version 2.

    # Changed in Scales

    • Scale.getLabelForIndex was replaced by scale.getLabelForValue
    • Scale.getPixelForValue now only requires one parameter. For the TimeScale that parameter must be millis since the epoch. As a performance optimization, it may take an optional second parameter, giving the index of the data point.
    # Changed in Ticks
    • Scale.afterBuildTicks now has no parameters like the other callbacks
    • Scale.buildTicks is now expected to return tick objects
    • Scale.convertTicksToLabels was renamed to generateTickLabels. It is now expected to set the label property on the ticks given as input
    • Scale.ticks now contains objects instead of strings
    • When the autoSkip option is enabled, Scale.ticks now contains only the non-skipped ticks instead of all ticks.
    • Ticks are now always generated in monotonically increasing order
    # Changed in Time Scale
    • getValueForPixel now returns milliseconds since the epoch

    # Changed in Controllers

    # Core Controller
    • The first parameter to updateHoverStyle is now an array of objects containing the element, datasetIndex, and index
    • The signature or resize changed, the first silent parameter was removed.
    # Dataset Controllers
    • updateElement was replaced with updateElements now taking the elements to update, the start index, count, and mode
    • setHoverStyle and removeHoverStyle now additionally take the datasetIndex and index

    # Changed in Interactions

    • Interaction mode methods now return an array of objects containing the element, datasetIndex, and index

    # Changed in Layout

    • ILayoutItem.update no longer has a return value

    # Changed in Helpers

    All helpers are now exposed in a flat hierarchy, e.g., Chart.helpers.canvas.clipArea -> Chart.helpers.clipArea

    # Canvas Helper
    • The second parameter to drawPoint is now the full options object, so style, rotation, and radius are no longer passed explicitly
    • helpers.getMaximumHeight was replaced by helpers.dom.getMaximumSize
    • helpers.getMaximumWidth was replaced by helpers.dom.getMaximumSize
    • helpers.clear was renamed to helpers.clearCanvas and now takes canvas and optionally ctx as parameter(s).
    • helpers.retinaScale accepts optional third parameter forceStyle, which forces overriding current canvas style. forceRatio no longer falls back to window.devicePixelRatio, instead it defaults to 1.

    # Changed in Platform

    • Chart.platform is no longer the platform object used by charts. Every chart instance now has a separate platform instance.
    • Chart.platforms is an object that contains two usable platform classes, BasicPlatform and DomPlatform. It also contains BasePlatform, a class that all platforms must extend from.
    • If the canvas passed in is an instance of OffscreenCanvas, the BasicPlatform is automatically used.
    • isAttached method was added to platform.

    # Changed in IPlugin interface

    • All plugin hooks have unified signature with 3 arguments: chart, args and options. This means change in signature for these hooks: beforeInit, afterInit, reset, beforeLayout, afterLayout, beforeRender, afterRender, beforeDraw, afterDraw, beforeDatasetsDraw, afterDatasetsDraw, beforeEvent, afterEvent, resize, destroy.
    • afterDatasetsUpdate, afterUpdate, beforeDatasetsUpdate, and beforeUpdate now receive args object as second argument. options argument is always the last and thus was moved from 2nd to 3rd place.
    • afterEvent and beforeEvent now receive a wrapped event as the event property of the second argument. The native event is available via args.event.native.
    • Initial resize is no longer silent. Meaning that resize event can fire between beforeInit and afterInit
    • New hooks: install, start, stop, and uninstall
    • afterEvent should notify about changes that need a render by setting args.changed to true. Because the args are shared with all plugins, it should only be set to true and not false.
    Last Updated: 2/4/2024, 6:43:48 PM

    ←

    - + diff --git a/docs/master/migration/v4-migration.html b/docs/master/migration/v4-migration.html index cd28db073e..776c1a530d 100644 --- a/docs/master/migration/v4-migration.html +++ b/docs/master/migration/v4-migration.html @@ -7,7 +7,7 @@ - + @@ -42,7 +42,7 @@ (opens new window)

    # 4.x Migration Guide

    Chart.js 4.0 introduces a number of breaking changes. We tried keeping the amount of breaking changes to a minimum. For some features and bug fixes it was necessary to break backwards compatibility, but we aimed to do so only when worth the benefit.

    # End user migration

    # Charts

    • Charts don't override the default tooltip callbacks, so all chart types have the same-looking tooltips.
    • Default scale override has been removed if the configured scale starts with x/y. Defining xAxes in your config will now create a second scale instead of overriding the default x axis.

    # Options

    A number of changes were made to the configuration options passed to the Chart constructor. Those changes are documented below.

    # Specific changes

    • The radialLinear grid indexable and scriptable options don't decrease the index of the specified grid line anymore.
    • The destroy plugin hook has been removed and replaced with afterDestroy.
    • Ticks callback on time scale now receives timestamp instead of a formatted label.
    • scales[id].grid.drawBorder has been renamed to scales[id].border.display.
    • scales[id].grid.borderWidth has been renamed to scales[id].border.width.
    • scales[id].grid.borderColor has been renamed to scales[id].border.color.
    • scales[id].grid.borderDash has been renamed to scales[id].border.dash.
    • scales[id].grid.borderDashOffset has been renamed to scales[id].border.dashOffset.
    • The z index for the border of a scale is now configurable instead of being 1 higher as the grid z index.
    • Linear scales now add and subtracts 5% of the max value to the range if the min and max are the same instead of 1.
    • If the tooltip callback returns undefined, then the default callback will be used.
    • maintainAspectRatio respects container height.
    • Time and timeseries scales use ticks.stepSize instead of time.stepSize, which has been removed.
    • maxTickslimit wont be used for the ticks in autoSkip if the determined max ticks is less then the maxTicksLimit.
    • dist/chart.js has been removed.
    • dist/chart.min.js has been renamed to dist/chart.umd.js.
    • dist/chart.esm.js has been renamed to dist/chart.js.

    # Type changes

    • The order of the ChartMeta parameters have been changed from <Element, DatasetElement, Type> to <Type, Element, DatasetElement>.

    # General

    Last Updated: 1/9/2024, 4:24:43 PM

    +

    If you are experiencing problems with Jest (opens new window), follow its documentation (opens new window) to enable the ESM support. Or, we can recommend you migrating to Vitest (opens new window). Vitest has the ESM support out of the box and almost the same API as Jest (opens new window). See an example of migration (opens new window).
  • Removed fallback to fontColor for the legend text and strikethrough color.
  • Removed config._chart fallback for this.chart in the filler plugin.
  • Removed this._chart in the filler plugin.
    • Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/advanced/data-decimation.html b/docs/master/samples/advanced/data-decimation.html index 4e18a6a95c..27f5dbfc2d 100644 --- a/docs/master/samples/advanced/data-decimation.html +++ b/docs/master/samples/advanced/data-decimation.html @@ -7,7 +7,7 @@ - + @@ -213,7 +213,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/advanced/derived-axis-type.html b/docs/master/samples/advanced/derived-axis-type.html index 21d3c86d37..1a0d3b3dcb 100644 --- a/docs/master/samples/advanced/derived-axis-type.html +++ b/docs/master/samples/advanced/derived-axis-type.html @@ -7,7 +7,7 @@ - + @@ -154,7 +154,7 @@ Log2Axis.defaults = {}; // The derived axis is registered like this: // Chart.register(Log2Axis); -

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/advanced/derived-chart-type.html b/docs/master/samples/advanced/derived-chart-type.html index b99a7d740c..807d639220 100644 --- a/docs/master/samples/advanced/derived-chart-type.html +++ b/docs/master/samples/advanced/derived-chart-type.html @@ -7,7 +7,7 @@ - + @@ -122,7 +122,7 @@ // Custom.overrides = Chart.overrides.bubble; // Stores the controller so that the chart initialization routine can look it up Chart.register(Custom); -

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/advanced/linear-gradient.html b/docs/master/samples/advanced/linear-gradient.html index 46b07ccc3b..9f895e2d90 100644 --- a/docs/master/samples/advanced/linear-gradient.html +++ b/docs/master/samples/advanced/linear-gradient.html @@ -7,7 +7,7 @@ - + @@ -205,7 +205,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/advanced/programmatic-events.html b/docs/master/samples/advanced/programmatic-events.html index c0be8694a7..3257f510fa 100644 --- a/docs/master/samples/advanced/programmatic-events.html +++ b/docs/master/samples/advanced/programmatic-events.html @@ -7,7 +7,7 @@ - + @@ -195,7 +195,7 @@ hoverBorderColor: 'green', } ] -};

    # API

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # API

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/advanced/progress-bar.html b/docs/master/samples/advanced/progress-bar.html index 9c9bfa1461..16c67cb874 100644 --- a/docs/master/samples/advanced/progress-bar.html +++ b/docs/master/samples/advanced/progress-bar.html @@ -7,7 +7,7 @@ - + @@ -263,7 +263,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/advanced/radial-gradient.html b/docs/master/samples/advanced/radial-gradient.html index 92c93aac06..5a5f3afbc0 100644 --- a/docs/master/samples/advanced/radial-gradient.html +++ b/docs/master/samples/advanced/radial-gradient.html @@ -7,7 +7,7 @@ - + @@ -219,7 +219,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/animations/delay.html b/docs/master/samples/animations/delay.html index b1bcf154c2..7e5e813c1a 100644 --- a/docs/master/samples/animations/delay.html +++ b/docs/master/samples/animations/delay.html @@ -7,7 +7,7 @@ - + @@ -161,7 +161,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/animations/drop.html b/docs/master/samples/animations/drop.html index 6e02552732..f09062f37c 100644 --- a/docs/master/samples/animations/drop.html +++ b/docs/master/samples/animations/drop.html @@ -7,7 +7,7 @@ - + @@ -245,7 +245,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/animations/loop.html b/docs/master/samples/animations/loop.html index 11f8ffc74b..edb3b68cb6 100644 --- a/docs/master/samples/animations/loop.html +++ b/docs/master/samples/animations/loop.html @@ -7,7 +7,7 @@ - + @@ -245,7 +245,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/animations/progressive-line-easing.html b/docs/master/samples/animations/progressive-line-easing.html index 4c0ba3bd93..512519657f 100644 --- a/docs/master/samples/animations/progressive-line-easing.html +++ b/docs/master/samples/animations/progressive-line-easing.html @@ -7,7 +7,7 @@ - + @@ -337,7 +337,7 @@ restartAnims(chart); } }, -];

    # Api

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Api

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/animations/progressive-line.html b/docs/master/samples/animations/progressive-line.html index a040c7b461..4049158d9d 100644 --- a/docs/master/samples/animations/progressive-line.html +++ b/docs/master/samples/animations/progressive-line.html @@ -7,7 +7,7 @@ - + @@ -183,7 +183,7 @@ data.push({x: i, y: prev}); prev2 += 5 - Math.random() * 10; data2.push({x: i, y: prev2}); -}

    # Api

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +}

    # Api

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/area/line-boundaries.html b/docs/master/samples/area/line-boundaries.html index 9334d297fb..aae72b0f70 100644 --- a/docs/master/samples/area/line-boundaries.html +++ b/docs/master/samples/area/line-boundaries.html @@ -7,7 +7,7 @@ - + @@ -233,7 +233,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/area/line-datasets.html b/docs/master/samples/area/line-datasets.html index 63ff286872..a849d800a8 100644 --- a/docs/master/samples/area/line-datasets.html +++ b/docs/master/samples/area/line-datasets.html @@ -7,7 +7,7 @@ - + @@ -319,7 +319,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/area/line-drawtime.html b/docs/master/samples/area/line-drawtime.html index 8f35d057ba..29c2eb3df7 100644 --- a/docs/master/samples/area/line-drawtime.html +++ b/docs/master/samples/area/line-drawtime.html @@ -7,7 +7,7 @@ - + @@ -223,7 +223,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/area/line-stacked.html b/docs/master/samples/area/line-stacked.html index ae3d17f563..4a8f1768fa 100644 --- a/docs/master/samples/area/line-stacked.html +++ b/docs/master/samples/area/line-stacked.html @@ -7,7 +7,7 @@ - + @@ -339,7 +339,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/area/radar.html b/docs/master/samples/area/radar.html index 8c424912df..9042704b0e 100644 --- a/docs/master/samples/area/radar.html +++ b/docs/master/samples/area/radar.html @@ -7,7 +7,7 @@ - + @@ -273,7 +273,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/bar/border-radius.html b/docs/master/samples/bar/border-radius.html index f3a9beef37..80456a66c6 100644 --- a/docs/master/samples/bar/border-radius.html +++ b/docs/master/samples/bar/border-radius.html @@ -7,7 +7,7 @@ - + @@ -145,7 +145,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/bar/floating.html b/docs/master/samples/bar/floating.html index f3a9660b5a..e6ce8fd01e 100644 --- a/docs/master/samples/bar/floating.html +++ b/docs/master/samples/bar/floating.html @@ -7,7 +7,7 @@ - + @@ -141,7 +141,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/bar/horizontal.html b/docs/master/samples/bar/horizontal.html index 9dafec82b8..e16b1c1ec8 100644 --- a/docs/master/samples/bar/horizontal.html +++ b/docs/master/samples/bar/horizontal.html @@ -7,7 +7,7 @@ - + @@ -241,7 +241,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/bar/stacked-groups.html b/docs/master/samples/bar/stacked-groups.html index e767961ac1..186c563fae 100644 --- a/docs/master/samples/bar/stacked-groups.html +++ b/docs/master/samples/bar/stacked-groups.html @@ -7,7 +7,7 @@ - + @@ -161,7 +161,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/bar/stacked.html b/docs/master/samples/bar/stacked.html index 675a5d8073..e7dc1138fa 100644 --- a/docs/master/samples/bar/stacked.html +++ b/docs/master/samples/bar/stacked.html @@ -7,7 +7,7 @@ - + @@ -149,7 +149,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/bar/vertical.html b/docs/master/samples/bar/vertical.html index 420d47b368..60c372b86d 100644 --- a/docs/master/samples/bar/vertical.html +++ b/docs/master/samples/bar/vertical.html @@ -7,7 +7,7 @@ - + @@ -225,7 +225,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/information.html b/docs/master/samples/information.html index b1eae4e8fe..b24a6cffed 100644 --- a/docs/master/samples/information.html +++ b/docs/master/samples/information.html @@ -7,7 +7,7 @@ - + @@ -40,11 +40,11 @@ (opens new window) GitHub (opens new window)
    • Chart.js Samples

    • Bar Charts

    • Line Charts

    • Other charts

    • Area charts

    • Scales

    • Scale Options

    • Legend

    • Title

    • Subtitle

    • Tooltip

    • Scriptable Options

    • Animations

    • Advanced

    • Plugins

    • Utils

    # Chart.js Samples

    You can navigate through the samples via the sidebar.

    Alternatively, you can run them locally. To do so, clone the Chart.js repository (opens new window) from GitHub, run pnpm ci to install all packages, then run pnpm run docs:dev to build the documentation. As soon as the build is done, you can go to localhost:8080/samples (opens new window) to see the samples.

    # Out of the box working samples

    These samples are made for demonstration purposes only. They won't work out of the box if you copy paste them into your own website. This is because of how the docs are getting built. Some boilerplate code gets hidden. -For a sample that can be copied and pasted and used directly you can check the usage page.

    # Autogenerated data

    The data used in the samples is autogenerated using custom functions. These functions do not ship with the library, for more information about this you can check the utils page.

    # Actions block

    The samples have an actions code block. These actions are not part of Chart.js. They are internally transformed to separate buttons together with onClick listeners by a plugin we use in the documentation. To implement such actions yourself you can make some buttons and add onClick event listeners to them. Then in these event listeners you can call your variable in which you made the chart and do the logic that the button is supposed to do.

    Last Updated: 1/9/2024, 4:24:43 PM

    +For a sample that can be copied and pasted and used directly you can check the usage page.

    # Autogenerated data

    The data used in the samples is autogenerated using custom functions. These functions do not ship with the library, for more information about this you can check the utils page.

    # Actions block

    The samples have an actions code block. These actions are not part of Chart.js. They are internally transformed to separate buttons together with onClick listeners by a plugin we use in the documentation. To implement such actions yourself you can make some buttons and add onClick event listeners to them. Then in these event listeners you can call your variable in which you made the chart and do the logic that the button is supposed to do.

    Last Updated: 2/4/2024, 6:43:48 PM

    Bar Chart Border Radius →

    - + diff --git a/docs/master/samples/legend/events.html b/docs/master/samples/legend/events.html index 6345834833..965281180e 100644 --- a/docs/master/samples/legend/events.html +++ b/docs/master/samples/legend/events.html @@ -7,7 +7,7 @@ - + @@ -109,7 +109,7 @@ borderWidth: 1, backgroundColor: ['#CB4335', '#1F618D', '#F1C40F', '#27AE60', '#884EA0', '#D35400'], }] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/legend/html.html b/docs/master/samples/legend/html.html index a25b78701c..4f25b96bd5 100644 --- a/docs/master/samples/legend/html.html +++ b/docs/master/samples/legend/html.html @@ -7,7 +7,7 @@ - + @@ -242,7 +242,7 @@ } }, plugins: [htmlLegendPlugin], -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/legend/point-style.html b/docs/master/samples/legend/point-style.html index d8283193c5..4f50870f91 100644 --- a/docs/master/samples/legend/point-style.html +++ b/docs/master/samples/legend/point-style.html @@ -7,7 +7,7 @@ - + @@ -119,7 +119,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/legend/position.html b/docs/master/samples/legend/position.html index f3f9491818..1595995e03 100644 --- a/docs/master/samples/legend/position.html +++ b/docs/master/samples/legend/position.html @@ -7,7 +7,7 @@ - + @@ -135,7 +135,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/legend/title.html b/docs/master/samples/legend/title.html index 1368e396f3..0bc30d695c 100644 --- a/docs/master/samples/legend/title.html +++ b/docs/master/samples/legend/title.html @@ -7,7 +7,7 @@ - + @@ -147,7 +147,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/line/interpolation.html b/docs/master/samples/line/interpolation.html index b215b1a903..0b95b81cb0 100644 --- a/docs/master/samples/line/interpolation.html +++ b/docs/master/samples/line/interpolation.html @@ -7,7 +7,7 @@ - + @@ -165,7 +165,7 @@ fill: false } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/line/line.html b/docs/master/samples/line/line.html index 24b8c45ef5..49e1f9ee53 100644 --- a/docs/master/samples/line/line.html +++ b/docs/master/samples/line/line.html @@ -7,7 +7,7 @@ - + @@ -223,7 +223,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/line/multi-axis.html b/docs/master/samples/line/multi-axis.html index 452e1296f6..3603522d33 100644 --- a/docs/master/samples/line/multi-axis.html +++ b/docs/master/samples/line/multi-axis.html @@ -7,7 +7,7 @@ - + @@ -173,7 +173,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/line/point-styling.html b/docs/master/samples/line/point-styling.html index 5b9507f141..33d7fa1959 100644 --- a/docs/master/samples/line/point-styling.html +++ b/docs/master/samples/line/point-styling.html @@ -7,7 +7,7 @@ - + @@ -295,7 +295,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/line/segments.html b/docs/master/samples/line/segments.html index 2da4d5931b..4ae9fb85a9 100644 --- a/docs/master/samples/line/segments.html +++ b/docs/master/samples/line/segments.html @@ -7,7 +7,7 @@ - + @@ -91,7 +91,7 @@ intersect: false }, radius: 0, -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/line/stepped.html b/docs/master/samples/line/stepped.html index 7973ae60cc..3d32316835 100644 --- a/docs/master/samples/line/stepped.html +++ b/docs/master/samples/line/stepped.html @@ -7,7 +7,7 @@ - + @@ -191,7 +191,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/line/styling.html b/docs/master/samples/line/styling.html index 47e29cf203..398fb0ca02 100644 --- a/docs/master/samples/line/styling.html +++ b/docs/master/samples/line/styling.html @@ -7,7 +7,7 @@ - + @@ -161,7 +161,7 @@ fill: true, } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/bubble.html b/docs/master/samples/other-charts/bubble.html index 16da02ff66..cb9f30edaa 100644 --- a/docs/master/samples/other-charts/bubble.html +++ b/docs/master/samples/other-charts/bubble.html @@ -7,7 +7,7 @@ - + @@ -215,7 +215,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/combo-bar-line.html b/docs/master/samples/other-charts/combo-bar-line.html index 8152fe2663..b2a7f5f016 100644 --- a/docs/master/samples/other-charts/combo-bar-line.html +++ b/docs/master/samples/other-charts/combo-bar-line.html @@ -7,7 +7,7 @@ - + @@ -231,7 +231,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/doughnut.html b/docs/master/samples/other-charts/doughnut.html index ddfe7a4090..04b7aa5b01 100644 --- a/docs/master/samples/other-charts/doughnut.html +++ b/docs/master/samples/other-charts/doughnut.html @@ -7,7 +7,7 @@ - + @@ -261,7 +261,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/multi-series-pie.html b/docs/master/samples/other-charts/multi-series-pie.html index cce587c209..49f0b37285 100644 --- a/docs/master/samples/other-charts/multi-series-pie.html +++ b/docs/master/samples/other-charts/multi-series-pie.html @@ -7,7 +7,7 @@ - + @@ -183,7 +183,7 @@ data: [10, 90] } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/pie.html b/docs/master/samples/other-charts/pie.html index 63515c4919..281b2d46d6 100644 --- a/docs/master/samples/other-charts/pie.html +++ b/docs/master/samples/other-charts/pie.html @@ -7,7 +7,7 @@ - + @@ -213,7 +213,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/polar-area-center-labels.html b/docs/master/samples/other-charts/polar-area-center-labels.html index 7add98b149..89db9d605d 100644 --- a/docs/master/samples/other-charts/polar-area-center-labels.html +++ b/docs/master/samples/other-charts/polar-area-center-labels.html @@ -7,7 +7,7 @@ - + @@ -199,7 +199,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/polar-area.html b/docs/master/samples/other-charts/polar-area.html index e7a30313cf..d951aaa61f 100644 --- a/docs/master/samples/other-charts/polar-area.html +++ b/docs/master/samples/other-charts/polar-area.html @@ -7,7 +7,7 @@ - + @@ -177,7 +177,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/radar-skip-points.html b/docs/master/samples/other-charts/radar-skip-points.html index eda0bf1d92..5cc76889ea 100644 --- a/docs/master/samples/other-charts/radar-skip-points.html +++ b/docs/master/samples/other-charts/radar-skip-points.html @@ -7,7 +7,7 @@ - + @@ -167,7 +167,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/radar.html b/docs/master/samples/other-charts/radar.html index 0845a32380..e055be96a9 100644 --- a/docs/master/samples/other-charts/radar.html +++ b/docs/master/samples/other-charts/radar.html @@ -7,7 +7,7 @@ - + @@ -217,7 +217,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/scatter-multi-axis.html b/docs/master/samples/other-charts/scatter-multi-axis.html index 7b7d0a08a6..6a9111524e 100644 --- a/docs/master/samples/other-charts/scatter-multi-axis.html +++ b/docs/master/samples/other-charts/scatter-multi-axis.html @@ -7,7 +7,7 @@ - + @@ -259,7 +259,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/scatter.html b/docs/master/samples/other-charts/scatter.html index 2caec321f8..f993876a57 100644 --- a/docs/master/samples/other-charts/scatter.html +++ b/docs/master/samples/other-charts/scatter.html @@ -7,7 +7,7 @@ - + @@ -215,7 +215,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/other-charts/stacked-bar-line.html b/docs/master/samples/other-charts/stacked-bar-line.html index aff4b32ef7..c058d3f730 100644 --- a/docs/master/samples/other-charts/stacked-bar-line.html +++ b/docs/master/samples/other-charts/stacked-bar-line.html @@ -7,7 +7,7 @@ - + @@ -235,7 +235,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/plugins/chart-area-border.html b/docs/master/samples/plugins/chart-area-border.html index bca30dd835..3787a81dc9 100644 --- a/docs/master/samples/plugins/chart-area-border.html +++ b/docs/master/samples/plugins/chart-area-border.html @@ -7,7 +7,7 @@ - + @@ -135,7 +135,7 @@ backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5), } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/plugins/doughnut-empty-state.html b/docs/master/samples/plugins/doughnut-empty-state.html index 0e3aa59d4b..403fc61bf0 100644 --- a/docs/master/samples/plugins/doughnut-empty-state.html +++ b/docs/master/samples/plugins/doughnut-empty-state.html @@ -7,7 +7,7 @@ - + @@ -131,7 +131,7 @@ data: [] } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/plugins/quadrants.html b/docs/master/samples/plugins/quadrants.html index 9dcf3cc55f..78f48239ce 100644 --- a/docs/master/samples/plugins/quadrants.html +++ b/docs/master/samples/plugins/quadrants.html @@ -7,7 +7,7 @@ - + @@ -141,7 +141,7 @@ backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5), } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scale-options/center.html b/docs/master/samples/scale-options/center.html index 8039da7a53..329a74de87 100644 --- a/docs/master/samples/scale-options/center.html +++ b/docs/master/samples/scale-options/center.html @@ -7,7 +7,7 @@ - + @@ -177,7 +177,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scale-options/grid.html b/docs/master/samples/scale-options/grid.html index 615332ef1d..1fc2d6fe7d 100644 --- a/docs/master/samples/scale-options/grid.html +++ b/docs/master/samples/scale-options/grid.html @@ -7,7 +7,7 @@ - + @@ -193,7 +193,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scale-options/ticks.html b/docs/master/samples/scale-options/ticks.html index 2a637d0306..b925ec31dc 100644 --- a/docs/master/samples/scale-options/ticks.html +++ b/docs/master/samples/scale-options/ticks.html @@ -7,7 +7,7 @@ - + @@ -177,7 +177,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scale-options/titles.html b/docs/master/samples/scale-options/titles.html index 191c1cbaa3..46550d1459 100644 --- a/docs/master/samples/scale-options/titles.html +++ b/docs/master/samples/scale-options/titles.html @@ -7,7 +7,7 @@ - + @@ -159,7 +159,7 @@ backgroundColor: Utils.transparentize(Utils.CHART_COLORS.blue, 0.5), } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/linear-min-max-suggested.html b/docs/master/samples/scales/linear-min-max-suggested.html index 79cc93ed8e..08a77c0a58 100644 --- a/docs/master/samples/scales/linear-min-max-suggested.html +++ b/docs/master/samples/scales/linear-min-max-suggested.html @@ -7,7 +7,7 @@ - + @@ -121,7 +121,7 @@ backgroundColor: Utils.CHART_COLORS.blue, } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/linear-min-max.html b/docs/master/samples/scales/linear-min-max.html index 8469915af0..6451aef372 100644 --- a/docs/master/samples/scales/linear-min-max.html +++ b/docs/master/samples/scales/linear-min-max.html @@ -7,7 +7,7 @@ - + @@ -117,7 +117,7 @@ backgroundColor: Utils.CHART_COLORS.blue, } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/linear-step-size.html b/docs/master/samples/scales/linear-step-size.html index 2a836fcef3..6d6376f2b0 100644 --- a/docs/master/samples/scales/linear-step-size.html +++ b/docs/master/samples/scales/linear-step-size.html @@ -7,7 +7,7 @@ - + @@ -273,7 +273,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/log.html b/docs/master/samples/scales/log.html index bb0eaa52c3..089241c2da 100644 --- a/docs/master/samples/scales/log.html +++ b/docs/master/samples/scales/log.html @@ -7,7 +7,7 @@ - + @@ -149,7 +149,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/stacked.html b/docs/master/samples/scales/stacked.html index 2a7d1f7719..432cd3b1c3 100644 --- a/docs/master/samples/scales/stacked.html +++ b/docs/master/samples/scales/stacked.html @@ -7,7 +7,7 @@ - + @@ -153,7 +153,7 @@ yAxisID: 'y2', } ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/time-combo.html b/docs/master/samples/scales/time-combo.html index 993cd623a3..2443244e4d 100644 --- a/docs/master/samples/scales/time-combo.html +++ b/docs/master/samples/scales/time-combo.html @@ -7,7 +7,7 @@ - + @@ -169,7 +169,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/time-line.html b/docs/master/samples/scales/time-line.html index 9a756d1c59..43edf90e66 100644 --- a/docs/master/samples/scales/time-line.html +++ b/docs/master/samples/scales/time-line.html @@ -7,7 +7,7 @@ - + @@ -225,7 +225,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scales/time-max-span.html b/docs/master/samples/scales/time-max-span.html index f8ea8ce1a7..22199f0f68 100644 --- a/docs/master/samples/scales/time-max-span.html +++ b/docs/master/samples/scales/time-max-span.html @@ -7,7 +7,7 @@ - + @@ -255,7 +255,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scriptable/bar.html b/docs/master/samples/scriptable/bar.html index 1aceff48f9..d0bc74f3ad 100644 --- a/docs/master/samples/scriptable/bar.html +++ b/docs/master/samples/scriptable/bar.html @@ -7,7 +7,7 @@ - + @@ -143,7 +143,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scriptable/bubble.html b/docs/master/samples/scriptable/bubble.html index c0dd937848..a8c4ec8080 100644 --- a/docs/master/samples/scriptable/bubble.html +++ b/docs/master/samples/scriptable/bubble.html @@ -7,7 +7,7 @@ - + @@ -197,7 +197,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scriptable/line.html b/docs/master/samples/scriptable/line.html index 4d3b502d85..7b3f947eb5 100644 --- a/docs/master/samples/scriptable/line.html +++ b/docs/master/samples/scriptable/line.html @@ -7,7 +7,7 @@ - + @@ -175,7 +175,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scriptable/pie.html b/docs/master/samples/scriptable/pie.html index 7ea2a5fc92..56e4fc5d97 100644 --- a/docs/master/samples/scriptable/pie.html +++ b/docs/master/samples/scriptable/pie.html @@ -7,7 +7,7 @@ - + @@ -167,7 +167,7 @@ chart.update(); } } -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scriptable/polar.html b/docs/master/samples/scriptable/polar.html index b7d53913a6..197b46955f 100644 --- a/docs/master/samples/scriptable/polar.html +++ b/docs/master/samples/scriptable/polar.html @@ -7,7 +7,7 @@ - + @@ -147,7 +147,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/scriptable/radar.html b/docs/master/samples/scriptable/radar.html index 77d14dd5dc..c3d17e92d5 100644 --- a/docs/master/samples/scriptable/radar.html +++ b/docs/master/samples/scriptable/radar.html @@ -7,7 +7,7 @@ - + @@ -179,7 +179,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/subtitle/basic.html b/docs/master/samples/subtitle/basic.html index 96f5effe3d..cc548a5c14 100644 --- a/docs/master/samples/subtitle/basic.html +++ b/docs/master/samples/subtitle/basic.html @@ -7,7 +7,7 @@ - + @@ -119,7 +119,7 @@ backgroundColor: Utils.transparentize(Utils.CHART_COLORS.red, 0.5), }, ] -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/title/alignment.html b/docs/master/samples/title/alignment.html index f7f62277cc..d0b7b61bd4 100644 --- a/docs/master/samples/title/alignment.html +++ b/docs/master/samples/title/alignment.html @@ -7,7 +7,7 @@ - + @@ -137,7 +137,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/tooltip/content.html b/docs/master/samples/tooltip/content.html index 3aa681a228..b3912b0d19 100644 --- a/docs/master/samples/tooltip/content.html +++ b/docs/master/samples/tooltip/content.html @@ -7,7 +7,7 @@ - + @@ -129,7 +129,7 @@ sum += tooltipItem.parsed.y; }); return 'Sum: ' + sum; -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/tooltip/html.html b/docs/master/samples/tooltip/html.html index b077030b5b..0c8114200b 100644 --- a/docs/master/samples/tooltip/html.html +++ b/docs/master/samples/tooltip/html.html @@ -7,7 +7,7 @@ - + @@ -287,7 +287,7 @@ tooltipEl.style.top = positionY + tooltip.caretY + 'px'; tooltipEl.style.font = tooltip.options.bodyFont.string; tooltipEl.style.padding = tooltip.options.padding + 'px ' + tooltip.options.padding + 'px'; -};

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +};

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/tooltip/interactions.html b/docs/master/samples/tooltip/interactions.html index 9730c0adcb..4d6e716ff0 100644 --- a/docs/master/samples/tooltip/interactions.html +++ b/docs/master/samples/tooltip/interactions.html @@ -7,7 +7,7 @@ - + @@ -261,7 +261,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/tooltip/point-style.html b/docs/master/samples/tooltip/point-style.html index e8b22d9de2..e774657450 100644 --- a/docs/master/samples/tooltip/point-style.html +++ b/docs/master/samples/tooltip/point-style.html @@ -7,7 +7,7 @@ - + @@ -161,7 +161,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/tooltip/position.html b/docs/master/samples/tooltip/position.html index 9e10d3b17c..0fbd5b7d44 100644 --- a/docs/master/samples/tooltip/position.html +++ b/docs/master/samples/tooltip/position.html @@ -7,7 +7,7 @@ - + @@ -189,7 +189,7 @@ chart.update(); } }, -];

    # Docs

    Last Updated: 1/9/2024, 4:24:43 PM

    +];

    # Docs

    Last Updated: 2/4/2024, 6:43:48 PM

    ← →

    - + diff --git a/docs/master/samples/utils.html b/docs/master/samples/utils.html index bb0ad38347..b1ab901c49 100644 --- a/docs/master/samples/utils.html +++ b/docs/master/samples/utils.html @@ -7,7 +7,7 @@ - + @@ -180,11 +180,11 @@

    File on github (opens new window)

    # Components

    Some of the samples make reference to a components object. This is an artifact of using a module bundler to build the samples. The creation of that components object is shown below. If chart.js is included as a browser script, these items are accessible via the Chart object, i.e Chart.Tooltip.

    // Add Chart components needed in samples here.
 // Usable through `components[name]`.
 export {Tooltip} from '../../dist/chart.js';
-

    File on github (opens new window)

    +

    File on github (opens new window)

    ←

    - +