Class CellSearchProvider

Search provider for cells.

Hierarchy (view full)




_stateChanged: Signal<IBaseSearchProvider, void>
currentIndex: null | number

Current match index

filters: undefined | IFilters

Current search filters

query: null | RegExp

Current search query


  • get currentMatchIndex(): null | number
  • Current match index

    Returns null | number

  • get isActive(): boolean
  • Whether the cell search is active.

    This is used when applying search only on selected cells.

    Returns boolean

  • get isDisposed(): boolean
  • Whether the search provider is disposed or not.

    Returns boolean

  • get matchesCount(): number
  • Number of matches in the cell.

    Returns number


  • Replace the currently selected match with the provided text.

    If no match is selected, it won't do anything.

    The caller of this method is expected to call highlightNext if after calling replaceCurrentMatch() attribute this.currentIndex is null. It is necessary to let the caller handle highlighting because this method is used in composition pattern (search engine of notebook cells) and highlighting on the composer (notebook) level needs to switch to next engine (cell) with matches.


    • newText: string

      The replacement text.

    • Optional loop: boolean
    • Optional options: IReplaceOptions

    Returns Promise<boolean>

    Whether a replace occurred.

  • Set whether user selection should be protected from modifications.

    If disabled, the selection will be updated on search and on editor focus to cover the current match. We need to protect selection from modifications for both: search in text and search in cells; since setSearchSelection is only telling us about search in text, we need to have an additional way to signal that either search in text or in cells is active, or for any other reason selection range should be protected.


    • v: boolean

    Returns void

  • Initialize the search using the provided options. Should update the UI to highlight all matches and "select" the first match.


    • query: null | RegExp

      A RegExp to be use to perform the search

    • Optional filters: IFilters

      Filter parameters to pass to provider

    Returns Promise<void>