Appearance

@graphty/graphty-element / session / StyleUpdateOptions

Interface: StyleUpdateOptions ​

Defined in: graphty-element/src/session/styles/StylesApi.ts:349

How styles.update runs: a signal and a progress handler, and whether the layer may be left writing nothing.

Extends ​

Properties ​

dryRun? ​

readonly optional dryRun?: boolean

Defined in: graphty-element/src/session/runs/types.ts:421

Ask what this would do and cost instead of doing it. Nothing is performed.

Inherited from ​

RunOptions.dryRun

keepEmpty? ​

readonly optional keepEmpty?: boolean

Defined in: graphty-element/src/session/styles/StylesApi.ts:359

Keep the layer when the patch takes its last value away: it stays in its place, painting nothing until something is written again, as a starting row that writes nothing does. A panel that removes properties one at a time sets it, so removing the last one does not remove the layer. Without it (the default), such an update is refused with E_BAD_LAYER, as add refuses a layer that writes nothing. A layer that already writes nothing (a row added with no look yet) may be renamed or given another selector without it.

Since ​

3.26.0

onProgress? ​

readonly optional onProgress?: (progress) => void

Defined in: graphty-element/src/session/runs/types.ts:417

Called as the work advances, with the run's current progress.

Parameters ​

progress ​

Progress

Returns ​

void

Inherited from ​

RunOptions.onProgress

queue? ​

readonly optional queue?: "replace" | "append" | "now"

Defined in: graphty-element/src/session/runs/types.ts:419

How the call joins the queue. Defaults to "append".

Inherited from ​

RunOptions.queue

signal? ​

readonly optional signal?: AbortSignal

Defined in: graphty-element/src/session/runs/types.ts:415

A signal that cancels the work. Cancelling rejects with an AbortError.

Inherited from ​

RunOptions.signal

transitionMs? ​

readonly optional transitionMs?: number

Defined in: graphty-element/src/session/runs/types.ts:423

Override the configured transition duration for this call only, in milliseconds.

Inherited from ​

RunOptions.transitionMs