Graphty

Appearance

@graphty/graphty-element / session / TemplateOptions

Interface: TemplateOptions ​

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

What applying a style document accepts beyond the document itself.

Extends ​

Properties ​

dryRun? ​

readonly optional dryRun?: boolean

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

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

Inherited from ​

RunOptions.dryRun

onProgress? ​

readonly optional onProgress?: (progress) => void

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

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:351

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:347

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

Inherited from ​

RunOptions.signal

templateId? ​

readonly optional templateId?: string

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

What to record as the template the layers came from, on every layer that named no source of its own. That is what lets the whole import be swept away again in one call.

transitionMs? ​

readonly optional transitionMs?: number

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

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

Inherited from ​

RunOptions.transitionMs