tutorial-Swipe_status.html 8.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>Tutorial: Swipe status - Documentation</title>
  6. <script src="scripts/prettify/prettify.js"></script>
  7. <script src="scripts/prettify/lang-css.js"></script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
  12. <link type="text/css" rel="stylesheet" href="styles/prettify.css">
  13. <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
  14. </head>
  15. <body>
  16. <input type="checkbox" id="nav-trigger" class="nav-trigger" />
  17. <label for="nav-trigger" class="navicon-button x">
  18. <div class="navicon"></div>
  19. </label>
  20. <label for="nav-trigger" class="overlay"></label>
  21. <nav>
  22. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="$.html">$</a></li><li><a href="$.fn.html">fn</a></li><li><a href="$.fn.swipe.html">swipe</a><ul class='methods'><li data-type='method'><a href="$.fn.swipe.html#destroy">destroy</a></li><li data-type='method'><a href="$.fn.swipe.html#disable">disable</a></li><li data-type='method'><a href="$.fn.swipe.html#enable">enable</a></li><li data-type='method'><a href="$.fn.swipe.html#option">option</a></li></ul></li></ul><h3>Events</h3><ul><li><a href="$.fn.swipe.html#event:click">click</a></li><li><a href="$.fn.swipe.html#event:doubleTap">doubleTap</a></li><li><a href="$.fn.swipe.html#event:hold">hold</a></li><li><a href="$.fn.swipe.html#event:longTap">longTap</a></li><li><a href="$.fn.swipe.html#event:pinchIn">pinchIn</a></li><li><a href="$.fn.swipe.html#event:pinchOut">pinchOut</a></li><li><a href="$.fn.swipe.html#event:pinchStatus">pinchStatus</a></li><li><a href="$.fn.swipe.html#event:swipe">swipe</a></li><li><a href="$.fn.swipe.html#event:swipeDown">swipeDown</a></li><li><a href="$.fn.swipe.html#event:swipeLeft">swipeLeft</a></li><li><a href="$.fn.swipe.html#event:swipeRight">swipeRight</a></li><li><a href="$.fn.swipe.html#event:swipeStatus">swipeStatus</a></li><li><a href="$.fn.swipe.html#event:swipeUp">swipeUp</a></li><li><a href="$.fn.swipe.html#event:tap">tap</a></li></ul><h3>Namespaces</h3><ul><li><a href="$.fn.swipe.defaults.html">defaults</a></li><li><a href="$.fn.swipe.directions.html">directions</a></li><li><a href="$.fn.swipe.fingers.html">fingers</a></li><li><a href="$.fn.swipe.pageScroll.html">pageScroll</a></li><li><a href="$.fn.swipe.phases.html">phases</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-Any_finger_swipe.html">Any finger swipe</a></li><li><a href="tutorial-Basic_swipe.html">Basic swipe</a></li><li><a href="tutorial-Enable_and_destroy.html">Enable and destroy</a></li><li><a href="tutorial-Excluded_children.html">Excluded children</a></li><li><a href="tutorial-Finger_swipe.html">Finger swipe</a></li><li><a href="tutorial-Handlers_and_events.html">Handlers and events</a></li><li><a href="tutorial-Hold.html">Hold</a></li><li><a href="tutorial-Image_gallery_example.html">Image gallery example</a></li><li><a href="tutorial-Options.html">Options</a></li><li><a href="tutorial-Page_scrolling.html">Page scrolling</a></li><li><a href="tutorial-Page_zoom.html">Page zoom</a></li><li><a href="tutorial-Pinch.html">Pinch</a></li><li><a href="tutorial-Pinch_and_Swipe.html">Pinch and Swipe</a></li><li><a href="tutorial-Pinch_status.html">Pinch status</a></li><li><a href="tutorial-Single_swipe.html">Single swipe</a></li><li><a href="tutorial-Stop_propegation.html">Stop_propegation</a></li><li><a href="tutorial-Swipe_status.html">Swipe status</a></li><li><a href="tutorial-Tap_vs_swipe.html">Tap vs swipe</a></li><li><a href="tutorial-Thresholds.html">Thresholds</a></li><li><a href="tutorial-Trigger_handlers.html">Trigger handlers</a></li><li><a href="tutorial-index_.html">index</a></li></ul>
  23. </nav>
  24. <div id="main">
  25. <h1 class="page-title">Tutorial: Swipe status</h1>
  26. <section>
  27. <header>
  28. <h2>Swipe status</h2>
  29. </header>
  30. <article>
  31. <!DOCTYPE HTML>
  32. <html>
  33. <head>
  34. <meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0, user-scalable=no"/>
  35. <meta http-equiv="x-ua-compatible" content="IE=9">
  36. <link href="http://netdna.bootstrapcdn.com/twitter-bootstrap/2.2.2/css/bootstrap-combined.min.css" rel="stylesheet">
  37. <link href="http://twitter.github.com/bootstrap/assets/js/google-code-prettify/prettify.css" rel="stylesheet" />
  38. <link href="css/main.css" type="text/css" rel="stylesheet" />
  39. <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/1.8.2/jquery.min.js"></script>
  40. <script type="text/javascript" src="https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js"></script>
  41. <script type="text/javascript" src="../jquery.touchSwipe.js"></script>
  42. <script type="text/javascript" src="js/main.js"></script>
  43. <title>touchSwipe</title>
  44. </head>
  45. <body>
  46. <a href="https://github.com/mattbryson"><img style="position: absolute; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_white_ffffff.png" alt="Fork me on GitHub"></a>
  47. <div class="container">
  48. <script id='code_1'>
  49. $(function() {
  50. //Enable swiping...
  51. $("#test").swipe( {
  52. swipeStatus:function(event, phase, direction, distance, duration, fingers, fingerData, currentDirection)
  53. {
  54. var str = "<h4>Swipe Phase : " + phase + "<br/>";
  55. str += "Current direction: " + currentDirection + "<br/>";
  56. str += "Direction from inital touch: " + direction + "<br/>";
  57. str += "Distance from inital touch: " + distance + "<br/>";
  58. str += "Duration of swipe: " + duration + "<br/>";
  59. str += "Fingers used: " + fingers + "<br/></h4>";
  60. //Here we can check the:
  61. //phase : 'start', 'move', 'end', 'cancel'
  62. //direction : 'left', 'right', 'up', 'down'
  63. //distance : Distance finger is from initial touch point in px
  64. //duration : Length of swipe in MS
  65. //fingerCount : the number of fingers used
  66. if (phase!="cancel" && phase!="end") {
  67. if (duration<5000)
  68. str +="Under maxTimeThreshold.<h3>Swipe handler will be triggered if you release at this point.</h3>"
  69. else
  70. str +="Over maxTimeThreshold. <h3>Swipe handler will be canceled if you release at this point.</h3>"
  71. if (distance<200)
  72. str +="Not yet reached threshold. <h3>Swipe will be canceled if you release at this point.</h3>"
  73. else
  74. str +="Threshold reached <h3>Swipe handler will be triggered if you release at this point.</h3>"
  75. }
  76. if (phase=="cancel")
  77. str +="<br/>Handler not triggered. <br/> One or both of the thresholds was not met "
  78. if (phase=="end")
  79. str +="<br/>Handler was triggered."
  80. $("#test").html(str);
  81. },
  82. threshold:200,
  83. maxTimeThreshold:5000,
  84. fingers:'all'
  85. });
  86. });
  87. </script>
  88. <span class='title'></span>
  89. <h4>event: <span class='events'><code>swipeStatus</code></span></h4>
  90. <p>You can also get the current status of the swipe, which can be used in place of all other methods. The status reports <code>phase</code>, <code>direction</code>, <code>distance</code>, <code>duration</code>, <code>fingerCount</code>, <code>fingerData</code> and <code>currentDirection</code>
  91. Below has a 200px threshold and a 5 second time limit
  92. </p>
  93. <button class='btn btn-small btn-info example_btn'>Jump to Example</button>
  94. <pre class="prettyprint lang-js" data-src="code_1"></pre>
  95. <span class='navigation'></span>
  96. <div id="test" class="box">Swipe me</div>
  97. <span class='navigation'></span>
  98. </div>
  99. </body>
  100. </html>
  101. </article>
  102. </section>
  103. </div>
  104. <br class="clear">
  105. <footer>
  106. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 17 2018 13:09:45 GMT+0100 (British Summer Time) using the docdash theme.
  107. </footer>
  108. <script>prettyPrint();</script>
  109. <script src="scripts/linenumber.js"></script>
  110. </body>
  111. </html>