Maps API for JavaScript Developer's Guide

H.geo.MultiPoint

Class Summary

Extends: H.geo.MultiGeometry

A MultiPoint is a collection of points represented as a H.geo.MultiGeometry with a H.geo.Point as generic type parameter T.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

splice (index, opt_deleteCount, opt_items) : {!Array<!T>}

This method splices the specified MultiGeometry at the provided index, removing the specified number of items at that index and inserting new items.

removeAt (index) : {!T}

Removes a contained geometry at the given index.

remove (geometry) : {T}

Removes the specified geometry from the multi-geometry

getGeometries () : {!Array<!T>}

Returns the aggregated geometries of the multi-geometry. The returned geometries must be treated as read-only to not violate the integrity of the multi-geometry.

push (geometry)

Adds the specified geometry to the current multi-geometry.

getBounds () : {?H.geo.Rect}

Returns the bounding rectangle of the geometry.

equals (other) : {boolean}

Checks whether the geometry is equal to the geometry supplied by the caller. Two geometries are considered as equal if they represent the same geometry type and have equal coordinate values.

toString () : {!string}

To obtain a Well-Known-Text (WKT) representation of the geometry.

Class Description

A MultiPoint is a collection of points represented as a H.geo.MultiGeometry with a H.geo.Point as generic type parameter T.

Constructor Details

H.geo.MultiPoint(points)

Parameters:
 
points:
{!Array<!H.geo.IPoint>}
 
The list of points which are initially represented by the MultiPoint.
Throws:
 
{H.lang.InvalidArgumentError}
 
if the points arguments is not valid

Method Details

splice (index, opt_deleteCount, opt_items) : {!Array<!T>}

This method splices the specified MultiGeometry at the provided index, removing the specified number of items at that index and inserting new items.

Parameters:
 
index:
{number}
 
The index at which to start changing the list.
opt_deleteCount:
{number=} [optional]
 
The number of geometries to remove.
opt_items:
{!Array<!T>=} [optional]
 
The geometries to add.
Returns:
 
{!Array<!T>}
the removed geometries.

removeAt (index) : {!T}

Removes a contained geometry at the given index.

Parameters:
 
index:
{number}
 
The index of the geometry to remove.
Returns:
 
{!T}
the removed geometry.
Throws:
 
{H.lang.OutOfRangeError}
 
if no geometry exists at the given index.

remove (geometry) : {T}

Removes the specified geometry from the multi-geometry

Parameters:
 
geometry:
{T}
 
The geometry (by reference) to remove from this multi-geometry.
Returns:
 
{T}
the removed geometry or null if the geometry was not found

getGeometries () : {!Array<!T>}

Returns the aggregated geometries of the multi-geometry. The returned geometries must be treated as read-only to not violate the integrity of the multi-geometry.

Returns:
 
{!Array<!T>}
An array of geometries

push (geometry)

Adds the specified geometry to the current multi-geometry.

Parameters:
 
geometry:
{!T}
 
A geometry which will be added to the current multi-geometry
Throws:
 
{H.lang.InvalidArgumentError}
 
in case of invalid geometry argument

getBounds () : {?H.geo.Rect}

Returns the bounding rectangle of the geometry.

Returns:
 
{?H.geo.Rect}
the bounding rectangle of the geometry or null if the bounding rectangle can't be computed (e.g. for a geometry without coordinates)

equals (other) : {boolean}

Checks whether the geometry is equal to the geometry supplied by the caller. Two geometries are considered as equal if they represent the same geometry type and have equal coordinate values.

Parameters:
 
other:
{*}
 
The geometry to check against
Returns:
 
{boolean}
true if the two geometries are equal, otherwise false

toString () : {!string}

To obtain a Well-Known-Text (WKT) representation of the geometry.

Returns:
 
{!string}
the resulting WKT string

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.