Class AnimationTrigger

constructor

• new AnimationTrigger(
      propertyName: string,
      animationSettings?: { duration?: number; easing?: EasingFunction; finished?: (animation: Animation) => void },
      startCondition?: TriggerStart,
  ): AnimationTrigger

  This constructor creates an AnimationTrigger. These are typically constructed within Part templates.

   // ...
   new go.Shape(
     {
       // ... Shape properties
     })
     // Animate all changes to Shape.opacity immediately
     .trigger("opacity", null, go.TriggerStart.Immediate)
  Copy

  Parameters

  • propertyName: string

    A string naming the target property to animate. This should not be the empty string.

  • OptionalanimationSettings: { duration?: number; easing?: EasingFunction; finished?: (animation: Animation) => void }

    An optional Object describing properties to set on animations created by this AnimationTrigger. See the animationSettings property for detail. If specified, this also sets the startCondition to TriggerStart.Immediate.

  • OptionalstartCondition: TriggerStart

    An optional TriggerStart to set the startCondition property.

  Returns AnimationTrigger

animationSettings

• get animationSettings(): { duration?: number; easing?: EasingFunction; finished?: (animation: Animation) => void }

  These settings are only used if the startCondition is TriggerStart.Immediate. Creating a new AnimationTrigger with animationSettings in the constructor automatically sets startCondition to TriggerStart.Immediate

  This gets or sets the settings for any Animations this trigger creates. Immediate triggers create a new Animation with each triggering, and apply these settings to that Animation.

  This can be set to an object with a subset of possible Animation settings. The default value is null, which keeps default Animation settings.

  Since a startCondition of TriggerStart.Bundled uses the default animation, you must set the properties of AnimationManager.defaultAnimation, and not this property, to modify the animation settings.

  To set default settings for all created Animations, you can modify the settings on AnimationManager instead, such as AnimationManager.duration.

  Possible properties to set in this object are:

  • duration: a number, corresponding to Animation.duration.
  • finished: a Function, corresponding to Animation.finished.
  • easing: an EasingFunction, corresponding to Animation.easing.

  Returns { duration?: number; easing?: EasingFunction; finished?: (animation: Animation) => void }

propertyName

• get propertyName(): string

  Gets or sets the name of the property to animate on the target GraphObject. The default value is set during constructor initialization.

  You can only specify properties that exist on the GraphObject, and are also registered with AnimationManager.defineAnimationEffect. By default these properties are the same as the list of possible Animation effects:

  • "position"
  • "location" (on Parts)
  • "scale"
  • "opacity"
  • "angle"
  • "desiredSize"
  • "background"
  • "fill" (on Shapes)
  • "strokeWidth" (on Shapes)
  • "strokeDashOffset" (on Shapes)
  • "stroke" (on Shapes, TextBlocks)

  Examples of defining additional properties by adding animation effects are given in the Learn page on Animations.

  Returns string

startCondition

• get startCondition(): TriggerStart

  Gets or sets the starting condition for this trigger.

  AnimationTriggers can invoke an animation immediately, starting a new animation with each property of each GraphObject that has been modified, or they can (more efficiently) be bundled together into the default animation (AnimationManager.defaultAnimation) and begin only one animation, at the end of the next transaction.

  It is useful for the startCondition to be TriggerStart.Immediate when changing GraphObject properties on GraphObject.mouseEnter or GraphObject.mouseLeave. It is useful for the startCondition to be TriggerStart.Bundled when changing several GraphObject properties together, such as when highlighting multiple parts, on selection changes, and during transactions, or when performance is a consideration.

  These behaviors can be set with the values TriggerStart.Immediate and TriggerStart.Bundled, respectively. The default value, TriggerStart.Default, attempts to infer which is best: It will start immediately if there is no ongoing transaction or if Diagram.skipsUndoManager is true, and otherwise bundle them.

  Returns TriggerStart

Virtualcopy

• copy(): AnimationTrigger

  Create a copy of this AnimationTrigger, with the same property values.

  Returns AnimationTrigger

Static ReadonlyBundled

Static ReadonlyDefault

Static ReadonlyImmediate