SearSuite
← All packages

@searsuite/sear-plugin-zoom

Editor-local zoom state, commands, observations, and render integration.

classSheetZoomPlugin
class SheetZoomPlugin extends Plugin<SearCoreSheet, CellProperties, Record<string, never>>

Local-only Excel-style sheet view zoom. It never changes document data or OT state.

constructorSheetZoomPlugin(keyboardRouter: KeyboardRouter, commands?: SheetCommandBus, platform?: Platform): SheetZoomPlugin
propertyreadonly pluginKey: PluginKeystatic

Stable plugin key for SheetZoomPlugin.

propertyreadonly symbol: typeof symbolstatic

DI token for resolving SheetZoomPlugin.

methodapply(state: Record<string, never>, _transaction: Transaction): Record<string, never>

Applies a transaction to SheetZoomPlugin state.

methodgetPluginConfig(): unknown

Returns the plugin config.

methodgetScale(): number

Returns the scale.

methodregisterCommands(commands: SheetCommandBus): void

Registers the commands.

methodregisterConfig(): { config: ConfigUnit<{ maxScale: number; minScale: number; step: number }>; key: PluginKey }[]

Registers default configuration values owned by this plugin.

methodregisterSessionState(registry: SessionStateRegistry): void

Registers local view scale after Core initialization makes zoom effects available.

methodregisterState(): { key: PluginKey; state: Record<string, never> }

Registers the state.

methodrender(core: SearCoreSheet): Node<CellProperties>[]

Renders SheetZoomPlugin scene output.

methodsetScale(nextScale: number): void

Updates the scale.

Inherited members 28

Inherited from Plugin.

variableSetSheetZoomCommand
SetSheetZoomCommand: SheetCommandDefinition<number, SheetCommandResult>

Command that updates local sheet view zoom; input is the next zoom scale.

variableSheetZoomSessionStateDefinition
SheetZoomSessionStateDefinition: SessionStateDefinition<number>

Stable session-state identity owned by SheetZoomPlugin.