Olympe SDK

Class: Transition

olympe.ui.std. Transition

A Transition is the operation of switching from one screen to another in a Storyboard. It can have an optional Animation for added effect.

new Transition(fromScreenId, toScreenId, transitionId [, preload] [, animation])

Creates an instance of Transition.

Parameters:
Name Type Argument Default Description
fromScreenId string

ID of the origin screen ('*' for any).
toScreenId string

ID of the destination screen.
transitionId string

ID for this transition.
preload boolean <optional>
 false

true to enable pre-loading.
animation olympe.df.Proxy.<olympe.ui.std.TransitionAnimation> | olympe.ui.std.TransitionAnimation <optional>

Animation to use.

Methods

getAnimation()

Gets the animation of this Transition.

Returns:

The animation.

Type
!olympe.df.Proxy.<!olympe.ui.std.TransitionAnimation> | olympe.ui.std.TransitionAnimation

getFromScreenId()

Gets the ID of the origin screen.

Returns:

The ID.

Type
string

getToScreenId()

Gets the ID of the destination screen.

Returns:

The ID.

Type
string

getTransitionId()

Gets the ID for this Transition.

Returns:

The ID.

Type
string

isPreloaded()

Checks whether this Transition has pre-loading enabled.

Returns:

true if pre-loading is enabled.

Type
boolean