ESM: import ViewAnimation from "@arcgis/core/views/ViewAnimation.js";
CDN: const ViewAnimation = await $arcgis.import("@arcgis/core/views/ViewAnimation.js");
Class: @arcgis/core/views/ViewAnimation
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;
}
}
); new ViewAnimation(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
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 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"
The target of the animation.
Show inherited methods Hide inherited methods
Name Return Type Summary Class addHandles()Adds one or more handles which are to be tied to the lifecycle of the object.
Accessor finish()Finishes the view animation by immediately going to the target and sets the state of the animation to finished.
Returns true if a named group of handles exist.
Accessor isFulfilled() BooleanisFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
isRejected() may be used to verify if creating an instance of the class is rejected.
isResolved() may be used to verify if creating an instance of the class is resolved.
Removes a group of handles owned by the object.
Accessor stop()Stops the view animation at its current state and sets the state of the animation to stopped.
Promise
when() may be leveraged once an instance of the class is created.
Inherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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.
Finishes the view animation by immediately going to the target and sets the state of the animation to finished.
Inherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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(){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.Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");Stops the view animation at its current state and sets the state of the animation to stopped.
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
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new promise for the result ofcallback 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
});RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4