Class SlidingList

constructor

• new SlidingList(list: MSC3575List): SlidingList

• Construct a new sliding list.

  Parameters

  • list: MSC3575List

    The range, sort and filter values to use for this list.

  Returns SlidingList

joinedCount

getList

• getList(forceIncludeAllParams: boolean): MSC3575List

• Return a copy of the list suitable for a request body.

  Parameters

  • forceIncludeAllParams: boolean

    True to forcibly include all params even if the list hasn't been modified. Callers may want to do this if they are modifying the list prior to calling updateList.

  Returns MSC3575List

replaceList

• replaceList(list: MSC3575List): void

• Replace list parameters. All fields will be replaced with the new list parameters.

  Parameters

  • list: MSC3575List

    The new list parameters

  Returns void

setModified

• setModified(modified: boolean): void

• Mark this list as modified or not. Modified lists will return sticky params with calls to getList. This is useful for the first time the list is sent, or if the list has changed in some way.

  Parameters

  • modified: boolean

    True to mark this list as modified so all sticky parameters will be re-sent.

  Returns void

updateListRange

• updateListRange(newRanges: number[][]): void

• Update the list range for this list. Does not affect modified status as list ranges are non-sticky.

  Parameters

  • newRanges: number[][]

    The new ranges for the list

  Returns void