40 lines
18 KiB
HTML
40 lines
18 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en"><!-- use theme color or fallback -->
|
||
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
||
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="http://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="http://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="http://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><script type="text/javascript">var dox = {rootPath: "../../",platforms: ["Neko","Android","Flash","iOS","macOS","Linux","HTML5","Windows"]};</script><script type="text/javascript" src="../../nav.js"></script><script type="text/javascript" src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"></link><title>js.html.Animation - API Reference</title><meta name="description" content="The <code><a href="../../js/html/Animation.html">Animation</a></code> interface of the Web Animations API represents a single animation player and provides playback controls and a timeline for an animation node or source."/></head><body><style>
|
||
a, code .type {
|
||
color: #24afc4;
|
||
}
|
||
.navbar .brand {
|
||
display: inline-block;
|
||
float: none;
|
||
text-shadow: 0 0 0 transparent;
|
||
}
|
||
.nav-list>.active>a.treeLink, .nav-list>.active>a.treeLink:hover, .nav-list>.active>a.treeLink:focus {
|
||
background: #24afc4;
|
||
color: #ffffff;
|
||
text-shadow: 0 0 0 transparent;
|
||
}
|
||
.navbar .container {
|
||
width: 940px ;
|
||
}
|
||
@media (max-width: 767px) {
|
||
.navbar .container {
|
||
width: auto;
|
||
}
|
||
}
|
||
@media (max-width: 979px) and (min-width: 768px) {
|
||
.navbar .container {
|
||
width: 724px;
|
||
}
|
||
}
|
||
@media (min-width: 1200px) {
|
||
.navbar .container {
|
||
width: 1170px;
|
||
}
|
||
}
|
||
.navbar .container img {
|
||
margin: 5px 0 0 4px;
|
||
}
|
||
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" href="http://www.openfl.org"><img alt="" src="http://www.openfl.org/images/logo.png"/></a><a class="brand" style="color:#777777" href="../../">API Reference</a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="icon-search"></i></span><input id="search" type="text" placeholder="Search" autocomplete="off"/></div></form><div class="dropdown"><select id="select-platform" class="selectpicker" title="Filter by platform" data-width="100%"><option value="all" selected="true">All Platforms</option><option>Neko</option><option>Android</option><option>Flash</option><option>iOS</option><option>macOS</option><option>Linux</option><option>HTML5</option><option>Windows</option></select></div></div><div class="well sidebar-nav"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> Animation</h1><h4><small>package <a href="../../js/html/index.html">js.html</a></small></h4><h4><small>extends <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</a></small></h4> <p class="availability"><hr/><em>Available on HTML5</em></p></div><div class="body"><div class="doc doc-main"><div class="indent"><p>The <code><a href="../../js/html/Animation.html">Animation</a></code> interface of the Web Animations API represents a single animation player and provides playback controls and a timeline for an animation node or source.</p>
|
||
<p>Documentation <a href="https://developer.mozilla.org/en-US/docs/Web/API/Animation">Animation</a> by <a href="https://developer.mozilla.org/en-US/docs/Web/API/Animation$history">Mozilla Contributors</a>, licensed under <a href="https://creativecommons.org/licenses/by-sa/2.5/">CC-BY-SA 2.5</a>.</p><p class="javadoc">See:</p><div class="indent inline-content"><p><a href="https://developer.mozilla.org/en-US/docs/Web/API/Animation">https://developer.mozilla.org/en-US/docs/Web/API/Animation</a></p></div></div></div><h3 class="section">Constructor</h3><div class="fields"><div class="field "><a name="new"></a><h3><p><code><a href="#new"><span class="identifier">new</span></a> (<span style="white-space:nowrap">?effect:<a class="type" title="The KeyframeEffectReadOnly interface of the Web Animations API describes sets of animatable properties and values that can be played using the Animation." href="../../js/html/KeyframeEffectReadOnly.html">KeyframeEffectReadOnly</a>,</span> <span style="white-space:nowrap">?timeline:<a class="type" title="The AnimationTimeline interface of the Web Animations API represents the timeline of an animation." href="../../js/html/AnimationTimeline.html">AnimationTimeline</a></span>)</code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div><h3 class="section">Variables</h3><div class="fields"><div class="field "><a name="currentTime"></a><h3><p><code><a href="../../js/html/Animation.html#currentTime"><span class="identifier">currentTime</span></a>:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="../../Float.html">Float</a></code></p></h3><div class="doc"><p>The current time value of the animation in milliseconds, whether running or paused. If the animation lacks a <code><a href="../../js/html/AnimationTimeline.html">AnimationTimeline</a></code>, is inactive or hasn't been played yet, its value is <code>null</code>.</p></div></div><div class="field "><a name="effect"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Animation.html#effect"><span class="identifier">effect</span></a>:<a class="type" title="The AnimationEffectReadOnly interface of the Web Animations API defines current and future animation effects like KeyframeEffect, which can be passed to Animation objects for playing, and KeyframeEffectReadOnly (which is used by CSS Animations and Transitions)." href="../../js/html/AnimationEffectReadOnly.html">AnimationEffectReadOnly</a></code></p></h3><div class="doc"><p>Gets and sets the <code><a href="../../js/html/AnimationEffectReadOnly.html">AnimationEffectReadOnly</a></code> associated with this animation. This will usually be a <code>KeyframeEffect</code> object.</p></div></div><div class="field "><a name="finished"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Animation.html#finished"><span class="identifier">finished</span></a>:<a class="type" title="" href="../../js/Promise.html">Promise</a><<a class="type" title="The Animation interface of the Web Animations API represents a single animation player and provides playback controls and a timeline for an animation node or source." href="../../js/html/Animation.html">Animation</a>></code></p></h3><div class="doc"><p>Returns the current finished Promise for this animation.</p></div></div><div class="field "><a name="id"></a><h3><p><code><a href="../../js/html/Animation.html#id"><span class="identifier">id</span></a>:<a class="type" title="The basic String class." href="../../String.html">String</a></code></p></h3><div class="doc"><p>Gets and sets the <code><a href="../../String.html">String</a></code> used to identify the animation.</p></div></div><div class="field "><a name="oncancel"></a><h3><p><code><a href="../../js/html/Animation.html#oncancel"><span class="identifier">oncancel</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Gets and sets the event handler for the <code>cancel</code> event.</p></div></div><div class="field "><a name="onfinish"></a><h3><p><code><a href="../../js/html/Animation.html#onfinish"><span class="identifier">onfinish</span></a>:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a></code></p></h3><div class="doc"><p>Gets and sets the event handler for the <code>finish</code> event.</p></div></div><div class="field "><a name="playState"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Animation.html#playState"><span class="identifier">playState</span></a>:<a class="type" title="" href="../../js/html/AnimationPlayState.html">AnimationPlayState</a></code></p></h3><div class="doc"><p>Returns an enumerated value describing the playback state of an animation.</p></div></div><div class="field "><a name="playbackRate"></a><h3><p><code><a href="../../js/html/Animation.html#playbackRate"><span class="identifier">playbackRate</span></a>:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="../../Float.html">Float</a></code></p></h3><div class="doc"><p>Gets or sets the playback rate of the animation.</p></div></div><div class="field "><a name="ready"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Animation.html#ready"><span class="identifier">ready</span></a>:<a class="type" title="" href="../../js/Promise.html">Promise</a><<a class="type" title="The Animation interface of the Web Animations API represents a single animation player and provides playback controls and a timeline for an animation node or source." href="../../js/html/Animation.html">Animation</a>></code></p></h3><div class="doc"><p>Returns the current ready Promise for this animation.</p></div></div><div class="field "><a name="startTime"></a><h3><p><code><a href="../../js/html/Animation.html#startTime"><span class="identifier">startTime</span></a>:<a class="type" title="The standard Float type, this is a double-precision IEEE 64bit float." href="../../Float.html">Float</a></code></p></h3><div class="doc"><p>Gets or sets the scheduled time when an animation's playback should begin.</p></div></div><div class="field "><a name="timeline"></a><h3><p><code><span class="label">read only</span><a href="../../js/html/Animation.html#timeline"><span class="identifier">timeline</span></a>:<a class="type" title="The AnimationTimeline interface of the Web Animations API represents the timeline of an animation." href="../../js/html/AnimationTimeline.html">AnimationTimeline</a></code></p></h3><div class="doc"><p>Gets or sets the <code><a href="../../js/html/AnimationTimeline.html">AnimationTimeline</a></code> associated with this animation.</p></div></div></div><h3 class="section">Methods</h3><div class="fields"><div class="field "><a name="cancel"></a><h3><p><code><a href="#cancel"><span class="identifier">cancel</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p>Clears all <code>KeyframeEffect</code> caused by this animation and aborts its playback.</p></div></div><div class="field "><a name="finish"></a><h3><p><code><a href="#finish"><span class="identifier">finish</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="pause"></a><h3><p><code><a href="#pause"><span class="identifier">pause</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="play"></a><h3><p><code><a href="#play"><span class="identifier">play</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="reverse"></a><h3><p><code><a href="#reverse"><span class="identifier">reverse</span></a> ():<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div> <div class="inherited-fields well"><h3 class="section">Inherited Variables</h3><div class="fields"><div style="display:none"></div></div><h3 class="section">Inherited Methods</h3><div class="fields"><h4><a href="#" class="expand-button"><i class="fa fa-arrow-circle-o-right"></i></a> Defined by <a class="type" title="EventTarget is an interface implemented by objects that can receive events and may have listeners for them." href="../../js/html/EventTarget.html">EventTarget</a></h4><div style="display:none"><div class="field "><a name="addEventListener"></a><h3><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#addEventListener"><span class="identifier">addEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false,</span> <span style="white-space:nowrap">?wantsUntrusted:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="dispatchEvent"></a><h3><p><code><a href="#dispatchEvent"><span class="identifier">dispatchEvent</span></a> (<span style="white-space:nowrap">event:<a class="type" title="The Event interface represents any event which takes place in the DOM; some are user-generated (such as mouse or keyboard events), while others are generated by APIs (such as events that indicate an animation has finished running, a video has been paused, and so forth)." href="../../js/html/Event.html">Event</a></span>):<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div><div class="field "><a name="removeEventListener"></a><h3><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This type unifies with any function type." href="../../haxe/Function.html">Function</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p><p><code><a href="#removeEventListener"><span class="identifier">removeEventListener</span></a> (<span style="white-space:nowrap">type:<a class="type" title="The basic String class." href="../../String.html">String</a>,</span> <span style="white-space:nowrap">listener:<a class="type" title="This method is called whenever an event occurs of the type for which the EventListener interface was registered." href="../../js/html/EventListener.html">EventListener</a>,</span> <span style="white-space:nowrap">capture:<a class="type" title="The standard Boolean type, which can either be true or false." href="../../Bool.html">Bool</a> = false</span>):<a class="type" title="The standard Void type." href="../../Void.html">Void</a></code></p></h3><div class="doc"><p class="javadoc">Throws:</p><table class="table table-bordered params"><div class="indent inline-content"><tr><th width="25%"><code>null</code></th><td><p>DOMError</p></td></tr></div></table></div></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#777777">© 2017 <a style="color:#777777" href="http://www.openfl.org">http://www.openfl.org</a></p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html> |