ViewSequence

Helper object used to iterate through items sequentially. Used in views that deal with layout. A ViewSequence object conceptually points to a node in a linked list.

Overview

Options
index
array
_
loop
Methods
getPrevious
getNext
indexOf
getIndex
toString
unshift
push
splice
swap
get
getSize

ViewSequence(options)

Constructor Parameters

options

Object|Array

Options object, or content array.

index
Number
starting index.
array
Number
Array of elements to populate the ViewSequence
_
Object
Optional backing store (internal
loop
Boolean
Whether to wrap when accessing elements just past the end (or beginning) of the sequence.
Methods

getPrevious()

Return ViewSequence node previous to this node in the list, respecting looping if applied.

Returns
ViewSequence
previous node.

getNext()

Return ViewSequence node next after this node in the list, respecting looping if applied.

Returns
ViewSequence
previous node.

indexOf()

Return index of the provided item in the backing array

Returns
Number
index or -1 if not found

getIndex()

Return index of this ViewSequence node.

Returns
Number
index

toString()

Return printable version of this ViewSequence node.

Returns
String
this index as a string

unshift(value)

Add one or more objects to the beginning of the sequence.

Parameters
value
...Object
arguments array of objects

push(value)

Add one or more objects to the end of the sequence.

Parameters
value
...Object
arguments array of objects

splice(index, howMany, value)

Remove objects from the sequence

Parameters
index
Number
starting index for removal
howMany
Number
how many elements to remove
value
...Object
arguments array of objects

swap(other)

Exchange this element's sequence position with another's.

Parameters
other
ViewSequence
element to swap with.

get()

Return value of this ViewSequence node.

Returns
Object
value of thiss

getSize()

Call getSize() on the contained View.

Returns
Array.Number
[width, height]