# Interface: LabelAnnotationOptions
# Hierarchy
-
↳
LabelAnnotationOptions
# 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>
# Inherited from
LabelTypeOptions.backgroundColor
# Defined in
label.d.ts:92 (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'
# Inherited from
LabelTypeOptions.borderCapStyle
# Defined in
label.d.ts:99 (opens new window)
# borderColor
• Optional borderColor: Scriptable<Color, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:39 (opens new window)
# borderDash
• Optional borderDash: Scriptable<number[], PartialEventContext>
Border line dash. See MDN.
Default
[]
# Inherited from
# Defined in
options.d.ts:40 (opens new window)
# borderDashOffset
• Optional borderDashOffset: Scriptable<number, PartialEventContext>
Border line dash offset. See MDN.
Default
0.0
# Inherited from
LabelTypeOptions.borderDashOffset
# Defined in
options.d.ts:41 (opens new window)
# borderJoinStyle
• Optional borderJoinStyle: Scriptable<CanvasLineJoin, PartialEventContext>
Border line join style. See MDN.
Default
'miter'
# Inherited from
LabelTypeOptions.borderJoinStyle
# Defined in
label.d.ts:114 (opens new window)
# borderRadius
• Optional borderRadius: Scriptable<number | BorderRadius, PartialEventContext>
Border radius of the label rectangle
Default
6
# Inherited from
# Defined in
label.d.ts:119 (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
# Defined in
options.d.ts:42 (opens new window)
# callout
• Optional callout: CalloutOptions
# Inherited from
# Defined in
label.d.ts:120 (opens new window)
# color
• Optional color: Scriptable<Color | Color[], PartialEventContext>
# Inherited from
# Defined in
label.d.ts:43 (opens new window)
# content
• content: Scriptable<string | string[] | HTMLCanvasElement | HTMLImageElement, PartialEventContext>
Text to display in label. Provide an array to display multiple lines
# Inherited from
# Defined in
label.d.ts:73 (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
# Defined in
options.d.ts:44 (opens new window)
# font
• Optional font: Scriptable<Partial<FontSpec> | Partial<FontSpec>[], PartialEventContext>
# Inherited from
# Defined in
label.d.ts:42 (opens new window)
# height
• Optional height: Scriptable<number | `${number}%`, PartialEventContext>
Overrides the height of the image. Could be set in pixel by a number, or in percentage of current height of image by a string
# Inherited from
# Defined in
label.d.ts:83 (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)
# opacity
• Optional opacity: Scriptable<number, PartialEventContext>
Overrides the opacity of the image.
# Inherited from
# Defined in
label.d.ts:87 (opens new window)
# padding
• Optional padding: Scriptable<number | LabelPadding, PartialEventContext>
Padding of label
Default
6
# Inherited from
# Defined in
label.d.ts:48 (opens new window)
# position
• Optional position: Scriptable<LabelPosition | LabelPositionObject, PartialEventContext>
# Inherited from
# Defined in
label.d.ts:148 (opens new window)
# rotation
• Optional rotation: Scriptable<number, PartialEventContext>
# Defined in
options.d.ts:136 (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)
# textAlign
• Optional textAlign: Scriptable<LabelTextAlign, PartialEventContext>
Text alignment when the content of the label is multi-line.
Default
'center'
# Inherited from
# Defined in
label.d.ts:53 (opens new window)
# textStrokeColor
• Optional textStrokeColor: Scriptable<Color, PartialEventContext>
# Inherited from
LabelTypeOptions.textStrokeColor
# Defined in
label.d.ts:54 (opens new window)
# textStrokeWidth
• Optional textStrokeWidth: Scriptable<number, PartialEventContext>
# Inherited from
LabelTypeOptions.textStrokeWidth
# Defined in
label.d.ts:55 (opens new window)
# width
• Optional width: Scriptable<number | `${number}%`, PartialEventContext>
Overrides the width of the image. Could be set in pixel by a number, or in percentage of current width of image by a string
# Inherited from
# Defined in
label.d.ts:78 (opens new window)
# xAdjust
• Optional xAdjust: Scriptable<number, PartialEventContext>
Adjustment along x-axis (left-right) of label relative to above number (can be negative) For horizontal lines positioned left or right, negative values move the label toward the edge, and positive values toward the center.
Default
0
# Inherited from
# Defined in
label.d.ts:62 (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)
# xValue
• Optional xValue: Scriptable<ScaleValue, PartialEventContext>
# Inherited from
AnnotationPointCoordinates.xValue
# Defined in
options.d.ts:57 (opens new window)
# yAdjust
• Optional yAdjust: Scriptable<number, PartialEventContext>
Adjustment along y-axis (top-bottom) of label relative to above number (can be negative) For vertical lines positioned top or bottom, negative values move the label toward the edge, and positive values toward the center.
Default
0
# Inherited from
# Defined in
label.d.ts:69 (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)
# yValue
• Optional yValue: Scriptable<ScaleValue, PartialEventContext>
# Inherited from
AnnotationPointCoordinates.yValue
# Defined in
options.d.ts:58 (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