OpenLayers 3 API Documentation

Class: SimpleGeometry

ol.geom.SimpleGeometry

Abstract base class; only used for creating subclasses; do not instantiate in apps, as cannot be rendered.

new ol.geom.SimpleGeometry()

src/ol/geom/simplegeometry.js, line 21
Fires:
  • change - Triggered when the geometry changes.

Subclasses

Extends

Methods

applyTransform(transformFn)

src/ol/geom/simplegeometry.js, line 249

Apply a transform function to the geometry. Modifies the geometry 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.

clone(){ol.geom.Geometry} inherited

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

Make a complete copy of the geometry.

Returns:
Clone.

dispatchChangeEvent() inherited experimental

src/ol/observable.js, line 42

Dispatches a change event.

Fires:
  • change experimental

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}

src/ol/geom/simplegeometry.js, line 95

Get the extent of the geometry.

Name Type Description
extent ol.Extent

Extent.
Returns:
extent Extent.

getFirstCoordinate(){ol.Coordinate}

src/ol/geom/simplegeometry.js, line 111
Returns:
First coordinate.

getLastCoordinate(){ol.Coordinate}

src/ol/geom/simplegeometry.js, line 128
Returns:
Last point.

getLayout(){ol.geom.GeometryLayout}

src/ol/geom/simplegeometry.js, line 137
Returns:
Layout.

getRevision(){number} inherited experimental

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

getType(){ol.geom.GeometryType} inherited

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

Get the type of this geometry.

Returns:
Geometry type.

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

src/ol/observable.js, line 65

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 78

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.

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

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

Transform a geometry from one coordinate reference system to another. Modifies the geometry 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
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.

un(type, listener, opt_this) inherited

src/ol/observable.js, line 91

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 101

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

Name Type Description
key goog.events.Key

Key.