Class CompletionProviderManager

constructor

• new CompletionProviderManager(): CompletionProviderManager

• Construct a new completer manager.

  Returns CompletionProviderManager

Optionalinline

activeProvidersChanged

• get activeProvidersChanged(): ISignal<ICompletionProviderManager, void>

• Signal emitted when active providers list is changed.

  Returns ISignal<ICompletionProviderManager, void>

inlineProviders

• get inlineProviders(): IInlineCompletionProviderInfo[]

• Inline providers information.

  Returns IInlineCompletionProviderInfo[]

selected

• get selected(): ISignal<ICompletionProviderManager, ICompleterSelection>

• Signal emitted when a selection is made from a completer menu.

  Returns ISignal<ICompletionProviderManager, ICompleterSelection>

activateProvider

• activateProvider(providerIds: string[]): void

• Activate the providers by id, the list of ids is populated from user setting. The non-existing providers will be discarded.

  Parameters

  • providerIds: string[]

    Array of strings with ids of provider

  Returns void

getProviders

• getProviders(): Map<string, ICompletionProvider<ICompletionItem>>

• Return the map of providers.

  Returns Map<string, ICompletionProvider<ICompletionItem>>

invoke

• invoke(id: string): void

• Invoke the completer in the widget with provided id.

  Parameters

  • id: string

    the id of notebook panel, console panel or code editor.

  Returns void

registerInlineProvider

• registerInlineProvider(
      provider: IInlineCompletionProvider<IInlineCompletionItem>,
  ): void

• Register an inline completer provider with the manager.

  Parameters

  • provider: IInlineCompletionProvider<IInlineCompletionItem>

  Returns void

registerProvider

• registerProvider(provider: ICompletionProvider<ICompletionItem>): void

• Register a completer provider with the manager.

  Parameters

  • provider: ICompletionProvider<ICompletionItem>

    the provider to be registered.

  Returns void

select

• select(id: string): void

• Activate select command in the widget with provided id.

  Parameters

  • id: string

    the id of notebook panel, console panel or code editor.

  Returns void

setContinuousHinting

• setContinuousHinting(value: boolean): void

• Enable/disable continuous hinting mode.

  Parameters

  • value: boolean

  Returns void

setInlineCompleterFactory

• setInlineCompleterFactory(factory: IInlineCompleterFactory): void

• Set inline completer factory.

  Parameters

  • factory: IInlineCompleterFactory

  Returns void

setShowDocumentationPanel

• setShowDocumentationPanel(showDoc: boolean): void

• Enable/disable the document panel.

  Parameters

  • showDoc: boolean

  Returns void

setSuppressIfInlineCompleterActive

• setSuppressIfInlineCompleterActive(suppress: boolean): void

• Whether to suppress the tab completer when inline completions are presented.

  Parameters

  • suppress: boolean

  Returns void

setTimeout

• setTimeout(timeout: number): void

• Set provider timeout.

  Parameters

  • timeout: number

    value of timeout in millisecond.

  Returns void

updateCompleter

• updateCompleter(newCompleterContext: ICompletionContext): Promise<void>

• Create or update completer handler of a widget with new context.

  Parameters

  • newCompleterContext: ICompletionContext

    The completion context.

  Returns Promise<void>