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 API 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
ColorBackgroundmore details

The background color of the WebMap.

more detailsInitialViewProperties
Stringmore details

The name of the class.

more detailsAccessor
SpatialReferencemore details

The spatial reference of the WebMap.

more detailsInitialViewProperties
Viewpointmore details

The initial viewpoint of the WebMap.

more detailsInitialViewProperties

Property Details

The background color of the WebMap.

Default Value:null
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.

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

Name Return Type Summary Class
InitialViewPropertiesmore details

Creates a deep clone of this object.

more detailsInitialViewProperties
Booleanmore details

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

more detailsInitialViewProperties
Booleanmore details

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

more detailsInitialViewProperties
Booleanmore details

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

more detailsInitialViewProperties
Promisemore details

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

more detailsInitialViewProperties

Method Details

Creates a deep clone of this object.

Returns:
Type Description
InitialViewProperties Creates a deep clone of the instance that called this 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(){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.
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.