NotebookSearchProvider | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• SearchProvider<NotebookPanel>
  • NotebookSearchProvider

Index

Constructors

constructor

• new NotebookSearchProvider(
  widget: NotebookPanel,
  translator?: ITranslator,
  ): NotebookSearchProvider

• Returns NotebookSearchProvider

Properties

Protected_filtersChanged

Protected_stateChanged

ProtecteddelayedActiveCellChangeHandlerReady

delayedActiveCellChangeHandlerReady: Promise<void>

Protectedtranslator

Protectedwidget

Accessors

currentMatchIndex

• get currentMatchIndex(): null | number

• Returns null | number

filtersChanged

• get filtersChanged(): ISignal<this, void>

• Returns ISignal<this, void>

isDisposed

• get isDisposed(): boolean

• Returns boolean

isReadOnly

• get isReadOnly(): boolean

• Returns boolean

matchesCount

• get matchesCount(): null | number

• Returns null | number

replaceOptionsSupport

• get replaceOptionsSupport(): IReplaceOptionsSupport

• Returns IReplaceOptionsSupport

stateChanged

• get stateChanged(): ISignal<this, void>

• Returns ISignal<this, void>

Methods

clearHighlight

• clearHighlight(): Promise<void>

• Returns Promise<void>

dispose

• dispose(): void

• Returns void

endQuery

• endQuery(): Promise<void>

• Returns Promise<void>

getFilters

• getFilters(): { [key: string]: IFilter }

• Returns { [key: string]: IFilter }

The filters.

getInitialQuery

• getInitialQuery(): string

• Returns string

Initial value used to populate the search box.

getSelectionState

• getSelectionState(): SelectionState

• Returns SelectionState

highlightNext

• highlightNext(
  loop?: boolean,
  options?: IHighlightAdjacentMatchOptions,
  ): Promise<undefined | ISearchMatch>

• Returns Promise<undefined | ISearchMatch>

The next match if available.

highlightPrevious

• highlightPrevious(
  loop?: boolean,
  options?: IHighlightAdjacentMatchOptions,
  ): Promise<undefined | ISearchMatch>

• Returns Promise<undefined | ISearchMatch>

The previous match if available.

replaceAllMatches

• replaceAllMatches(newText: string, options?: IReplaceOptions): Promise<boolean>

• Returns Promise<boolean>

A promise that resolves with a boolean indicating whether a replace occurred.

replaceCurrentMatch

• replaceCurrentMatch(
  newText: string,
  loop?: boolean,
  options?: IReplaceOptions,
  ): Promise<boolean>

• Parameters

  • newText: string
  • loop: boolean = true
  • Optionaloptions: IReplaceOptions

Returns Promise<boolean>

A promise that resolves with a boolean indicating whether a replace occurred.

startQuery

• startQuery(query: RegExp, filters: undefined | IFilters): Promise<void>

• Returns Promise<void>

validateFilter

• validateFilter(name: string, value: boolean): Promise<boolean>

• Parameters

  • name: string
  • value: boolean

Returns Promise<boolean>

StaticcreateNew

• createNew(widget: NotebookPanel, translator?: ITranslator): ISearchProvider

• Returns ISearchProvider

The search provider on the notebook panel

StaticisApplicable

• isApplicable(domain: Widget): domain is NotebookPanel

• Returns domain is NotebookPanel

Search ability

StaticpreserveCase

• preserveCase(oldText: string, newText: string): string

• Parameters

  • oldText: string
  • newText: string

Returns string