InitialViewProperties
require(["esri/webmap/InitialViewProperties"], function(InitialViewProperties) { /* code goes here */ });esri/webmap/InitialViewPropertiesConstructors
- new InitialViewProperties(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| ColorBackground | The background color of the WebMap. more details | more details | InitialViewProperties | |
| String | The name of the class. more details | more details | Accessor | |
| SpatialReference | The spatial reference of the WebMap. more details | more details | InitialViewProperties | |
| Viewpoint | The initial viewpoint of the WebMap. more details | more details | InitialViewProperties |
Property Details
- background ColorBackgroundautocast
The background color of the WebMap.
- Default Value:null
- 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 Coordinate System or the Geographic Coordinate System used to locate geographic features in the map.
The initial viewpoint of the WebMap.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| InitialViewProperties | Creates a deep clone of this object. more details | more details | InitialViewProperties | |
| Boolean |
| more details | InitialViewProperties | |
| Boolean |
| more details | InitialViewProperties | |
| Boolean |
| more details | InitialViewProperties | |
| Promise |
| more details | InitialViewProperties |
Method Details
- clone(){InitialViewProperties}
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,truewill 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,truewill 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,truewill 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: acallbackfunction and anerrbackfunction. Thecallbackexecutes when the instance of the class loads. Theerrbackexecutes if the instance of the class fails to load.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
Returns:Type Description Promise Returns a new promise for the result of callbackthat 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 var 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 });