SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ContributeSheetCommandsOptions

    interface ContributeSheetCommandsOptions {
        activateTaskPane?: (
            key: string,
            options?: ActivateFrameOptions<any>,
        ) => void;
        editModeHandler?: EditModeHandler;
        globalClipboard?: GlobalClipboardLike;
        manager?: UndoManager;
        notifier?: IReactNotifier;
        pickerMemory?: PickerMemory;
        taskPaneArea?: ITaskPaneArea;
        viewport?: IViewport;
    }

    Hierarchy (View Summary)

    Index
    activateTaskPane?: (key: string, options?: ActivateFrameOptions<any>) => void

    Activate a task pane by key (e.g. dataValidationDetails). Threaded from the bridge's useTaskPaneArea() — sheet commands that open a side pane (data validation, table details) can't reach the task-pane area themselves (it lives deeper in the tree). No-op if omitted.

    editModeHandler?: EditModeHandler

    Edit-mode handler — insert-cells reads the copy/cut mode; image clears it. From useEditMode().

    globalClipboard?: GlobalClipboardLike

    Global clipboard — insert-cells reads a copied range reference to "insert copied cells".

    manager?: UndoManager

    Undo manager the sheet records into — enables F4 / redo-as-repeat (see the transactional middleware).

    notifier?: IReactNotifier

    Busy + error UI for the transactional middleware.

    pickerMemory?: PickerMemory

    Persistent last-used values for the style pickers (color quick swatch + border) + memory. From the bridge's usePersistentState.

    taskPaneArea?: ITaskPaneArea

    The read side of the same task-pane area activateTaskPane writes to — which pane is showing, plus the subscription that says when that changed. A command whose state is "my pane is the one on screen" (editTable) needs both; opening one only needs the writer above. Threaded from the bridge's useTaskPaneArea(); omitted ⇒ those commands carry no state.

    viewport?: IViewport

    The sheet's scroll controller — the cell area's client size, which Zoom to Selection fits the selection into. The model has no viewport size, so it cannot do this itself. Omitted ⇒ the command is a no-op (a bare grid).