Deck

A Sequential Layout that can be opened and closed with animations. Takes the same options as SequentialLayout as well as options for the open/close transition and the rotation you want your Deck instance to layout in.

Overview

Options
transition
direction
Methods
getSize
isOpen
open
close
close

Deck(options, [options.transition={duration:, stackRotation)

Constructor Parameters

options

Options

An object of configurable options

transition
Object
A transition object for changing between states.
direction
Number
axis of expansion (Utility.Direction.X or .Y)

[options.transition={duration:

Transition

500, curve: 'easeOutBounce'} The transition that executes upon opening or closing your deck instance.

stackRotation

Number

The amount of rotation applied to the propogation of the Deck instance's stack of renderables.

Methods

getSize()

Returns the width and the height of the Deck instance.

Returns
Array
A two value array of Deck's current width and height (in that order). Scales as Deck opens and closes.

isOpen()

An accesor method to find out if the messaged Deck instance is open or closed.

Returns
Boolean
Returns true if the instance is open or false if it's closed.

open(callback)

Sets the Deck instance to an open state.

Parameters
callback
Function
Executes after transitioning to a fully open state.

close(callback)

Sets the Deck instance to an open state.

Parameters
callback
Function
Executes after transitioning to a fully closed state.

close(callback)

Sets the Deck instance from its current state to the opposite state.

Parameters
callback
Function
Executes after transitioning to the toggled state.