ESM: import Extent from "@arcgis/core/geometry/Extent.js";
CDN: const Extent = await $arcgis.import("@arcgis/core/geometry/Extent.js");
Class: @arcgis/core/geometry/Extent
Since: ArcGIS Maps SDK for JavaScript 4.0
The minimum and maximum X and Y coordinates of a bounding box. Extent is used to describe the visible portion of a MapView. When working in a SceneView, Camera is used to define the visible part of the map within the view.
Constructors new Extent(properties)
Parameter
optionalSee the properties for a list of all the properties that may be passed into the constructor.
Show inherited properties Hide inherited properties
Property DetailsInherited
Property cache Objectreadonly
The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. An example is the extent of a polygon.
center Pointreadonly
The center point of the extent in map units.
Inherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.
The name of the class. The declared class name is formatted as esri.folder.className
.
The extent of the geometry. For a point, the extent is null.
Indicates if the geometry has M values.
Indicates if the geometry has z-values (elevation).
Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.
height Numberreadonly
The height of the extent in map units (the distance between ymin and ymax).
The maximum possible m
value in an extent envelope.
The minimum possible m
value of an extent envelope.
The spatial reference of the geometry.
Default Value:SpatialReference.WGS84 // wkid: 4326
type Stringreadonly
For Extent the type is always "extent".
width Numberreadonly
The width of the extent in map units (the distance between xmin and xmax).
The maximum X-coordinate of an extent envelope.
The minimum X-coordinate of an extent envelope.
The maximum Y-coordinate of an extent envelope.
The minimum Y-coordinate of an extent envelope.
The maximum possible z
, or elevation, value in an extent envelope.
Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.
The minimum possible z
, or elevation, value of an extent envelope.
Z-values defined in a geographic or metric coordinate system are expressed in meters. However, in local scenes that use a projected coordinate system, vertical units are assumed to be the same as the horizontal units specified by the service.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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
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.
centerAt(point){Extent}
Centers the extent to the specified Point. This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.
Parameter
The point to center the extent.
Returns
Type Description Extent The new extent withpoint
as the center.
Creates a deep clone of Extent object.
Returns
Type Description Extent A new instance of a Extent object equal to the object used to call.clone()
.
contains(geometry){Boolean}
Checks if the input geometry is contained within the extent.
Parameter
Input geometry to test if it is contained within the extent.
Returns
Type Description Boolean Returnstrue
if the input geometry is contained within the extent.
equals(extent){Boolean}
Indicates if the input extent is equal to the testing extent.
Returns
Type Description Boolean Returnstrue
if the input extent is equal to the extent that calls equals()
.
expand(factor){Extent}
Expands the extent by the given factor. For example, a value of 1.5 will expand the extent to be 50 percent larger than the original extent. This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.
Returns
Type Description Extent Returns the expanded extent.Inherited
Method fromJSON(json){* |null |undefined}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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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");
}
Shrinks the original extent to the intersection with the input extent.
This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate. If the original extent and the input extent have no intersection, the extent is not modified and null is returned.
Returns
Type Description Extent | null | undefined The intersection of the input Extent with the original Extent or null. intersects(geometry){Boolean}
Tests to validate if the input geometry intersects the extent and returns a Boolean value.
Returns
Type Description Boolean Returnstrue
, if the input geometry intersects the extent.
Returns an array with either one Extent that's been shifted to within +/- 180 or two Extents if the original extent intersects the International Dateline.
This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.
Returns
Type Description Extent[] The normalized Extent(s). offset(dx, dy, dz){Extent}
Modifies the extent geometry in-place with X and Y offsets in map units. You should clone the extent object before calling this method where appropriate.
Parameters
The offset distance in map units for the X-coordinate.
The offset distance in map units for the Y-coordinate.
optionalThe offset distance in map units for the Z-coordinate.
Returns
Type Description Extent The offset Extent.Inherited
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA 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");
union(extent){Extent}
Expands the original extent to include the extent of the input Extent. This method modifies the extent geometry in-place. You should clone the extent object before calling this method where appropriate.
Parameter
The input extent to union.
Returns
Type Description Extent The union of the input Extent with the original Extent.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4