$.fn.swipe.pageScroll.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>pageScroll - 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">pageScroll</h1>
  26. <section>
  27. <header>
  28. <h2>
  29. <span class="ancestors"><a href="$.html">$</a><a href="$.fn.html">.fn</a><a href="$.fn.swipe.html">.swipe</a>.</span>
  30. pageScroll
  31. </h2>
  32. </header>
  33. <article>
  34. <div class="container-overview">
  35. <dl class="details">
  36. <dt class="tag-source">Source:</dt>
  37. <dd class="tag-source"><ul class="dummy"><li>
  38. <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line379">line 379</a>
  39. </li></ul></dd>
  40. <dt class="tag-see">See:</dt>
  41. <dd class="tag-see">
  42. <ul>
  43. <li>$.fn.swipe.defaults#allowPageScroll</li>
  44. </ul>
  45. </dd>
  46. </dl>
  47. <h5 class="subsection-title">Properties:</h5>
  48. <table class="props">
  49. <thead>
  50. <tr>
  51. <th>Name</th>
  52. <th>Type</th>
  53. <th class="last">Description</th>
  54. </tr>
  55. </thead>
  56. <tbody>
  57. <tr>
  58. <td class="name"><code>NONE</code></td>
  59. <td class="type">
  60. <span class="param-type">string</span>
  61. </td>
  62. <td class="description last">Constant indicating no page scrolling is allowed. Value is <code>"none"</code>.</td>
  63. </tr>
  64. <tr>
  65. <td class="name"><code>HORIZONTAL</code></td>
  66. <td class="type">
  67. <span class="param-type">string</span>
  68. </td>
  69. <td class="description last">Constant indicating horizontal page scrolling is allowed. Value is <code>"horizontal"</code>.</td>
  70. </tr>
  71. <tr>
  72. <td class="name"><code>VERTICAL</code></td>
  73. <td class="type">
  74. <span class="param-type">string</span>
  75. </td>
  76. <td class="description last">Constant indicating vertical page scrolling is allowed. Value is <code>"vertical"</code>.</td>
  77. </tr>
  78. <tr>
  79. <td class="name"><code>AUTO</code></td>
  80. <td class="type">
  81. <span class="param-type">string</span>
  82. </td>
  83. <td class="description last">Constant indicating either horizontal or vertical will be allowed, depending on the swipe handlers registered. Value is <code>"auto"</code>.</td>
  84. </tr>
  85. </tbody>
  86. </table>
  87. <div class="description">The page scroll constants that can be used to set the value of <code>allowPageScroll</code> option
  88. These properties are read only</div>
  89. </div>
  90. </article>
  91. </section>
  92. </div>
  93. <br class="clear">
  94. <footer>
  95. 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.
  96. </footer>
  97. <script>prettyPrint();</script>
  98. <script src="scripts/linenumber.js"></script>
  99. </body>
  100. </html>