• esri/webmap

InitialViewProperties

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

Represents the initial viewing state of the WebMap when displayed in a MapView.

Constructors

new InitialViewProperties(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
ColorBackground

The background color of the WebMap.

more details
InitialViewProperties
String

The name of the class.

more details
Accessor
SpatialReference

The spatial reference of the WebMap.

more details
InitialViewProperties
Viewpoint

The initial viewpoint of the WebMap.

more details
InitialViewProperties

Property Details

The background color of the WebMap.

Default Value:null
declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK for JavaScript 4.7

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

spatialReference SpatialReferenceautocast

The spatial reference of the WebMap. This indicates the projected or geographic coordinate system used to locate geographic features in the map. For complete listings of supported coordinate systems, see Using spatial references.

viewpoint Viewpointautocast

The initial viewpoint of the WebMap.

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.

more details
Accessor
InitialViewProperties

Creates a deep clone of this object.

more details
InitialViewProperties
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Boolean

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

more details
InitialViewProperties
Boolean

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

more details
InitialViewProperties
Boolean

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

more details
InitialViewProperties

Removes a group of handles owned by the object.

more details
Accessor
Promise

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

more details
InitialViewProperties

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

Creates a deep clone of this object.

Returns
Type Description
InitialViewProperties Creates a deep clone of the instance that called this method.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 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(){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.
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 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");
when(callback, errback){Promise}
Since: ArcGIS Maps SDK 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.