require(["esri/webmap/InitialViewProperties"], (InitialViewProperties) => { /* code goes here */ });
import InitialViewProperties from "@arcgis/core/webmap/InitialViewProperties.js";
esri/webmap/InitialViewProperties
Constructors
-
new InitialViewProperties(properties)
-
Parameterproperties 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 | InitialViewProperties | |
String | The name of the class. more details | Accessor | |
SpatialReference | The spatial reference of the WebMap. more details | InitialViewProperties | |
String | The initial time zone of the WebMap. more details | InitialViewProperties | |
Viewpoint | The initial viewpoint of the WebMap. more details | InitialViewProperties |
Property Details
-
background ColorBackgroundautocast
-
The background color of the WebMap.
- Default Value:null
-
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.
-
timeZone StringSince: ArcGIS Maps SDK for JavaScript 4.28
-
The initial time zone of the WebMap.
Possible Values
Value Description system Dates and times are be displayed in the timezone of the device or browser. unknown Dates and times will be displayed based on the time zone that has been defined for the layer. No adjustments are made to the display of date info. esri:esri/widgets/TimeSlider is disabled. Specified IANA timezone Dates and times will be displayed in the specified IANA time zone. See wikipedia - List of tz database time zones. - See also
-
The initial viewpoint of the WebMap.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
this | Creates a deep clone of this object. more details | InitialViewProperties | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]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.
-
clone(){this}
-
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");