ViewAnimation

AMD: require(["esri/views/ViewAnimation"], (ViewAnimation) => { /* code goes here */ });
ESM: import ViewAnimation from "@arcgis/core/views/ViewAnimation.js";
Class: esri/views/ViewAnimation
Inheritance: ViewAnimation Accessor
Since: ArcGIS Maps SDK 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.

reactiveUtils.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 });

reactiveUtils.watch(
  () => animation.state,
  (state) => {
    switch (state) {
      case "finished":
        console.log("Animation finished.");
        break;
      case "stopped":
        console.log("Animation stopped.");
        break;
    }
  }
);
See also

Constructors

ViewAnimation

Constructor
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
String

The name of the class.

Accessor
String

The state of the animation.

ViewAnimation
Viewpoint

The target of the animation.

ViewAnimation

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

state

Property
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

Property
target Viewpoint

The target of the animation.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor

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

ViewAnimation
Boolean

Returns true if a named group of handles exist.

Accessor
Boolean

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

ViewAnimation
Boolean

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

ViewAnimation
Boolean

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

ViewAnimation

Removes a group of handles owned by the object.

Accessor

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

ViewAnimation
Promise

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

ViewAnimation

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

finish

Method
finish()

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

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled

Method
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

Method
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

Method
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.

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

stop

Method
stop()

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

when

Method
when(callback, errback){Promise}
Since: ArcGIS Maps SDK for JavaScript 4.6 ViewAnimation since 4.0, when added at 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.