HeadlessCanvasHost

A mounted document: its scenes and environments, the shared session store and the semantic diagnostics.

@internote/canvas-sdk/hostInterface
On this page
import { HeadlessCanvasHost } from '@internote/canvas-sdk/host';

#Fields

datasetsRequired
The document's @data datasets, by id, for consumers that bind one.
Record<string, ChalkDataset>
dbRequired
The durable per-reader store the host was given — the same one session+db environments receive — or a store that keeps nothing. Blank content that keeps a reader's work, such as a question's answers, reads and writes it here.
KeyValueStorage
diagnosticsRequired
What the canvas semantic pass reported about the document.
SemanticPassResult
disposeRequired
Detaches every runtime from its step controller and clears the session store.
void
environmentByIdRequired
Returns the environment with an id, the author's #id or else its instance id, or undefined.
HeadlessEnvironment | undefined
focusEnvironmentRequired
Focuses one environment, or none, so it alone owns the keyboard.
void
sceneAtRequired
Returns the scene at an index, and throws when there is none there.
HeadlessScene
scenesRequired
Every scene in the document body, in order.
HeadlessScene[]
sessionRequired
The session store behind every environment's session tier.
SessionStore
setPresentingRequired
Sets isPresenting on every environment's context.
void

Declared in packages/canvas-sdk/src/host/headless.ts:224.

Last updated