Private
_completionPrivate
_currentPrivate
_cursorPrivate
_isPrivate
_orderedPrivate
_originalPrivate
_processedThe weak map between a processed completion item with the original item. It's used to keep track of original completion item in case of displaying the completer with query.
Private
_queryPrivate
_queryPrivate
_resolvingA counter to cancel ongoing resolveItem
call.
Private
_statePrivate
_subsetPrivate
_typeProtected
processedThe current text change details.
The current text state details.
The cursor details that the API has used to return matching options.
The cursor details that the API has used to return matching options.
Get whether the model is disposed.
The original completion request details.
The original completer request details.
The query against which items are filtered.
The query against which items are filtered.
A signal emitted when query string changes (at invocation, or as user types).
A flag that is true when the model value was modified by a subset match.
A flag that is true when the model value was modified by a subset match.
Private
_escapeEscape item label, storing the original label and adding insertText
if needed.
If escaping changes label creates a new item unless inplace
is true.
Private
_markupCheck if CompletionItem matches against query. Highlight matching prefix by adding tags.
Private
_resetPrivate
_resolveLazy load missing data of a completion item.
the item to be resolved
See resolveItem
method
The list of visible items in the completer menu.
This is a read-only property.
When overriding it is recommended to cache results in processedItemsCache
property which will be automatically nullified when needed.
Handle a cursor change.
Handle a text change.
An ordered list of all the known types in the typeMap.
To visually encode the types of the completer matches, we assemble an ordered list. This list begins with:
['function', 'instance', 'class', 'module', 'keyword']
and then has any remaining types listed alphabetically. This will give reliable visual encoding for these known types, but allow kernels to provide new types.
Lazy load missing data of an item.
the item or its index
Return undefined
if the completion item with activeIndex
index can not be found.
Return a promise of null
if another resolveItem
is called. Otherwise return the
promise of resolved completion item.
Resolving item by index will be deprecated in the JupyterLab 5.0 and removed in JupyterLab 6.0.
Set the list of visible items in the completer menu, and append any new types to KNOWN_TYPES.
The map from identifiers (a.b) to types (function, module, class, instance, etc.).
A type map is currently only provided by the latest IPython kernel using
the completer reply metadata field _jupyter_types_experimental
. The
values are completely up to the kernel.
An implementation of a completer model.