12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>swipe - Documentation</title>
- <script src="scripts/prettify/prettify.js"></script>
- <script src="scripts/prettify/lang-css.js"></script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
- <link type="text/css" rel="stylesheet" href="styles/prettify.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
- </head>
- <body>
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
- <label for="nav-trigger" class="navicon-button x">
- <div class="navicon"></div>
- </label>
- <label for="nav-trigger" class="overlay"></label>
- <nav>
- <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>
- </nav>
- <div id="main">
-
- <h1 class="page-title">swipe</h1>
-
-
- <section>
- <header>
-
- <h2>
- <span class="ancestors"><a href="$.html">$</a><a href="$.fn.html">.fn</a>.</span>
-
- swipe
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <h4 class="name" id="swipe"><span class="type-signature"></span>new swipe<span class="signature">(method)</span><span class="type-signature"></span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line293">line 293</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-see">See:</dt>
- <dd class="tag-see">
- <ul>
- <li>TouchSwipe</li>
- </ul>
- </dd>
-
-
- </dl>
- <div class="description">
- 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)
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>method</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Mixed</span>
-
- </td>
-
-
- <td class="description last">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</td>
- </tr>
-
- </tbody>
- </table>
-
- </div>
-
-
-
-
-
- <h3 class="subsection-title">Namespaces</h3>
- <dl>
- <dt><a href="$.fn.swipe.defaults.html">defaults</a></dt>
- <dd></dd>
-
- <dt><a href="$.fn.swipe.directions.html">directions</a></dt>
- <dd></dd>
-
- <dt><a href="$.fn.swipe.fingers.html">fingers</a></dt>
- <dd></dd>
-
- <dt><a href="$.fn.swipe.pageScroll.html">pageScroll</a></dt>
- <dd></dd>
-
- <dt><a href="$.fn.swipe.phases.html">phases</a></dt>
- <dd></dd>
- </dl>
-
-
- <h3 class="subsection-title">Members</h3>
-
-
- <h4 class="name" id=".version"><span class="type-signature">(static, readonly) </span>version<span class="type-signature"></span></h4>
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line323">line 323</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- The version of the plugin
- </div>
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
- <h4 class="name" id="destroy"><span class="type-signature"></span>destroy<span class="signature">()</span><span class="type-signature"></span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line549">line 549</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- Destroy the swipe plugin completely. To use any swipe methods, you must re initialise the plugin.
- </div>
- <h5>Example</h5>
-
- <pre class="prettyprint"><code>$("#element").swipe("destroy");</code></pre>
-
-
-
- <h4 class="name" id="disable"><span class="type-signature"></span>disable<span class="signature">()</span><span class="type-signature"> → {DOMNode}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line537">line 537</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- disables the swipe plugin
- </div>
- <h5>Example</h5>
-
- <pre class="prettyprint"><code>$("#element").swipe("disable");</code></pre>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- The Dom element that is now registered with TouchSwipe
- </div>
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">DOMNode</span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="enable"><span class="type-signature"></span>enable<span class="signature">()</span><span class="type-signature"> → {DOMNode}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line522">line 522</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- </dl>
- <div class="description">
- re-enables the swipe plugin with the previous configuration
- </div>
- <h5>Example</h5>
-
- <pre class="prettyprint"><code>$("#element").swipe("enable");</code></pre>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- The Dom element that was registered with TouchSwipe
- </div>
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">DOMNode</span>
- </dd>
- </dl>
-
-
-
-
- <h4 class="name" id="option"><span class="type-signature"></span>option<span class="signature">(property, value<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Object}</span></h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line562">line 562</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-see">See:</dt>
- <dd class="tag-see">
- <ul>
- <li><a href="$.fn.swipe.defaults.html">$.fn.swipe.defaults</a></li>
- </ul>
- </dd>
-
-
- </dl>
- <div class="description">
- Allows run time updating of the swipe configuration options.
- </div>
- <h5>Examples</h5>
-
- <pre class="prettyprint"><code>$("#element").swipe("option", "threshold"); // return the threshold</code></pre>
- <pre class="prettyprint"><code>$("#element").swipe("option", "threshold", 100); // set the threshold after init</code></pre>
- <pre class="prettyprint"><code>$("#element").swipe("option", {threshold:100, fingers:3} ); // set multiple properties after init</code></pre>
- <pre class="prettyprint"><code>$("#element").swipe({threshold:100, fingers:3} ); // set multiple properties after init - the "option" method is optional!</code></pre>
- <pre class="prettyprint"><code>$("#element").swipe("option"); // Return the current options hash</code></pre>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>property</code></td>
-
- <td class="type">
-
-
- <span class="param-type">String</span>
-
- </td>
-
- <td class="attributes">
-
-
-
- </td>
-
-
- <td class="description last">The option property to get or set, or a has of multiple options to set</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>value</code></td>
-
- <td class="type">
-
-
- <span class="param-type">Object</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last">The value to set the property to</td>
- </tr>
-
- </tbody>
- </table>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- If only a property name is passed, then that property value is returned. If nothing is passed the current options hash is returned.
- </div>
- <dl class="param-type">
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Object</span>
- </dd>
- </dl>
-
-
-
-
-
- <h3 class="subsection-title">Events</h3>
-
-
-
- <h4 class="name" id="event:click">click</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2055">line 2055</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
- <dt class="important tag-deprecated">Deprecated:</dt><dd><ul class="dummy"><li>since version 1.6.2, please use $.fn.swipe#tap instead</li></ul></dd>
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A click handler triggered when a user simply clicks, rather than swipes on an element.
- This is deprecated since version 1.6.2, any assignment to click will be assigned to the tap handler.
- You cannot use <code>on</code> to bind to this event as the default jQ <code>click</code> event will be triggered.
- Use the <code>tap</code> event instead.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>target</code></td>
-
- <td class="type">
-
-
- <span class="param-type">DomObject</span>
-
- </td>
-
-
- <td class="description last">The element clicked on.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:doubleTap">doubleTap</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2077">line 2077</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
- <dt class="tag-see">See:</dt>
- <dd class="tag-see">
- <ul>
- <li>$.fn.swipe.defaults#doubleTapThreshold</li>
- </ul>
- </dd>
-
-
- </dl>
- <div class="description">
- A double tap handler triggered when a user double clicks or taps on an element.
- You can set the time delay for a double tap with the $.fn.swipe.defaults#doubleTapThreshold property.
- Note: If you set both <code>doubleTap</code> and <code>tap</code> handlers, the <code>tap</code> event will be delayed by the <code>doubleTapThreshold</code>
- as the script needs to check if its a double tap.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>target</code></td>
-
- <td class="type">
-
-
- <span class="param-type">DomObject</span>
-
- </td>
-
-
- <td class="description last">The element clicked on.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:hold">hold</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2101">line 2101</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
- <dt class="tag-see">See:</dt>
- <dd class="tag-see">
- <ul>
- <li>$.fn.swipe.defaults#longTapThreshold</li>
- </ul>
- </dd>
-
-
- </dl>
- <div class="description">
- A hold tap handler triggered as soon as the longTapThreshold is reached
- You can set the time delay for a long tap with the $.fn.swipe.defaults#longTapThreshold property.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>target</code></td>
-
- <td class="type">
-
-
- <span class="param-type">DomObject</span>
-
- </td>
-
-
- <td class="description last">The element clicked on.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:longTap">longTap</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2090">line 2090</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
- <dt class="tag-see">See:</dt>
- <dd class="tag-see">
- <ul>
- <li>$.fn.swipe.defaults#longTapThreshold</li>
- </ul>
- </dd>
-
-
- </dl>
- <div class="description">
- A long tap handler triggered once a tap has been release if the tap was longer than the longTapThreshold.
- You can set the time delay for a long tap with the $.fn.swipe.defaults#longTapThreshold property.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>target</code></td>
-
- <td class="type">
-
-
- <span class="param-type">DomObject</span>
-
- </td>
-
-
- <td class="description last">The element clicked on.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:pinchIn">pinchIn</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2013">line 2013</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler triggered for pinch in events.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user pinched in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user pinched</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>zoom</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The zoom/scale level the user pinched too, 0-1.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:pinchOut">pinchOut</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2027">line 2027</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler triggered for pinch out events.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user pinched in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user pinched</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>zoom</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The zoom/scale level the user pinched too, 0-1.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:pinchStatus">pinchStatus</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2041">line 2041</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler triggered for all pinch events. This handler is constantly fired for the duration of the pinch. This is triggered regardless of thresholds.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user pinched in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user pinched</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>zoom</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The zoom/scale level the user pinched too, 0-1.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:swipe">swipe</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line1924">line 1924</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A catch all handler that is triggered for all swipe directions.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user swiped in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user swiped</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>currentDirection</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The current direction the user is swiping.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:swipeDown">swipeDown</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line1983">line 1983</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler that is triggered for "down" swipes.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user swiped in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user swiped</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>currentDirection</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The current direction the user is swiping.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:swipeLeft">swipeLeft</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line1941">line 1941</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler that is triggered for "left" swipes.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user swiped in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user swiped</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>currentDirection</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The current direction the user is swiping.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:swipeRight">swipeRight</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line1955">line 1955</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler that is triggered for "right" swipes.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user swiped in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user swiped</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>currentDirection</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The current direction the user is swiping.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:swipeStatus">swipeStatus</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line1997">line 1997</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler triggered for every phase of the swipe. This handler is constantly fired for the duration of the pinch.
- This is triggered regardless of swipe thresholds.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>phase</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The phase of the swipe event. See <a href="$.fn.swipe.phases.html">$.fn.swipe.phases</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The direction the user swiped in. This is null if the user has yet to move. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user swiped. This is 0 if the user has yet to move.</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>currentDirection</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The current direction the user is swiping.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:swipeUp">swipeUp</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line1969">line 1969</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A handler that is triggered for "up" swipes.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>direction</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The direction the user swiped in. See <a href="$.fn.swipe.directions.html">$.fn.swipe.directions</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>distance</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The distance the user swiped</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>duration</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The duration of the swipe in milliseconds</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerCount</code></td>
-
- <td class="type">
-
-
- <span class="param-type">int</span>
-
- </td>
-
-
- <td class="description last">The number of fingers used. See <a href="$.fn.swipe.fingers.html">$.fn.swipe.fingers</a></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>fingerData</code></td>
-
- <td class="type">
-
-
- <span class="param-type">object</span>
-
- </td>
-
-
- <td class="description last">The coordinates of fingers in event</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>currentDirection</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last">The current direction the user is swiping.</td>
- </tr>
-
- </tbody>
- </table>
-
-
-
- <h4 class="name" id="event:tap">tap</h4>
-
- <dl class="details">
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="jquery.touchSwipe.js.html">jquery.touchSwipe.js</a>, <a href="jquery.touchSwipe.js.html#line2068">line 2068</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-default">Default Value:</dt>
- <dd class="tag-default"><ul class="dummy">
- <li>null</li>
- </ul></dd>
-
-
-
-
- </dl>
- <div class="description">
- A click / tap handler triggered when a user simply clicks or taps, rather than swipes on an element.
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>event</code></td>
-
- <td class="type">
-
-
- <span class="param-type">EventObject</span>
-
- </td>
-
-
- <td class="description last">The original event object</td>
- </tr>
-
- <tr>
-
- <td class="name"><code>target</code></td>
-
- <td class="type">
-
-
- <span class="param-type">DomObject</span>
-
- </td>
-
-
- <td class="description last">The element clicked on.</td>
- </tr>
-
- </tbody>
- </table>
-
-
- </article>
- </section>
- </div>
- <br class="clear">
- <footer>
- 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.
- </footer>
- <script>prettyPrint();</script>
- <script src="scripts/linenumber.js"></script>
- </body>
- </html>
|