index.html
12.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
<!DOCTYPE HTML>
<html lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>JsDoc Reference - Index</title>
<meta name="generator" content="JsDoc Toolkit" />
<link media="all" rel="stylesheet" href="css/common.css" type="text/css" />
<link media="all" rel="stylesheet" href="css/prettify.css" type="text/css" />
<link media="all" rel="stylesheet" href="css/bootstrap.min.css" type="text/css" />
<link media="print" rel="stylesheet" href="css/print.css" type="text/css" />
<style type="text/css">
.icon-jsdoc {
background: url("img/classicons.png") no-repeat;
}
</style>
<script src="js/jquery-1.7.2.min.js" type="text/javascript"></script>
<script src="js/bootstrap.min.js" type="text/javascript"></script>
<script src="js/prettify.js" type="text/javascript"></script>
<script src="js/accordion.js" type="text/javascript"></script>
</head>
<body onload="prettyPrint()"><div class="container-fluid">
<div class="container-fluid">
<header class="header navbar navbar-fixed-top">
<div class="navbar-inner">
<div class="container-fluid">
<a class="brand" href="#"><strong>JsDoc</strong> Reference</a>
<ul id="class-file-selector" class="nav">
<li><a href="#">Class Index</a></li>
<li><a href="files.html">File Index</a></li>
</ul>
</div>
</div>
</header>
<div class="row-fluid">
<div id="index" class="span3">
<div class="well" id="class-list">
<ul class="nav nav-list">
<li class="nav-header">Classes</li>
<li><a href="symbols/%24.html"><span class="indent" style="padding-left:0px;"><i class="icon-jsdoc icon-jsdoc-class"></i><span class="jsdoc-class-index">$</span></span></a></li>
<li><a href="symbols/%24.fn.html"><span class="indent" style="padding-left:14px;"><i class="icon-jsdoc icon-jsdoc-class"></i><span class="jsdoc-class-index">fn</span></span></a></li>
<li><a href="symbols/%24.fn.swipe.html"><span class="indent" style="padding-left:28px;"><i class="icon-jsdoc icon-jsdoc-class"></i><span class="jsdoc-class-index">swipe</span></span></a></li>
<li><a href="symbols/%24.fn.swipe.defaults.html"><span class="indent" style="padding-left:42px;"><i class="icon-jsdoc icon-jsdoc-namespace"></i><span class="jsdoc-class-index">defaults</span></span></a></li>
<li><a href="symbols/%24.fn.swipe.directions.html"><span class="indent" style="padding-left:42px;"><i class="icon-jsdoc icon-jsdoc-namespace"></i><span class="jsdoc-class-index">directions</span></span></a></li>
<li><a href="symbols/%24.fn.swipe.fingers.html"><span class="indent" style="padding-left:42px;"><i class="icon-jsdoc icon-jsdoc-namespace"></i><span class="jsdoc-class-index">fingers</span></span></a></li>
<li><a href="symbols/%24.fn.swipe.pageScroll.html"><span class="indent" style="padding-left:42px;"><i class="icon-jsdoc icon-jsdoc-namespace"></i><span class="jsdoc-class-index">pageScroll</span></span></a></li>
<li><a href="symbols/%24.fn.swipe.phases.html"><span class="indent" style="padding-left:42px;"><i class="icon-jsdoc icon-jsdoc-namespace"></i><span class="jsdoc-class-index">phases</span></span></a></li>
<li><a href="symbols/_global_.html"><span class="indent" style="padding-left:0px;"><i class="icon-jsdoc icon-jsdoc-namespace"></i><span class="jsdoc-class-index">_global_</span></span></a></li>
</ul>
</div>
</div>
<div id="content" class="span9">
<h1 class="classTitle">Class Index</h1>
<div class="jsdoc-members">
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="$" href="symbols/%24.html">$</a></b>
( )
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
See (http://jquery.com/).
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
</div>
</div>
</div>
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="fn" href="symbols/%24.fn.html">fn</a></b>
( )
<span class="label label-jsdoc label-jsdoc-static">Static</span>
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
See (http://jquery.com/)
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
</div>
</div>
</div>
<div class="jsdoc-member accordion-button">
<div class="jsdoc-member-definition">
<b><a id="swipe" href="symbols/%24.fn.swipe.html">swipe</a></b>
( <span class="jsdoc-typedesc">Mixed</span> method )
<span class="label label-jsdoc label-jsdoc-static">Static</span>
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
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.
An existing plugin can have its options changed simply by re calling .swipe(options)
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
<div class="jsdoc-member-see jsdoc-member-info">
<span class="label label-jsdoc label-jsdoc-see">See</span>
<span class="jsdoc-symbol-enum">TouchSwipe</span>
</div>
<div class="jsdoc-member-detail accordion-content">
<b>Parameters</b>
<dl>
<dt>method : <span class="jsdoc-typedesc">Mixed</span></dt>
<dd>If the current DOMNode is a TouchSwipe object, and <code>method</code> is a TouchSwipe method, then
the <code>method</code> is executed, and any following arguments are passed to the TouchSwipe method.
If <code>method</code> is an object, then the TouchSwipe class is instantiated on the current DOMNode, passing the
configuration properties defined in the object. See TouchSwipe</dd>
</dl>
</div>
</div>
</div>
</div>
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="defaults" href="symbols/%24.fn.swipe.defaults.html">defaults</a></b>
( )
<span class="label label-jsdoc label-jsdoc-static">Static</span>
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
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.
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
</div>
</div>
</div>
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="directions" href="symbols/%24.fn.swipe.directions.html">directions</a></b>
( )
<span class="label label-jsdoc label-jsdoc-static">Static</span>
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
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.
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
</div>
</div>
</div>
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="fingers" href="symbols/%24.fn.swipe.fingers.html">fingers</a></b>
( )
<span class="label label-jsdoc label-jsdoc-static">Static</span>
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
Constants representing the number of fingers used in a swipe. These are used to set both the value of <code>fingers</code> in the
options object, as well as the value of the <code>fingers</code> event property.
These properties are read only, attempting to change them will not alter the values passed to the event handlers.
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
<div class="jsdoc-member-see jsdoc-member-info">
<span class="label label-jsdoc label-jsdoc-see">See</span>
<span class="jsdoc-symbol-enum"><a href="symbols/%24.fn.swipe.defaults.html#fingers">$.fn.swipe.defaults#fingers</a></span>
</div>
</div>
</div>
</div>
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="pageScroll" href="symbols/%24.fn.swipe.pageScroll.html">pageScroll</a></b>
( )
<span class="label label-jsdoc label-jsdoc-static">Static</span>
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
The page scroll constants that can be used to set the value of <code>allowPageScroll</code> option
These properties are read only
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
<div class="jsdoc-member-see jsdoc-member-info">
<span class="label label-jsdoc label-jsdoc-see">See</span>
<span class="jsdoc-symbol-enum"><a href="symbols/%24.fn.swipe.defaults.html#allowPageScroll">$.fn.swipe.defaults#allowPageScroll</a></span>
</div>
</div>
</div>
</div>
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="phases" href="symbols/%24.fn.swipe.phases.html">phases</a></b>
( )
<span class="label label-jsdoc label-jsdoc-static">Static</span>
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
The phases that a touch event goes through. The <code>phase</code> 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.
<span class="pull-right"><a href="symbols/src/jquery.touchSwipe.js.html">code »</a></span>
</div>
</div>
</div>
</div>
<div class="jsdoc-member">
<div class="jsdoc-member-definition">
<b><a id="_global_" href="symbols/_global_.html">_global_</a></b>
( )
</div>
<div class="jsdoc-member-description">
<div class="jsdoc-member-content">
<div class="jsdoc-member-summary">
No description.
<span class="pull-right"></span>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<footer class="footer">
<p>Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.4.0 on Sat Dec 19 2015 01:35:03 GMT-0000 (GMT)</p>
</footer>
</div>
</body>
</html>