Notebook | @jupyterlab (original) (raw)

_findCellById

• _findCellById(queryId: string): null | IScrollTarget

• Parameters

  • queryId: string

Returns null | IScrollTarget

_findHeading

• _findHeading(queryId: string): Promise<null | IScrollTarget>

• Parameters

  • queryId: string

Returns Promise<null | IScrollTarget>

Protected_onCellsChanged

• _onCellsChanged(
  sender: CellList,
  args: IObservableList.IChangedArgs<ICellModel>,
  ): void

• Returns void

activate

• activate(): void

• Returns void

addClass

• addClass(name: string): void

• Returns void

ProtectedaddFooter

• addFooter(): void

• Returns void

ProtectedaddHeader

• addHeader(): void

• Returns void

children

• children(): IterableIterator<Widget>

• Returns IterableIterator<Widget>

A new iterator over the children of the widget.

Notes

The widget must have a populated layout in order to have children.
If a layout is not installed, the returned iterator will be empty.

clearFlag

• clearFlag(flag: Flag): void

• Returns void

close

• close(): void

• Returns void

contains

• contains(widget: Widget): boolean

• Returns boolean

true if the widget is a descendant, false otherwise.

deselect

• deselect(widget: Cell<ICellModel>): void

• Returns void

deselectAll

• deselectAll(): void

• Returns void

dispose

• dispose(): void

• Returns void

extendContiguousSelectionTo

• extendContiguousSelectionTo(index: number): void

• Returns void

fit

• fit(): void

• Returns void

getContiguousSelection

• getContiguousSelection(): | { anchor: number; head: number }
  | { anchor: null; head: null }

• Returns { anchor: number; head: number } | { anchor: null; head: null }

handleEvent

• handleEvent(event: Event): void

• Returns void

hasClass

• hasClass(name: string): boolean

• Returns boolean

true if the node has the class, false otherwise.

hide

• hide(): void

• Returns void

isSelected

• isSelected(widget: Cell<ICellModel>): boolean

• Returns boolean

isSelectedOrActive

• isSelectedOrActive(widget: Cell<ICellModel>): boolean

• Returns boolean

moveCell

• moveCell(from: number, to: number, n?: number): void

• Parameters

  • from: number
  • to: number
  • n: number = 1

Returns void

ProtectednotifyLayout

• notifyLayout(msg: Message): void

• Returns void

ProtectedonActivateRequest

• onActivateRequest(msg: Message): void

• Returns void

ProtectedonAfterAttach

• onAfterAttach(msg: Message): void

• Returns void

ProtectedonAfterDetach

• onAfterDetach(msg: Message): void

• Returns void

ProtectedonAfterHide

• onAfterHide(msg: Message): void

• Returns void

ProtectedonAfterShow

• onAfterShow(msg: Message): void

• Returns void

ProtectedonBeforeAttach

• onBeforeAttach(msg: Message): void

• Returns void

ProtectedonBeforeDetach

• onBeforeDetach(msg: Message): void

• Returns void

ProtectedonBeforeHide

• onBeforeHide(msg: Message): void

• Returns void

ProtectedonBeforeShow

• onBeforeShow(msg: Message): void

• Returns void

ProtectedonCellInserted

• onCellInserted(index: number, cell: Cell<ICellModel>): void

• Returns void

ProtectedonCellRemoved

• onCellRemoved(index: number, cell: Cell<ICellModel>): void

• Returns void

ProtectedonChildAdded

• onChildAdded(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonChildRemoved

• onChildRemoved(msg: ChildMessage): void

• Parameters

  • msg: ChildMessage

Returns void

ProtectedonCloseRequest

• onCloseRequest(msg: Message): void

• Returns void

ProtectedonFitRequest

• onFitRequest(msg: Message): void

• Returns void

ProtectedonMetadataChanged

• onMetadataChanged(sender: INotebookModel, args: IMapChange<any>): void

• Returns void

ProtectedonModelChanged

• onModelChanged(oldValue: INotebookModel, newValue: INotebookModel): void

• Returns void

ProtectedonModelContentChanged

• onModelContentChanged(model: INotebookModel, args: void): void

• Returns void

ProtectedonResize

• onResize(msg: ResizeMessage): void

• Parameters

  • msg: ResizeMessage

Returns void

ProtectedonScroll

• onScroll(event: Event): void

• Returns void

ProtectedonStateChanged

• onStateChanged(
  model: WindowedList.IModel<any>,
  changes: IChangedArgs<number | boolean, number | boolean, string>,
  ): void

• Parameters

  • model: WindowedList.IModel<any>
  • changes: IChangedArgs<number | boolean, number | boolean, string>

Returns void

ProtectedonUpdateRequest

• onUpdateRequest(msg: Message): void

• Returns void

processMessage

• processMessage(msg: Message): void

• Returns void

removeClass

• removeClass(name: string): void

• Returns void

ProtectedremoveHeader

• removeHeader(): void

• Returns void

renderCellOutputs

• renderCellOutputs(index: number): void

• Returns void

scrollTo

• scrollTo(scrollOffset: number): void

• Parameters

  • scrollOffset: number

Returns void

scrollToCell

• scrollToCell(cell: Cell<ICellModel>, align?: ScrollToAlign): Promise<void>

• Returns Promise<void>

scrollToItem

• scrollToItem(
  index: number,
  align?: ScrollToAlign,
  margin?: number,
  alignPreference?: BaseScrollToAlignment,
  ): Promise<void>

• Parameters

  • index: number
  • Optionalalign: ScrollToAlign
  • Optionalmargin: number
  • OptionalalignPreference: BaseScrollToAlignment

Returns Promise<void>

select

• select(widget: Cell<ICellModel>): void

• Returns void

setFlag

• setFlag(flag: Flag): void

• Returns void

setFragment

• setFragment(fragment: string): Promise<void>

• Parameters

  • fragment: string

Returns Promise<void>

setHidden

• setHidden(hidden: boolean): void

• Parameters

  • hidden: boolean

Returns void

ProtectedsetMode

• setMode(newValue: NotebookMode, options?: { focus?: boolean }): void

• Parameters

  • newValue: NotebookMode
  • options: { focus?: boolean } = {}
    * ##### Optionalfocus?: boolean

Returns void

show

• show(): void

• Returns void

testFlag

• testFlag(flag: Flag): boolean

• Returns boolean

toggleClass

• toggleClass(name: string, force?: boolean): boolean

• Parameters

  • name: string
  • Optionalforce: boolean

Returns boolean

true if the class is now present, false otherwise.

Notes

The class name must not contain whitespace.

update

• update(): void

• Returns void