# Chart.js annotation - v3.1.0
# Interfaces
- AnnotationBoxModel
- AnnotationElement
- AnnotationEvents
- AnnotationHooks
- AnnotationPluginOptions
- AnnotationPointCoordinates
- AnnotationTypeRegistry
- ArrowHeadOptions
- ArrowHeadsOptions
- BoxAnnotationOptions
- BoxLabelOptions
- CalloutOptions
- ContainedLabelOptions
- ControlPointOptions
- CoreAnnotationOptions
- CoreLabelOptions
- DoughnutLabelAnnotationOptions
- DoughnutLabelOptions
- EllipseAnnotationOptions
- EventContext
- LabelAnnotationOptions
- LabelOptions
- LabelPadding
- LabelPositionObject
- LabelTypeOptions
- LineAnnotationOptions
- PartialEventContext
- PointAnnotationOptions
- PolygonAnnotationOptions
- ShadowOptions
# Type Aliases
# AnnotationOptions
Ƭ AnnotationOptions<TYPE>: { [key in TYPE]: Object & AnnotationTypeRegistry[key] }[TYPE]
# Type parameters
| Name | Type |
|---|---|
TYPE | extends AnnotationType = AnnotationType |
# Defined in
options.d.ts:18 (opens new window)
# AnnotationType
Ƭ AnnotationType: keyof AnnotationTypeRegistry
# Defined in
options.d.ts:17 (opens new window)
# CalloutPosition
Ƭ CalloutPosition: "left" | "top" | "bottom" | "right" | "auto"
# Defined in
label.d.ts:10 (opens new window)
# DrawTime
Ƭ DrawTime: "afterDraw" | "afterDatasetsDraw" | "beforeDraw" | "beforeDatasetsDraw" | number
# Defined in
options.d.ts:6 (opens new window)
# LabelPosition
Ƭ LabelPosition: "start" | "center" | "end" | percentString
# Defined in
label.d.ts:6 (opens new window)
# LabelTextAlign
Ƭ LabelTextAlign: "left" | "start" | "center" | "right" | "end"
# Defined in
label.d.ts:8 (opens new window)
# ScaleValue
Ƭ ScaleValue: number | string
# Defined in
options.d.ts:27 (opens new window)
# Scriptable
Ƭ Scriptable<T, TContext>: T | (ctx: TContext, options: AnnotationOptions) => T
# Type parameters
| Name |
|---|
T |
TContext |
# Defined in
options.d.ts:26 (opens new window)
# percentString
Ƭ percentString: `${number}%`
# Defined in
label.d.ts:5 (opens new window)
# Variables
# default
• Const default: Plugin & { getAnnotations: (chart: Chart<keyof ChartTypeRegistry, (number | [number, number] | Point | BubbleDataPoint)[], unknown>) => AnnotationElement[] }