Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ContainerEvent

name

ContainerEvent

Hierarchy

Index

Methods

getSize

  • getSize(): number
  • Gets the size of the container.

    The value returned here is the true size of the container, which may be larger than the size of the container window that you have subscribed to.

    The value returned here is useful for sizing the scroll bars of a data view showing the elements within a container.

    Returns number

    The size of the container.

getSubject

  • getSubject(): string
  • Returns the subject to which the event relates.

    Returns string

    the subject

getWindowEnd

  • getWindowEnd(): number
  • Gets the index of the end of the container window.

    Returns number

    The end of the window, or -1 if no window has been specified.

getWindowStart

  • getWindowStart(): number
  • Gets the index of the start of the window.

    Returns number

    The start of the window, or -1 if no window has been specified.

isImage

  • isImage(): boolean
  • Returns whether this was an image event or an update event.

    If this method returns true, all data for the subject is contained within this event; you should therefore clear the application's caches of any current data for the subject of this event before refreshing them with the new data.

    Returns boolean

    true if this event contains all data for the subject (an "image"), false if the event contains only some of the data (an "update").

updateModel

  • Update your implementation of ContainerModel with the contents of this ContainerEvent.

    Parameters

    Returns void

Generated using TypeDoc