ViewState

AMD: require(["esri/views/2d/ViewState"], (ViewState) => { /* code goes here */ });
ESM: import ViewState from "@arcgis/core/views/2d/ViewState.js";
Class: esri/views/2d/ViewState
Inheritance: ViewState Accessor
Since: ArcGIS Maps SDK for JavaScript 4.8

Object that holds information about the MapView state.

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

Represents the view's center point as an array of two numbers [x, y].

ViewState

The name of the class.

Accessor

The extent represents the visible portion of a map within the view as an instance of Extent.

ViewState

Represents the size of one pixel in map units.

ViewState

The clockwise rotation of due north in relation to the top of the view in degrees.

ViewState

Represents the map scale at the center of the view.

ViewState

Represents the width and height of the view in pixels, e.g.

ViewState

Property Details

center

Property
center Number[]readonly

Represents the view's center point as an array of two numbers [x, y].

See also

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

extent

Property
extent Extentreadonly

The extent represents the visible portion of a map within the view as an instance of Extent.

See also

resolution

Property
resolution Numberreadonly
Since: ArcGIS Maps SDK for JavaScript 4.9 ViewState since 4.8, resolution added at 4.9.

Represents the size of one pixel in map units. The value of resolution is the result of the division of the extent width by the size.

rotation

Property
rotation Numberreadonly

The clockwise rotation of due north in relation to the top of the view in degrees.

See also

scale

Property
scale Numberreadonly

Represents the map scale at the center of the view.

See also

size

Property
size Number[]readonly

Represents the width and height of the view in pixels, e.g. [width, height].

See also

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

Creates a deep clone of ViewState object.

ViewState

Copies the properties from a given view state.

ViewState
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

ViewState

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

ViewState

Converts the x and y screen coordinates to map coordinates.

ViewState

Converts the x and y map coordinates to screen coordinates.

ViewState

Converts the x and y map coordinates to screen coordinates.

ViewState

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(){ViewState}

Creates a deep clone of ViewState object.

Returns
Type Description
ViewState A new instance of a ViewState object equal to the object used to call .clone().

copy

Method
copy(state){ViewState}

Copies the properties from a given view state.

Parameter
state ViewState

The view state to copy the properties from.

Returns
Type Description
ViewState This ViewState instance.

fromJSON

Method
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.

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");

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

toMap

Method
toMap(out, x, y){Number[]}

Converts the x and y screen coordinates to map coordinates.

Parameters
out Number[]

The receiving array of the conversion.

x Number

The horizontal screen coordinate to convert.

y Number

The vertical screen coordinate to convert.

Returns
Type Description
Number[] The receiving array of the conversion.

toScreen

Method
toScreen(out, x, y){Number[]}

Converts the x and y map coordinates to screen coordinates.

Parameters
out Number[]

The receiving array of the conversion.

x Number

The horizontal screen coordinate to convert.

y Number

The vertical screen coordinate to convert.

Returns
Type Description
Number[] The receiving array of the conversion.

toScreenNoRotation

Method
toScreenNoRotation(out, x, y){Number[]}

Converts the x and y map coordinates to screen coordinates. This method is similar to toScreen, without applying the view state rotation.

Parameters
out Number[]

The receiving array of the conversion.

x Number

The horizontal screen coordinate to convert.

y Number

The vertical screen coordinate to convert.

Returns
Type Description
Number[] The receiving array of the conversion.

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