# Interface: AnnotationPluginOptions

# Hierarchy

# Properties

# animations

Optional animations: Record<string, unknown>

# Defined in

options.d.ts:154 (opens new window)


# annotations

annotations: AnnotationOptions<keyof AnnotationTypeRegistry>[] | Record<string, AnnotationOptions<keyof AnnotationTypeRegistry>>

# Defined in

options.d.ts:155 (opens new window)


# clip

Optional clip: boolean

# Defined in

options.d.ts:156 (opens new window)


# common

Optional common: LineAnnotationOptions | BoxAnnotationOptions | EllipseAnnotationOptions | LabelAnnotationOptions | PointAnnotationOptions | PolygonAnnotationOptions

# Defined in

options.d.ts:157 (opens new window)


# interaction

Optional interaction: CoreInteractionOptions

# Defined in

options.d.ts:158 (opens new window)

# Methods

# click

Optional click(context, event): boolean | void

# Parameters

Name Type
context EventContext
event ChartEvent

# Returns

boolean | void

# Inherited from

AnnotationEvents.click

# 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

AnnotationEvents.enter

# 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

# Inherited from

AnnotationEvents.leave

# Defined in

events.d.ts:24 (opens new window)