Class: AnnotationManager

Defined in: src/annotations.ts:27

Lightweight per-vertex annotations rendered as small markers attached to surfaces. Designed to be efficient (shared geometry) and easy to control (activate/deactivate).

Constructors

Constructor

new AnnotationManager(viewer, defaults?): AnnotationManager;

Defined in: src/annotations.ts:40

Parameters

viewer

NeuroSurfaceViewer

defaults?

radius?

number

colorOn?

number

colorOff?

number

Returns

AnnotationManager

Methods

add()

add(
   surfaceId, 
   vertexIndex, 
   data?, 
   options?): string | null;

Defined in: src/annotations.ts:51

Parameters

surfaceId

string

vertexIndex

number

data?

any

options?

AnnotationOptions = {}

Returns

string | null

---

list()

list(surfaceId?): AnnotationRecord[];

Defined in: src/annotations.ts:122

Parameters

surfaceId?

string

Returns

AnnotationRecord[]

---

removeBySurface()

removeBySurface(surfaceId): void;

Defined in: src/annotations.ts:127

Parameters

surfaceId

string

Returns

void

---

move()

move(id, vertexIndex): boolean;

Defined in: src/annotations.ts:135

Parameters

id

string

vertexIndex

number

Returns

boolean

---

get()

get(id): AnnotationRecord | undefined;

Defined in: src/annotations.ts:165

Parameters

id

string

Returns

AnnotationRecord | undefined

---

remove()

remove(id): void;

Defined in: src/annotations.ts:169

Parameters

id

string

Returns

void

---

reset()

reset(): void;

Defined in: src/annotations.ts:193

Returns

void

---

dispose()

dispose(): void;

Defined in: src/annotations.ts:212

Returns

void

---

activate()

activate(id, options?): void;

Defined in: src/annotations.ts:219

Parameters

id

string

options?

exclusive?

boolean

Returns

void

---

forEach()

forEach(callback): void;

Defined in: src/annotations.ts:251

Parameters

callback

(annotation) => void

Returns

void

---

setDefaults()

setDefaults(defaults): void;

Defined in: src/annotations.ts:255

Parameters

defaults

radius?

number

colorOn?

number

colorOff?

number

Returns

void