NotebookViewModel | @jupyterlab (original) (raw)

Hierarchy (View Summary)

• WindowedListModel
  • NotebookViewModel

Index

Constructors

constructor

• new NotebookViewModel(
  cells: Cell<ICellModel>[],
  options?: WindowedList.IModelOptions,
  ): NotebookViewModel

• Returns NotebookViewModel

Properties

Protected_estimatedWidgetSize

_estimatedWidgetSize: number

Protected_stateChanged

Protectedcells

ProtectedcellsEstimatedHeight

cellsEstimatedHeight: Map<string, number> = ...

paddingTop

paddingTop: number

ReadonlyscrollDownThreshold

scrollDownThreshold: number = ...

ReadonlyscrollUpThreshold

scrollUpThreshold: number = ...

StaticDEFAULT_CELL_MARGIN

DEFAULT_CELL_MARGIN: number = 22

StaticDEFAULT_CELL_SIZE

DEFAULT_CELL_SIZE: number = 39

StaticDEFAULT_EDITOR_LINE_HEIGHT

DEFAULT_EDITOR_LINE_HEIGHT: number = 17

Accessors

height

• get height(): number

• Returns number

• set height(h: number): void

• Returns void

isDisposed

• get isDisposed(): boolean

• Returns boolean

itemsList

• get itemsList(): null | ISimpleObservableList<any>

• Returns null | ISimpleObservableList<any>

• set itemsList(v: null | ISimpleObservableList<any>): void

• Returns void

overscanCount

• get overscanCount(): number

• Returns number

• set overscanCount(newValue: number): void

• Parameters

  • newValue: number

Returns void

scrollOffset

• get scrollOffset(): number

• Returns number

• set scrollOffset(offset: number): void

• Returns void

stateChanged

• get stateChanged(): ISignal<WindowedListModel, IChangedArgs<any, any, string>>

• Returns ISignal<WindowedListModel, IChangedArgs<any, any, string>>

widgetCount

• get widgetCount(): number

• Returns number

• set widgetCount(newValue: number): void

• Parameters

  • newValue: number

Returns void

windowingActive

• get windowingActive(): boolean

• Returns boolean

• set windowingActive(newValue: boolean): void

• Parameters

  • newValue: boolean

Returns void

Methods

dispose

• dispose(): void

• Returns void

estimateWidgetSize

• estimateWidgetSize(index: number): number

• Returns number

Cell height in pixels

getEstimatedTotalSize

• getEstimatedTotalSize(): number

• Returns number

Total estimated size

getOffsetForIndexAndAlignment

• getOffsetForIndexAndAlignment(
  index: number,
  align?: ScrollToAlign,
  margin?: number,
  precomputed?: {
  currentOffset: number;
  itemMetadata: ItemMetadata;
  totalSize: number;
  },
  alignPreference?: BaseScrollToAlignment,
  ): number

• Parameters

  • index: number
  • Optionalalign: ScrollToAlign
  • Optionalmargin: number
  • Optionalprecomputed: { currentOffset: number; itemMetadata: ItemMetadata; totalSize: number }
  • OptionalalignPreference: BaseScrollToAlignment

Returns number

The needed scroll offset

getRangeToRender

• getRangeToRender(): null | WindowIndex

• Returns null | WindowIndex

The current items range to display

getSpan

• getSpan(startIndex: number, stopIndex: number): [number, number]

• Parameters

  • startIndex: number
  • stopIndex: number

Returns [number, number]

The viewport top position and its height

ProtectedonListChanged

• onListChanged(
  list: IObservableList<Widget>,
  changes: IObservableList.IChangedArgs<Widget>,
  ): void

• Returns void

resetAfterIndex

• resetAfterIndex(index: number): void

• Returns void

setEstimatedWidgetSize

• setEstimatedWidgetSize(cellId: string, size: null | number): void

• Parameters

  • cellId: string
  • size: null | number

Returns void

setWidgetSize

• setWidgetSize(sizes: { index: number; size: number }[]): boolean

• Parameters

  • sizes: { index: number; size: number }[]

Returns boolean

Whether some sizes changed or not

widgetRenderer

• widgetRenderer(index: number): Widget

• Returns Widget

Cell widget