Type: Object
Default: {}
This are the elements that will create the animations. You will learn about this on Chapter 5.
Type: String
Default: linear
Values: linear | tree
Set this to "tree" if you want to use a tree structure when building "elements" object.(See example)
Type: Integer
Default: 1000
This is the default duration in milliseconds for any animation. This value can be overwrite by "durationTweaks" object.
Type: Object
Default: auto
With this object you can set durations for "scroll","jump","dragm"wipe","scrollbar" animations. Every one of this settings can have a "duration","durationType", and a "minStepDuration" value. If none is provided the default duration will be used.(See example)
Type: Boolean
Default: true
Values: true | false
Set to false if you do not want mouse scroll events for your animations.
Type: String
Default: scroll
Values: scroll | jump
There are two types of scrolling types. "scroll" is when the animation is runing one step after another, "jump" is when the user sets an array of "jumpPoints" and the animation si jumping from one point to another.(See example)
Type: Array
Default: []
If "scrollType" is set to "jump" then here you will enter the points that you want to use for your animations. Minimum 2 are needed.(See example)
Type: Integer
Default: auto
Sets how long do you want your animation to last. If nothing is set then this value will detect this value.
Type: Integer
Default: 0
Sets the minimum step that a user can go with his animation at. Only applies to "scroll"(mouse) and "drag"(touch) events.(See example)
Type: Integer
Default: auto
Sets how many steps you can scroll at max in one animation.(See example)
Type: Integer
Default: 0
Sets how many steps you can drag at max in one animation.(See example)
Type: Boolean
Default: False
Values: true | false
Adds a small debug tool.
Type: String
Default: linear
Values: linear | swing | easing.js functions (if easing.js is included)
Easing that will be used for jQuery and CSS3 animation. More can be added.(See example)
Type: String
Default: linear
Values: linear | swing | easing.js function (if easing.js is included)
Set the type of easing you want when having a jQuery animation. This will overwrite the easing option for jQuery animations.
Type: String
Default: linear
Values: linear | ease | ease-in | ease-out | ease-in-out | easing.js functions are also included (without easing.js)
Set the type of easing you want when having a CSS3 animation. This will overwrite the easing option for CSS3 animations.
Type: Integer
Default: 0
Sets the starting value.(See example)
Type: Boolean
Default: False
Values: true | false
Enables loop animations.(See example)
Type: Boolean
Default: True
Values: true | false
Prevents default action when scrolling of the site.
Type: Array
Define here the steps where you want to have a "breakpoint".(See example)
Type: String
The "breakpoint" jQuery selector.(See example)
Type: String
The "breakpoint" active jQuery class selector.(See example)
Type: Boolean
Default: false
Values: true | false
Enables touch events.
Type: String
Default: drag
Values: drag | wipe
There are 2 types of touch events.(See example)
Type: Object
Default: {left:0,down:1,right:0,up:-1}
You can define the action for each touch. +1 means forward and -1 means backward. 0 means no action.(See example)
Type: Integer
Default: 10
Number of pixels for horizontal drag to start.
Type: Integer
Default: 10
Number of pixels for vertical drag to start.
Type: Integer
Default: 20
Number of pixels for horizontal wipe to start.
Type: Integer
Default: 20
Number of pixels for vertical wipe to start.
Type: Array
Define here the steps where you want to jump on each wipe(only when "touchType" is set to "wipe").(See example)
Type: Boolean
Default: true
Values: true | false
Prevents default action when dragging of the site.
Type: String
Default: isalive-(random number)
Every animating element will get a class with this value. If none is defined a class is given.
Type: Boolean
Default: true
Values: true | false
Set on TRUE is you want to rebuild the page on window resize.(See example)
Type: Array
Define here the steps where you want to have a "playpoint". This will be used only at "play/rewind" method.(See example)
Type: Integer
Default: 1
The number of steps you want when having a scroll event(only when "scrollType" is on "scroll").(See example)
Type: Integer
Default: 1
The number of steps you want when having a drag event(only when "touchType" is on "drag").(See example)
Type: Integer
Default: 1
The number of steps you want when having a scrollbar event(only when "scrollbarType" is on "scroll").(See example)
Type: Integer
Default: 0
The milliseconds you want set as the minimum duration for each step to be animated.(See example)
Type: Boolean
Default: false
Values: true | false
Inits all the css value at the start.(See example)
Type: Boolean
Default: false
Values: true | false
Enables CSS3 animations.(See example)
Type: String
Default: scroll
Values: scroll | jump
There are 2 types of actions on scrollbar move.(See example)
Type: Array
Set here the step points where you want to have a scrollbar jump point.(See example)
Type: String
jQuery class for scroll active state.(See example)
Type: Boolean
Default: false
Values: true | false
Enables touch events on scrollbar element.
Type: Integer
Default: 250
Values: number | false
Set here the number of milliseconds before a new scroll action can be taken(only when "scrollType" is on "scroll"). If set to "false" the animations will have to end before a new animation can start.(See example)
Type: Bolean or String
Default: false
Values: true | false | webkit | chrome | safari | mobile | webkit&mobile | webkit!mobile | chrome&mobile | safari&mobile | chrome!mobile | safari!mobile
For webkit browsers you can enable the use of GPU. This will make your animation run smother but may also cause some bugs. This is useful on mobile devices, but can use it on desktop too.
Type: Boolean
Default: false
Values: true | false
If this is set to TRUE the plugin will use the "id" HTML attribute as a selector. If one is not avalaible then it will generate an ID. This is used for faster animations and prevent CSS3 bugs.
Type: Function
This function will be called at every step of animation.(See example)
Type: Function
This function will be called when the animations are ready.(See example)
Type: Function
This function will be called when the rebuild is performed.(See example)