require(["esri/geometry/Multipoint"], (Multipoint) => { /* code goes here */ });
import Multipoint from "@arcgis/core/geometry/Multipoint.js";
esri/geometry/Multipoint
An ordered collection of points.
- See also
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The cache is used to store values computed from geometries that need to be cleared or recomputed upon mutation. | Geometry | ||
The name of the class. | Accessor | ||
The extent of the geometry. | Geometry | ||
Indicates if the geometry has M values. | Geometry | ||
Indicates if the geometry has z-values (elevation). | Geometry | ||
An array of points. | Multipoint | ||
The spatial reference of the geometry. | Geometry | ||
The string value representing the type of geometry. | Multipoint |
Property Details
-
hasZ
InheritedPropertyhasZ Boolean
Inherited from Geometry -
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.
-
spatialReference
InheritedPropertyspatialReference SpatialReferenceautocast
Inherited from Geometry -
The spatial reference of the geometry.
- Default Value:WGS84 (wkid: 4326)
-
type
type Stringreadonly
-
The string value representing the type of geometry.
For Multipoint the type is always "multipoint".
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Adds a point to the Multipoint. | Multipoint | ||
Creates a deep clone of Multipoint object. | Multipoint | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | Geometry | |
Returns the point at the specified index. | Multipoint | ||
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Removes a point from the Multipoint. | Multipoint | ||
Updates the point at the specified index. | Multipoint | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | Geometry |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
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.
-
addPoint
addPoint(point){Multipoint}
-
Adds a point to the Multipoint.
ParameterReturnsType Description Multipoint Returns the updated Multipoint.
-
clone
clone(){Multipoint}
-
Creates a deep clone of Multipoint object.
ReturnsType Description Multipoint A new instance of a Multipoint object equal to the object used to call .clone()
.
-
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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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");
-
setPoint
setPoint(index, point){Multipoint}
-
Updates the point at the specified index.
ParametersReturnsType Description Multipoint Returns the updated Multipoint.
-
toJSON
InheritedMethodtoJSON(){Object}
Inherited from Geometry -
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.