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

    Interface IReferenceInputHandle

    A caret-owning input that participates in reference (point) mode — grid-react's generic IInputHandle plus the reference-specific caret ops that only make sense over a spreadsheet. Implemented by the cell formula editor and (later) standalone reference inputs (a chart series / dialog range field). Kept in @sheetxl/react so grid-react stays spreadsheet-agnostic.

    interface IReferenceInputHandle {
        focus(): void;
        insertText(text: string): void;
        selectAll(): void;
        setSelection(selection: EditorTextSelection): void;
        toggleReferences(): void;
    }

    Hierarchy

    • IInputHandle
      • IReferenceInputHandle
    Index
    • Focus this input (used by toggleEditorFocus to move the edit between inputs).

      Returns void

    • Insert text at the caret (replacing any selection); the caret ends up after it.

      Parameters

      • text: string

      Returns void

    • Select all of the input's text.

      Returns void

    • Place this input's caret / selection. The host-facing counterpart of the read-side caret ops: caret position is a view concern (each input owns its own), so a host that needs one parked somewhere — e.g. after the reference just picked — asks the input rather than the edit carrying a caret of its own.

      Parameters

      • selection: EditorTextSelection

      Returns void

    • F4 — cycle $ (relative ⇄ absolute) on the reference under this input's caret. No-op off a reference.

      Returns void