Class: Geometry

ol.geom.Geometry

Abstract base class; normally only used for creating subclasses and not instantiated in apps. Base class for vector geometries.

new ol.geom.Geometry()

Fires:

Subclasses

Extends

Methods

changed() inherited experimental

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

Fires:
  • change experimental

Gets a value.

Name Type Description
key string

Key name.

Returns:
Value.

getClosestPoint(point, opt_closestPoint){ol.Coordinate}

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}

Get the extent of the geometry.

Name Type Description
extent ol.Extent

Extent.

Returns:
extent Extent.

getKeys(){Array.<string>} inherited

Get a list of object property names.

Returns:
List of property names.

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

Get an object of all property names and values.

Returns:
Object.

getRevision(){number} inherited experimental

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.

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.