# Interface: AnnotationPluginOptions

# Hierarchy

# Properties

# animations

• Optional animations: Record<string, unknown>

# Defined in

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


# annotations

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

# Defined in

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


# clip

• Optional clip: boolean

# Defined in

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


# common

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

# Defined in

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


# interaction

• Optional interaction: CoreInteractionOptions

# Defined in

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

# Methods

# afterDraw

▸ Optional afterDraw(context): void

# Parameters

Name Type
context EventContext

# Returns

void

# Inherited from

AnnotationHooks.afterDraw

# Defined in

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


# beforeDraw

▸ Optional beforeDraw(context): void

# Parameters

Name Type
context EventContext

# Returns

void

# Inherited from

AnnotationHooks.beforeDraw

# Defined in

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


# 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:27 (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:25 (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:26 (opens new window)