# Interface: DoughnutLabelAnnotationOptions
# Hierarchy
-
↳
DoughnutLabelAnnotationOptions
# Properties
# autoFit
• Optional autoFit: Scriptable<boolean, PartialEventContext>
# Defined in
options.d.ts:141 (opens new window)
# autoHide
• Optional autoHide: Scriptable<boolean, PartialEventContext>
# Defined in
options.d.ts:142 (opens new window)
# backgroundColor
• Optional backgroundColor: Scriptable<Color, PartialEventContext>
# Inherited from
DoughnutLabelOptions.backgroundColor
# Defined in
label.d.ts:92 (opens new window)
# backgroundShadowColor
• Optional backgroundShadowColor: Scriptable<Color, PartialEventContext>
# Inherited from
ShadowOptions.backgroundShadowColor
# Defined in
options.d.ts:30 (opens new window)
# borderColor
• Optional borderColor: Scriptable<Color, PartialEventContext>
# Inherited from
DoughnutLabelOptions.borderColor
# Defined in
label.d.ts:94 (opens new window)
# borderDash
• Optional borderDash: Scriptable<number[], PartialEventContext>
Border line dash. See MDN.
Default
[]
# Inherited from
DoughnutLabelOptions.borderDash
# Defined in
label.d.ts:104 (opens new window)
# borderDashOffset
• Optional borderDashOffset: Scriptable<number, PartialEventContext>
Border line dash offset. See MDN.
Default
0.0
# Inherited from
DoughnutLabelOptions.borderDashOffset
# Defined in
label.d.ts:109 (opens new window)
# borderJoinStyle
• Optional borderJoinStyle: Scriptable<CanvasLineJoin, PartialEventContext>
Border line join style. See MDN.
Default
'miter'
# Inherited from
DoughnutLabelOptions.borderJoinStyle
# Defined in
label.d.ts:114 (opens new window)
# borderShadowColor
• Optional borderShadowColor: Scriptable<Color, PartialEventContext>
# Inherited from
ShadowOptions.borderShadowColor
# Defined in
options.d.ts:31 (opens new window)
# borderWidth
• Optional borderWidth: Scriptable<number, PartialEventContext>
# Inherited from
DoughnutLabelOptions.borderWidth
# Defined in
label.d.ts:93 (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>
Whether the label should be displayed
Default
true
# Inherited from
# Defined in
label.d.ts:163 (opens new window)
# drawTime
• Optional drawTime: Scriptable<DrawTime, PartialEventContext>
# Inherited from
# Defined in
label.d.ts:41 (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
# Defined in
options.d.ts:143 (opens new window)
# init
• init: boolean | (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>, properties: AnnotationBoxModel, options: AnnotationOptions<keyof AnnotationTypeRegistry>) => boolean | void | AnnotationBoxModel
# Defined in
options.d.ts:144 (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)
# position
• Optional position: Scriptable<LabelPosition | LabelPositionObject, PartialEventContext>
# Inherited from
# Defined in
label.d.ts:158 (opens new window)
# rotation
• Optional rotation: Scriptable<number, PartialEventContext>
# Inherited from
# Defined in
label.d.ts:164 (opens new window)
# shadowBlur
• Optional shadowBlur: Scriptable<number, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:32 (opens new window)
# shadowOffsetX
• Optional shadowOffsetX: Scriptable<number, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:33 (opens new window)
# shadowOffsetY
• Optional shadowOffsetY: Scriptable<number, PartialEventContext>
# Inherited from
# Defined in
options.d.ts:34 (opens new window)
# spacing
• Optional spacing: Scriptable<number, PartialEventContext>
# Defined in
options.d.ts:145 (opens new window)
# textAlign
• Optional textAlign: Scriptable<LabelTextAlign, PartialEventContext>
Text alignment when the content of the label is multi-line.
Default
'center'
# Inherited from
DoughnutLabelOptions.textAlign
# Defined in
label.d.ts:53 (opens new window)
# textStrokeColor
• Optional textStrokeColor: Scriptable<Color, PartialEventContext>
# Inherited from
DoughnutLabelOptions.textStrokeColor
# Defined in
label.d.ts:54 (opens new window)
# textStrokeWidth
• Optional textStrokeWidth: Scriptable<number, PartialEventContext>
# Inherited from
DoughnutLabelOptions.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)
# 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)
# z
• Optional z: Scriptable<number, PartialEventContext>
# Inherited from
# Defined in
label.d.ts:88 (opens new window)
# Methods
# click
▸ Optional click(context, event): boolean | void
# Parameters
| Name | Type |
|---|---|
context | EventContext |
event | ChartEvent |
# Returns
boolean | void
# Inherited from
# Defined in
events.d.ts:27 (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:25 (opens new window)
# leave
▸ Optional leave(context, event): boolean | void
# Parameters
| Name | Type |
|---|---|
context | EventContext |
event | ChartEvent |
# Returns
boolean | void