SearSuite
← All packages

API reference

@searsuite/sear-assembly-setup

Public Sheet and Doc editor composition, lifecycle, commands, queries, and host-adapter wiring.

204 exportsderived from source

Concept 1

Choose an editor entry point

createSheetEditor() assembles one visual Sheet editor from an initial document, selected plugins, and host-provided platform, rendering, and input adapters. Use createDocEditor() for a standalone rich-text document. A Workbook host uses createWorkbookEditor() when it needs stable Sheet identities and switching between Sheets.

Import these entry points from their owning @searsuite/sear-assembly-* package. The assembly connects contracts; it does not take ownership of a feature's document state. If no visual host is needed, createHeadlessEditor() provides a smaller entry point for server work and tests.

Use when: the application is ready to provide the adapters required by its chosen editor and to own the editor lifecycle. Start with the headless assembly when rendering and input are unnecessary.

Concept 2

Follow state through the editor lifecycle

createEmptySheetDocumentState() supplies a starting Sheet state. After creation, application actions and input handlers run typed commands through editor.commands; state owners stage operations, and the editor commits them together. Queries read the current state, observations report committed changes, and capabilities expose services owned by this editor instance.

A visual Sheet session also contains viewport and other local state. That session is separate from the durable document. A Workbook captures the mounted Sheet's document and local session before switching Sheets. Call editor.destroy() when the host unmounts the editor so adapters, listeners, and plugins release their resources.

Related concepts: commands define the mutation path; plugins own feature state; the Workbook assembly owns Sheet structure and switching.

classCaretPluginsource ↗
class CaretPlugin extends DocPlugin<null>

Owns caret movement, focus, blink state, and caret overlay rendering.

constructorconstructor
CaretPlugin(caretState: DocCaretState): CaretPlugin

Creates a CaretPlugin instance.

caretState: DocCaretState
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving CaretPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers caret-owned state before the plugin is resolved.

context: DocPluginServiceContext
Inherited members 39

Inherited from DocPlugin.

classDefaultSheetClipboardDataSourcesource ↗
class DefaultSheetClipboardDataSource extends SheetClipboardDataSource

Default data source bridging clipboard commands to the active Sheet data view.

constructorconstructor
DefaultSheetClipboardDataSource(dataEngine: DataEngine, queries: SheetQueryRegistry, ownerFormats: SheetFormatTransferRegistry, platform: Platform, rangeMoves: SheetRangeMoveRegistry, cutSession: SheetClipboardCutSession, identity: SheetClipboardSheetIdentity): DefaultSheetClipboardDataSource
dataEngine: DataEngine
queries: SheetQueryRegistry
ownerFormats: SheetFormatTransferRegistry
platform: Platform
rangeMoves: SheetRangeMoveRegistry
cutSession: SheetClipboardCutSession
identity: SheetClipboardSheetIdentity
propertycutSession
readonly cutSession: SheetClipboardCutSession
propertycutSourceId
readonly cutSourceId: string
propertyformatTarget
readonly formatTarget: PluginKey
propertytarget
readonly target: PluginKey
methodbindPreviewRuntime
bindPreviewRuntime(core: SearCoreSheet, plugins: PluginManager<SearCoreSheet, CellProperties>, bridge: SheetClipboardWorkbookBridge | null): void
core: SearCoreSheet
plugins: PluginManager<SearCoreSheet, CellProperties>
bridge: SheetClipboardWorkbookBridge | null
methodcaptureMergedRanges
captureMergedRanges(range: SheetRangeBounds): readonly SheetClipboardMergedRange[]
range: SheetRangeBounds
methodcaptureOwnerFormats
captureOwnerFormats(range: SheetRangeBounds): readonly SheetPortableFormatTransfer[]
range: SheetRangeBounds
methodclearOwnerFormats
clearOwnerFormats(range: SheetRangeBounds): readonly SheetFormatTransferPlan[]
range: SheetRangeBounds
methodcreateClipboardCutId
createClipboardCutId(): string
methodgetColumnCount
getColumnCount(): number
methodgetMergedRange
getMergedRange(row: number, column: number): SheetRangeBounds | null

Optional host projection for rejecting writes hidden by merged cells.

row: number
column: number
methodgetRowCount
getRowCount(): number
methodgetSelection
getSelection(): SheetRangeBounds | null
methodisRowVisible
isRowVisible(row: number): boolean
row: number
methodplanClearMergedRanges
planClearMergedRanges(range: SheetRangeBounds): { operations: UpdateCellOTOperation<SheetCellMerge>[]; target: PluginKey }
range: SheetRangeBounds
methodplanOwnerFormats
planOwnerFormats(captured: readonly SheetPortableFormatTransfer[], target: SheetRangeBounds): readonly SheetFormatTransferPlan[]
captured: readonly SheetPortableFormatTransfer[]
target: SheetRangeBounds
methodplanPasteMergedRanges
planPasteMergedRanges(merges: readonly SheetClipboardMergedRange[], target: SheetClipboardCellPoint): { operations: UpdateCellOTOperation<SheetCellMerge>[]; target: PluginKey }
merges: readonly SheetClipboardMergedRange[]
target: SheetClipboardCellPoint
methodplanRangeMove
planRangeMove(source: SheetClipboardRangeInput, destination: SheetClipboardRangeInput): readonly SheetRangeMovePlan[]
source: SheetClipboardRangeInput
destination: SheetClipboardRangeInput
methodprepareCrossSheetCut
prepareCrossSheetCut(cutId: string, clearPipeline: Pipeline): void
cutId: string
clearPipeline: Pipeline
methodreadCell
readCell(row: number, column: number): CellMatrixElement | null
row: number
column: number
methodreadCellFormat
readCellFormat(row: number, column: number): CellFormat | null
row: number
column: number
methodscheduleCrossSheetMove
scheduleCrossSheetMove(cutId: string, sourceId: string, pastePipeline: Pipeline): Promise<void>
cutId: string
sourceId: string
pastePipeline: Pipeline
classDocCaretStatesource ↗
class DocCaretState

Shared caret blink state used by document feature plugins and render layout.

constructorconstructor
DocCaretState(): DocCaretState
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving caret state owned by CaretPlugin.

methodenforceCommandBoundary
enforceCommandBoundary(isCommandExecuting: (): boolean): void

Closes direct caret writes after editor assembly.

isCommandExecuting: (): boolean
methodisVisible
isVisible(): boolean

Returns whether the caret should be painted in the current frame.

methodreset
reset(): void

Restarts the blink cycle with the caret visible.

methodsetVisible
setVisible(visible: boolean): void

Sets the current caret visibility.

visible: boolean
methodtoggle
toggle(): boolean

Toggles the caret visibility for a blink tick.

classDocContentRenderPluginsource ↗
class DocContentRenderPlugin extends DocPlugin<null>

Default content renderer for text nodes laid out by the document layout engine.

constructorconstructor
DocContentRenderPlugin(): DocContentRenderPlugin

Creates a DocContentRenderPlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving DocContentRenderPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(searCore: SearCoreDoc): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

searCore: SearCoreDoc
Inherited members 42

Inherited from DocPlugin.

classDocDebugOverlayPluginsource ↗
class DocDebugOverlayPlugin extends DocPlugin<null>

Debug overlay for document block-level render bounds.

constructorconstructor
DocDebugOverlayPlugin(): DocDebugOverlayPlugin

Creates a DocDebugOverlayPlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving DocDebugOverlayPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodstart
start(): void

Starts runtime behavior after the first document frame.

Inherited members 41

Inherited from DocPlugin.

classDocInputBindingRegistrysource ↗
class DocInputBindingRegistry

Registry that lets multiple document plugins contribute handlers to single-subscription input adapters.

constructorconstructor
DocInputBindingRegistry(): DocInputBindingRegistry
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving the input binding registry.

methodclear
clear(): void

Removes every registered handler.

methodcreateKeyboardHandlers
createKeyboardHandlers(): KeyboardRouterHandlers

Creates the composed keyboard handlers passed to the host keyboard adapter.

methodcreateTextHandlers
createTextHandlers(): TextInputHandlers

Creates the composed text handlers passed to the host text adapter.

methodenforceCommandBoundary
enforceCommandBoundary(isCommandExecuting: (): boolean, isTearingDown: (): boolean): void

Closes registration changes after editor startup.

isCommandExecuting: (): boolean
isTearingDown: (): boolean
methodregisterKeyboardHandlers
registerKeyboardHandlers(handlers: KeyboardRouterHandlers): (): void

Adds keyboard-action handlers and returns a disposer.

handlers: KeyboardRouterHandlers
methodregisterTextHandlers
registerTextHandlers(handlers: TextInputHandlers): (): void

Adds text-input handlers and returns a disposer.

handlers: TextInputHandlers
classDocRenderLayoutServicesource ↗
class DocRenderLayoutService

Owns Doc layout cache, page map, and viewport range derivation.

constructorconstructor
DocRenderLayoutService(inputPlugin: DocInputPlugin, extensions: DocRuntimeExtensionRegistry, renderContext: RenderContext, scrollManager: ScrollManager, sceneTree: Tree<PositionRect<templateLiteral>>, configuration: DocEditorRuntimeConfiguration, configEngine: ConfigEngine, cursorManager: DocCursorManager, compositionProvider: DocCompositionProvider, layoutEngine: DocLayoutEngine, virtualLayouts: DocVirtualLayoutStore, commands: DocCommandBus): DocRenderLayoutService

Creates a render-layout service for one standalone document editor.

inputPlugin: DocInputPlugin
extensions: DocRuntimeExtensionRegistry
renderContext: RenderContext
scrollManager: ScrollManager
sceneTree: Tree<PositionRect<templateLiteral>>
configuration: DocEditorRuntimeConfiguration
configEngine: ConfigEngine
cursorManager: DocCursorManager
compositionProvider: DocCompositionProvider
layoutEngine: DocLayoutEngine
virtualLayouts: DocVirtualLayoutStore
commands: DocCommandBus
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving the render-layout service.

methodgetLatestVirtualLayoutSummary
getLatestVirtualLayoutSummary(): DocVirtualLayoutSummary | null
methodprepareRenderLayout
prepareRenderLayout(contentRect: DocEditorContentRect, viewport: DocEditorViewport, renderOperations?: DocRenderOperations): DocRenderLayout

Builds the current render layout before plugins produce render nodes.

contentRect: DocEditorContentRect
viewport: DocEditorViewport
renderOperations: DocRenderOperations
methodprepareViewportLayout
prepareViewportLayout(contentRect: DocEditorContentRect, viewport: DocEditorViewport): DocRenderLayout

Reuses the previous full-document layout and updates only viewport-derived fields.

contentRect: DocEditorContentRect
viewport: DocEditorViewport
methodrecordBlockRenderDebugSnapshot
recordBlockRenderDebugSnapshot(snapshot: DocBlockRenderDebugSnapshot): void

Records block-render reuse/debug stats for the latest render frame.

snapshot: DocBlockRenderDebugSnapshot
methodrecordRenderPrepareTiming
recordRenderPrepareTiming(mode: DocRenderPrepareMode, durationMs: number): void
mode: DocRenderPrepareMode
durationMs: number
methodrefreshInteractionLayout
refreshInteractionLayout(contentRect: DocEditorContentRect, _viewport: DocEditorViewport): DocRenderLayout | null

Reuses the latest layout snapshot and refreshes selection/caret geometry only.

contentRect: DocEditorContentRect
_viewport: DocEditorViewport
methodreset
reset(): void

Clears cached layout and page state.

methodsubscribeVirtualLayoutSummary
subscribeVirtualLayoutSummary(listener: DocVirtualLayoutSummaryListener): (): void
listener: DocVirtualLayoutSummaryListener
classHistoryPluginsource ↗
class HistoryPlugin extends DocPlugin<null>

Tracks committed document snapshots and contributes transaction-safe undo/redo commands.

constructorconstructor
HistoryPlugin(input: DocInputPlugin, platform?: Platform): HistoryPlugin
input: DocInputPlugin
platform: Platform
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving HistoryPlugin.

methodapply
apply(_state: null, _transaction: Transaction): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: Transaction
methodconfigure
configure(context: DocPluginSetupContext): void

Registers document undo and redo shortcuts with the composed keyboard adapter.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodgetStatus
getStatus(): DocHistoryStatus
methodinitialize
initialize(): void

Aligns the history baseline with state restored before Core initialization.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodonTransactionCommitted
onTransactionCommitted(transaction: Transaction): void

Updates history only after Core has committed the owning document transaction.

transaction: Transaction
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
methodregisterObservations
registerObservations(observations: ObservationRegistry): void

Registers typed state and event observations owned by this document plugin.

observations: ObservationRegistry
methodregisterSessionState
registerSessionState(registry: SessionStateRegistry): void

Registers local state that must survive an in-memory editor remount.

registry: SessionStateRegistry
methodregisterState
registerState(): { dataEngine: { enabled: boolean }; key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodsubscribe
subscribe(listener: (status: DocHistoryStatus): void): (): void
listener: (status: DocHistoryStatus): void
Inherited members 36

Inherited from DocPlugin.

classRichTextBlockNodesource ↗
class RichTextBlockNode extends RichTextVisualNode

Scene node that indexes and draws one top-level rich-text block.

constructorconstructor
RichTextBlockNode(input: { block: { id: string; index: number }; font: string; lineRenderer: RichTextLineRenderer; lines: readonly RichTextRenderLine[]; origin?: Pick<PositionRectProps, "x" | "y">; rect: PositionRectProps }): RichTextBlockNode

Creates a block-level rich-text scene node.

input: { block: { id: string; index: number }; font: string; lineRenderer: RichTextLineRenderer; lines: readonly RichTextRenderLine[]; origin?: Pick<PositionRectProps, "x" | "y">; rect: PositionRectProps }
methoddrawScene
drawScene(context: RenderContext, clipRegion?: ClipRegion): void

Draws all visible text runs inside this block.

context: RenderContext
clipRegion: ClipRegion
Inherited members 42

Inherited from RichTextVisualNode.

classRichTextRunNodesource ↗
class RichTextRunNode extends RichTextVisualNode

Scene node that draws one contiguous styled rich-text run in world coordinates.

constructorconstructor
RichTextRunNode(input: { baselineY: number; font: string; fontAscent: number; fontDescent: number; properties: Partial<RichTextRenderNodeProperties>; rect: PositionRectProps; runRenderer: RichTextRunRenderer; style?: Readonly<Record<string, unknown>>; … }): RichTextRunNode

Creates a text-run scene node.

input: { baselineY: number; font: string; fontAscent: number; fontDescent: number; properties: Partial<RichTextRenderNodeProperties>; rect: PositionRectProps; runRenderer: RichTextRunRenderer; style?: Readonly<Record<string, unknown>>; … }
methoddrawScene
drawScene(context: RenderContext, clipRegion?: ClipRegion): void

Draws the text run into the active world-space transform.

context: RenderContext
clipRegion: ClipRegion
Inherited members 42

Inherited from RichTextVisualNode.

classSelectionPluginsource ↗
class SelectionPlugin extends DocPlugin<null>

Owns document selection commands, select-all shortcut, and pointer drag selection.

constructorconstructor
SelectionPlugin(input: DocInputPlugin): SelectionPlugin
input: DocInputPlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving SelectionPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
methodregisterObservations
registerObservations(observations: ObservationRegistry): void

Registers the host-facing selection observation.

observations: ObservationRegistry
methodregisterSessionState
registerSessionState(registry: SessionStateRegistry): void

Registers selection-owned local remount state.

registry: SessionStateRegistry
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodstart
start(): void

Starts runtime behavior after the first document frame.

Inherited members 37

Inherited from DocPlugin.

classSheetDebugOverlayPluginsource ↗
class SheetDebugOverlayPlugin extends SheetPlugin<null>

Empty Sheet debug overlay placeholder used by hosts that enable ?debug.

constructorconstructor
SheetDebugOverlayPlugin(): SheetDebugOverlayPlugin

Creates a SheetDebugOverlayPlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving SheetDebugOverlayPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<CellProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

Inherited members 44

Inherited from SheetPlugin.

classSheetPluginsource ↗
class SheetPlugin<StateType> extends Plugin<SearCoreSheet, CellProperties, StateType>, PluginExtension<SheetCommandBus, ObservationRegistry, SessionStateRegistry, SheetRuntimeExtensionRegistry, SheetQueryRegistry>

Convenience base class for a Plugin targeting createSheetEditor().

constructorconstructor
SheetPlugin<StateType>(__namedParameters: PluginSpec<StateType>): SheetPlugin<StateType>

Creates a plugin with its stable identity and initial state.

__namedParameters: PluginSpec<StateType>
methodconfigure
configure(context: SheetPluginSetupContext): void

Configures the Sheet editor before its Core is created.

context: SheetPluginSetupContext
methodinitialize
initialize(context: SheetPluginRuntimeContext): void

Prepares behavior that requires initialized Core state but must run before the first frame and other runtime effects.

context: SheetPluginRuntimeContext
methodonEditorDestroy
onEditorDestroy(context: SheetPluginRuntimeContext): void

Releases resources owned by this plugin before the Core is destroyed.

This deliberately does not use the name destroy: DI containers may treat a no-argument destroy() method as an owned-instance disposer.

context: SheetPluginRuntimeContext
methodregisterCapabilities
registerCapabilities(registry: SheetRuntimeExtensionRegistry): void

Publishes typed runtime services owned by this plugin.

registry: SheetRuntimeExtensionRegistry
methodregisterCellVisualReaders
registerCellVisualReaders(registry: SheetCellVisualReaderRegistry, context: SheetCellVisualReaderRegistrationContext): void

Registers plugin-owned properties used to compose rendered Sheet cells.

registry: SheetCellVisualReaderRegistry
context: SheetCellVisualReaderRegistrationContext
methodregisterCommands
registerCommands(commands: SheetCommandBus): void

Registers every stable command id owned by this plugin.

commands: SheetCommandBus
methodregisterFormatTransfers
registerFormatTransfers(registry: SheetFormatTransferRegistry): void

Contributes owner-defined format capture and transfer plans.

registry: SheetFormatTransferRegistry
methodregisterObservations
registerObservations(observations: ObservationRegistry): void

Registers typed state and event observations owned by this plugin.

observations: ObservationRegistry
methodregisterQueries
registerQueries(queries: SheetQueryRegistry): void
queries: SheetQueryRegistry
methodregisterRangeMoves
registerRangeMoves(registry: SheetRangeMoveRegistry): void

Contributes state-owner planning for same-sheet cell moves.

registry: SheetRangeMoveRegistry
methodregisterSessionState
registerSessionState(registry: SessionStateRegistry): void

Registers local state that must survive an in-memory editor remount.

registry: SessionStateRegistry
methodregisterStructureMoves
registerStructureMoves(registry: SheetStructureMoveRegistry): void

Contributes preflight and dependent operation planning for whole-axis reordering.

registry: SheetStructureMoveRegistry
methodstart
start(context: SheetPluginRuntimeContext): void

Starts runtime behavior after the Core has rendered its first frame.

context: SheetPluginRuntimeContext
methodregisterServicesstatic
registerServices(context: SheetPluginServiceContext): void

Registers bindings required before this Sheet plugin is instantiated.

context: SheetPluginServiceContext
Inherited members 34

Inherited from Plugin.

classSheetRuntimeExtensionRegistrysource ↗
class SheetRuntimeExtensionRegistry extends RuntimeCapabilityRegistry

Registry for typed sheet runtime extension values.

Third-party plugins use this registry to publish and consume capabilities without mutating the runtime facade shape directly.

constructorconstructor
SheetRuntimeExtensionRegistry(): SheetRuntimeExtensionRegistry
Inherited members 7

Inherited from RuntimeCapabilityRegistry.

classTextInputPluginsource ↗
class TextInputPlugin extends DocPlugin<null>

Owns printable text input and delete bindings.

constructorconstructor
TextInputPlugin(): TextInputPlugin

Creates a TextInputPlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving TextInputPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers text node model support owned by this plugin.

context: DocPluginServiceContext
Inherited members 39

Inherited from DocPlugin.

classViewportOverlayNodesource ↗
class ViewportOverlayNode extends RichTextVisualNode

Viewport overlay node that draws transient UI under an identity transform.

constructorconstructor
ViewportOverlayNode(input: { depth?: number; drawOverlay: (context: RenderContext): void; nodeKey: string; rect: PositionRectProps; role?: "selection" | "caret" }): ViewportOverlayNode

Creates a viewport overlay render node.

input: { depth?: number; drawOverlay: (context: RenderContext): void; nodeKey: string; rect: PositionRectProps; role?: "selection" | "caret" }
methoddrawScene
drawScene(context: RenderContext): void

Draws overlay content; the node owns transform isolation for viewport-space plugins.

context: RenderContext
Inherited members 42

Inherited from RichTextVisualNode.

interfaceCaptureDocSessionStateCommandResultsource ↗
interface CaptureDocSessionStateCommandResult extends DocCommandResult

Result of capturing editor-local state for an in-memory document remount.

propertysessionState
readonly sessionState: DocSessionState
Inherited members 2

Inherited from DocCommandResult.

interfaceCaptureSheetSessionStateCommandResultsource ↗
interface CaptureSheetSessionStateCommandResult extends SheetCommandResult

Result of capturing editor-local state for an in-memory workbook remount.

propertysessionState
readonly sessionState: SheetSessionState
Inherited members 4

Inherited from SheetCommandResult.

interfaceDocBaseServicessource ↗
interface DocBaseServices

Base service instances created before runtime adapters and plugins are wired.

propertyconfigEngine
readonly configEngine: ConfigEngine

Configuration engine registered in the DI container.

propertystage
readonly stage: SceneGraph<RichTextRenderNodeProperties>

Scene graph that owns standalone document content render nodes.

interfaceDocDocumentStatesource ↗
interface DocDocumentState

Document-owned rich content eligible for future ExportPlugin serialization.

propertydocument
readonly document: RichDocNode[]

Rich-document tree owned by this editor document.

interfaceDocEditorsource ↗
interface DocEditor

Public standalone document editor API returned by createDocEditor().

propertycapabilities
readonly capabilities: RuntimeCapabilityReader

Read-only access to typed services owned by this editor's isolated runtime.

propertycommands
readonly commands: DocCommandBus

The supported command entry point for document user and program actions.

propertyobservations
readonly observations: ObservationRegistry

Typed editor-local state and event observations exposed to the host.

methoddestroy
destroy(): void

Releases listeners, timers, adapter state, and DI-owned services for this editor instance.

methodfocus
focus(): void

Requests focus for the host text-input adapter, preserving IME placement.

methodgetDocument
getDocument(): RichDocNode[]

Returns a clone of the current rich-document content.

methodgetText
getText(): string

Returns the current plain-text view using one newline between paragraphs.

methodloadDocument
loadDocument(document: RichDocNode[]): void

Replaces the document content and renders the new state.

document: RichDocNode[]
methodrender
render(): void

Renders the current editor state into the configured render context.

interfaceDocEditorAdapterssource ↗
interface DocEditorAdapters

Platform-specific services required to assemble a standalone document editor.

propertyeventRegistrar
eventRegistrar?: InjectableImplementation<EventRegistrar>

Optional host event registrar; defaults to a headless registrar when omitted.

propertykeyboardRouter
keyboardRouter: InjectableImplementation<KeyboardRouter>

Keyboard router for action keys such as arrows, backspace, enter, and select-all.

propertyplatform
platform: InjectableImplementation<Platform>

Platform implementation that owns timers, resize observation, and diagnostics.

propertypointerCapture
pointerCapture: InjectableImplementation<PointerCapture>

Host-wide pointer capture adapter that emits render-root view coordinates.

propertyscroller
scroller?: InjectableImplementation<Scroller & { getPublisher: unknown }>

Optional host scroller adapter for wheel/touch viewport scrolling.

propertytextInput
textInput: InjectableImplementation<TextInput>

Text input adapter for printable text, paste/cut, and IME composition.

methodcreateRenderContext
createRenderContext(): RenderContext

Creates the visible render context used by the document editor.

methodcreateTextShaper
createTextShaper(renderContext: RenderContext): TextShaper

Optional text-shaping adapter; omission uses render-context measurements.

renderContext: RenderContext
methodregisterEnvironment
registerEnvironment(container: Container): void

Registers host environment values, such as keyboard and pointer event sources. Runs after base services are registered and before adapters are resolved.

container: Container
interfaceDocEditorChangesource ↗
interface DocEditorChange

Snapshot delivered when the document content changes.

propertydocument
readonly document: RichDocNode[]

Cloned rich-document content after the change.

propertytext
readonly text: string

Plain-text view using one newline between paragraphs.

interfaceDocEditorConfigurationsource ↗
interface DocEditorConfiguration

Configuration for assembling a standalone rich-document editor.

propertyadapters
adapters: DocEditorAdapters

Platform adapters supplied by the host application.

propertydefaultPlugins
defaultPlugins?: false | readonly DocPluginImplementation<DocPlugin<unknown>>[]

Default document feature plugins; pass false to assemble only custom plugins.

propertydevicePixelRatio
devicePixelRatio?: number

Raster scale used to initialize and resize the render context.

propertydocumentState
documentState: DocDocumentState

Initial document-owned state.

propertyfontFamily
fontFamily?: string

Default font family and fallback list applied to document text.

propertyfontSize
fontSize?: number

Default font size applied when measuring and rendering document text.

propertyincrementalRenderPolicyLimits
incrementalRenderPolicyLimits?: IncrementalRenderPolicyLimitsConfig

Guardrails used when deciding whether document block raster reuse should run for a frame.

propertylineHeightMultiplier
lineHeightMultiplier?: number

Default line-height multiplier applied to paragraphs without an explicit override.

propertyparagraphSpacingAfter
paragraphSpacingAfter?: number

Default spacing after non-final paragraphs.

propertyplugins
plugins?: DocPluginImplementation<DocPlugin<unknown>>[]

Document plugins installed after the default editing and rendering features.

propertysessionState
sessionState?: Readonly<Record<string, unknown>>

Optional editor-local state restored during an in-memory remount.

propertyverticalAlign
verticalAlign?: DocVerticalAlign

Vertical positioning used by standalone document layout; defaults to top.

propertyviewport
viewport?: DocEditorViewport

Initial viewport size; defaults to 800 by 600 when the host cannot know it yet.

methodcontentRect
contentRect(viewport: DocEditorViewport): DocEditorContentRect

Resolves the editable content rectangle from the current viewport. Hosts use this to add page margins, rulers, or chrome without changing core document layout.

viewport: DocEditorViewport
methodonCreated
onCreated(editor: DocEditor): void

Called once the editor object has been assembled and initial content rendered.

editor: DocEditor
interfaceDocEditorContentRectsource ↗
interface DocEditorContentRect extends DocEditorViewport

Rectangle used for document text layout and rendering.

propertyx
x: number

Left edge in host-view coordinates.

propertyy
y: number

Top edge in host-view coordinates.

Inherited members 2

Inherited from DocEditorViewport.

interfaceDocEditorViewportsource ↗
interface DocEditorViewport

Viewport dimensions in host-view coordinates.

propertyheight
height: number

Viewport height in host-view units.

propertywidth
width: number

Viewport width in host-view units.

interfaceDocHistoryEntrysource ↗
interface DocHistoryEntry

Detached before/after snapshots for one committed document mutation.

propertyafterDocument
readonly afterDocument: RichDocNode[]
propertyafterSelection
readonly afterSelection: DocSelection
propertybeforeDocument
readonly beforeDocument: RichDocNode[]
propertybeforeSelection
readonly beforeSelection: DocSelection
propertyoperations
readonly operations?: readonly RichDocOTOperation[]

RichDoc OT operations committed by the document mutation.

interfaceDocHistorySessionStatesource ↗
interface DocHistorySessionState

Document-local undo and redo stacks retained during editor remounts.

propertyredoStack
readonly redoStack: readonly DocHistoryEntry[]
propertyundoStack
readonly undoStack: readonly DocHistoryEntry[]
interfaceDocHistoryStatussource ↗
interface DocHistoryStatus

Current document undo/redo availability.

propertycanRedo
readonly canRedo: boolean
propertycanUndo
readonly canUndo: boolean
interfaceDocInlineStyleStatussource ↗
interface DocInlineStyleStatus

Whether one inline style can be applied, is active, and has a common selected value.

propertyactive
readonly active: boolean
propertyenabled
readonly enabled: boolean
propertyvalue
readonly value: unknown

The common selected value, or null when unset or mixed.

interfaceDocRenderLayoutsource ↗
interface DocRenderLayout

Layout/cache/page-map result exposed to document plugins for one render pass.

propertyblockLayoutDiff
readonly blockLayoutDiff: DocBlockLayoutDiff

Block-level diff between the previous and current layout caches.

propertycomposingCaretPixelOffset
readonly composingCaretPixelOffset: number

Pixel offset from composing-text start to the IME caret.

propertycursorX
readonly cursorX: number

Cursor x in world coordinates.

propertycursorY
readonly cursorY: number

Cursor y in world coordinates.

propertydocumentRect
readonly documentRect: { height: number; width: number; x: number; y: number }

Current document layout rectangle in world coordinates.

propertylayoutCache
readonly layoutCache: DocLayoutCache

Latest full-document layout cache.

propertypageMap
readonly pageMap: DocPageMap

Latest page map derived from the layout cache.

propertyvisibleBlocks
readonly visibleBlocks: readonly DocBlockLayout[]

Laid-out blocks selected for plugin-owned render nodes.

interfaceDocRuntimesource ↗
interface DocRuntime

Runtime services assembled after Doc base services and host environment values are available.

propertyeventEngine
readonly eventEngine: EventEngine<NodeProperties>

Event pipeline and hit-testing facade for document interactions.

propertyeventRegistrar
readonly eventRegistrar: EventRegistrar

Event registrar selected by the host or the headless fallback.

propertypluginManager
readonly pluginManager: PluginManager<SearCoreDoc, NodeProperties>

Document plugin manager populated by feature registration.

propertyrenderContexts
readonly renderContexts: { hit: RenderContext; main: RenderContext; offScreen: RenderContext }

Render contexts for visible, off-screen, and hit-test layers.

propertyrenderEngine
readonly renderEngine: DocRenderEngine

Document render engine populated with the shared Sheet-like strategy chain.

propertyscrollManager
readonly scrollManager: ScrollManager

Scroll manager coordinating document viewport state.

interfaceDocViewportSessionStatesource ↗
interface DocViewportSessionState

Local viewport position retained while remounting one document editor.

propertyx
readonly x: number
propertyy
readonly y: number
interfaceExportDocStateCommandResultsource ↗
interface ExportDocStateCommandResult extends DocCommandResult

Result of exporting detached document-owned state for an in-memory remount.

propertydocumentState
readonly documentState: DocDocumentState
Inherited members 2

Inherited from DocCommandResult.

interfaceExportSheetStateCommandResultsource ↗
interface ExportSheetStateCommandResult extends SheetCommandResult

Command result for exporting the current sheet state snapshot.

The pipeline is intentionally empty: exporting state must not mutate OT state, request rendering, or produce local effects.

propertysheetState
readonly sheetState: SheetDocumentState

Cloned state payload suitable for workbook persistence or sheet remounting.

Inherited members 4

Inherited from SheetCommandResult.

interfaceRichTextRenderLinesource ↗
interface RichTextRenderLine

Minimal layout-line shape consumed by rich-text render nodes.

propertychars
readonly chars: readonly RichTextRenderChar[]
propertycharStartOffset
readonly charStartOffset: number
propertycursorXOffsets
readonly cursorXOffsets?: readonly number[]
propertyfontAscent
readonly fontAscent: number
propertyheight
readonly height: number
propertytextNodePath
readonly textNodePath: readonly number[]
propertyx
readonly x: number
propertyy
readonly y: number
interfaceRichTextRenderNodePropertiessource ↗
interface RichTextRenderNodeProperties extends NodeProperties

Render-node properties used by rich-text scene graphs.

propertyblockId
readonly blockId?: string

Stable top-level rich-text block id.

propertyblockIndex
readonly blockIndex?: number

Top-level rich-text block index.

propertylineIndex
readonly lineIndex?: number

Layout line index inside the full rich-text snapshot.

propertyrenderRole
readonly renderRole?: "block" | "line" | "page" | "text-run" | "selection" | "caret" | "composition"

Semantic role for rich-text render nodes.

Inherited members 24

Inherited from NodeProperties.

interfaceSheetClipboardWorkbookBridgesource ↗
interface SheetClipboardWorkbookBridge

Workbook-owned endpoint for an atomic move between two sheets.

methodcommitMove
commitMove(cutId: string, sourceId: string, targetId: string, targetAfter: SheetDocumentState): Promise<void>
cutId: string
sourceId: string
targetId: string
targetAfter: SheetDocumentState
methodprepareCut
prepareCut(cutId: string, sourceId: string, sourceBefore: SheetDocumentState, clearedSource: SheetDocumentState): void
cutId: string
sourceId: string
sourceBefore: SheetDocumentState
clearedSource: SheetDocumentState
interfaceSheetDocumentStatesource ↗
interface SheetDocumentState

Document data owned by one sheet and eligible for future ExportPlugin serialization.

propertycellAlignments
cellAlignments: AlignmentMatrix
propertycellBorders
cellBorders?: CellBorderMatrix

Sparse custom cell-edge state; absence initializes an empty border owner.

propertycellFills
cellFills: CellFillMatrix

Sparse cell fill state.

propertycellFormats
cellFormats: CellFormatMatrix

Sparse per-cell number-format state.

propertycellHighlights
cellHighlights: CellHighlightMatrix

Sparse conditional highlight rules anchored at their range starts.

propertycellMerges
cellMerges: CellMergeMatrix
propertycellVerticalAlignments
cellVerticalAlignments: VerticalAlignmentMatrix

Sparse vertical cell alignment state.

propertycolumnHiddenOriginalSizes
columnHiddenOriginalSizes?: CSRMatrix<number>
propertycolumnSizes
columnSizes: ColumnShapeDimensionsCSRMatrix
propertydataValidations
dataValidations?: DataValidationMatrix

Sparse data validation rules anchored at range starts.

propertyduplicates
duplicates: DuplicateMatrix

Sparse duplicate-item highlight state.

propertyfilters
filters?: SheetFilterMatrix

Sheet-owned filter range and column rules.

propertyfixedRows
fixedRows?: FixedRowMatrix

Sparse per-row fixed state.

propertyfreeze
freeze?: SheetFreezeMatrix

Persistent top and left freeze boundaries.

propertyrowHiddenOriginalSizes
rowHiddenOriginalSizes?: CSRMatrix<number>
propertyrowSizes
rowSizes: RowShapeDimensionsCSRMatrix
propertysheetData
sheetData: SheetMatrix
interfaceSheetEditorsource ↗
interface SheetEditor

Public contract for SheetEditor.

propertycapabilities
readonly capabilities: RuntimeCapabilityReader

Read-only access to typed services owned by this editor's isolated runtime.

propertycommands
readonly commands: SheetCommandBus

The sole supported entry point for user and program commands.

propertyobservations
readonly observations: ObservationRegistry

Typed editor-local state and event observations exposed to the host.

propertyqueries
readonly queries: SheetQueryRegistry

Typed runtime query registry for side-effect-free editor reads.

methoddestroy
destroy(): void

Releases runtime services and every active host observation subscription.

interfaceSheetEditorAdapterssource ↗
interface SheetEditorAdapters

Platform-specific services required to assemble the default sheet editor.

propertyclipboard
clipboard?: InjectableImplementation<SheetClipboard>
propertycollabTransport
collabTransport: InjectableImplementation<CollabTransport>
propertycursorEngine
cursorEngine: InjectableImplementation<CursorEngine>
propertyeventRegistrar
eventRegistrar: InjectableImplementation<EventRegistrar>
propertyfileDownload
fileDownload?: InjectableImplementation<FileDownload>

Optional host file-save capability; existing environment bindings take precedence. The editor owns newly created adapters.

propertyformulaBar
formulaBar?: InjectableImplementation<SearFormulaBar>

Optional formula input surface supplied by the host.

propertykeyboardRouter
keyboardRouter: InjectableImplementation<KeyboardRouter>
propertyplatform
platform: InjectableImplementation<Platform>
propertypointerCapture
pointerCapture: InjectableImplementation<PointerCapture>
propertyscroller
scroller: InjectableImplementation<Scroller & { getPublisher: unknown }>
propertytextInput
textInput: InjectableImplementation<TextInput>
propertytoolbar
toolbar: InjectableImplementation<SearToolbar>
propertyuserInteraction
userInteraction?: InjectableImplementation<UserInteractionService>

Host-owned service for decisions that require a user response.

propertywebServiceClient
webServiceClient?: InjectableImplementation<WebServiceClient>

Asynchronous web-service transport used by host-managed formula caches.

propertyxmlXPathEvaluator
xmlXPathEvaluator?: InjectableImplementation<XmlXPathEvaluator>

XML/XPath evaluator used by XML-backed formula plugins.

methodcreateFunctionRegistry
createFunctionRegistry(): IFunctionRegistry

Creates the function catalog owned by this editor or its parent workbook.

methodcreateRenderContexts
createRenderContexts(): { hitRenderContext: RenderContext; offScreenRenderContext: RenderContext; renderContext: RenderContext }
methodcreateTextShaper
createTextShaper(renderContext: RenderContext): TextShaper

Creates an editor-local text shaper; omission uses render-context measurements.

renderContext: RenderContext
methodregisterEnvironment
registerEnvironment(container: Container): void
container: Container
interfaceSheetEditorConfigurationsource ↗
interface SheetEditorConfiguration

Public contract for SheetEditorConfiguration.

propertyadapters
adapters: SheetEditorAdapters
propertycellFontFamily
cellFontFamily?: string

Default font family and fallback list used by ordinary Sheet cells.

propertycellFontSize
cellFontSize?: number

Default font size used by ordinary Sheet cells.

propertyembeddedEditor
embeddedEditor?: SheetEmbeddedEditor

Optional editor used to render and edit rich text embedded in Sheet cells.

propertyplugins
plugins?: SheetEditorPluginImplementation[]
propertysessionState
sessionState?: Readonly<Record<string, unknown>>

Optional editor-local state restored when remounting a workbook sheet.

propertysheetState
sheetState: SheetDocumentState
propertyviewport
viewport?: { height: number; width: number }
methodonCreated
onCreated(editor: SheetEditor): void
editor: SheetEditor
interfaceSheetPluginImplementationsource ↗
interface SheetPluginImplementation<TPlugin>

Injectable SheetPlugin class accepted by createSheetEditor().

constructorconstructor
SheetPluginImplementation(...args: never[]): TPlugin
args: never[]
propertysymbol
readonly symbol: symbol
methodregisterServices
registerServices(context: SheetPluginServiceContext): void
context: SheetPluginServiceContext
interfaceSheetPluginRuntimesource ↗
interface SheetPluginRuntime extends SheetPluginSetupRuntime

Runtime capabilities available after the command bus is bound and Core exists.

propertycommands
readonly commands: SheetCommandBus
propertytoolbar
readonly toolbar: SearToolbar
Inherited members 19

Inherited from SheetPluginSetupRuntime.

interfaceSheetPluginRuntimeContextsource ↗
interface SheetPluginRuntimeContext extends SheetPluginSetupContext

Sheet setup capabilities plus the Core created by createSheetEditor().

propertycore
readonly core: SearCoreSheet
propertyruntime
readonly runtime: SheetPluginRuntime
Inherited members 2

Inherited from SheetPluginSetupContext.

interfaceSheetPluginServiceContextsource ↗
interface SheetPluginServiceContext

Services available while createSheetEditor() registers Sheet plugins.

propertycontainer
readonly container: Container
interfaceSheetPluginSetupContextsource ↗
interface SheetPluginSetupContext

Typed public services available before createSheetEditor() creates its Core.

propertycontainer
readonly container: Container
propertyruntime
readonly runtime: SheetPluginSetupRuntime
methodaddStrategy
addStrategy(token: symbol, strategy: RenderStrategy<CellProperties>, position: { before: symbol } | { after: symbol }): void
token: symbol
strategy: RenderStrategy<CellProperties>
position: { before: symbol } | { after: symbol }
interfaceSheetPluginSetupRuntimesource ↗
interface SheetPluginSetupRuntime

Stable host capabilities available before the command bus and Core are ready. Services are grouped by responsibility so plugins need not rely on untyped container lookups for normal extension work.

propertycells
readonly cells: { catalog: CellTypeCatalog }
propertycollaboration
readonly collaboration: { session: Pick<CollaborationSession, "getStatus"> }
propertyconfig
readonly config: ConfigEngine
propertydata
readonly data: SheetDataEngine
propertyembeddedEditor
readonly embeddedEditor?: { editor: SheetEmbeddedEditor }

Optional Sheet-facing rich-text editor supplied by the host.

propertyevents
readonly events: { engine: EventEngine<CellProperties>; registrar: EventRegistrar }
propertyextensions
readonly extensions: SheetRuntimeExtensionRegistry
propertyformula
readonly formula: { externalServices: IFormulaExternalServiceProvider; functions: IFunctionRegistry; results: FormulaResultProviderRegistry; richResults: FormulaRichResultProviderRegistry; sources: FormulaSourceProviderRegistry; textServices: IFormulaTextServiceProvider; webService: WebServiceClient; xmlXPath: XmlXPathEvaluator }
propertyinput
readonly input: { cursor: CursorEngine; cursorRules: CursorRegistry; keyboard: KeyboardRouter; pointer: PointerCapture; text: TextInput }
propertyinteraction
readonly interaction: { pipelineSteps: PipelineStepExecutorRegistry; reducers: SheetInteractionReducerRegistry; store: SheetInteractionStore }
propertylifecycle
readonly lifecycle: SheetLifecycleCoordinator
propertyobservations
readonly observations: ObservationRegistry
propertyplatform
readonly platform: Platform
propertyplugins
readonly plugins: PluginManager<SearCoreSheet, CellProperties>
propertyqueries
readonly queries: SheetQueryRegistry
propertyrender
readonly render: { cellVisualReaders: SheetCellVisualReaderRegistry; contexts: { hit: RenderContext; main: RenderContext; offScreen: RenderContext }; coordinator: SheetRenderCoordinatorManager; dirtyTracker: GenerationalDirtyTracker; dirtyTree: Tree<PositionRect<templateLiteral>>; engine: SheetRenderEngine; rendererRegistry: SheetRendererRegistry<CellProperties>; stage: SceneGraph<CellProperties>; … }
propertyscroll
readonly scroll: { coordinates: CoordinateEngine; manager: ScrollManager; scroller: Scroller; transformer: CoordinateTransformer }
propertysession
readonly session: SessionStateRegistry

Editor-local capture and restore registry shared by every session-state owner.

propertytextShaper
readonly textShaper: TextShaper
interfaceSheetScrollToInputsource ↗
interface SheetScrollToInput

Public programmatic input for an absolute world-space viewport position.

propertyx
readonly x: number
propertyy
readonly y: number
interfaceSheetViewportSessionStatesource ↗
interface SheetViewportSessionState

Local viewport position retained while remounting one workbook sheet.

propertyx
readonly x: number
propertyy
readonly y: number
typeDocInlineStyleStatesource ↗
type DocInlineStyleState = Readonly<Record<string, DocInlineStyleStatus>>

Inline style state consumed by document toolbars and other host controls.

typeDocSessionStatesource ↗
type DocSessionState = SessionStateSnapshot

Opaque in-memory contributor snapshot retained while remounting a document editor.

typeDocViewportScrollInputsource ↗
type DocViewportScrollInput = ScrollManagerState

Internal adapter input for one platform-originated document scroll state update.

typeDocVirtualLayoutSummaryListenersource ↗
type DocVirtualLayoutSummaryListener = (summary: DocVirtualLayoutSummary): void
typeSheetRuntimeCapabilityReadersource ↗
type SheetRuntimeCapabilityReader = RuntimeCapabilityReader

Read-only view of editor-local runtime capabilities exposed to hosts.

typeSheetRuntimeCapabilityTokensource ↗
type SheetRuntimeCapabilityToken = RuntimeCapability<T>

Typed extension capability exposed through the sheet runtime facade.

typeSheetScrollInputsource ↗
type SheetScrollInput = ScrollManagerState

Internal adapter input for one platform-originated scroll state update.

typeSheetSessionStatesource ↗
type SheetSessionState = SessionStateSnapshot

Opaque, in-memory contributor snapshot retained per sheet while a workbook editor is open.

variableApplyDocViewportScrollCommandsource ↗
ApplyDocViewportScrollCommand: DocCommandDefinition<ScrollManagerState, DocCommandResult>

Applies one platform-originated document scroll update.

variableApplyViewportScrollCommandsource ↗
ApplyViewportScrollCommand: SheetCommandDefinition<ScrollManagerState, SheetCommandResult>
variableCaptureDocSessionStateCommandsource ↗
CaptureDocSessionStateCommand: DocCommandDefinition<void, CaptureDocSessionStateCommandResult>

Captures every registered local document session contributor.

variableCaptureSheetSessionStateCommandsource ↗
CaptureSheetSessionStateCommand: SheetCommandDefinition<void, CaptureSheetSessionStateCommandResult>

Captures local state that must survive switching away from one workbook sheet.

variableDefaultDocFeaturePluginssource ↗
DefaultDocFeaturePlugins: readonly [typeof ParagraphPlugin, typeof CompositionPlugin, typeof TextInputPlugin, typeof SelectionPlugin, typeof CaretPlugin, typeof DocContentRenderPlugin, typeof RichTextLineBoxPlugin, typeof FontFamilyTextStylePlugin, typeof FontSizeTextStylePlugin, typeof BoldTextStylePlugin, typeof ItalicTextStylePlugin, typeof UnderlineTextStylePlugin, typeof StrikethroughTextStylePlugin, typeof TextColorStylePlugin, typeof TablePlugin, typeof HistoryPlugin]

Default feature plugins installed by createDocEditor unless overridden.

variableDocDocumentObservationsource ↗
DocDocumentObservation: StateObservationDefinition<DocEditorChange>

Committed document content exposed as an editor-local typed state observation.

variableDocHistorySessionStateDefinitionsource ↗
DocHistorySessionStateDefinition: SessionStateDefinition<DocHistorySessionState>

Stable session-state identity owned by document history.

variableDocHistoryStatusObservationsource ↗
DocHistoryStatusObservation: StateObservationDefinition<DocHistoryStatus>

Undo/redo availability exposed as an editor-local state observation.

variableDocInlineStyleObservationsource ↗
DocInlineStyleObservation: StateObservationDefinition<Readonly<Record<string, DocInlineStyleStatus>>>

Current inline-style availability and activation for the document selection.

variableDocSelectionObservationsource ↗
DocSelectionObservation: StateObservationDefinition<DocSelection>

Current document selection exposed as an editor-local typed observation.

variableDocSelectionSessionStateDefinitionsource ↗
DocSelectionSessionStateDefinition: SessionStateDefinition<DocSelection>

Stable identity for local document selection retained during remounts.

variableDocViewportObservationsource ↗
DocViewportObservation: StateObservationDefinition<DocViewportSessionState>

Current document viewport position exposed to hosts and plugins.

variableDocViewportSessionStateDefinitionsource ↗
DocViewportSessionStateDefinition: SessionStateDefinition<DocViewportSessionState>

Stable session-state identity owned by the document viewport assembly.

variableExportDocStateCommandsource ↗
ExportDocStateCommand: DocCommandDefinition<void, ExportDocStateCommandResult>

Exports the current document-owned state without local session values.

variableExportSheetStateCommandsource ↗
ExportSheetStateCommand: SheetCommandDefinition<void, ExportSheetStateCommandResult>

Host command that exports a cloned state snapshot for the active SheetEditor.

variableRedoDocCommandsource ↗
RedoDocCommand: DocCommandDefinition<void, DocCommandResult>

Re-applies the most recently undone document mutation.

variableRenderDocViewportCommandsource ↗
RenderDocViewportCommand: DocCommandDefinition<void, DocCommandResult>

Renders the document viewport after the committed scroll state changes.

variableResizeDocViewportCommandsource ↗
ResizeDocViewportCommand: DocCommandDefinition<DocEditorViewport, DocCommandResult>

Resizes the standalone document viewport.

variableResizeSheetViewportCommandsource ↗
ResizeSheetViewportCommand: SheetCommandDefinition<{ height: number; width: number }, SheetCommandResult>
variableScrollDocViewportToCommandsource ↗
ScrollDocViewportToCommand: DocCommandDefinition<DocViewportSessionState, DocCommandResult>

Scrolls the standalone document viewport to an absolute world position.

variableScrollViewportToCommandsource ↗
ScrollViewportToCommand: SheetCommandDefinition<SheetScrollToInput, SheetCommandResult>
variableSheetClipboardWorkbookBridgeSymbolsource ↗
SheetClipboardWorkbookBridgeSymbol: typeof SheetClipboardWorkbookBridgeSymbol
variableSheetRuntimeCapabilitysource ↗
SheetRuntimeCapability: { Cells: SheetRuntimeCapability<{ catalog: CellTypeCatalog }>; Collaboration: SheetRuntimeCapability<{ session: Pick<CollaborationSession, "getStatus"> }>; Commands: SheetRuntimeCapability<SheetCommandBus>; Config: SheetRuntimeCapability<ConfigEngine<any>>; Data: SheetRuntimeCapability<SheetDataEngine>; EmbeddedEditor: SheetRuntimeCapability<{ editor: SheetEmbeddedEditor }>; Events: SheetRuntimeCapability<{ engine: EventEngine<CellProperties>; registrar: EventRegistrar }>; Formula: SheetRuntimeCapability<{ externalServices: IFormulaExternalServiceProvider; functions: IFunctionRegistry; results: FormulaResultProviderRegistry; richResults: FormulaRichResultProviderRegistry; sources: FormulaSourceProviderRegistry; textServices: IFormulaTextServiceProvider; webService: WebServiceClient; xmlXPath: XmlXPathEvaluator }>; … }
variableSheetViewportSessionStateDefinitionsource ↗
SheetViewportSessionStateDefinition: SessionStateDefinition<SheetViewportSessionState>

Stable session-state identity owned by the Sheet viewport assembly.

variableUndoDocCommandsource ↗
UndoDocCommand: DocCommandDefinition<void, DocCommandResult>

Reverts the most recent committed document mutation.

variableUnregisterSheetInputValidatorCommandsource ↗
UnregisterSheetInputValidatorCommand: SheetCommandDefinition<number, SheetCommandResult>

Removes one editor-local input validator through the Sheet command bus.

variableUpdateDocDefaultConfigCommandsource ↗
UpdateDocDefaultConfigCommand: DocCommandDefinition<EditorDefaultConfigOverrides<DocConfig>, DocCommandResult>

Updates editor-local Doc defaults without changing document state.

variableUpdateSheetDefaultConfigCommandsource ↗
UpdateSheetDefaultConfigCommand: SheetCommandDefinition<EditorDefaultConfigOverrides<SheetConfig>, SheetCommandResult>

Updates editor-local Sheet defaults without changing document state.

functioncloneSheetDocumentStatesource ↗
cloneSheetDocumentState(state: SheetDocumentState): SheetDocumentState

Takes ownership of an input Sheet snapshot without retaining caller-owned mutable values.

state: SheetDocumentState
functioncreateDefaultSheetDocumentStateExportRegistrysource ↗
createDefaultSheetDocumentStateExportRegistry(): DocumentStateCodecRegistry<SheetDocumentState>

Creates the default registry for built-in Sheet document-state modules.

functioncreateDocEditorsource ↗
createDocEditor(options: DocEditorConfiguration): DocEditor

Assembles a standalone rich-document editor from platform-neutral adapters and document content.

The editor owns its DI container, selected document plugins, rendering services, input adapters, and lifecycle. Product chrome remains a host concern and communicates with the editor through its public facade.

ReturnsA fully initialized rich-document editor facade.

Example
const editor = createDocEditor({ adapters, documentState });
editor.focus();
editor.destroy();
options: DocEditorConfiguration

Platform adapters, initial document state, plugins, and viewport configuration.

functioncreateEmptySheetDocumentStatesource ↗
createEmptySheetDocumentState(rowCount: number, columnCount: number): SheetDocumentState

Creates an empty Sheet document with matching dimensions for import adapters.

rowCount: number
columnCount: number
functioncreateRichTextRunRectsource ↗
createRichTextRunRect(x: number, baselineY: number, width: number, height: number, fontAscent: number): PositionRect<templateLiteral>

Creates a world-space rectangle for one rich-text line/run.

x: number
baselineY: number
width: number
height: number
fontAscent: number
functioncreateSheetEditorsource ↗
createSheetEditor(options: SheetEditorConfiguration): SheetEditor

Assembles the default sheet editor runtime from platform adapters and state.

The returned editor owns an isolated dependency container, plugin graph, and render lifecycle. Hosts interact with it through commands, queries, observations, and capabilities, and must call destroy() when the session is no longer mounted.

ReturnsA fully initialized Sheet editor facade.

Example
const editor = createSheetEditor({ adapters, sheetState, plugins });
await editor.commands.run(command, input);
editor.destroy();
options: SheetEditorConfiguration

Platform adapters, initial Sheet state, plugins, and runtime configuration.

functiondefineSheetRuntimeCapabilitysource ↗
defineSheetRuntimeCapability<T>(id: string): SheetRuntimeCapability<T>

Defines a typed runtime capability token.

ReturnsImmutable capability descriptor.

id: string

Stable capability id.

functiondeserializeSheetDocumentStatesource ↗
deserializeSheetDocumentState<TSheetState>(payload: unknown, registry?: DocumentStateCodecRegistry<TSheetState>, path?: string): TSheetState

Deserializes one Sheet document state through registered state-owner codecs.

payload: unknown
registry: DocumentStateCodecRegistry<TSheetState>
path: string
functionregisterDefaultDependenciessource ↗
registerDefaultDependencies(container: Container): void

Registers the small common runtime set into an explicit host container.

container: Container
functionregisterDefaultDocFeaturessource ↗
registerDefaultDocFeatures(container: Container, manager: PluginManager<SearCoreDoc, NodeProperties>, implementations: false | readonly DocPluginImplementation<DocPlugin<unknown>>[] | undefined): DocPlugin<unknown>[]

Registers the default document feature plugins selected for one editor instance.

container: Container
manager: PluginManager<SearCoreDoc, NodeProperties>
implementations: false | readonly DocPluginImplementation<DocPlugin<unknown>>[] | undefined
functionregisterDocBaseServicessource ↗
registerDocBaseServices(container: Container, adapters: DocEditorAdapters, _viewport: DocEditorViewport, defaultConfigOverrides?: EditorDefaultConfigOverrides<DocConfig>): DocBaseServices

Registers document editor base services into the DI container.

container: Container
adapters: DocEditorAdapters
_viewport: DocEditorViewport
defaultConfigOverrides: EditorDefaultConfigOverrides<DocConfig>
functionregisterDocConfigCommandssource ↗
registerDocConfigCommands(commands: DocCommandBus, config: ConfigEngine<DocConfig>): void

Registers Doc configuration changes on the owning command bus.

commands: DocCommandBus
config: ConfigEngine<DocConfig>
functionregisterDocDocumentObservationsource ↗
registerDocDocumentObservation(observations: ObservationRegistry, document: DocDocumentSessionCoordinator): void

Registers the document-owned read projection with the editor observation registry.

observations: ObservationRegistry
document: DocDocumentSessionCoordinator
functionregisterDocFeaturePluginssource ↗
registerDocFeaturePlugins(container: Container, manager: PluginManager<SearCoreDoc, NodeProperties>, implementations: readonly DocPluginImplementation<DocPlugin<unknown>>[] | undefined): DocPlugin<unknown>[]

Registers document feature plugin instances with the Core-owned PluginManager.

container: Container
manager: PluginManager<SearCoreDoc, NodeProperties>
implementations: readonly DocPluginImplementation<DocPlugin<unknown>>[] | undefined
functionregisterDocInlineStyleObservationsource ↗
registerDocInlineStyleObservation(observations: ObservationRegistry, input: DocInputPlugin, inlineStyles: RichTextInlineStyleRegistry): void

Registers the selection-derived inline-style state with the editor observation registry.

observations: ObservationRegistry
input: DocInputPlugin
inlineStyles: RichTextInlineStyleRegistry
functionregisterDocRuntimesource ↗
registerDocRuntime(container: Container, adapters: DocEditorAdapters, viewport: DocEditorViewport): DocRuntime

Registers render, input, scroll, command, and plugin runtime services for Doc.

container: Container
adapters: DocEditorAdapters
viewport: DocEditorViewport
functionregisterDocSessionStateCommandssource ↗
registerDocSessionStateCommands(commands: DocCommandBus, session: SessionStateRegistry): void

Registers the in-memory document session capture command.

commands: DocCommandBus
session: SessionStateRegistry
functionregisterDocStateSnapshotCommandssource ↗
registerDocStateSnapshotCommands(commands: DocCommandBus, document: DocDocumentSessionCoordinator): void

Registers the document-owned state snapshot command.

commands: DocCommandBus
document: DocDocumentSessionCoordinator
functionregisterDocViewportCommandssource ↗
registerDocViewportCommands(input: { commands: DocCommandBus; renderCoordinator: DocRenderCoordinator; scrollManager: ScrollManager; viewportEnvironment: DocViewportEnvironment }): void

Registers viewport-owned document commands on the editor command bus.

input: { commands: DocCommandBus; renderCoordinator: DocRenderCoordinator; scrollManager: ScrollManager; viewportEnvironment: DocViewportEnvironment }
functionregisterDocViewportStatesource ↗
registerDocViewportState(session: SessionStateRegistry, observations: ObservationRegistry, scrollManager: ScrollManager): void

Registers viewport remount state and its host-facing observation.

session: SessionStateRegistry
observations: ObservationRegistry
scrollManager: ScrollManager
functionregisterSheetConfigCommandssource ↗
registerSheetConfigCommands(commands: SheetCommandBus, config: ConfigEngine<SheetConfig>): void

Registers Sheet configuration changes on the owning command bus.

commands: SheetCommandBus
config: ConfigEngine<SheetConfig>
functionregisterSheetPluginCapabilitiessource ↗
registerSheetPluginCapabilities(plugins: readonly unknown[], registry: SheetRuntimeExtensionRegistry): void

Publishes every typed runtime capability contributed by Sheet plugins.

plugins: readonly unknown[]
registry: SheetRuntimeExtensionRegistry
functionregisterSheetPluginCellVisualReaderssource ↗
registerSheetPluginCellVisualReaders(plugins: readonly unknown[], registry: SheetCellVisualReaderRegistry, context: SheetCellVisualReaderRegistrationContext): void

Registers every plugin-owned Sheet cell visual reader.

plugins: readonly unknown[]
registry: SheetCellVisualReaderRegistry
context: SheetCellVisualReaderRegistrationContext
functionregisterSheetPluginCommandssource ↗
registerSheetPluginCommands(plugins: readonly unknown[], commands: SheetCommandBus): void

Runs the register sheet plugin commands helper.

plugins: readonly unknown[]
commands: SheetCommandBus
functionregisterSheetPluginObservationssource ↗
registerSheetPluginObservations(plugins: readonly unknown[], observations: ObservationRegistry): void

Registers every typed observation source contributed by Sheet plugins.

plugins: readonly unknown[]
observations: ObservationRegistry
functionregisterSheetPluginQueriessource ↗
registerSheetPluginQueries(plugins: readonly unknown[], queries: SheetQueryRegistry): void
plugins: readonly unknown[]
queries: SheetQueryRegistry
functionregisterSheetPluginSessionStatessource ↗
registerSheetPluginSessionStates(plugins: readonly unknown[], registry: SessionStateRegistry): void

Registers every local session-state adapter contributed by Sheet plugins.

plugins: readonly unknown[]
registry: SessionStateRegistry
functionregisterSheetSessionStateCommandssource ↗
registerSheetSessionStateCommands(commands: SheetCommandBus, session: SessionStateRegistry): void

Registers the in-memory Sheet session capture command.

commands: SheetCommandBus
session: SessionStateRegistry
functionregisterSheetStateSnapshotCommandssource ↗
registerSheetStateSnapshotCommands(commands: SheetCommandBus, pluginManager: PluginManager<SearCoreSheet, CellProperties>): void

Registers sheet state snapshot commands for the default sheet assembly.

commands: SheetCommandBus
pluginManager: PluginManager<SearCoreSheet, CellProperties>
functionregisterSheetViewportCommandssource ↗
registerSheetViewportCommands(commands: SheetCommandBus, scrollManager: ScrollManager, resizeController: SheetViewportResizeController): void

Registers viewport-owned commands on the editor command bus.

commands: SheetCommandBus
scrollManager: ScrollManager
resizeController: SheetViewportResizeController
functionregisterSheetViewportSessionStatesource ↗
registerSheetViewportSessionState(registry: SessionStateRegistry, scrollManager: ScrollManager): void

Registers viewport-owned local remount state with the editor-local registry.

registry: SessionStateRegistry
scrollManager: ScrollManager
functionserializeSheetDocumentStatesource ↗
serializeSheetDocumentState<TSheetState>(sheetState: TSheetState, registry?: DocumentStateCodecRegistry<TSheetState>): SearSheetDocumentFile

Serializes one Sheet document state through registered state-owner codecs.

sheetState: TSheetState
registry: DocumentStateCodecRegistry<TSheetState>
enumBoldTextStyleKeysource ↗
enum BoldTextStyleKey

Persisted style key owned by the bold text-style plugin.

enum memberBold
Bold: "bold"
classBoldTextStylePluginsource ↗
class BoldTextStylePlugin extends InlineTextStylePluginBase

Contributes bold rendering and bold document commands.

constructorconstructor
BoldTextStylePlugin(): BoldTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving BoldTextStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.

variableClearDocCompositionCommandsource ↗
ClearDocCompositionCommand: DocCommandDefinition<void, DocCommandResult>

Clears the active IME composition preview text.

functiondefineDocRuntimeCapabilitysource ↗
defineDocRuntimeCapability<T>(id: string): DocRuntimeCapability<T>

Creates a typed document runtime capability token.

id: string
functiondefineSessionStatesource ↗
defineSessionState<State>(id: string): SessionStateDefinition<State>

Creates an immutable typed identity for one local session value.

id: string
variableDeleteDocBackwardCommandsource ↗
DeleteDocBackwardCommand: DocCommandDefinition<void, DocCommandResult>

Deletes content before the current document selection.

variableDocCaretPluginKeysource ↗
DocCaretPluginKey: PluginKey
variableDocCompositionPluginKeysource ↗
DocCompositionPluginKey: PluginKey
variableDocContentRenderPluginKeysource ↗
DocContentRenderPluginKey: PluginKey

Default document feature plugin keys used by command pipelines.

interfaceDocInteractionRuntimesource ↗
interface DocInteractionRuntime

View services exposed to document interaction plugins.

methodgetContentRect
getContentRect(): DocInteractionContentRect
methodgetRoot
getRoot(): unknown
methodgetViewport
getViewport(): DocInteractionViewport
methodreadRootViewOffset
readRootViewOffset(): { x: number; y: number }
methodresolveCursorFromPointer
resolveCursorFromPointer(input: DocPointerInput): DocCursorPos
input: DocPointerInput
methodsubscribePointerDrag
subscribePointerDrag(handlers: DocPointerDragHandlers): (): void
handlers: DocPointerDragHandlers
classDocPluginsource ↗
class DocPlugin<StateType> extends Plugin<SearCoreDoc, NodeProperties, StateType>, PluginExtension<DocCommandBus, ObservationRegistry, SessionStateRegistry, DocRuntimeExtensionRegistry>

Convenience base class for a Plugin targeting createDocEditor().

constructorconstructor
DocPlugin<StateType>(__namedParameters: PluginSpec<StateType>): DocPlugin<StateType>

Creates a plugin with its stable identity and initial state.

__namedParameters: PluginSpec<StateType>
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodinitialize
initialize(context: DocPluginRuntimeContext): void

Prepares behavior that requires initialized Core state but must run before runtime effects.

context: DocPluginRuntimeContext
methodonEditorDestroy
onEditorDestroy(context: DocPluginRuntimeContext): void

Releases resources owned by this plugin before the Core is destroyed.

context: DocPluginRuntimeContext
methodregisterBlockFlows
registerBlockFlows(registry: RichTextBlockFlowRegistry): void

Registers plugin-owned top-level block flow resolvers.

registry: RichTextBlockFlowRegistry
methodregisterCapabilities
registerCapabilities(registry: DocRuntimeExtensionRegistry): void

Publishes typed runtime services owned by this document plugin.

registry: DocRuntimeExtensionRegistry
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterInlineStyleRenderers
registerInlineStyleRenderers(registry: RichTextRunRenderRegistry): void

Registers plugin-owned render behavior for styled text runs.

registry: RichTextRunRenderRegistry
methodregisterInlineStyles
registerInlineStyles(registry: RichTextInlineStyleRegistry): void

Registers plugin-owned inline text style readers and mutation policies.

registry: RichTextInlineStyleRegistry
methodregisterKeyboardHandlers
registerKeyboardHandlers(context: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

context: DocKeyboardHandlerRegistrationContext
methodregisterLineBoxes
registerLineBoxes(registry: RichTextLineBoxRegistry): void

Registers plugin-owned rich-text line box resolvers.

registry: RichTextLineBoxRegistry
methodregisterObservations
registerObservations(observations: ObservationRegistry): void

Registers typed state and event observations owned by this document plugin.

observations: ObservationRegistry
methodregisterSessionState
registerSessionState(registry: SessionStateRegistry): void

Registers local state that must survive an in-memory editor remount.

registry: SessionStateRegistry
methodstart
start(context: DocPluginRuntimeContext): void

Starts runtime behavior after the first document frame.

context: DocPluginRuntimeContext
methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers bindings required before this Doc plugin is instantiated.

context: DocPluginServiceContext
Inherited members 34

Inherited from Plugin.

interfaceDocPluginImplementationsource ↗
interface DocPluginImplementation<TPlugin>

Injectable DocPlugin class accepted by createDocEditor().

constructorconstructor
DocPluginImplementation(...args: never[]): TPlugin
args: never[]
propertysymbol
readonly symbol: symbol
methodregisterServices
registerServices(context: DocPluginServiceContext): void
context: DocPluginServiceContext
interfaceDocPluginRuntimesource ↗
interface DocPluginRuntime

Stable host capabilities supplied to a DocPlugin after editor assembly.

propertycommands
readonly commands: DocCommandBus

Command bus exposed by the document editor instance.

propertydocument
readonly document: { blockFlows: RichTextBlockFlowRegistry; core: SearCoreDoc; cursor: DocCursorManager; inlineStyles: RichTextInlineStyleRegistry; input: DocInputPlugin; layout: DocLayoutEngine; lineBoxes: RichTextLineBoxRegistry; nodes: DocNodeRegistry }

Rich-document domain services.

propertyevents
readonly events: { engine: EventEngine<NodeProperties>; registrar: EventRegistrar }

Event and hit-test services used by document interactions.

propertyextensions
readonly extensions: DocRuntimeExtensionRegistry

Extension capability registry for third-party document plugins.

propertyinput
readonly input: { keyboard: KeyboardRouter; pointer: PointerCapture; text: TextInput }

Host input adapters used by document editing commands.

propertyobservations
readonly observations: ObservationRegistry

Typed state and event observations owned by this editor instance.

propertyplatform
readonly platform: Platform

Platform adapter for timers, resize observation, and diagnostics.

propertyplugins
readonly plugins: PluginManager<SearCoreDoc, NodeProperties>

Ordered document plugin registry for this editor.

propertyrender
readonly render: { context: RenderContext; engine: DocRenderEngineCapability }

Document render services and visible context.

propertyscroll
readonly scroll: { manager: ScrollManager }

Scroll state shared by document layout and rendering.

propertysession
readonly session: SessionStateRegistry

Local remount state contributed by built-in and third-party plugins.

propertytextShaper
readonly textShaper: TextShaper

Text shaper used by document layout and rendering.

variableDocPluginRuntimeCapabilitysource ↗
DocPluginRuntimeCapability: { CaretState: DocRuntimeCapability<DocCaretStateCapability>; Composition: DocRuntimeCapability<DocCompositionManager>; InputBindings: DocRuntimeCapability<DocInputBindingRegistryCapability>; Interaction: DocRuntimeCapability<DocInteractionRuntime> }

Runtime extension tokens owned by document plugins assembled by editor composition roots.

interfaceDocPluginRuntimeContextsource ↗
interface DocPluginRuntimeContext extends DocPluginSetupContext

Document setup capabilities plus the Core created by createDocEditor().

propertycore
readonly core: SearCoreDoc

Core document runtime.

Inherited members 2

Inherited from DocPluginSetupContext.

interfaceDocPluginServiceContextsource ↗
interface DocPluginServiceContext

Services available while createDocEditor() registers document plugins.

propertycontainer
readonly container: Container

DI container used by the document assembly root.

interfaceDocPluginSetupContextsource ↗
interface DocPluginSetupContext

Typed public services available before createDocEditor() starts Core.

propertycontainer
readonly container: Container

DI container used by the document assembly root.

propertyruntime
readonly runtime: DocPluginRuntime

Runtime services available to document plugins.

variableDocRuntimeCapabilitysource ↗
DocRuntimeCapability: { BlockFlows: DocRuntimeCapability<RichTextBlockFlowRegistry>; Commands: DocRuntimeCapability<DocCommandBus>; Config: DocRuntimeCapability<ConfigEngine<any>>; Document: DocRuntimeCapability<{ blockFlows: RichTextBlockFlowRegistry; core: SearCoreDoc; cursor: DocCursorManager; inlineStyles: RichTextInlineStyleRegistry; input: DocInputPlugin; layout: DocLayoutEngine; lineBoxes: RichTextLineBoxRegistry; nodes: DocNodeRegistry }>; Events: DocRuntimeCapability<{ engine: EventEngine<NodeProperties>; registrar: EventRegistrar }>; InlineStyles: DocRuntimeCapability<RichTextInlineStyleRegistry>; Input: DocRuntimeCapability<{ keyboard: KeyboardRouter; pointer: PointerCapture; text: TextInput }>; LayoutService: DocRuntimeCapability<DocRenderLayoutServiceCapability>; … }

Document runtime capabilities registered by the default assembly root.

typeDocRuntimeCapabilityReadersource ↗
type DocRuntimeCapabilityReader = RuntimeCapabilityReader

Read-only view of editor-local document runtime capabilities exposed to hosts.

variableDocRuntimeCapabilityTokensource ↗
DocRuntimeCapabilityToken: { BlockFlows: DocRuntimeCapability<RichTextBlockFlowRegistry>; Commands: DocRuntimeCapability<DocCommandBus>; Config: DocRuntimeCapability<ConfigEngine<any>>; Document: DocRuntimeCapability<{ blockFlows: RichTextBlockFlowRegistry; core: SearCoreDoc; cursor: DocCursorManager; inlineStyles: RichTextInlineStyleRegistry; input: DocInputPlugin; layout: DocLayoutEngine; lineBoxes: RichTextLineBoxRegistry; nodes: DocNodeRegistry }>; Events: DocRuntimeCapability<{ engine: EventEngine<NodeProperties>; registrar: EventRegistrar }>; InlineStyles: DocRuntimeCapability<RichTextInlineStyleRegistry>; Input: DocRuntimeCapability<{ keyboard: KeyboardRouter; pointer: PointerCapture; text: TextInput }>; LayoutService: DocRuntimeCapability<DocRenderLayoutServiceCapability>; … }

Document runtime capabilities registered by the default assembly root.

classDocRuntimeExtensionRegistrysource ↗
class DocRuntimeExtensionRegistry extends RuntimeCapabilityRegistry

Registry of extension capabilities available to document plugins.

constructorconstructor
DocRuntimeExtensionRegistry(): DocRuntimeExtensionRegistry
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving the document runtime extension registry.

Inherited members 7

Inherited from RuntimeCapabilityRegistry.

interfaceDocVirtualLayoutSummarysource ↗
interface DocVirtualLayoutSummary

Public virtual layout summary exposed through the Doc layout-service capability.

propertyblockRender
readonly blockRender?: DocBlockRenderDebugSnapshot
propertycacheHits
readonly cacheHits: number
propertycacheMisses
readonly cacheMisses: number
propertycursorBlock
readonly cursorBlock: number | null
propertydocumentHeight
readonly documentHeight: number
propertyheightIndexUpdated
readonly heightIndexUpdated: boolean
propertyinitialLoadMs
readonly initialLoadMs?: number
propertymaterializedBlocks
readonly materializedBlocks: number
propertymaterializedIndexes
readonly materializedIndexes: string
propertymodel
readonly model: "reused" | "rebuilt"
propertyrangeEnd
readonly rangeEnd: number
propertyrangeStart
readonly rangeStart: number
propertyrenderPhase
readonly renderPhase?: DocVirtualLayoutRenderPhase
propertytimings
readonly timings: DocVirtualLayoutTimingSummary
propertytotalBlocks
readonly totalBlocks: number
variableFocusDocCommandsource ↗
FocusDocCommand: DocCommandDefinition<void, DocCommandResult>

Focuses the host text-input adapter for the document editor.

enumFontFamilyTextStyleKeysource ↗
enum FontFamilyTextStyleKey

Persisted style key owned by the font-family text-style plugin.

enum memberFontFamily
FontFamily: "fontFamily"
classFontFamilyTextStylePluginsource ↗
class FontFamilyTextStylePlugin extends InlineTextStylePluginBase

Contributes font-family rendering and the set-font-family document command.

constructorconstructor
FontFamilyTextStylePlugin(): FontFamilyTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving FontFamilyTextStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
Inherited members 47

Inherited from InlineTextStylePluginBase.

enumFontSizeTextStyleKeysource ↗
enum FontSizeTextStyleKey

Persisted style key owned by the font-size text-style plugin.

enum memberFontSize
FontSize: "fontSize"
classFontSizeTextStylePluginsource ↗
class FontSizeTextStylePlugin extends InlineTextStylePluginBase

Contributes font-size rendering and the set-font-size document command.

constructorconstructor
FontSizeTextStylePlugin(): FontSizeTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving FontSizeTextStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
Inherited members 47

Inherited from InlineTextStylePluginBase.

variableInsertDocTableCommandsource ↗
InsertDocTableCommand: DocCommandDefinition<InsertDocTableInput, DocCommandResult>

Inserts a table block at the current document position.

interfaceInsertDocTableInputsource ↗
interface InsertDocTableInput

Input accepted by InsertDocTableCommand.

propertycolumns
readonly columns: number

Number of columns in the inserted table.

propertyrows
readonly rows: number

Number of rows in the inserted table.

variableInsertDocTextCommandsource ↗
InsertDocTextCommand: DocCommandDefinition<InsertDocTextInput, DocCommandResult>

Inserts text at the current document selection.

interfaceInsertDocTextInputsource ↗
interface InsertDocTextInput

Input accepted by InsertDocTextCommand.

propertytext
readonly text: string

Text to insert at the current document selection.

enumItalicTextStyleKeysource ↗
enum ItalicTextStyleKey
enum memberItalic
Italic: "italic"
classItalicTextStylePluginsource ↗
class ItalicTextStylePlugin extends InlineTextStylePluginBase

Contributes italic rendering, mutation, and keyboard commands.

constructorconstructor
ItalicTextStylePlugin(): ItalicTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.

variableLoadDocumentCommandsource ↗
LoadDocumentCommand: DocCommandDefinition<LoadDocumentInput, DocCommandResult>

Replaces the active document content.

interfaceLoadDocumentInputsource ↗
interface LoadDocumentInput

Input accepted by LoadDocumentCommand.

propertydocument
readonly document: RichDocNode[]

Rich-document content to load into the document editor.

variableMoveDocCursorCommandsource ↗
MoveDocCursorCommand: DocCommandDefinition<MoveDocCursorInput, DocCommandResult>

Moves the current document cursor.

interfaceMoveDocCursorInputsource ↗
interface MoveDocCursorInput

Input accepted by MoveDocCursorCommand.

propertydirection
readonly direction: DocCursorDirection

Direction for cursor movement.

propertyshiftKey
readonly shiftKey?: boolean

Whether the movement should extend the current selection.

classParagraphPluginsource ↗
class ParagraphPlugin extends DocPlugin<null>

Registers paragraph and text node model support plus block-level commands.

constructorconstructor
ParagraphPlugin(): ParagraphPlugin

Creates a ParagraphPlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving ParagraphPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterBlockFlows
registerBlockFlows(registry: RichTextBlockFlowRegistry): void

Registers plugin-owned top-level block flow resolvers.

registry: RichTextBlockFlowRegistry
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
methodregisterLineBoxes
registerLineBoxes(registry: RichTextLineBoxRegistry): void

Registers plugin-owned rich-text line box resolvers.

registry: RichTextLineBoxRegistry
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers paragraph node model support owned by this plugin.

context: DocPluginServiceContext
Inherited members 37

Inherited from DocPlugin.

functionreadSessionStatesource ↗
readSessionState<State>(snapshot: SessionStateSnapshot, definition: SessionStateDefinition<State>): State | undefined

Reads one contributor value from an opaque snapshot through its typed definition.

snapshot: SessionStateSnapshot
definition: SessionStateDefinition<State>
functionregisterDocPluginCapabilitiessource ↗
registerDocPluginCapabilities(plugins: readonly unknown[], registry: DocRuntimeExtensionRegistry): void

Publishes every typed runtime capability contributed by document plugins.

plugins: readonly unknown[]
registry: DocRuntimeExtensionRegistry
functionregisterDocPluginCommandssource ↗
registerDocPluginCommands(plugins: readonly unknown[], commands: DocCommandBus): (): void

Runs the register document plugin commands helper.

plugins: readonly unknown[]
commands: DocCommandBus
functionregisterDocPluginInlineStylessource ↗
registerDocPluginInlineStyles(plugins: readonly unknown[], registry: RichTextInlineStyleRegistry): (): void

Registers every inline text-style contribution owned by document plugins.

plugins: readonly unknown[]
registry: RichTextInlineStyleRegistry
functionregisterDocPluginLineBoxessource ↗
registerDocPluginLineBoxes(plugins: readonly unknown[], registry: RichTextLineBoxRegistry): (): void

Registers every rich-text line box contribution owned by document plugins.

plugins: readonly unknown[]
registry: RichTextLineBoxRegistry
functionregisterDocPluginObservationssource ↗
registerDocPluginObservations(plugins: readonly unknown[], observations: ObservationRegistry): void

Registers every typed observation source contributed by document plugins.

plugins: readonly unknown[]
observations: ObservationRegistry
functionregisterDocPluginSessionStatessource ↗
registerDocPluginSessionStates(plugins: readonly unknown[], registry: SessionStateRegistry): void

Registers every local session-state adapter contributed by document plugins.

plugins: readonly unknown[]
registry: SessionStateRegistry
variableRenderDocCommandsource ↗
RenderDocCommand: DocCommandDefinition<void, DocCommandResult>

Requests a document render without changing content.

typeRichTextInlineStylesource ↗
type RichTextInlineStyle = Readonly<Record<string, unknown>>

Domain-neutral inline style bag carried by measured rich-text chars.

classRichTextLineBoxPluginsource ↗
class RichTextLineBoxPlugin extends DocPlugin<null>

Registers rich-text line box resolution for document layout.

constructorconstructor
RichTextLineBoxPlugin(): RichTextLineBoxPlugin
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving RichTextLineBoxPlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodregisterLineBoxes
registerLineBoxes(registry: RichTextLineBoxRegistry): void

Registers plugin-owned rich-text line box resolvers.

registry: RichTextLineBoxRegistry
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

Inherited members 43

Inherited from DocPlugin.

variableSelectAllDocCommandsource ↗
SelectAllDocCommand: DocCommandDefinition<void, DocCommandResult>

Selects all document content.

interfaceSessionStateAdaptersource ↗
interface SessionStateAdapter<State>

Captures and restores one detached local session value.

propertyrestoreAfter
readonly restoreAfter?: readonly SessionStateDefinition<unknown>[]

Contributors in the same phase that must restore before this one when they are registered.

propertyrestorePhase
readonly restorePhase: SessionStateRestorePhase

Lifecycle phase in which restore() may safely update the owning feature.

methodcapture
capture(): State | undefined

Returns plain data or a supported built-in value; custom class instances are not session snapshots.

methodrestore
restore(state: State): void

Restores local state during the declared lifecycle phase.

state: State
interfaceSessionStateDefinitionsource ↗
interface SessionStateDefinition<State>

Typed identity owned and exported by one local-state contributor.

propertyid
readonly id: string

Stable, globally unique id used in the in-memory session snapshot.

propertystateType
readonly stateType?: State

Compile-time state carrier; never populated at runtime.

classSessionStateErrorsource ↗
class SessionStateError extends SearError

Error raised when a session-state contributor violates its registry contract.

constructorconstructor
SessionStateError(code: SessionStateErrorCode, message: string, details?: SearErrorDetails): SessionStateError

Creates a session-state contract error.

code: SessionStateErrorCode
message: string
details: SearErrorDetails
propertycode
readonly code: SessionStateErrorCode

Stable machine-readable error code.

Inherited members 9

Inherited from SearError.

variableSessionStateErrorCodesource ↗
SessionStateErrorCode: { invalidDefinition: "SEAR_SESSION_STATE_INVALID_DEFINITION"; invalidRestoreDependency: "SEAR_SESSION_STATE_INVALID_RESTORE_DEPENDENCY"; invalidRestoreOrder: "SEAR_SESSION_STATE_INVALID_RESTORE_ORDER"; invalidRestorePhase: "SEAR_SESSION_STATE_INVALID_RESTORE_PHASE"; registrationConflict: "SEAR_SESSION_STATE_REGISTRATION_CONFLICT"; restoreDependencyCycle: "SEAR_SESSION_STATE_RESTORE_DEPENDENCY_CYCLE"; restoreInProgress: "SEAR_SESSION_STATE_RESTORE_IN_PROGRESS"; restorePhaseClosed: "SEAR_SESSION_STATE_RESTORE_PHASE_CLOSED"; … }

Stable machine-readable errors raised by session-state contracts.

classSessionStateRegistrysource ↗
class SessionStateRegistry

Editor-local coordinator for all built-in and plugin-contributed session state.

constructorconstructor
SessionStateRegistry(): SessionStateRegistry
propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving the editor-local registry.

methodassertRestorationOpen
assertRestorationOpen(): void

Rejects a retained contributor restore callback after editor initialization.

methodcapture
capture(): SessionStateSnapshot

Captures every registered contributor while preserving state whose owner is not loaded.

methodclear
clear(lifecycleToken?: object): void

Clears contributors and retained state owned by this registry instance.

lifecycleToken: object
methodgetCompletedRestorePhases
getCompletedRestorePhases(): readonly SessionStateRestorePhase[]

Returns restore phases already completed by this editor lifecycle.

methodgetRegisteredStateIds
getRegisteredStateIds(): readonly string[]

Returns sorted ids for currently registered contributors.

methodloadSnapshot
loadSnapshot(snapshot: SessionStateSnapshot): void

Loads a complete snapshot before lifecycle restoration begins.

snapshot: SessionStateSnapshot
methodregister
register<State>(definition: SessionStateDefinition<State>, adapter: SessionStateAdapter<State>): (): void

Registers one state owner and returns an idempotent disposer.

definition: SessionStateDefinition<State>
adapter: SessionStateAdapter<State>
methodrestorePhase
restorePhase(phase: SessionStateRestorePhase): void

Restores every registered contributor assigned to one ordered lifecycle phase.

phase: SessionStateRestorePhase
methodsealRestoration
sealRestoration(lifecycleToken: object): void

Closes initialization-only restore operations for an assembled editor.

lifecycleToken: object
variableSessionStateRestorePhasesource ↗
SessionStateRestorePhase: { AfterInitialize: "afterInitialize"; BeforeInitialize: "beforeInitialize" }

Ordered lifecycle phases in which local state may be restored.

typeSessionStateSnapshotsource ↗
type SessionStateSnapshot = Readonly<Record<string, unknown>>

Opaque in-memory snapshot keyed by contributor-owned definition ids.

variableSetDocBoldCommandsource ↗
SetDocBoldCommand: DocCommandDefinition<SetDocBoldInput, DocCommandResult>

Sets whether the selected document text is bold.

interfaceSetDocBoldInputsource ↗
interface SetDocBoldInput

Input accepted by SetDocBoldCommand. A null or false value clears bold.

propertybold
readonly bold: boolean | null
variableSetDocCompositionCommandsource ↗
SetDocCompositionCommand: DocCommandDefinition<SetDocCompositionInput, DocCommandResult>

Sets the active IME composition preview text.

interfaceSetDocCompositionInputsource ↗
interface SetDocCompositionInput

Input accepted by SetDocCompositionCommand.

propertycaretOffset
readonly caretOffset: number

Caret offset inside the composing text.

propertytext
readonly text: string

Current composing text emitted by the host input method.

variableSetDocFontFamilyCommandsource ↗
SetDocFontFamilyCommand: DocCommandDefinition<SetDocFontFamilyInput, DocCommandResult>

Sets the font family on the selected document text.

interfaceSetDocFontFamilyInputsource ↗
interface SetDocFontFamilyInput

Input accepted by SetDocFontFamilyCommand. A null or empty value clears the font family.

propertyfontFamily
readonly fontFamily: string | null
variableSetDocFontSizeCommandsource ↗
SetDocFontSizeCommand: DocCommandDefinition<SetDocFontSizeInput, DocCommandResult>

Sets the font size in pixels on the selected document text.

interfaceSetDocFontSizeInputsource ↗
interface SetDocFontSizeInput

Input accepted by SetDocFontSizeCommand. A null or empty value clears the font size.

propertyfontSize
readonly fontSize: number | null
variableSetDocItalicCommandsource ↗
SetDocItalicCommand: DocCommandDefinition<SetDocItalicInput, DocCommandResult>
interfaceSetDocItalicInputsource ↗
interface SetDocItalicInput
propertyitalic
readonly italic: boolean | null
variableSetDocSelectionCommandsource ↗
SetDocSelectionCommand: DocCommandDefinition<SetDocSelectionInput, DocCommandResult>

Sets the active document selection without changing content.

interfaceSetDocSelectionInputsource ↗
interface SetDocSelectionInput

Input accepted by SetDocSelectionCommand.

propertyselection
readonly selection: DocSelection

Selection to make active in the document editor.

variableSetDocStrikethroughCommandsource ↗
SetDocStrikethroughCommand: DocCommandDefinition<SetDocStrikethroughInput, DocCommandResult>
interfaceSetDocStrikethroughInputsource ↗
interface SetDocStrikethroughInput
propertystrikethrough
readonly strikethrough: boolean | null
variableSetDocTextColorCommandsource ↗
SetDocTextColorCommand: DocCommandDefinition<SetDocTextColorInput, DocCommandResult>

Sets the text color on the selected document text.

interfaceSetDocTextColorInputsource ↗
interface SetDocTextColorInput

Input accepted by SetDocTextColorCommand. A null or empty value clears the text color.

propertycolor
readonly color: string | null
variableSetDocUnderlineCommandsource ↗
SetDocUnderlineCommand: DocCommandDefinition<SetDocUnderlineInput, DocCommandResult>
interfaceSetDocUnderlineInputsource ↗
interface SetDocUnderlineInput
propertyunderline
readonly underline: boolean | null
variableSplitDocParagraphCommandsource ↗
SplitDocParagraphCommand: DocCommandDefinition<void, DocCommandResult>

Splits the current paragraph at the current document selection.

enumStrikethroughTextStyleKeysource ↗
enum StrikethroughTextStyleKey
enum memberStrikethrough
Strikethrough: "strikethrough"
classStrikethroughTextStylePluginsource ↗
class StrikethroughTextStylePlugin extends InlineTextStylePluginBase

Contributes strikethrough rendering, mutation, and keyboard commands.

constructorconstructor
StrikethroughTextStylePlugin(): StrikethroughTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.

classTablePluginsource ↗
class TablePlugin extends DocPlugin<null>

Contributes table model and insertion command without adding table knowledge to Core.

constructorconstructor
TablePlugin(): TablePlugin

Creates a TablePlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving TablePlugin.

methodapply
apply(_state: null, _transaction: unknown): null

Applies a transaction to plugin-owned state and returns the next state.

_state: null
_transaction: unknown
methodconfigure
configure(context: DocPluginSetupContext): void

Configures the document editor before runtime start.

context: DocPluginSetupContext
methodgetPluginConfig
getPluginConfig(): null

Returns this plugin's runtime configuration view for the current core.

methodonEditorDestroy
onEditorDestroy(): void

Releases resources owned by this plugin before the Core is destroyed.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterState
registerState(): { key: PluginKey; state: null }

Registers one or more plugin-owned state records with the host manager.

methodrender
render(): Node<NodeProperties>[] | null

Produces scene nodes owned by this plugin for the current core state.

methodregisterServicesstatic
registerServices(context: DocPluginServiceContext): void

Registers table node model support owned by this plugin.

context: DocPluginServiceContext
Inherited members 40

Inherited from DocPlugin.

enumTextColorStyleKeysource ↗
enum TextColorStyleKey

Persisted style key owned by the text-color style plugin.

enum memberColor
Color: "color"
classTextColorStylePluginsource ↗
class TextColorStylePlugin extends InlineTextStylePluginBase

Contributes text-color rendering and mutation for text nodes.

constructorconstructor
TextColorStylePlugin(): TextColorStylePlugin

Creates a TextColorStylePlugin instance.

propertysymbolstatic
readonly symbol: typeof symbol

DI token for resolving TextColorStylePlugin.

methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
Inherited members 47

Inherited from InlineTextStylePluginBase.

variableToggleDocBoldCommandsource ↗
ToggleDocBoldCommand: DocCommandDefinition<void, DocCommandResult>

Toggles bold on the selected document text.

variableToggleDocItalicCommandsource ↗
ToggleDocItalicCommand: DocCommandDefinition<void, DocCommandResult>
variableToggleDocStrikethroughCommandsource ↗
ToggleDocStrikethroughCommand: DocCommandDefinition<void, DocCommandResult>
variableToggleDocUnderlineCommandsource ↗
ToggleDocUnderlineCommand: DocCommandDefinition<void, DocCommandResult>
enumUnderlineTextStyleKeysource ↗
enum UnderlineTextStyleKey
enum memberUnderline
Underline: "underline"
classUnderlineTextStylePluginsource ↗
class UnderlineTextStylePlugin extends InlineTextStylePluginBase

Contributes underline rendering, mutation, and keyboard commands.

constructorconstructor
UnderlineTextStylePlugin(): UnderlineTextStylePlugin
propertysymbolstatic
readonly symbol: typeof symbol
methodregisterCommands
registerCommands(commands: DocCommandBus): void

Registers every stable command id owned by this document plugin.

commands: DocCommandBus
methodregisterKeyboardHandlers
registerKeyboardHandlers(__namedParameters: DocKeyboardHandlerRegistrationContext): void

Registers keyboard-to-command bindings owned by this document plugin.

__namedParameters: DocKeyboardHandlerRegistrationContext
Inherited members 46

Inherited from InlineTextStylePluginBase.