# Interface: BoxAnnotationOptions
# Hierarchy
-
↳
BoxAnnotationOptions
# Properties
# adjustScaleRange
• Optional adjustScaleRange: Scriptable<boolean, PartialEventContext>
# Inherited from
CoreAnnotationOptions.adjustScaleRange
# Defined in
options.d.ts:38 (opens new window)
# backgroundColor
• Optional backgroundColor: Scriptable<Color, PartialEventContext>
# Defined in
options.d.ts:94 (opens new window)
# backgroundShadowColor
• Optional backgroundShadowColor: Scriptable<Color, PartialEventContext>
# Inherited from
CoreAnnotationOptions.backgroundShadowColor
# Defined in
options.d.ts:30 (opens new window)
# borderCapStyle
• Optional borderCapStyle: Scriptable<CanvasLineCap, PartialEventContext>
Border line cap style. See MDN.
Default
'butt'
# Defined in
options.d.ts:99 (opens new window)
# borderColor
• Optional borderColor: Scriptable<Color, PartialEventContext>
# Inherited from
CoreAnnotationOptions.borderColor
# Defined in
options.d.ts:39 (opens new window)
# borderDash
• Optional borderDash: Scriptable<number[], PartialEventContext>
Border line dash. See MDN.
Default
[]
# Overrides
CoreAnnotationOptions.borderDash
# Defined in
options.d.ts:104 (opens new window)
# borderDashOffset
• Optional borderDashOffset: Scriptable<number, PartialEventContext>
Border line dash offset. See MDN.
Default
0.0
# Overrides
CoreAnnotationOptions.borderDashOffset
# Defined in
options.d.ts:109 (opens new window)
# borderJoinStyle
• Optional borderJoinStyle: Scriptable<CanvasLineJoin, PartialEventContext>
Border line join style. See MDN.
Default
'miter'
# Defined in
options.d.ts:114 (opens new window)
# borderRadius
• Optional borderRadius: Scriptable<number | BorderRadius, PartialEventContext>
# Defined in
options.d.ts:115 (opens new window)
# borderShadowColor
• Optional borderShadowColor: Scriptable<Color, PartialEventContext>
# Inherited from
CoreAnnotationOptions.borderShadowColor
# Defined in
options.d.ts:31 (opens new window)
# borderWidth
• Optional borderWidth: Scriptable<number, PartialEventContext>
# Inherited from
CoreAnnotationOptions.borderWidth
# Defined in
options.d.ts:42 (opens new window)
# display
• Optional display: Scriptable<boolean, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:43 (opens new window)
# drawTime
• Optional drawTime: Scriptable<DrawTime, PartialEventContext>
# Inherited from
CoreAnnotationOptions.drawTime
# Defined in
options.d.ts:44 (opens new window)
# id
• Optional id: string
# Inherited from
# Defined in
options.d.ts:46 (opens new window)
# init
• Optional init: boolean | (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, properties: AnnotationBoxModel, options: AnnotationOptions<keyof AnnotationTypeRegistry>) => boolean | void | AnnotationElement
# Inherited from
# Defined in
options.d.ts:45 (opens new window)
# label
• Optional label: BoxLabelOptions
# Defined in
options.d.ts:116 (opens new window)
# rotation
• Optional rotation: Scriptable<number, PartialEventContext>
# Defined in
options.d.ts:117 (opens new window)
# shadowBlur
• Optional shadowBlur: Scriptable<number, PartialEventContext>
# Inherited from
CoreAnnotationOptions.shadowBlur
# Defined in
options.d.ts:32 (opens new window)
# shadowOffsetX
• Optional shadowOffsetX: Scriptable<number, PartialEventContext>
# Inherited from
CoreAnnotationOptions.shadowOffsetX
# Defined in
options.d.ts:33 (opens new window)
# shadowOffsetY
• Optional shadowOffsetY: Scriptable<number, PartialEventContext>
# Inherited from
CoreAnnotationOptions.shadowOffsetY
# Defined in
options.d.ts:34 (opens new window)
# xMax
• Optional xMax: Scriptable<ScaleValue, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:47 (opens new window)
# xMin
• Optional xMin: Scriptable<ScaleValue, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:48 (opens new window)
# xScaleID
• Optional xScaleID: Scriptable<string, PartialEventContext>
# Inherited from
CoreAnnotationOptions.xScaleID
# Defined in
options.d.ts:49 (opens new window)
# yMax
• Optional yMax: Scriptable<ScaleValue, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:50 (opens new window)
# yMin
• Optional yMin: Scriptable<ScaleValue, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:51 (opens new window)
# yScaleID
• Optional yScaleID: Scriptable<string, PartialEventContext>
# Inherited from
CoreAnnotationOptions.yScaleID
# Defined in
options.d.ts:52 (opens new window)
# z
• Optional z: Scriptable<number, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:53 (opens new window)
# Methods
# afterDraw
▸ Optional afterDraw(context): void
# Parameters
| Name | Type |
|---|---|
context | EventContext |
# Returns
void
# Inherited from
CoreAnnotationOptions.afterDraw
# Defined in
options.d.ts:23 (opens new window)
# beforeDraw
▸ Optional beforeDraw(context): void
# Parameters
| Name | Type |
|---|---|
context | EventContext |
# Returns
void
# Inherited from
CoreAnnotationOptions.beforeDraw
# Defined in
options.d.ts:22 (opens new window)
# click
▸ Optional click(context, event): boolean | void
# Parameters
| Name | Type |
|---|---|
context | EventContext |
event | ChartEvent |
# Returns
boolean | void
# Inherited from
# Defined in
events.d.ts:25 (opens new window)
# enter
▸ Optional enter(context, event): boolean | void
# Parameters
| Name | Type |
|---|---|
context | EventContext |
event | ChartEvent |
# Returns
boolean | void
# Inherited from
# Defined in
events.d.ts:23 (opens new window)
# leave
▸ Optional leave(context, event): boolean | void
# Parameters
| Name | Type |
|---|---|
context | EventContext |
event | ChartEvent |
# Returns
boolean | void