Class NotebookHistory

A console history manager object.

Implements

INotebookHistory

Constructors

constructor

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

Properties

`Private` _cursor

_cursor: number = 0

`Private` _editor

_editor: null | CodeEditor.IEditor = null

`Private` _filtered

_filtered: string[] = []

`Private` _hasSession

_hasSession: boolean = false

`Private` _history

_history: string[][] = []

`Private` _isDisposed

_isDisposed: boolean = false

`Private` _kernel

_kernel: undefined | null | IKernelConnection = null

`Private` _kernelSession

_kernelSession: string = ''

`Private` _placeholder

_placeholder: string = ''

`Private` _requestBatchSize

_requestBatchSize: number = 10

The number of history items to increase a batch size by per subsequent request.

`Private` _sessionContext

_sessionContext: ISessionContext

The client session used to query history.

`Private` _setByHistory

_setByHistory: boolean = false

`Private` _toRequest

_toRequest: number

The number of history items to request.

`Private` _trans

_trans: IRenderMime.TranslationBundle

Translator to be used for warnings

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): 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

`Private` _handleKernel

_handleKernel(): Promise<void>
Handle the current kernel changing.

Returns Promise<void>
- Defined in packages/notebook/src/history.ts:327

`Private` _retrieveHistory

_retrieveHistory(cell?): Promise<void>
retrieve the history from the kernel
Parameters
- Optional cell: Cell<ICellModel>
  The string to use when filtering the data.
Returns Promise<void>
- Defined in packages/notebook/src/history.ts:342

back

back(activeCell): 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): 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

`Private` fetchBatch

fetchBatch(): Promise<void>
Fetches a subsequent batch of history. Updates the filtered history and cursor to correct place in history, accounting for potentially new history items above it.

Returns Promise<void>
- Defined in packages/notebook/src/history.ts:250

forward

forward(activeCell): 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, cell?): 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.
- Optional cell: 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?): 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, content): 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

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NotebookHistory

Properties

Private _cursor

Private _editor

Private _filtered

Private _hasSession

Private _history

Private _isDisposed

Private _kernel

Private _kernelSession

Private _placeholder

Private _requestBatchSize

Private _sessionContext

Private _setByHistory

Private _toRequest

Private _trans

Accessors

editor

Returns null | CodeEditor.IEditor

Parameters

Returns void

isDisposed

Returns boolean

kernelSession

Returns string

placeholder

Returns string

Methods

Private _handleKernel

Returns Promise<void>

Private _retrieveHistory

Parameters

Returns Promise<void>

back

Parameters

Returns Promise<undefined | string>

Protected checkSession

Parameters

Returns Promise<void>

dispose

Returns void

Private fetchBatch

Returns Promise<void>

forward

Parameters

Returns Promise<undefined | string>

Protected onHistory

Parameters

Notes

Returns void

Protected onTextChange

Returns void

reset

Returns void

Protected setFilter

Parameters

Returns void

updateEditor

Parameters

Returns void

Settings

Member Visibility

Theme

On This Page

`Private` _cursor

`Private` _editor

`Private` _filtered

`Private` _hasSession

`Private` _history

`Private` _isDisposed

`Private` _kernel

`Private` _kernelSession

`Private` _placeholder

`Private` _requestBatchSize

`Private` _sessionContext

`Private` _setByHistory

`Private` _toRequest

`Private` _trans

`Private` _handleKernel

`Private` _retrieveHistory

`Protected` checkSession

`Private` fetchBatch

`Protected` onHistory

`Protected` onTextChange

`Protected` setFilter