ViewState
require(["esri/views/2d/ViewState"], function(ViewState) { /* code goes here */ });esri/views/2d/ViewStateObject that holds information about the MapView state.
Constructors
- new ViewState(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| Number[] | Represents the view's center point as an array of two numbers | more details | ViewState | |
| 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
- centerNumber[]readonly
Represents the view's center point as an array of two numbers
[x, y].- See also:
- extentExtentreadonly
The extent represents the visible portion of a map within the view as an instance of Extent.
- See also:
- resolutionNumberreadonlySince: ArcGIS API for JavaScript 4.9
Represents the size of one pixel in map units. The value of
resolutionis the result of the division of the extent width by the size.
- rotationNumberreadonly
The clockwise rotation of due north in relation to the top of the view in degrees.
- See also:
- scaleNumberreadonly
Represents the map scale at the center of the view.
- See also:
- sizeNumber[]readonly
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 | |
| 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.
- 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 NumberThe horizontal screen coordinate to convert.
y NumberThe 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 NumberThe horizontal screen coordinate to convert.
y NumberThe 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 NumberThe horizontal screen coordinate to convert.
y NumberThe vertical screen coordinate to convert.
Returns:Type Description Number[] The receiving array of the conversion.