Skip to main content
AnimationDescription.StaggerDelay | staggerDelay property

Gets the amount of time between the application of the animation effect to each object in a target that contains multiple objects. The StaggerDelay, together with the StaggerDelayFactor and DelayLimit, is one of the three elements used to control the relative timing of the animation effects.

Syntax


var staggerDelay = animationDescription.staggerDelay;

public TimeSpan StaggerDelay { get; }

Public ReadOnly Property StaggerDelay As TimeSpan

public:
property TimeSpan StaggerDelay { 
   TimeSpan get();
}

Property value

Type: Number [JavaScript] | System.TimeSpan [.NET] | Windows::Foundation::TimeSpan [C++]

The stagger delay time, expressed in 100-nanosecond units.

Remarks

Consider a target that consists of four objects—labeled A, B, C, and D—with a StaggerDelay of 100 ms. Object A animates at time t=0, object B at time t=100 ms, object C at time t=200 ms, and object D at time t=300 ms.

However, the StaggerDelay time between each object's animation can be changed by the values of the StaggerDelayFactor and DelayLimit. See those topics for a discussion of their effect on the relative animation timing.

Note that an animation can have its own inherent delay in addition to its StaggerDelay.

Requirements (Windows 10 device family)

Device family

Desktop, introduced version 10.0.10240.0

API contract

Windows.UI.Core.Animationmetrics.AnimationmetricsContract, introduced version 1.0

Namespace

Windows.UI.Core.AnimationMetrics
Windows::UI::Core::AnimationMetrics [C++]

Metadata

Windows.UI.Core.Animationmetrics.AnimationmetricsContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

None supported

Namespace

Windows.UI.Core.AnimationMetrics
Windows::UI::Core::AnimationMetrics [C++]

Metadata

Windows.winmd

See also

AnimationDescription
StaggerDelayFactor
DelayLimit
Animation metrics sample