FlexibleLayout

A layout which divides a context into sections based on a proportion of the total sum of ratios. FlexibleLayout can either lay renderables out vertically or horizontally.

Overview

Options
direction
transition
ratios
Methods
setOptions
sequenceFrom
setRatios
getSize

FlexibleLayout(options)

Constructor Parameters

options

Options

An object of configurable options.

direction
Number
Direction the FlexibleLayout instance should lay out renderables.
transition
Transition
The transiton that controls the FlexibleLayout instance's reflow.
ratios
Ratios
The proportions for the renderables to maintain
Methods

setOptions(options)

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

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

sequenceFrom(sequence)

Sets the collection of renderables under the FlexibleLayout instance's control. Also sets the associated ratio values for sizing the renderables if given.

Parameters
sequence
Array
An array of renderables.

setRatios(ratios)

Sets the associated ratio values for sizing the renderables.

Parameters
ratios
Array
Array of ratios corresponding to the percentage sizes each renderable should be

getSize()

Gets the size of the context the FlexibleLayout exists within.

Returns
Array
Size of the FlexibleLayout in pixels [width, height]