GraphDisplayOptions
GraphDisplayOptions provides an object for configuring the rendering of the corresponding Graph in the different views.
Extends
Methods
| Method | Description |
|---|---|
| onChanged() | Fires when any of the display options change. |
| state() | |
| stateSchema() | |
| setState() | Configures the GraphDisplayOptions 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. |
onChanged()
ts
onChanged(callback: (options: GraphDisplayOptions) => void): () => void;Fires when any of the display options change.
Parameters
| Parameter | Type |
|---|---|
callback | (options: GraphDisplayOptions) => void |
Returns
Unsubscribe function.
() => void
state()
ts
state(): Record<string, unknown>;Returns
Record<string, unknown>
The current configuration of the GraphDisplayOptions as a JS object.
stateSchema()
ts
stateSchema(): Record<string, unknown>;Returns
Record<string, unknown>
setState()
ts
setState(state: Record<string, unknown>): boolean;Configures the GraphDisplayOptions from the given JS object. Settings that are left out keep their current value.
Parameters
| Parameter | Type |
|---|---|
state | Record<string, unknown> |
Returns
boolean
If configuration was successful or false if an error occurred.