Object that holds information about the MapView state.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
Number[] | Represents the view's center point as an array of two numbers | more details | ViewState | |
String | The name of the class. more details | more details | Accessor | |
Extent | The extent represents the visible portion of a map within the view as an instance of Extent. more details | more details | ViewState | |
Number | Represents the size of one pixel in map units. more details | more details | ViewState | |
Number | The clockwise rotation of due north in relation to the top of the view in degrees. more details | more details | ViewState | |
Number | Represents the map scale at the center of the view. more details | more details | ViewState | |
Number[] | Represents the width and height of the view in pixels, e.g. more details | more details | ViewState |
Property Details
-
Represents the view's center point as an array of two numbers
[x, y]
.- See also:
-
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 NumberreadonlySince: 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:
-
Represents the width and height of the view in pixels, e.g.
[width, height]
.- See also:
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
ViewState | Creates a deep clone of ViewState object. more details | more details | ViewState | |
ViewState | Copies the properties from a given view state. more details | more details | ViewState | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | ViewState | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | ViewState | |
Number[] | Converts the x and y screen coordinates to map coordinates. more details | more details | ViewState | |
Number[] | Converts the x and y map coordinates to screen coordinates. more details | more details | ViewState | |
Number[] | Converts the x and y map coordinates to screen coordinates. more details | more details | ViewState |
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 ViewStateThe 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 a product in the ArcGIS platform. 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 ObjectA 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.
-
Converts the x and y screen coordinates to map coordinates.
Parameters:The receiving array of the conversion.
x NumberThe horizontal screen coordinate to convert.
y NumberThe vertical screen coordinate to convert.
Returns:Type Description Number[] The receiving array of the conversion.
-
Converts the x and y map coordinates to screen coordinates.
Parameters:The receiving array of the conversion.
x NumberThe horizontal screen coordinate to convert.
y NumberThe vertical screen coordinate to convert.
Returns:Type Description Number[] The receiving array of the conversion.
-
Converts the x and y map coordinates to screen coordinates. This method is similar to toScreen, without applying the view state rotation.
Parameters:The receiving array of the conversion.
x NumberThe horizontal screen coordinate to convert.
y NumberThe vertical screen coordinate to convert.
Returns:Type Description Number[] The receiving array of the conversion.