Class ViewList<T>

  • create_view and remove_view are default functions called when adding or removing views
  • create_view takes a model and an index and returns a view or a promise for a view for that model
  • remove_view takes a view and destroys it (including calling view.remove())
  • each time the update() function is called with a new list, the create and remove callbacks will be called in an order so that if you append the views created in the create callback and remove the views in the remove callback, you will duplicate the order of the list.
  • the remove callback defaults to just removing the view (e.g., pass in null for the second parameter)
  • the context defaults to the created ViewList. If you pass another context, the create and remove will be called in that context.

Type Parameters

  • T

Hierarchy

  • ViewList

Constructors

constructor

Properties

_create_view _handler_context _models _remove_view views

Methods

dispose initialize remove update

Constructors

constructor

  • Type Parameters

    • T

    Parameters

    • create_view: ((model: any, index: any) => T | Promise<T>)
        • (model: any, index: any): T | Promise<T>

        • Parameters

          • model: any
          • index: any

          Returns T | Promise<T>

    • remove_view: null | ((view: T) => void)
    • context: any

    Returns ViewList<T>

Properties

_create_view

_create_view: ((model: any, index: any) => T | Promise<T>)

Type declaration

    • (model: any, index: any): T | Promise<T>

    • Parameters

      • model: any
      • index: any

      Returns T | Promise<T>

_handler_context

_handler_context: any

_models

_models: any[]

_remove_view

_remove_view: ((view: T) => void)

Type declaration

    • (view: T): void

    • Parameters

      • view: T

      Returns void

views

views: Promise<T>[]

Methods

dispose

  • Dispose this viewlist.

    A synchronous function which just deletes references to child views. This function does not call .remove() on child views because that is asynchronous. Use this in cases where child views will be removed in another way.

    Returns void

initialize

  • Parameters

    • create_view: ((model: any, index: any) => T | Promise<T>)
        • (model: any, index: any): T | Promise<T>

        • Parameters

          • model: any
          • index: any

          Returns T | Promise<T>

    • remove_view: null | ((view: T) => void)
    • context: any

    Returns void

remove

  • removes every view in the list; convenience function for .update([]) that should be faster returns a promise that resolves after this removal is done

    Returns Promise<void>

update

  • the create_view, remove_view, and context arguments override the defaults specified when the list is created. after this function, the .views attribute is a list of promises for views if you want to perform some action on the list of views, do something like Promise.all(myviewlist.views).then(function(views) {...});

    Parameters

    • new_models: any[]
    • Optional create_view: ((model: any, index: any) => T | Promise<T>)
        • (model: any, index: any): T | Promise<T>

        • Parameters

          • model: any
          • index: any

          Returns T | Promise<T>

    • Optional remove_view: ((view: T) => void)
        • (view: T): void

        • Parameters

          • view: T

          Returns void

    • Optional context: any

    Returns Promise<T[]>

Settings

Member Visibility

Theme

Generated using TypeDoc