--- schema_version: "1" id: d37d7bf161ea0a52dd2c856b8b80ac800c9eb38ce8e4e649b8540117ef72fc28 title: AnimationRule collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_animationrule.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_animationrule.htm source_site: developer.salesforce.com content_type: documentation content_hash: 73807ee6bd1eea6204c1c97f8cba069abb825695bfa653c42cc5e12b364ba356 description: Represents criteria for determining when an animation is displayed to Path users.This type extends the Metadata metadata type and inherits its fullName field. --- # AnimationRule Represents criteria for determining when an animation is displayed to Path users.This type extends the Metadata metadata type and inherits its fullName field. ![Important](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/images/icon_note_important.png) #### Important Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations. ## File Suffix and Directory Location AnimationRule components have the suffix animationRule and are stored in the animationRules folder. ## Version AnimationRule components are available in API version 46.0 and later. ## Fields
Field Name Field Type Description
animationFrequency picklist Required. The frequency with which an animation is displayed when a user selects the designated picklist values in a path. Valid values are:
  • always
  • often
  • sometimes
  • rarely
A value of always triggers an animation every time. The values often, sometimes, and rarely trigger an animation progressively less frequently.
developerName string Required. The developer name for the animation rule.
Note

Note

Only users with View DeveloperName OR View Setup and Configuration permission can view, group, sort, and filter this field.
isActive boolean Required. Indicates whether the animation rule is active (true) or not (false).
masterLabel string Required. The label for the animation rule.
recordTypeContext picklist Required. An enum to track whether this AnimationRule applies to all record types for the associated sObject, or only to a single or main record type. Valid values are All, Master, or Custom.
recordTypeName reference The record type selected for the sObject in which the animation is displayed.
sobjectType string The object on which the animation rule is run.
targetField string Required. Name of the field used to determine when to display an animation.
targetFieldChangeToValues string Required. Values used to determine when to display an animation. When a user selects a value in targetField that matches a value stored in targetFieldChangeToValues, the animation is displayed.
## Declarative Metadata Sample Definition The following is an example of an AnimationRule component. Always AnimationRule\_DeveloperName true AnimationRule Label All \_\_MASTER\_\_ Opportunity StageName Delivered, Negotiating, Closed Won The following is an example package.xml that references the AnimationRule component. PathAssistant Settings AnimationRule\_Developer\_Name AnimationRule 46.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).