Olympe SDK

Class: Slide

olympe.ui.std.animations. Slide

A Slide animation slides the new screen from one of the four direction over a specified duration.

new Slide( [direction] [, duration] [, amplitude] [, easing])

Creates a Slide animation.

Parameters:
Name Type Argument Default Description
direction olympe.df.Proxy.<olympe.ui.std.animations.Slide.DIRECTION> | olympe.ui.std.animations.Slide.DIRECTION <optional>
 left

Direction in which to run the slide animation.
duration olympe.df.PONumber | number <optional>
 300

Animation duration in milliseconds.
amplitude olympe.df.PONumber | number <optional>

Amplitude of the slide, default is screen width/height, depending on orientation.
easing olympe.df.ONumber.EASING <optional>

Type of easing for animation.
Implements:

Members

<static> DIRECTION :string

Slide directions

Type:
  • string
Properties:
Name Type Default Description
LEFT string left
RIGHT string right
BOTTOM string bottom
TOP string top

Methods

run(oldElement, newElement, oldElementId, newElementId, container [, onAnimationEnd])

Function called to run the animation on two elements WARNING : onAnimationEnd must be called for compatibility

Parameters:
Name Type Argument Description
oldElement olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

screen to hide
newElement olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

screen to display
oldElementId string
newElementId string
container olympe.ui.std.DockableElement
onAnimationEnd function <optional>
Implements:

runForward(element [, elementId] [, container] [, onAnimationEnd] [, synchronizedAnimatedValue])

Element slide to its position with given direction.

Parameters:
Name Type Argument Description
element olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

UI element to animate
elementId string <optional>
container olympe.ui.std.DockableElement <optional>
onAnimationEnd function <optional>
synchronizedAnimatedValue olympe.df.PONumber <optional>

Use an already existing animated ONumber to synchronize animations
Implements:
Returns:

animated ONumber

Type
olympe.df.PONumber

runReverse(element [, elementId] [, container] [, onAnimationEnd] [, synchronizedAnimatedValue])

Elements slide from its position in given direction.

Parameters:
Name Type Argument Description
element olympe.ui.std.DockableElement | olympe.df.Proxy.<olympe.ui.std.DockableElement>

UI element to animate
elementId string <optional>
container olympe.ui.std.DockableElement <optional>
onAnimationEnd function <optional>
synchronizedAnimatedValue olympe.df.PONumber <optional>

Use an already existing animated ONumber to synchronize animations
Implements:
Returns:

animated ONumber

Type
olympe.df.PONumber