Class: GeometryCollection

ol.geom.GeometryCollection

An array of ol.geom.Geometry objects.

new ol.geom.GeometryCollection(opt_geometries)

src/ol/geom/geometrycollection.js, line 22
Name Type Description
geometries Array.<ol.geom.Geometry>

Geometries.

Fires:
  • change - Triggered when the geometry changes.

Extends

Methods

applyTransform(transformFn)

src/ol/geom/geometrycollection.js, line 262

Apply a transform function to each coordinate of the geometry. The geometry is modified in place. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

Name Type Description
transformFn ol.TransformFunction

Transform.

changed() inherited experimental

src/ol/observable.js, line 52

Increases the revision counter and disptches a 'change' event.

Fires:
  • change experimental

clone(){ol.geom.GeometryCollection}

src/ol/geom/geometrycollection.js, line 89

Make a complete copy of the geometry.

Returns:
Clone.

getClosestPoint(point, opt_closestPoint){ol.Coordinate} inherited

src/ol/geom/geometry.js, line 120
Name Type Description
point ol.Coordinate

Point.

closestPoint ol.Coordinate

Closest point.

Returns:
Closest point.

getExtent(opt_extent){ol.Extent} inherited

src/ol/geom/geometry.js, line 159

Get the extent of the geometry.

Name Type Description
extent ol.Extent

Extent.

Returns:
extent Extent.

getGeometries(){Array.<ol.geom.Geometry>}

src/ol/geom/geometrycollection.js, line 147
Returns:
Geometries.

getRevision(){number} inherited experimental

src/ol/observable.js, line 62
Returns:
Revision.

getType(){ol.geom.GeometryType}

src/ol/geom/geometrycollection.js, line 208

Get the type of this geometry.

Returns:
Geometry type.

intersectsExtent(extent){boolean} experimental

src/ol/geom/geometrycollection.js, line 217

Test if the geometry and the passed extent intersect.

Name Type Description
extent ol.Extent

Extent.

Returns:
true if the geometry and the extent intersect.

on(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 75

Listen for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

once(type, listener, opt_this){goog.events.Key} inherited

src/ol/observable.js, line 88

Listen once for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object to use as this in listener.

Returns:
Unique key for the listener.

setGeometries(geometries)

src/ol/geom/geometrycollection.js, line 241
Name Type Description
geometries Array.<ol.geom.Geometry>

Geometries.

transform(source, destination){ol.geom.Geometry} inherited

src/ol/geom/geometry.js, line 235

Transform each coordinate of the geometry from one coordinate reference system to another. The geometry is modified in place. For example, a line will be transformed to a line and a circle to a circle. If you do not want the geometry modified in place, first clone() it and then use this function on the clone.

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.

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

translate(deltaX, deltaY) experimental

src/ol/geom/geometrycollection.js, line 278

Translate the geometry.

Name Type Description
deltaX number

Delta X.

deltaY number

Delta Y.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 101

Unlisten for a certain type of event.

Name Type Description
type string | Array.<string>

The event type or array of event types.

listener function

The listener function.

this Object

The object which was used as this by the listener.

unByKey(key) inherited

src/ol/observable.js, line 114

Removes an event listener using the key returned by on() or once(). Note that using the ol.Observable.unByKey static function is to be preferred.

Name Type Description
key goog.events.Key

The key returned by on() or once().