JsDoc Reference - Index

# Class Index

$ ( )
See (http://jquery.com/). code »
fn ( ) Static
See (http://jquery.com/) code »
swipe ( Mixed method ) Static
Applies TouchSwipe behaviour to one or more jQuery objects. The TouchSwipe plugin can be instantiated via this method, or methods within TouchSwipe can be executed via this method as per jQuery plugin architecture. code »
See TouchSwipe
Parameters

method : Mixed
  If the current DOMNode is a TouchSwipe object, and `method` is a TouchSwipe method, then the `method` is executed, and any following arguments are passed to the TouchSwipe method. If `method` is an object, then the TouchSwipe class is instantiated on the current DOMNode, passing the configuration properties defined in the object. See TouchSwipe

defaults ( ) Static
The default configuration, and available options to configure touch swipe with. You can set the default values by updating any of the properties prior to instantiation. code »
directions ( ) Static
The direction constants that are passed to the event handlers. These properties are read only, attempting to change them will not alter the values passed to the event handlers. code »
fingers ( ) Static
Constants representing the number of fingers used in a swipe. These are used to set both the value of `fingers` in the options object, as well as the value of the `fingers` event property. These properties are read only, attempting to change them will not alter the values passed to the event handlers. code »
See $.fn.swipe.defaults#fingers
pageScroll ( ) Static
The page scroll constants that can be used to set the value of `allowPageScroll` option These properties are read only code »
See $.fn.swipe.defaults#allowPageScroll
phases ( ) Static
The phases that a touch event goes through. The `phase` is passed to the event handlers. These properties are read only, attempting to change them will not alter the values passed to the event handlers. code »
_global_ ( )
No description.