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:

Extends

Methods

applyTransform(transformFn)

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

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 dispatches 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.

get(key){*} inherited

src/ol/object.js, line 150

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

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

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

Return the closest point of the geometry to the passed point as coordinate.

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 161

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 148

Return the geometries that make up this geometry collection.

Returns:
Geometries.

getKeys(){Array.<string>} inherited

src/ol/object.js, line 164

Get a list of object property names.

Returns:
List of property names.

getProperties(){Object.<string, *>} inherited

src/ol/object.js, line 174

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

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

getType(){ol.geom.GeometryType}

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

Get the type of this geometry.

Returns:
Geometry type.

intersectsExtent(extent){boolean}

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

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.

set(key, value) inherited

src/ol/object.js, line 203

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

setGeometries(geometries)

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

Set the geometries that make up this geometry collection.

Name Type Description
geometries Array.<ol.geom.Geometry>

Geometries.

setProperties(values) inherited

src/ol/object.js, line 216

Sets a collection of key-value pairs. Note that this changes any existing properties and adds new ones (it does not remove any existing properties).

Name Type Description
values Object.<string, *>

Values.

translate(deltaX, deltaY) experimental

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

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().

unset(key) inherited

src/ol/object.js, line 229

Unsets a property.

Name Type Description
key string

Key name.