ViewState

Property Overview

Property Details

center Number[]readonly

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

See also

• MapView.center

declaredClass Stringreadonly inherited

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

extent Extentreadonly

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

See also

• MapView.extent

resolution Numberreadonly

Since: ArcGIS Maps SDK for JavaScript 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 Numberreadonly

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

See also

• MapView.rotation

scale Numberreadonly

Represents the map scale at the center of the view.

See also

• MapView.scale

size Number[]readonly

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

See also

• MapView.size

Method Overview

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: 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();

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(){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(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(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(groupKey){Boolean}inherited

Since: ArcGIS Maps SDK for JavaScript 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(groupKey)inherited

Since: ArcGIS Maps SDK for JavaScript 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(){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(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(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(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.