figureone
    Preparing search index...

    Interface OBJ_AnimationDefinition

    An animation definition object defines an animation in a json like object.

    One key of the object defines the animation to use, while the remaining keys are the properties of the animation.

    The value of the key (with the exception of the delay key) that defines the animation is a TypeElementPath defining which elements to apply the animation to. When using delay, the value will be a number in seconds.

    The remaining keys in the object then come from the definition objects of the associated animation.

    The possible key names that define animations are:

    • delay: delay where value is number in seconds
    • in: dissolve in with OBJ_ElementAnimationStep options where duration is dissolve in time
    • out: dissolve out with OBJ_ElementAnimationStep options where duration is dissolve out time
    • rotation: OBJ_RotationAnimationStep
    • position: OBJ_PositionAnimationStep
    • scale: OBJ_ScaleAnimationStep
    • scenario: OBJ_ScenarioAnimationStep
    • scenarios: OBJ_ScenariosAnimationStep
    • pulseWidth: OBJ_PulseWidthAnimationStep
    • length: OBJ_LengthAnimationStep
    • pulseAngle: OBJ_PulseAngleAnimationStep
    • pulse: OBJ_PulseAnimationStep
    • dim: dim animation step with OBJ_ElementAnimationStep options where duration is dim duration
    • undim: dim animation step with OBJ_ElementAnimationStep options where duration is undim duration
    • trigger: OBJ_TriggerAnimationStep
    • goToForm: OBJ_TriggerAnimationStep

    Several animation steps will automatically set their final targets just before steadyStateCommon is set. This means, if the slide is navigated to from a slide that doesn't trigger the transition, then these targets will still be set. In many cases, this reduces doubling up desired steady state targets when defining a slide. However, if the target should not be automatically set, then use final: false in the animation steps's options to disable this behavor. The animations that automatically set targets are:

    • in
    • out
    • scenario
    • dim
    • undim
    • rotation
    • position
    • scale

    If a transition definition contains in or out animation steps, then before the transition starts, the elements that will dissolve in are automatically hidden, and the elements that will dissolve out are automatically shown. If this behavior is not wanted, then for out steps use show: false in the animation step definition, and for in steps use show: true.