var config = {"monospaceLinks":false,"cleverLinks":false,"applicationName":"iwmlib","disqus":"","googleAnalytics":"","openGraph":{"title":"iwmlib API Documentation","type":"website","image":"","site_name":"","url":"https://www.iwm-tuebingen.de"},"meta":{"title":"iwmlib API Documentation","description":"The IWM Browser: One Browser for all apps.","keyword":""},"linenums":true,"cleverlinks":true,"default":{"outputSourceFiles":true,"useLongnameInNav":false}};
<p>In the background, the class UITest uses the Greensock TimelineMax class. The opts object is passed directly to the TimelineMax class, so it can use any key that uses the TimelineMax class.</p>
</div>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>opts</code></td>
<tdclass="type">
<spanclass="param-type">object</span>
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>An options object to specify the behaviour of the test case.</p>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>timeScale</code></td>
<tdclass="type">
<spanclass="param-type">number</span>
</td>
<tdclass="default">
1
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The speed at which the test should run, see https://greensock.com/docs/TimelineMax/timeScale().</p></td>
</tr>
<tr>
<tdclass="name"><code>eventType</code></td>
<tdclass="type">
<spanclass="param-type">string</span>
</td>
<tdclass="default">
auto
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The type of events which should be used. Possible values: pointer, touch, mouse, auto. If set to auto, the eventType is set depending on the support of the browser used.</p></td>
</tr>
<tr>
<tdclass="name"><code>debug</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
false
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>If set to true, multiple informations will be print to the console.</p></td>
</tr>
<tr>
<tdclass="name"><code>defaultInterval</code></td>
<tdclass="type">
<spanclass="param-type">number</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The interval used when no action is specified for an action.</p></td>
<p>Executes a pan event (pointerdown, pointermove, pointerup) on a specific element.</p>
</div>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>element</code></td>
<tdclass="type">
<spanclass="param-type">HTMLElement</span>
|
<spanclass="param-type">string</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<p>The HTML element on which the event is to be executed, e.g. button, document, h2, canvas, etc. or an selector string. If a selector has been specified, it is evaluated immediately before the event is called using the querySelector method.</p></td>
</tr>
<tr>
<tdclass="name"><code>position</code></td>
<tdclass="type">
<spanclass="param-type">Array.<number></span>
|
<spanclass="param-type">object</span>
|
<spanclass="param-type">PIXI.DisplayObject</span>
</td>
<tdclass="default">
The center of the element.
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The local position of the event in the context of the specified HTML element. If no position is specified, the center of the HTML element is used. The position can be specified as an array of numbers, as an object with the two properties x and y, or as a PIXI.Display object.</p></td>
<p>The position in seconds when the event should be triggered, see shttps://greensock.com/docs/TimelineMax/addCallback().</p></td>
</tr>
<tr>
<tdclass="name"><code>opts</code></td>
<tdclass="type">
<spanclass="param-type">object</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>An options object to specify the behaviour of the action.</p>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>onStart</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after the first event is fired. Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>onUpdate</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after each execution of the second event. Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>onComplete</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after the third event is fired. Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>to</code></td>
<tdclass="type">
<spanclass="param-type">Array.<number></span>
|
<spanclass="param-type">object</span>
|
<spanclass="param-type">PIXI.DisplayObject</span>
</td>
<tdclass="default">
{x: 0, y: 0}
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The target of the pan process. The position can be specified as an array of numbers, as an object with the two properties x and y, or as a PIXI.Display object.</p></td>
</tr>
<tr>
<tdclass="name"><code>duration</code></td>
<tdclass="type">
<spanclass="param-type">number</span>
</td>
<tdclass="default">
1
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The duration of the pan animation in seconds, see https://greensock.com/docs/TweenLite/duration().</p></td>
</tr>
<tr>
<tdclass="name"><code>ease</code></td>
<tdclass="type">
<spanclass="param-type">Ease</span>
</td>
<tdclass="default">
Power0.easeNone
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The easing of the pan animation, see https://greensock.com/docs/Easing.</p></td>
</tr>
<tr>
<tdclass="name"><code>eventTypes</code></td>
<tdclass="type">
<spanclass="param-type">Array.<string></span>
</td>
<tdclass="default">
['pointerdown', 'pointermove', 'pointerup']
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The event types to use. If no types are specified, the event types specified in the UITest constructor are used (or auto if not specified).</p></td>
</tr>
<tr>
<tdclass="name"><code>context</code></td>
<tdclass="type">
<spanclass="param-type">Window</span>
|
<spanclass="param-type">Frame</span>
</td>
<tdclass="default">
window
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The context within which the optionally specified element selector should be executed.</p></td>
</tr>
<tr>
<tdclass="name"><code>bubbles</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
true
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The Event property bubbles indicates whether the event bubbles up through the DOM or not.</p></td>
</tr>
<tr>
<tdclass="name"><code>cancelable</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
true
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>Events' cancelable property indicates if the event can be canceled, and therefore prevented as if the event never happened. If the event is not cancelable, then its cancelable property will be false and the event listener cannot stop the event from occurring.</p></td>
<p>Executes a pinch event (pointerdown, pointermove, pointerup) on a specific element with two "fingers" simultaneously.</p>
</div>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>element</code></td>
<tdclass="type">
<spanclass="param-type">HTMLElement</span>
|
<spanclass="param-type">string</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<p>The HTML element on which the event is to be executed, e.g. button, document, h2, canvas, etc. or an selector string. If a selector has been specified, it is evaluated immediately before the event is called using the querySelector method.</p></td>
</tr>
<tr>
<tdclass="name"><code>position</code></td>
<tdclass="type">
<spanclass="param-type">Array.<number></span>
|
<spanclass="param-type">object</span>
|
<spanclass="param-type">PIXI.DisplayObject</span>
</td>
<tdclass="default">
The center of the element.
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The local position of the event in the context of the specified HTML element. If no position is specified, the center of the HTML element is used. The position can be specified as an array of numbers, as an object with the two properties x and y, or as a PIXI.Display object.</p></td>
<p>The position in seconds when the event should be triggered, see shttps://greensock.com/docs/TimelineMax/addCallback().</p></td>
</tr>
<tr>
<tdclass="name"><code>opts</code></td>
<tdclass="type">
<spanclass="param-type">object</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>An options object to specify the behaviour of the action.</p>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>onStart</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after the first events are fired. Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>onUpdate</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after each execution of the second events. Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>onComplete</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after the third events are fired. Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>doubleCallbacks</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
false
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The callbacks onStart, onUpdate and onComplete will be fired only for one finger. If set to true, the events will be fired for both fingers.</p></td>
</tr>
<tr>
<tdclass="name"><code>distance</code></td>
<tdclass="type">
<spanclass="param-type">number</span>
</td>
<tdclass="default">
100
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The distance in pixels, how far the two "fingers" should move apart. If to or bezier specified, distance is ignored.</p></td>
<p>The targets of the pinch process. The position must be an array with two entries. An entry can be specified as an array of numbers, as an object with the two properties x and y, or as a PIXI.Display object. If bezier is specified, to is ignored.</p></td>
<p>The targets of the pinch process. The position must be an array with two entries. An entry may be an array of positions or a bezier object (https://greensock.com/docs/Plugins/BezierPlugin). A position in the array or the values array of the bezier object can be specified as an array of numbers, as an object with the two properties x and y, or as a PIXI.Display object. If bezier is specified, to is ignored.</p></td>
</tr>
<tr>
<tdclass="name"><code>duration</code></td>
<tdclass="type">
<spanclass="param-type">number</span>
</td>
<tdclass="default">
1
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The duration of the pan animation in seconds, see https://greensock.com/docs/TweenLite/duration().</p></td>
</tr>
<tr>
<tdclass="name"><code>ease</code></td>
<tdclass="type">
<spanclass="param-type">Ease</span>
</td>
<tdclass="default">
Power0.easeNone
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The easing of the pan animation, see https://greensock.com/docs/Easing.</p></td>
</tr>
<tr>
<tdclass="name"><code>eventTypes</code></td>
<tdclass="type">
<spanclass="param-type">Array.<string></span>
</td>
<tdclass="default">
['pointerdown', 'pointermove', 'pointerup']
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The event types to use. If no types are specified, the event types specified in the UITest constructor are used (or auto if not specified).</p></td>
</tr>
<tr>
<tdclass="name"><code>context</code></td>
<tdclass="type">
<spanclass="param-type">Window</span>
|
<spanclass="param-type">Frame</span>
</td>
<tdclass="default">
window
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The context within which the optionally specified element selector should be executed.</p></td>
</tr>
<tr>
<tdclass="name"><code>bubbles</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
true
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The Event property bubbles indicates whether the event bubbles up through the DOM or not.</p></td>
</tr>
<tr>
<tdclass="name"><code>cancelable</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
true
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>Events' cancelable property indicates if the event can be canceled, and therefore prevented as if the event never happened. If the event is not cancelable, then its cancelable property will be false and the event listener cannot stop the event from occurring.</p></td>
<p>Executes a tap event (pointerdown, pointerup) on a specific element.</p>
</div>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>element</code></td>
<tdclass="type">
<spanclass="param-type">HTMLElement</span>
|
<spanclass="param-type">string</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<p>The HTML element on which the event is to be executed, e.g. button, document, h2, canvas, etc. or an selector string. If a selector has been specified, it is evaluated immediately before the event is called using the querySelector method.</p></td>
</tr>
<tr>
<tdclass="name"><code>position</code></td>
<tdclass="type">
<spanclass="param-type">Array.<number></span>
|
<spanclass="param-type">object</span>
|
<spanclass="param-type">PIXI.DisplayObject</span>
</td>
<tdclass="default">
The center of the element.
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The local position of the event in the context of the specified HTML element. If no position is specified, the center of the HTML element is used. The position can be specified as an array of numbers, as an object with the two properties x and y, or as a PIXI.Display object.</p></td>
<p>The position in seconds when the event should be triggered, see shttps://greensock.com/docs/TimelineMax/addCallback().</p></td>
</tr>
<tr>
<tdclass="name"><code>opts</code></td>
<tdclass="type">
<spanclass="param-type">object</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>An options object to specify the behaviour of the action.</p>
<tableclass="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Default</th>
<thclass="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<tdclass="name"><code>onStart</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after the first event is fired. Will not be fired if only one event is running (for example, a click event). Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>onComplete</code></td>
<tdclass="type">
<spanclass="param-type">function</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>A function that runs after the second event is fired. Always fired, even if only one event is running (for example, a click event). Receives the fired event object as the first parameter. The test case (UITest) is bound to this.</p></td>
</tr>
<tr>
<tdclass="name"><code>eventTypes</code></td>
<tdclass="type">
<spanclass="param-type">Array.<string></span>
</td>
<tdclass="default">
['pointerdown', 'pointerup']
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The event types to use. If no types are specified, the event types specified in the UITest constructor are used (or auto if not specified).</p></td>
</tr>
<tr>
<tdclass="name"><code>eventType</code></td>
<tdclass="type">
<spanclass="param-type">string</span>
</td>
<tdclass="default">
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>If you want the tap method to fire only one event (for example, a click event), you can specify the opts.eventType parameter. If eventType is not null, the parameter opts.eventTypes is ignored.</p></td>
</tr>
<tr>
<tdclass="name"><code>context</code></td>
<tdclass="type">
<spanclass="param-type">Window</span>
|
<spanclass="param-type">Frame</span>
</td>
<tdclass="default">
window
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The context within which the optionally specified element selector should be executed.</p></td>
</tr>
<tr>
<tdclass="name"><code>bubbles</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
true
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>The Event property bubbles indicates whether the event bubbles up through the DOM or not.</p></td>
</tr>
<tr>
<tdclass="name"><code>cancelable</code></td>
<tdclass="type">
<spanclass="param-type">boolean</span>
</td>
<tdclass="default">
true
</td>
<tdclass="description last">
<spanclass="optional">optional</span>
<p>Events' cancelable property indicates if the event can be canceled, and therefore prevented as if the event never happened. If the event is not cancelable, then its cancelable property will be false and the event listener cannot stop the event from occurring.</p></td>
Documentation generated by <atarget="_blank"href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Aug 08 2019 13:45:13 GMT+0200 (Mitteleuropäische Sommerzeit)
