{
  "id": "api/animations/AnimationAnimateRefMetadata",
  "title": "AnimationAnimateRefMetadata",
  "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/AnimationAnimateRefMetadata\", \"name\": \"AnimationAnimateRefMetadata\" } }\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/animation_metadata.ts?message=docs(animations)%3A%20describe%20your%20change...#L355-L373\" 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/animation_metadata.ts#L355-L373\" 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=\"animationanimaterefmetadata\">AnimationAnimateRefMetadata<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/animations/AnimationAnimateRefMetadata#animationanimaterefmetadata\"><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>Encapsulates a reusable animation.\nInstantiated and returned by the <code><a href=\"api/animations/useAnimation\" class=\"code-anchor\">useAnimation</a>()</code> function.</p>\n\n    \n  </section>\n  \n  \n  <section class=\"interface-overview\">\n<code-example language=\"ts\" hidecopy=\"true\">\ninterface <a href=\"api/animations/AnimationAnimateRefMetadata\" class=\"code-anchor\">AnimationAnimateRefMetadata</a> extends <a class=\"code-anchor\" href=\"api/animations/AnimationMetadata\">AnimationMetadata</a> {\n  <a class=\"code-anchor\" href=\"api/animations/AnimationAnimateRefMetadata#animation\"><span class=\"member-name\">animation</span>: AnimationReferenceMetadata</a>\n  <a class=\"code-anchor\" href=\"api/animations/AnimationAnimateRefMetadata#options\"><span class=\"member-name\">options</span>: AnimationOptions | null</a>\n\n  // inherited from <a class=\"code-anchor\" href=\"api/animations/AnimationMetadata\">animations/AnimationMetadata</a>\n  <a class=\"code-anchor\" href=\"api/animations/AnimationMetadata#type\"><span class=\"member-name\">type</span>: AnimationMetadataType</a>\n}\n</code-example>\n\n  \n  \n\n\n  \n  \n\n</section>\n\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/AnimationAnimateRefMetadata#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=\"animation\"></a>\n          <code class=\"\"><span class=\"member-name\"><a href=\"api/animations/animation\" class=\"code-anchor\">animation</a></span>: <a href=\"api/animations/AnimationReferenceMetadata\" class=\"code-anchor\">AnimationReferenceMetadata</a></code>\n        </td>\n        <td>\n          \n          <p>An animation reference object.</p>\n\n          \n          </td>\n    </tr>\n    \n      <tr class=\"instance-property\">\n        <td>\n          <a id=\"options\"></a>\n          <code class=\"\"><span class=\"member-name\">options</span>: <a href=\"api/animations/AnimationOptions\" class=\"code-anchor\">AnimationOptions</a> | null</code>\n        </td>\n        <td>\n          \n          <p>An options object containing a delay and\ndeveloper-defined parameters that provide styling defaults and\ncan be overridden on invocation. Default delay is 0.</p>\n\n          \n          </td>\n    </tr>\n    \n    </tbody>\n  </table>\n</section>\n  \n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/animations\n - api/animations/AnimationMetadata\n - api/animations/useAnimation\n-->\n<!-- links from this doc:\n - /api\n - api/animations\n - api/animations/AnimationAnimateRefMetadata#animation\n - api/animations/AnimationAnimateRefMetadata#animationanimaterefmetadata\n - api/animations/AnimationAnimateRefMetadata#options\n - api/animations/AnimationAnimateRefMetadata#properties\n - api/animations/AnimationMetadata\n - api/animations/AnimationMetadata#type\n - api/animations/AnimationOptions\n - api/animations/AnimationReferenceMetadata\n - api/animations/animation\n - api/animations/useAnimation\n - https://github.com/angular/angular/edit/master/packages/animations/src/animation_metadata.ts?message=docs(animations)%3A%20describe%20your%20change...#L355-L373\n - https://github.com/angular/angular/tree/12.0.0-next.7/packages/animations/src/animation_metadata.ts#L355-L373\n-->"
}