Multipoint

AMD: require(["esri/geometry/Multipoint"], (Multipoint) => { /* code goes here */ });
ESM: import Multipoint from "@arcgis/core/geometry/Multipoint";
Class: esri/geometry/Multipoint
Inheritance: Multipoint Geometry Accessor
Since: ArcGIS API for JavaScript 4.0

An ordered collection of points.

See also:

Constructors

new Multipoint(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Objectmore details

The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation.

more detailsGeometry
Stringmore details

The name of the class.

more detailsAccessor
Extentmore details

The extent of the geometry.

more detailsGeometry
Booleanmore details

Indicates if the geometry has M values.

more detailsGeometry
Booleanmore details

Indicates if the geometry has z-values (elevation).

more detailsGeometry
Number[][]more details

An array of points.

more detailsMultipoint
SpatialReferencemore details

The spatial reference of the geometry.

more detailsGeometry
Stringmore details

The string value representing the type of geometry.

more detailsMultipoint

Property Details

cache Objectreadonly inherited

The cache is used to store values computed from geometries that need to cleared or recomputed upon mutation. An example is the extent of a polygon.

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

extent Extentreadonly inherited

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.

points Number[][]

An array of points.

The spatial reference of the geometry.

Default Value:WGS84 (wkid: 4326)
type Stringreadonly

The string value representing the type of geometry.

For Multipoint the type is always "multipoint".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Multipointmore details

Adds a point to the Multipoint.

more detailsMultipoint
Multipointmore details

Creates a deep clone of Multipoint object.

more detailsMultipoint
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsGeometry
Pointmore details

Returns the point at the specified index.

more detailsMultipoint
Pointmore details

Removes a point from the Multipoint.

more detailsMultipoint
Multipointmore details

Updates the point at the specified index.

more detailsMultipoint
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsGeometry

Method Details

addPoint(point){Multipoint}

Adds a point to the Multipoint.

Parameter:
point Point|Number[]

The point to add to the multipoint. The point can either be a Point or an array of numbers representing XY coordinates.

Returns:
Type Description
Multipoint Returns the updated Multipoint.
clone(){Multipoint}

Creates a deep clone of Multipoint object.

Returns:
Type Description
Multipoint A new instance of a Multipoint object equal to the object used to call .clone().
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.

Parameter:
json Object

A 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.
getPoint(index){Point}

Returns the point at the specified index.

Parameter:
index Number

The index of the point in the points property.

Returns:
Type Description
Point The point at the specified index.
removePoint(index){Point}

Removes a point from the Multipoint. The index specifies which point to remove.

Parameter:
index Number

The index of the point to remove.

Returns:
Type Description
Point Returns the removed point.
setPoint(index, point){Multipoint}

Updates the point at the specified index.

Parameters:
index Number

The index of the point in the points property.

point Point|Number[]

Point geometry that specifies the new location.

Returns:
Type Description
Multipoint Returns the updated Multipoint.
toJSON(){Object}inherited

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.