ViewState

Class: esri/views/2d/ViewState
Inheritance: ViewState Accessor
Since: ArcGIS API 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
Number[]more details

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

more detailsViewState
Stringmore details

The name of the class.

more detailsAccessor
Extentmore details

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

more detailsViewState
Numbermore details

Represents the size of one pixel in map units.

more detailsViewState
Numbermore details

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

more detailsViewState
Numbermore details

Represents the map scale at the center of the view.

more detailsViewState
Number[]more details

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

more detailsViewState

Property Details

center Number[]readonly

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

See also:
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:
resolution Numberreadonly
Since: ArcGIS API 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:
scale Numberreadonly

Represents the map scale at the center of the view.

See also:
size Number[]readonly

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

See also:

Method Overview

Name Return Type Summary Class
ViewStatemore details

Creates a deep clone of ViewState object.

more detailsViewState
ViewStatemore details

Copies the properties from a given view state.

more detailsViewState
*more details

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

more detailsViewState
Objectmore details

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

more detailsViewState
Number[]more details

Converts the x and y screen coordinates to map coordinates.

more detailsViewState
Number[]more details

Converts the x and y map coordinates to screen coordinates.

more detailsViewState
Number[]more details

Converts the x and y map coordinates to screen coordinates.

more detailsViewState

Method Details

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

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