HeadlessEnvironment

One mounted canvas environment in a headless host.

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

#Fields

ctxRequired
The context its surface, footer and toolbar receive; the host keeps step, focus and presenting current.
EnvironmentContext
environmentNameRequired
The environment's name, such as graph: also its node's identifier.
string
identityRequired
Its session key: internote, scene and environment id (the author's #id when given).
EnvironmentIdentity
nodeRequired
The compiled environment node.
CompiledNode
runtimeRequired
Its animation runtime, the same object as ctx.animation.
EnvironmentAnimationRuntime<EnvironmentContext>
toolbarItemsRequired
Returns the environment's toolbar contribution for this render, validated, with its slots still unresolved.
ToolbarContribution[]

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

Last updated