Class AnnotationLayer

Stores and exposes tutor annotation primitives for overlay rendering.

const annotations = new AnnotationLayer();
annotations.onUpdated(() => exerciseRenderer.redraw());
primitiveRenderer.registerLayer('annotations', annotations);

Index

Constructors

constructor

Methods

add clear getPrimitives onUpdated remove replace

Constructors

constructor

new AnnotationLayer(): AnnotationLayer
Creates a new empty AnnotationLayer.

Returns AnnotationLayer
- Defined in apps/edge/src/annotation/AnnotationLayer.ts:42

Methods

add

add(primitive: VisualPrimitive): void
Adds a primitive to the annotation layer and triggers an update notification.
Parameters
- primitive: VisualPrimitive
  The VisualPrimitive to add.
Returns void
- Defined in apps/edge/src/annotation/AnnotationLayer.ts:51

clear

clear(): void
Removes all annotations from the layer.

Returns void
- Defined in apps/edge/src/annotation/AnnotationLayer.ts:77

getPrimitives

getPrimitives(): VisualPrimitive[]
Returns the current ordered list of annotation primitives.

Returns VisualPrimitive[]
All active VisualPrimitives in draw order.
- Defined in apps/edge/src/annotation/AnnotationLayer.ts:86

onUpdated

onUpdated(cb: () => void): void
Registers a callback invoked whenever the annotation list changes.
Parameters
- cb: () => void
  Called (with no arguments) after any mutation.
Returns void
- Defined in apps/edge/src/annotation/AnnotationLayer.ts:95

remove

remove(primitiveId: string): boolean
Removes a primitive by its id field.
Parameters
- primitiveId: string
  The unique ID of the primitive to remove.
Returns boolean
true if a primitive with that ID was found and removed.
- Defined in apps/edge/src/annotation/AnnotationLayer.ts:61

replace

replace(primitives: VisualPrimitive[]): void
Replaces all current annotations with a new set.
Parameters
- primitives: VisualPrimitive[]
  The replacement list of VisualPrimitives.
Returns void
- Defined in apps/edge/src/annotation/AnnotationLayer.ts:70

Class AnnotationLayer

Index

Constructors

Methods

Constructors

constructor

Returns AnnotationLayer

Methods

add

Parameters

Returns void

clear

Returns void

getPrimitives

Returns VisualPrimitive[]

onUpdated

Parameters

Returns void

remove

Parameters

Returns boolean

replace

Parameters

Returns void

Settings

On This Page