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 | ViewState | |
String | The name of the class. more details | Accessor | |
Extent | The extent represents the visible portion of a map within the view as an instance of Extent. more details | ViewState | |
Number | Represents the size of one pixel in map units. more details | ViewState | |
Number | The clockwise rotation of due north in relation to the top of the view in degrees. more details | ViewState | |
Number | Represents the map scale at the center of the view. more details | ViewState | |
Number[] | Represents the width and height of the view in pixels, e.g. 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 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
-
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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
ViewState | Creates a deep clone of ViewState object. more details | ViewState | |
ViewState | Copies the properties from a given view state. more details | ViewState | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | ViewState | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | ViewState | |
Number[] | Converts the x and y screen coordinates to map coordinates. more details | ViewState | |
Number[] | Converts the x and y map coordinates to screen coordinates. more details | ViewState | |
Number[] | Converts the x and y map coordinates to screen coordinates. more details | ViewState |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
ReturnsType 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.
Parameterstate ViewStateThe view state to copy the properties from.
ReturnsType 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.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.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.
-
Converts the x and y screen coordinates to map coordinates.
ParametersThe receiving array of the conversion.
x NumberThe horizontal screen coordinate to convert.
y NumberThe vertical screen coordinate to convert.
ReturnsType Description Number[] The receiving array of the conversion.
-
Converts the x and y map coordinates to screen coordinates.
ParametersThe receiving array of the conversion.
x NumberThe horizontal screen coordinate to convert.
y NumberThe vertical screen coordinate to convert.
ReturnsType 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.
ParametersThe receiving array of the conversion.
x NumberThe horizontal screen coordinate to convert.
y NumberThe vertical screen coordinate to convert.
ReturnsType Description Number[] The receiving array of the conversion.