ViewAnimation

AMD: require(["esri/views/ViewAnimation"], (ViewAnimation) => { /* code goes here */ });
ESM: import ViewAnimation from "@arcgis/core/views/ViewAnimation";
Class: esri/views/ViewAnimation
Inheritance: ViewAnimation Accessor
Since: ArcGIS API for JavaScript 4.0

Contains a state property used for checking the state of the animation. The view animation is resolved when the animation has finished and is rejected if it is stopped.

watchUtils.when(view, "animation", function(animation) {
  console.log(animation.state); // prints out "running"
  animation.when(function(animation) {
      console.log(animation.state); // prints out "finished"
    })
    .catch(function(animation) {
      console.log(animation.state); // prints out "stopped"
    });
});

Alternatively the state property can be watched for changes:

let animation = view.goTo(target, { speedFactor: 0.1 });
animation.watch("state", function(state) {
 switch (state) {
   case "finished":
     console.log("Animation finished.");
     break;
   case "stopped":
     console.log("Animation stopped.");
     break;
 }
});
See also:

Constructors

new ViewAnimation(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The state of the animation.

more detailsViewAnimation
Viewpointmore details

The target of the animation.

more detailsViewAnimation

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

state Stringreadonly

The state of the animation.

The animation terminates when the state is either finished or stopped and cannot transition again to running. The finished state indicates the animation has successfully ended, while the stopped state indicates that the animation was interrupted before it reached its final target.

Possible Values:"running"|"finished"|"stopped"|"waiting-for-target"

Default Value:running
target Viewpoint

The target of the animation.

Method Overview

Name Return Type Summary Class
more details

Finishes the view animation by immediately going to the target and sets the state of the animation to finished.

more detailsViewAnimation
Booleanmore details

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more detailsViewAnimation
Booleanmore details

isRejected() may be used to verify if creating an instance of the class is rejected.

more detailsViewAnimation
Booleanmore details

isResolved() may be used to verify if creating an instance of the class is resolved.

more detailsViewAnimation
more details

Stops the view animation at its current state and sets the state of the animation to stopped.

more detailsViewAnimation
Promisemore details

when() may be leveraged once an instance of the class is created.

more detailsViewAnimation

Method Details

finish()

Finishes the view animation by immediately going to the target and sets the state of the animation to finished.

isFulfilled(){Boolean}

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
stop()

Stops the view animation at its current state and sets the state of the animation to stopped.

when(callback, errback){Promise}
Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.