# Class: ArcElement
# Hierarchy
default<ArcProps,ArcOptions>↳
ArcElement
# Constructors
# constructor
• new ArcElement(cfg)
# Parameters
| Name | Type |
|---|---|
cfg | any |
# Overrides
Element<ArcProps, ArcOptions>.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
← Animator BasePlatform →