# Interface: PolygonAnnotationOptions

# Hierarchy

# Properties

# adjustScaleRange

Optional adjustScaleRange: Scriptable<boolean, PartialEventContext>

# Inherited from

CoreAnnotationOptions.adjustScaleRange

# Defined in

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


# backgroundColor

backgroundColor: Scriptable<Color, PartialEventContext>

# Defined in

options.d.ts:140 (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>

# Defined in

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


# borderColor

Optional borderColor: Scriptable<Color, PartialEventContext>

# Inherited from

CoreAnnotationOptions.borderColor

# Defined in

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


# borderDash

Optional borderDash: Scriptable<number[], PartialEventContext>

# Inherited from

CoreAnnotationOptions.borderDash

# Defined in

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


# borderDashOffset

Optional borderDashOffset: Scriptable<number, PartialEventContext>

# Inherited from

CoreAnnotationOptions.borderDashOffset

# Defined in

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


# borderJoinStyle

Optional borderJoinStyle: Scriptable<CanvasLineJoin, PartialEventContext>

# Defined in

options.d.ts:142 (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

CoreAnnotationOptions.borderWidth

# Defined in

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


# display

Optional display: Scriptable<boolean, PartialEventContext>

# Inherited from

CoreAnnotationOptions.display

# Defined in

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


# drawTime

Optional drawTime: Scriptable<DrawTime, PartialEventContext>

# Inherited from

CoreAnnotationOptions.drawTime

# Defined in

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


# id

Optional id: string

# Inherited from

CoreAnnotationOptions.id

# 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

CoreAnnotationOptions.init

# Defined in

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


# point

Optional point: PointAnnotationOptions

# Defined in

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


# radius

Optional radius: Scriptable<number, PartialEventContext>

# Defined in

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


# rotation

Optional rotation: Scriptable<number, PartialEventContext>

# Defined in

options.d.ts:145 (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)


# sides

Optional sides: Scriptable<number, PartialEventContext>

# Defined in

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


# xAdjust

Optional xAdjust: Scriptable<number, PartialEventContext>

# Defined in

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


# xMax

Optional xMax: Scriptable<ScaleValue, PartialEventContext>

# Inherited from

CoreAnnotationOptions.xMax

# Defined in

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


# xMin

Optional xMin: Scriptable<ScaleValue, PartialEventContext>

# Inherited from

CoreAnnotationOptions.xMin

# 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>

# Defined in

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


# yMax

Optional yMax: Scriptable<ScaleValue, PartialEventContext>

# Inherited from

CoreAnnotationOptions.yMax

# Defined in

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


# yMin

Optional yMin: Scriptable<ScaleValue, PartialEventContext>

# Inherited from

CoreAnnotationOptions.yMin

# 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

CoreAnnotationOptions.z

# 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

CoreAnnotationOptions.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

CoreAnnotationOptions.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

CoreAnnotationOptions.leave

# Defined in

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