InitialViewProperties | References | ArcGIS Maps SDK for JavaScript

import InitialViewProperties from "@arcgis/core/webmap/InitialViewProperties.js";

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`InitialViewPropertiesProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`background`	`ColorBackground \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`spatialReference`	`SpatialReference \| null \| undefined`
`timeExtent`	`TimeExtent \| null \| undefined`
`timeZone`	`TimeZone`
`viewpoint`	`Viewpoint \| null \| undefined`

background

autocast Property

Type: ColorBackground | null | undefined

The background color of the WebMap.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

spatialReference

autocast Property

Type: SpatialReference | null | undefined

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.

timeExtent

autocast Property

Type: TimeExtent | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.31

The initial time extent of the WebMap.

timeZone

Property

Type: TimeZone

Since: 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. Additionally, the 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.

If the view’s MapView.timeZone is set to unknown and a layer’s date/time field includes time information, set the DateTimeFieldFormat.timeStyle property to either long or full on the corresponding date/time field.

See also

MapView.timeZone

viewpoint

autocast Property

Type: Viewpoint | null | undefined

The initial viewpoint of the WebMap.

Methods

Method	Signature	Class
`clone` inherited	`clone(): this`	ClonableMixin

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
A deep clone of the class instance that invoked this method.