SequentialLayout

SequentialLayout will lay out a collection of renderables sequentially in the specified direction.

Overview

Options
direction
Methods
getSize
sequenceFrom
setOptions
setOutputFunction

SequentialLayout(options)

Constructor Parameters

options

Options

An object of configurable options.

direction
Number
Using the direction helper found in the famous Utility module, this option will lay out the SequentialLayout instance's renderables either horizontally (x) or vertically (y). Utility's direction is essentially either zero (X) or one (Y), so feel free to just use integers as well.
Methods

getSize()

Returns the width and the height of the SequentialLayout instance.

Returns
Array
A two value array of the SequentialLayout instance's current width and height (in that order).

sequenceFrom(items)

Sets the collection of renderables under the SequentialLayout instance's control.

Parameters
items
Array|ViewSequence
Either an array of renderables or a Famous viewSequence.

setOptions(options)

Patches the SequentialLayout instance's options with the passed-in ones.

Parameters
options
Options
An object of configurable options for the SequentialLayout instance.

setOutputFunction(outputFunction)

setOutputFunction is used to apply a user-defined output transform on each processed renderable. For a good example, check out SequentialLayout's own DEFAULT_OUTPUT_FUNCTION in the code.

Parameters
outputFunction
Function
An output processer for each renderable in the SequentialLayout instance.