InitialViewProperties

AMD: require(["esri/webmap/InitialViewProperties"], (InitialViewProperties) => { /* code goes here */ });
ESM: import InitialViewProperties from "@arcgis/core/webmap/InitialViewProperties.js";
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

InitialViewProperties

Constructor
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.

InitialViewProperties
String

The name of the class.

Accessor
SpatialReference

The spatial reference of the WebMap.

InitialViewProperties
String

The initial time zone of the WebMap.

InitialViewProperties
Viewpoint

The initial viewpoint of the WebMap.

InitialViewProperties

Property Details

background

Property
background ColorBackgroundautocast

The background color of the WebMap.

Default Value:null

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
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.

spatialReference

Property
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

Property
timeZone String
Since: ArcGIS Maps SDK for JavaScript 4.28 InitialViewProperties since 4.0, timeZone added at 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

viewpoint

Property
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.

Accessor
this

Creates a deep clone of this object.

InitialViewProperties
Boolean

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
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
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.

clone

Method
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.

Returns
Type Description
this A deep clone of the class instance that invoked this method.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
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 *
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");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
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 *
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");

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.