5 lines
37 KiB
JSON
5 lines
37 KiB
JSON
{
|
|
"id": "api/animations/AnimationPlayer",
|
|
"title": "AnimationPlayer",
|
|
"contents": "\n\n<article>\n <div class=\"breadcrumb-container\">\n <div class=\"breadcrumb\">\n <script type=\"application/ld+json\">\n {\n \"@context\": \"http://schema.org\",\n \"@type\": \"BreadcrumbList\",\n \"itemListElement\": [\n { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://angular.io//api\", \"name\": \"API\" } },\n { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://angular.io/api/animations\", \"name\": \"@angular/animations\" } },\n { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://angular.io/api/animations/AnimationPlayer\", \"name\": \"AnimationPlayer\" } }\n ]\n }\n </script>\n <a href=\"/api\">API</a> > <a href=\"api/animations\">@angular/animations</a>\n </div>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L9-L107\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L9-L107\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n \n <header class=\"api-header\">\n <h1 id=\"animationplayer\">AnimationPlayer<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#animationplayer\"><i class=\"material-icons\">link</i></a></h1>\n \n <label class=\"api-type-label interface\">interface</label>\n \n \n \n </header>\n \n <aio-toc class=\"embedded\"></aio-toc>\n\n <div class=\"api-body\">\n \n <section class=\"short-description\">\n <p>Provides programmatic control of a reusable animation sequence,\nbuilt using the <code>build()</code> method of <code><a href=\"api/animations/AnimationBuilder\" class=\"code-anchor\">AnimationBuilder</a></code>. The <code>build()</code> method\nreturns a factory, whose <code>create()</code> method instantiates and initializes this interface.</p>\n\n \n </section>\n \n \n <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/animations/AnimationPlayer\" class=\"code-anchor\">AnimationPlayer</a> {\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#parentPlayer\"><span class=\"member-name\">parentPlayer</span>: AnimationPlayer | null</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#totalTime\"><span class=\"member-name\">totalTime</span>: number</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#beforeDestroy\"><span class=\"member-name\">beforeDestroy</span>?: () => any</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#onDone\"><span class=\"member-name\">onDone</span>(fn: () => void): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#onStart\"><span class=\"member-name\">onStart</span>(fn: () => void): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#onDestroy\"><span class=\"member-name\">onDestroy</span>(fn: () => void): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#init\"><span class=\"member-name\">init</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#hasStarted\"><span class=\"member-name\">hasStarted</span>(): boolean</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#play\"><span class=\"member-name\">play</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#pause\"><span class=\"member-name\">pause</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#restart\"><span class=\"member-name\">restart</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#finish\"><span class=\"member-name\">finish</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#destroy\"><span class=\"member-name\">destroy</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#reset\"><span class=\"member-name\">reset</span>(): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#setPosition\"><span class=\"member-name\">setPosition</span>(position: any): void</a>\n <a class=\"code-anchor\" href=\"api/animations/AnimationPlayer#getPosition\"><span class=\"member-name\">getPosition</span>(): number</a>\n}\n</code-example>\n\n \n \n\n\n \n \n <div class=\"descendants class\">\n <h2 id=\"class-implementations\">Class implementations<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#class-implementations\"><i class=\"material-icons\">link</i></a></h2>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/animations/NoopAnimationPlayer\" class=\"code-anchor\">NoopAnimationPlayer</a></code>\n \n\n<ul>\n \n <li>\n <code><a href=\"api/animations/browser/testing/MockAnimationPlayer\" class=\"code-anchor\">MockAnimationPlayer</a></code>\n \n\n\n </li>\n \n</ul>\n\n\n </li>\n \n</ul>\n\n\n </div>\n \n\n</section>\n\n \n<section class=\"see-also\">\n <h2 id=\"see-also\">See also<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#see-also\"><i class=\"material-icons\">link</i></a></h2>\n <ul>\n \n <li><p><code><a href=\"api/animations/AnimationBuilder\" class=\"code-anchor\">AnimationBuilder</a></code></p>\n</li>\n <li><p><code><a href=\"api/animations/AnimationFactory\" class=\"code-anchor\">AnimationFactory</a></code></p>\n</li>\n <li><p><code><a href=\"api/animations/animate\" class=\"code-anchor\">animate</a>()</code></p>\n</li>\n </ul>\n</section>\n\n\n \n \n \n<section class=\"instance-properties\">\n <h2 id=\"properties\">Properties<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#properties\"><i class=\"material-icons\">link</i></a></h2>\n <table class=\"is-full-width list-table property-table\">\n <thead>\n <tr>\n <th>Property</th>\n <th>Description</th>\n </tr>\n </thead>\n <tbody>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"parentPlayer\"></a>\n <code class=\"\"><span class=\"member-name\">parentPlayer</span>: <a href=\"api/animations/AnimationPlayer\" class=\"code-anchor\">AnimationPlayer</a> | null</code>\n </td>\n <td>\n \n <p>The parent of this player, if any.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"totalTime\"></a>\n <code class=\"\"><span class=\"member-name\">totalTime</span>: number</code>\n </td>\n <td><span class=\"read-only-property\">Read-Only</span>\n \n <p>The total run time of the animation, in milliseconds.</p>\n\n \n </td>\n </tr>\n \n <tr class=\"instance-property\">\n <td>\n <a id=\"beforeDestroy\"></a>\n <code class=\"\"><span class=\"member-name\">beforeDestroy</span>?: () => any</code>\n </td>\n <td>\n \n <p>Provides a callback to invoke before the animation is destroyed.</p>\n\n \n </td>\n </tr>\n \n </tbody>\n </table>\n</section>\n \n\n<section class=\"instance-methods\">\n <h2 id=\"methods\">Methods<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#methods\"><i class=\"material-icons\">link</i></a></h2>\n \n <a id=\"onDone\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"ondone\">\n onDone()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#ondone\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L22-L27\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L22-L27\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Provides a callback to invoke when the animation finishes.</p>\n\n <p>See also:</p>\n <ul>\n \n <li><p><code>finish()</code></p>\n</li>\n </ul>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">onDone</span>(fn: () => void): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>fn</code>\n </td>\n <td class=\"param-type\"><code>() => void</code></td>\n <td class=\"param-description\">\n <p>The callback function.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"onStart\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"onstart\">\n onStart()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#onstart\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L28-L33\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L28-L33\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Provides a callback to invoke when the animation starts.</p>\n\n <p>See also:</p>\n <ul>\n \n <li><p><code>run()</code></p>\n</li>\n </ul>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">onStart</span>(fn: () => void): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-1\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>fn</code>\n </td>\n <td class=\"param-type\"><code>() => void</code></td>\n <td class=\"param-description\">\n <p>The callback function.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-1\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"onDestroy\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"ondestroy\">\n onDestroy()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#ondestroy\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L34-L40\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L34-L40\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Provides a callback to invoke after the animation is destroyed.</p>\n\n <p>See also:</p>\n <ul>\n \n <li><p><code>destroy()</code></p>\n</li>\n <li><p><code>beforeDestroy()</code></p>\n</li>\n </ul>\n \n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">onDestroy</span>(fn: () => void): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-2\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>fn</code>\n </td>\n <td class=\"param-type\"><code>() => void</code></td>\n <td class=\"param-description\">\n <p>The callback function.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-2\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"init\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"init\">\n init()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#init\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L41-L44\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L41-L44\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Initializes the animation.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">init</span>(): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-3\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-3\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"hasStarted\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"hasstarted\">\n hasStarted()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#hasstarted\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L45-L49\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L45-L49\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Reports whether the animation has started.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">hasStarted</span>(): boolean</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-4\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-4\">Returns</h6>\n <p><code>boolean</code>: True if the animation has started, false otherwise.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"play\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"play\">\n play()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#play\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L50-L53\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L50-L53\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Runs the animation, invoking the <code>onStart()</code> callback.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">play</span>(): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-5\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-5\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"pause\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"pause\">\n pause()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#pause\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L54-L57\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L54-L57\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Pauses the animation.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">pause</span>(): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-6\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-6\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"restart\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"restart\">\n restart()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#restart\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L58-L61\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L58-L61\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Restarts the paused animation.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">restart</span>(): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-7\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-7\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"finish\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"finish\">\n finish()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#finish\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L62-L65\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L62-L65\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Ends the animation, invoking the <code>onDone()</code> callback.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">finish</span>(): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-8\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-8\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"destroy\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"destroy\">\n destroy()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#destroy\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L66-L70\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L66-L70\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Destroys the animation, after invoking the <code>beforeDestroy()</code> callback.\nCalls the <code>onDestroy()</code> callback when destruction is completed.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">destroy</span>(): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-9\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-9\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"reset\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"reset\">\n reset()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#reset\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L71-L74\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L71-L74\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Resets the animation to its initial state.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">reset</span>(): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-10\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-10\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"setPosition\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"setposition\">\n setPosition()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#setposition\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L75-L79\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L75-L79\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Sets the position of the animation.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">setPosition</span>(position: any): void</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-11\">Parameters</h6>\n <table class=\"is-full-width list-table parameters-table instance-method-overload-parameters\">\n <tbody>\n \n <tr class=\"instance-method-overload-parameter\">\n <td class=\"param-name\">\n <a id=\"\"></a>\n <code>position</code>\n </td>\n <td class=\"param-type\"><code>any</code></td>\n <td class=\"param-description\">\n <p>A 0-based offset into the duration, in milliseconds.</p>\n\n </td>\n </tr>\n </tbody>\n</table>\n\n \n <h6 class=\"no-anchor\" id=\"returns-11\">Returns</h6>\n <p><code>void</code></p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n <a id=\"getPosition\"></a>\n<table class=\"is-full-width method-table instance-method\">\n <thead><tr><th>\n <div class=\"with-github-links\">\n <h3 id=\"getposition\">\n getPosition()\n \n <a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationPlayer#getposition\"><i class=\"material-icons\">link</i></a></h3>\n <div class=\"github-links\">\n <a href=\"https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L80-L84\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n <a href=\"https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L80-L84\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n </div>\n </th></tr></thead>\n <tbody>\n <tr>\n <td class=\"short-description\">\n <p>Reports the current position of the animation.</p>\n\n </td>\n </tr>\n \n <tr>\n <td>\n <div class=\"overload-info\">\n \n\n <code-example language=\"ts\" hidecopy=\"true\" class=\"no-box api-heading\"><span class=\"member-name\">getPosition</span>(): number</code-example>\n\n \n\n <h6 class=\"no-anchor\" id=\"parameters-12\">Parameters</h6>\n <p>There are no parameters.</p>\n\n \n <h6 class=\"no-anchor\" id=\"returns-12\">Returns</h6>\n <p><code><a href=\"api/common/DecimalPipe\" class=\"code-anchor\">number</a></code>: A 0-based offset into the duration, in milliseconds.</p>\n\n \n\n\n \n\n \n</div>\n </td>\n </tr>\n \n\n \n\n \n </tbody>\n</table>\n\n \n</section>\n\n\n \n\n\n </div>\n</article>\n\n<!-- links to this doc:\n - api/animations\n - api/animations/AnimationBuilder\n - api/animations/AnimationFactory\n - api/animations/NoopAnimationPlayer\n-->\n<!-- links from this doc:\n - /api\n - api/animations\n - api/animations/AnimationBuilder\n - api/animations/AnimationFactory\n - api/animations/AnimationPlayer#animationplayer\n - api/animations/AnimationPlayer#beforeDestroy\n - api/animations/AnimationPlayer#class-implementations\n - api/animations/AnimationPlayer#destroy\n - api/animations/AnimationPlayer#finish\n - api/animations/AnimationPlayer#getPosition\n - api/animations/AnimationPlayer#getposition\n - api/animations/AnimationPlayer#hasStarted\n - api/animations/AnimationPlayer#hasstarted\n - api/animations/AnimationPlayer#init\n - api/animations/AnimationPlayer#methods\n - api/animations/AnimationPlayer#onDestroy\n - api/animations/AnimationPlayer#onDone\n - api/animations/AnimationPlayer#onStart\n - api/animations/AnimationPlayer#ondestroy\n - api/animations/AnimationPlayer#ondone\n - api/animations/AnimationPlayer#onstart\n - api/animations/AnimationPlayer#parentPlayer\n - api/animations/AnimationPlayer#pause\n - api/animations/AnimationPlayer#play\n - api/animations/AnimationPlayer#properties\n - api/animations/AnimationPlayer#reset\n - api/animations/AnimationPlayer#restart\n - api/animations/AnimationPlayer#see-also\n - api/animations/AnimationPlayer#setPosition\n - api/animations/AnimationPlayer#setposition\n - api/animations/AnimationPlayer#totalTime\n - api/animations/NoopAnimationPlayer\n - api/animations/animate\n - api/animations/browser/testing/MockAnimationPlayer\n - api/common/DecimalPipe\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L22-L27\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L28-L33\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L34-L40\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L41-L44\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L45-L49\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L50-L53\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L54-L57\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L58-L61\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L62-L65\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L66-L70\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L71-L74\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L75-L79\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L80-L84\n - https://github.com/angular/angular/edit/master/packages/animations/src/players/animation_player.ts?message=docs(animations)%3A%20describe%20your%20change...#L9-L107\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L22-L27\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L28-L33\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L34-L40\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L41-L44\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L45-L49\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L50-L53\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L54-L57\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L58-L61\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L62-L65\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L66-L70\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L71-L74\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L75-L79\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L80-L84\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/players/animation_player.ts#L9-L107\n-->"
|
|
} |