Class NotebookHistory

A console history manager object.

Implements

INotebookHistory

Index

Constructors

constructor

new NotebookHistory(options: NotebookHistory.IOptions): NotebookHistory
Construct a new console history object.
Parameters
- options: NotebookHistory.IOptions
Returns NotebookHistory
- Defined in packages/notebook/src/history.ts:75

Accessors

editor

get editor(): null | CodeEditor.IEditor
The current editor used by the history manager.

Returns null | CodeEditor.IEditor
Implementation of INotebookHistory.editor
- Defined in packages/notebook/src/history.ts:107
set editor(value: null | CodeEditor.IEditor): void
The current editor used by the history widget.
Parameters
- value: null | CodeEditor.IEditor
Returns void
Implementation of INotebookHistory.editor
- Defined in packages/notebook/src/history.ts:111

isDisposed

get isDisposed(): boolean
Get whether the notebook history manager is disposed.

Returns boolean
Implementation of INotebookHistory.isDisposed
- Defined in packages/notebook/src/history.ts:145

kernelSession

get kernelSession(): string
Kernel session number for filtering

Returns string
Implementation of INotebookHistory.kernelSession
- Defined in packages/notebook/src/history.ts:138

placeholder

get placeholder(): string
The placeholder text that a history session began with.

Returns string
Implementation of INotebookHistory.placeholder
- Defined in packages/notebook/src/history.ts:131

Methods

back

back(activeCell: Cell<ICellModel>): Promise<undefined | string>
Get the previous item in the notebook history.
Parameters
- activeCell: Cell<ICellModel>
  The currently selected Cell in the notebook.
Returns Promise<undefined | string>
A Promise resolving to the historical cell content text.
Implementation of INotebookHistory.back
- Defined in packages/notebook/src/history.ts:182

`Protected`checkSession

checkSession(activeCell: Cell<ICellModel>): Promise<void>
Set placeholder and editor. Start session if one is not already started.
Parameters
- activeCell: Cell<ICellModel>
  The currently selected Cell in the notebook.
Returns Promise<void>
- Defined in packages/notebook/src/history.ts:163

dispose

dispose(): void
Dispose of the resources held by the notebook history manager.

Returns void
Implementation of INotebookHistory.dispose
- Defined in packages/notebook/src/history.ts:152

forward

forward(activeCell: Cell<ICellModel>): Promise<undefined | string>
Get the next item in the notebook history.
Parameters
- activeCell: Cell<ICellModel>
  The currently selected Cell in the notebook.
Returns Promise<undefined | string>
A Promise resolving to the historical cell content text.
Implementation of INotebookHistory.forward
- Defined in packages/notebook/src/history.ts:201

`Protected`onHistory

onHistory(value: IHistoryReplyMsg, cell?: Cell<ICellModel>): void
Populate the history collection on history reply from a kernel.
Parameters
- value: IHistoryReplyMsg
  The kernel message history reply.
  
  Notes
  History entries have the shape: [session: number, line: number, input: string] Contiguous duplicates are stripped out of the API response.
- Optionalcell: Cell<ICellModel>
Returns void
- Defined in packages/notebook/src/history.ts:288

`Protected`onTextChange

onTextChange(): void
Handle a text change signal from the editor.

Returns void
- Defined in packages/notebook/src/history.ts:316

reset

reset(): void
Reset the history navigation state, i.e., start a new history session.

Returns void
Implementation of INotebookHistory.reset
- Defined in packages/notebook/src/history.ts:240

`Protected`setFilter

setFilter(filterStr?: string): void
Set the filter data.
Parameters
- filterStr: string = ''
  The string to use when filtering the data.
Returns void
- Defined in packages/notebook/src/history.ts:358

updateEditor

updateEditor(activeCell: Cell<ICellModel>, content: undefined | string): void
Update the editor of the cell with provided text content.
Parameters
- activeCell: Cell<ICellModel>
  The currently selected Cell in the notebook.
- content: undefined | string
  the result from back or forward
Returns void
Implementation of INotebookHistory.updateEditor
- Defined in packages/notebook/src/history.ts:216

Class NotebookHistory

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebookHistory

Accessors

editor

Returns null | CodeEditor.IEditor

Parameters

Returns void

isDisposed

Returns boolean

kernelSession

Returns string

placeholder

Returns string

Methods

back

Parameters

Returns Promise<undefined | string>

ProtectedcheckSession

Parameters

Returns Promise<void>

dispose

Returns void

forward

Parameters

Returns Promise<undefined | string>

ProtectedonHistory

Parameters

Notes

Returns void

ProtectedonTextChange

Returns void

reset

Returns void

ProtectedsetFilter

Parameters

Returns void

updateEditor

Parameters

Returns void

Settings

On This Page

`Protected`checkSession

`Protected`onHistory

`Protected`onTextChange

`Protected`setFilter