ol.geom. ol.geom.GeometryCollection

new GeometryCollection

Stability: experimental
Parameters:
Name Type Argument Description
geometries Array.<ol.geom.Geometry>= <optional>

Geometries.

Source:
  • geometrycollection.js, line 20

Extends

Methods

applyTransform

Stability: experimental

Apply a transform function to the geometry. Modifies the geometry in place.

Parameters:
Name Type Description
transformFn ol.TransformFunction

Transform.

Source:
  • geometrycollection.js, line 250

clone

Stability: experimental
Source:
  • geometrycollection.js, line 86
Returns:

Clone.

Type
ol.geom.Geometry

dispatchChangeEvent

Stability: experimental

Dispatches a change event. Register a listener for this event to get notified of changes.

Inherited From:
Source:
  • observable.js, line 39
Fires:
  • event:change

getClosestPoint

Stability: experimental
Parameters:
Name Type Argument Description
point ol.Coordinate

Point.

closestPoint ol.Coordinate <optional>

Closest point.

Inherited From:
Source:
  • geometry.js, line 112
Returns:

Closest point.

Type
ol.Coordinate

getExtent

Stability: experimental

Get the extent of the geometry.

Parameters:
Name Type Argument Description
extent ol.Extent <optional>

Extent.

Source:
  • geometrycollection.js, line 131
Returns:

extent Extent.

Type
ol.Extent

getGeometries

Stability: experimental
Source:
  • geometrycollection.js, line 151
Returns:

Geometries.

Type
Array.<ol.geom.Geometry>

getSimplifiedGeometry

Stability: experimental
Parameters:
Name Type Description
squaredTolerance number

Squared tolerance.

Source:
  • geometrycollection.js, line 168
Returns:

Simplified geometry.

Type
ol.geom.Geometry

getType

Stability: experimental
Source:
  • geometrycollection.js, line 213
Returns:

Geometry type.

Type
ol.geom.GeometryType

on

Stability: experimental

Listen for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>

The object to use as this in listener.

Inherited From:
Source:
  • observable.js, line 61
Returns:

Unique key for the listener.

Type
goog.events.Key

once

Stability: experimental

Listen once for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>

The object to use as this in listener.

Inherited From:
Source:
  • observable.js, line 74
Returns:

Unique key for the listener.

Type
goog.events.Key

setGeometries

Stability: experimental
Parameters:
Name Type Description
geometries Array.<ol.geom.Geometry>

Geometries.

Source:
  • geometrycollection.js, line 230

transform

Stability: experimental

Transform a geometry from one coordinate reference system to another. Modifies the geometry in place.

Parameters:
Name Type Description
source ol.proj.ProjectionLike

The current projection. Can be a string identifier or a ol.proj.Projection object.

destination ol.proj.ProjectionLike

The desired projection. Can be a string identifier or a ol.proj.Projection object.

Inherited From:
Source:
  • geometry.js, line 183
Returns:

This geometry. Note that original geometry is modified in place.

Type
ol.geom.Geometry

un

Stability: experimental

Unlisten for a certain type of event.

Parameters:
Name Type Argument Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object <optional>

The object to use as this in listener.

Inherited From:
Source:
  • observable.js, line 86

unByKey

Stability: experimental

Removes an event listener using the key returned by on() or once().

Parameters:
Name Type Description
key goog.events.Key

Key.

Inherited From:
Source:
  • observable.js, line 96