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

Fires:
  • change experimental - Triggered when the revision counter is increased.
  • propertychange (ol.ObjectEvent) - Triggered when a property is changed.

Subclasses

Extends

Methods

applyTransform(transformFn)

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

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

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

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

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.

Get the extent of the geometry.

Name Type Description
extent ol.Extent

Extent.

Returns:
extent Extent.

Return the first coordinate of the geometry.

Returns:
First coordinate.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

Return the last coordinate of the geometry.

Returns:
Last point.

Return the layout of the geometry.

Returns:
Layout.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

Get the version number for this object. Each time the object is modified, its version number will be incremented.

Returns:
Revision.

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

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

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.

Sets a value.

Name Type Description
key string

Key name.

value *

Value.

setProperties(values) inherited

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.

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

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)

Translate the geometry. This modifies the geometry coordinates in place. If instead you want a new geometry, first clone() this geometry.

Name Type Description
deltaX number

Delta X.

deltaY number

Delta Y.

un(type, listener, opt_this) inherited

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.

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

Unsets a property.

Name Type Description
key string

Key name.