Function: Annotation()

Annotation(options?: object): OverlayPlugin & AnnotationController

Creates an annotation overlay plugin enabling the presenter to draw smooth, luminous ink directly over slide content.

Annotation is part of the shared pointer tool, so it activates together with LaserPointer. Toggle the tool with P; press Escape to exit. C clears ink. Cmd/Ctrl+Z or Z undo, and Cmd/Ctrl+Shift+Z or Shift+Z redo. These act on existing ink regardless of whether the pointer tool is active.

Parameters

Parameter	Type	Description
options	{ active?: boolean; autoClearOnScene?: boolean; autoClearOnStep?: boolean; color?: string; smoothing?: number; strokeWidth?: number; }	-
options.active?	boolean	Enable the presenter pointer tool immediately. Defaults to false.
options.autoClearOnScene?	boolean	Clear annotations when the scene changes. Defaults to true.
options.autoClearOnStep?	boolean	Clear annotations on every step advance, e.g. bullet reveals. Defaults to false.
options.color?	string	Ink color. Defaults to the active theme primary color.
options.smoothing?	number	Pointer position smoothing from 0 (raw and responsive) to 1 (maximum). Defaults to 0.8. Higher values remove hand tremor at the cost of slight lag.
options.strokeWidth?	number	Base stroke width in virtual canvas pixels. Defaults to 3.

Returns

OverlayPlugin & AnnotationController

Example

stage.overlay(Annotation());
stage.overlay(LaserPointer());