Class NotebookViewModel

Notebook view model for the windowed list.

Hierarchy

Constructors

constructor

Properties

_estimatedWidgetSize _stateChanged cells estimateWidgetSize widgetRenderer DEFAULT_CELL_MARGIN DEFAULT_CELL_SIZE DEFAULT_EDITOR_LINE_HEIGHT

Accessors

height isDisposed itemsList overscanCount scrollOffset stateChanged widgetCount windowingActive

Methods

dispose getEstimatedTotalSize getOffsetForIndexAndAlignment getRangeToRender getSpan onListChanged resetAfterIndex setWidgetSize

Constructors

constructor

Properties

Protected _estimatedWidgetSize

_estimatedWidgetSize: number

Default widget size estimation

Protected _stateChanged

_stateChanged: Signal<WindowedListModel, IChangedArgs<any, any, "index" | "list" | "count" | "overscanCount" | "windowingActive">>

Protected cells

cells: Cell<ICellModel>[]

estimateWidgetSize

estimateWidgetSize: ((index) => number)

Type declaration

    • (index): number

    • Cell size estimator

      Parameters

      • index: number

        Cell index

      Returns number

      Cell height in pixels

widgetRenderer

widgetRenderer: ((index) => Widget)

Type declaration

    • (index): Widget

    • Render the cell at index.

      Parameters

      • index: number

        Cell index

      Returns Widget

      Cell widget

Static DEFAULT_CELL_MARGIN

DEFAULT_CELL_MARGIN: number

Default cell margin (top + bottom)

Static DEFAULT_CELL_SIZE

DEFAULT_CELL_SIZE: number

Default cell height

Static DEFAULT_EDITOR_LINE_HEIGHT

DEFAULT_EDITOR_LINE_HEIGHT: number

Default editor line height

Accessors

height

  • get height(): number

  • List widget height

    Returns number

  • set height(h): void

  • List widget height

    Parameters

    • h: number

    Returns void

isDisposed

  • get isDisposed(): boolean

  • Test whether the model is disposed.

    Returns boolean

itemsList

  • get itemsList(): IObservableList<any>

  • Items list to be rendered

    Returns IObservableList<any>

  • set itemsList(v): void

  • Items list to be rendered

    Parameters

    Returns void

overscanCount

  • get overscanCount(): number

  • Number of widgets to render in addition to those visible in the viewport.

    Returns number

  • set overscanCount(newValue): void

  • Number of widgets to render in addition to those visible in the viewport.

    Parameters

    • newValue: number

    Returns void

scrollOffset

  • get scrollOffset(): number

  • Viewport scroll offset.

    Returns number

  • set scrollOffset(offset): void

  • Viewport scroll offset.

    Parameters

    • offset: number

    Returns void

stateChanged

  • get stateChanged(): ISignal<WindowedListModel, IChangedArgs<any, any, "index" | "list" | "count" | "overscanCount" | "windowingActive">>

  • A signal emitted when any model state changes.

    Returns ISignal<WindowedListModel, IChangedArgs<any, any, "index" | "list" | "count" | "overscanCount" | "windowingActive">>

widgetCount

  • get widgetCount(): number

  • Total number of widgets in the list

    Returns number

  • set widgetCount(newValue): void

  • Total number of widgets in the list

    Parameters

    • newValue: number

    Returns void

windowingActive

  • get windowingActive(): boolean

  • Whether windowing is active or not.

    This is true by default.

    Returns boolean

  • set windowingActive(newValue): void

  • Whether windowing is active or not.

    Parameters

    • newValue: boolean

    Returns void

Methods

dispose

  • Dispose the model.

    Returns void

getEstimatedTotalSize

  • Get the total list size.

    Returns number

    Total estimated size

getOffsetForIndexAndAlignment

  • Get the scroll offset to display an item in the viewport.

    By default, the list will scroll as little as possible to ensure the item is visible. You can control the alignment of the item though by specifying a second alignment parameter. Acceptable values are:

    auto (default) - Scroll as little as possible to ensure the item is visible. (If the item is already visible, it won't scroll at all.) smart - If the item is already visible (including the margin), don't scroll at all. If it is less than one viewport away, scroll so that it becomes visible (including the margin). If it is more than one viewport away, scroll so that it is centered within the list. center - Center align the item within the list. end - Align the item to the end of the list start - Align the item to the beginning of the list

    Parameters

    • index: number

      Item index

    • Optional align: ScrollToAlign

      Where to align the item in the viewport

    • Optional margin: number

      In 'smart' mode the viewport proportion to add

    Returns number

    The needed scroll offset

getRangeToRender

  • Compute the items range to display.

    It returns null if the range does not need to be updated.

    Returns WindowIndex

    The current items range to display

getSpan

  • Return the viewport top position and height for range spanning from startIndex to stopIndex.

    Parameters

    • startIndex: number

      First item in viewport index

    • stopIndex: number

      Last item in viewport index

    Returns [number, number]

    The viewport top position and its height

Protected onListChanged

resetAfterIndex

  • WindowedListModel caches offsets and measurements for each index for performance purposes. This method clears that cached data for all items after (and including) the specified index.

    The list will automatically re-render after the index is reset.

    Parameters

    • index: number

    Returns void

setWidgetSize

  • Update item sizes.

    This should be called when the real item sizes has been measured.

    Parameters

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

      New sizes per item index

    Returns boolean

    Whether some sizes changed or not

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc