Class CompleterModel

An implementation of a completer model.

Hierarchy

CompleterModel

Implements

IModel

Index

Properties

Accessors

Methods

Properties

Private _current

_current: ITextState | null = null

Private _cursor

_cursor: ICursorSpan | null = null

Private _isDisposed

_isDisposed: boolean = false

Private _options

_options: string[] = []

Private _orderedTypes

_orderedTypes: string[] = []

Private _original

_original: ITextState | null = null

Private _query

_query: string = ""

Private _stateChanged

_stateChanged: Signal<this, void> = new Signal<this, void>(this)

Private _subsetMatch

_subsetMatch: boolean = false

Private _typeMap

_typeMap: TypeMap

Accessors

current

get current(): ITextState | null
set current(newValue: ITextState | null): void

- Defined in model.ts:58
The current text change details.

Returns ITextState | null
- Defined in model.ts:61
The current text change details.

Parameters
- newValue: ITextState | null
Returns void

cursor

get cursor(): ICursorSpan | null
set cursor(newValue: ICursorSpan | null): void

- Defined in model.ts:117
The cursor details that the API has used to return matching options.

Returns ICursorSpan | null
- Defined in model.ts:120
The cursor details that the API has used to return matching options.

Parameters
- newValue: ICursorSpan | null
Returns void

isDisposed

get isDisposed(): boolean

- Defined in model.ts:152
Get whether the model is disposed.

Returns boolean

original

get original(): ITextState | null
set original(newValue: ITextState | null): void

- Defined in model.ts:34
The original completion request details.

Returns ITextState | null
- Defined in model.ts:37
The original completion request details.

Parameters
- newValue: ITextState | null
Returns void

query

get query(): string
set query(newValue: string): void

- Defined in model.ts:132
The query against which items are filtered.

Returns string
- Defined in model.ts:135
The query against which items are filtered.

Parameters
- newValue: string
Returns void

stateChanged

get stateChanged(): ISignal<this, void>

- Defined in model.ts:27
A signal emitted when state of the completer menu changes.

Returns ISignal<this, void>

subsetMatch

get subsetMatch(): boolean
set subsetMatch(newValue: boolean): void

- Defined in model.ts:142
A flag that is true when the model value was modified by a subset match.

Returns boolean
- Defined in model.ts:145
A flag that is true when the model value was modified by a subset match.

Parameters
- newValue: boolean
Returns void

Methods

Private _filter

_filter(): IIterator<IItem>

- Defined in model.ts:360
Apply the query to the complete options list to return the matching subset.

Returns IIterator<IItem>

Private _reset

_reset(): void

- Defined in model.ts:387
Reset the state of the model.

Returns void

createPatch

createPatch(patch: string): IPatch | undefined

Implementation of IModel.createPatch
- Defined in model.ts:325
Create a resolved patch between the original state and a patch string.

Parameters
- patch: string
  
  The patch string to apply to the original value.
Returns IPatch | undefined

A patched text change or undefined if original value did not exist.

dispose

dispose(): void

Implementation of IModel.dispose
- Defined in model.ts:159
Dispose of the resources held by the model.

Returns void

handleCursorChange

handleCursorChange(change: ITextState): void

Implementation of IModel.handleCursorChange
- Defined in model.ts:247
Handle a cursor change.

Parameters
- change: ITextState
Returns void

handleTextChange

handleTextChange(change: ITextState): void

Implementation of IModel.handleTextChange
- Defined in model.ts:296
Handle a text change.

Parameters
- change: ITextState
Returns void

items

items(): IIterator<IItem>

Implementation of IModel.items
- Defined in model.ts:174
The list of visible items in the completer menu.

Notes

This is a read-only property.

Returns IIterator<IItem>

options

options(): IIterator<string>

Implementation of IModel.options
- Defined in model.ts:181
The unfiltered list of all available options in a completer menu.

Returns IIterator<string>

orderedTypes

orderedTypes(): string[]

Implementation of IModel.orderedTypes
- Defined in model.ts:212
An ordered list of all the known types in the typeMap.

Notes

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 alphebetically. This will give reliable visual encoding for these known types, but allow kernels to provide new types.
Returns string[]

reset

reset(hard?: boolean): void

Implementation of IModel.reset
- Defined in model.ts:346
Reset the state of the model and emit a state change signal.

Parameters
- Default value hard: boolean = false
  
  Reset even if a subset match is in progress.
Returns void

setOptions

setOptions(newValue: IterableOrArrayLike<string>, typeMap?: TypeMap): void

Implementation of IModel.setOptions
- Defined in model.ts:219
Set the available options in the completer menu.

Parameters
- newValue: IterableOrArrayLike<string>
- Optional typeMap: TypeMap
Returns void

typeMap

typeMap(): TypeMap

Implementation of IModel.typeMap
- Defined in model.ts:195
The map from identifiers (a.b) to types (function, module, class, instance, etc.).

Notes

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.

Returns TypeMap

Generated using TypeDoc