ScrollContainer

A Container surface with a scrollview automatically added. The convenience of ScrollContainer lies in being able to clip out portions of the associated scrollview that lie outside the bounding surface, and in being able to move the scrollview more easily by applying modifiers to the parent container surface.

Overview

Options
container
scrollview
Methods
setOptions
sequenceFrom
getSize

ScrollContainer(options)

Constructor Parameters

options

Options

An object of configurable options.

container
Options
Options for the ScrollContainer instance's surface.
scrollview
Options
Options for the ScrollContainer instance's scrollview.
Methods

setOptions(options)

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

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

sequenceFrom(sequence)

Sets the collection of renderables under the ScrollContainer instance scrollview's control.

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

getSize()

Returns the width and the height of the ScrollContainer instance.

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