← All packages

API reference

@searsuite/sear-plugin-clear-style

Owner-composed Sheet format clearing without content deletion.

3 exportsderived from source

classSheetClearStylePluginsource ↗
class SheetClearStylePlugin extends Plugin<unknown, CellProperties, null>

Composes owner-defined format clearing; owns no persisted document or session state.

constructorconstructor
SheetClearStylePlugin(options: SheetClearStyleOptions): SheetClearStylePlugin
options: SheetClearStyleOptions
propertywarnOnDuplicateDepth
readonly warnOnDuplicateDepth: false

Whether PluginManager should warn when another ordered plugin shares this depth.

propertysymbolstatic
readonly symbol: typeof symbol
methodapply
apply(): null

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

methodgetPluginConfig
getPluginConfig(): null

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

methodregisterCommands
registerCommands(commands: SheetCommandBus): void
commands: SheetCommandBus
methodregisterState
registerState(): { dataEngine: { enabled: boolean }; key: PluginKey; state: null }

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

methodrender
render(): null

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

Inherited members 29

Inherited from Plugin.

interfaceSheetClearStyleOptionssource ↗
interface SheetClearStyleOptions

Editor-local dependencies provided by the owning composition root.

propertyformats
readonly formats: SheetFormatTransferRegistry
propertyreadShape
readonly readShape: (): readonly [number, number]
variableClearRangeStylesCommandsource ↗
ClearRangeStylesCommand: SheetCommandDefinition<ClearRangeStylesInput, SheetCommandResult>

Clears explicit formatting from one or more selections, preserving cell data.