Interface IModel

Windowed list model interface

Hierarchy

Implemented by

Properties

estimateWidgetSize height isDisposed itemsList overscanCount paddingTop? scrollOffset stateChanged widgetCount widgetRenderer windowingActive

Methods

dispose getEstimatedTotalSize getOffsetForIndexAndAlignment getRangeToRender getSpan resetAfterIndex setWidgetSize

Properties

estimateWidgetSize

estimateWidgetSize: ((index) => number)

Type declaration

    • (index): number

    • Provide a best guess for the widget size at position index

      Notes

      This function should be very light to compute especially when returning the default size. The default value should be constant (i.e. two calls with null should return the same value). But it can change for a given index.

      Parameters

      • index: number

        Widget position

      Returns number

      Estimated widget size

height

height: number

List widget height

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

itemsList

itemsList: {
    changed: ISignal<any, IObservableList.IChangedArgs<any>>;
    length: number;
}

Items list to be rendered

Type declaration

overscanCount

overscanCount: number

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

Optional paddingTop

paddingTop?: number

Top padding of the the outer window node.

scrollOffset

scrollOffset: number

Viewport scroll offset.

Readonly stateChanged

stateChanged: ISignal<WindowedList.IModel, IChangedArgs<any, any, "index" | "list" | "count" | "overscanCount" | "windowingActive">>

A signal emitted when any model state changes.

widgetCount

widgetCount: number

Total number of widgets in the list

widgetRenderer

widgetRenderer: ((index) => Widget)

Type declaration

    • (index): Widget

    • Widget factory for the list items.

      Caching the resulting widgets should be done by the callee.

      Parameters

      • index: number

        List index

      Returns Widget

      The widget at the given position

windowingActive

windowingActive: boolean

Whether windowing is active or not.

Methods

dispose

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    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

    • start: number

      First item in viewport index

    • stop: number

      Last item in viewport index

    Returns [number, number]

    The viewport top position and its height

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