Annotation
An annotation.
Extends
Methods
| Method | Description |
|---|---|
| type() | Returns the type of the annotation. |
| state() | Returns the current configuration of the annotation as JS object. |
| stateSchema() | |
| setState() | Configures the annotation options from the given JS object. |
Inherited from ClassHandle
| Method | Description |
|---|---|
| isAliasOf() | Returns true if this handle and other alias the same underlying C++ object. |
| delete() | Releases this JavaScript handle. |
| deleteLater() | Schedules this handle for deferred deletion and returns this handle. |
| isDeleted() | Returns true if this handle has already been deleted. |
| [dispose]() | Releases this handle when the enclosing scope exits, so a handle can be declared with using instead of calling delete() later manually. |
| clone() | Returns a new JavaScript handle aliasing the same underlying C++ object. |
type()
ts
type(): AnnotationType;Returns the type of the annotation.
Returns
state()
ts
state(): Record<string, unknown>;Returns the current configuration of the annotation as JS object.
Returns
Record<string, unknown>
stateSchema()
ts
stateSchema(): Record<string, unknown>;Returns
Record<string, unknown>
setState()
ts
setState(state: Record<string, unknown>): void;Configures the annotation options from the given JS object.
Parameters
| Parameter | Type |
|---|---|
state | Record<string, unknown> |
Returns
void
If configuration was successful or false if an error occurred.