@squareys/webdecks-sdk - v0.0.0
    Preparing search index...

    Class FindSession

    A headless find/replace session over the workbook's active sheet. Created by Spreadsheet.find. Navigation moves the workbook's selection to each match; replace edits the matching text cells and recomputes. The session is stateful in the engine — one is live at a time, so re-query with FindSession.refresh rather than juggling several.

    Index
    • get matchCount(): number

      The number of matches for the current query.

      Returns number

    • get currentIndex(): number

      The index of the highlighted match, or -1 when there is none.

      Returns number

    • Move to the next match (wrapping), selecting its cell; returns whether one was found.

      Returns boolean

    • Move to the previous match (wrapping), selecting its cell; returns whether one was found.

      Returns boolean

    • Replace the current match with replacement then advance; returns whether a cell changed.

      Parameters

      • replacement: string

      Returns boolean

    • Replace every matching text cell with replacement; returns the number of cells changed.

      Parameters

      • replacement: string

      Returns number

    • Re-run the search with a new query and/or flags; returns the match count.

      Parameters

      • query: string
      • flags: number = 0

      Returns number