Name | Type | Description |
---|---|---|
coordinates |
Array.<module:ol/coordinate~Coordinate> | Array.<number> |
Coordinates.
For internal use, flat coordinates in combination with |
layout |
module:ol/geom/GeometryLayout |
Layout. |
Fires:
-
change
(module:ol/events/Event~Event) - Generic change event. Triggered when the revision counter is increased. -
propertychange
(module:ol/Object.ObjectEvent) - Triggered when a property is changed.
Extends
Methods
-
Append the passed point to this multipoint.
Name Type Description point
module:ol/geom/Point~Point Point.
-
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
module:ol/proj~TransformFunction Transform.
-
Increases the revision counter and dispatches a 'change' event.
-
Make a complete copy of the geometry.
Returns:
Clone.
-
Gets a value.
Name Type Description key
string Key name.
Returns:
Value.
-
getClosestPoint(point, opt_closestPoint){module:ol/coordinate~Coordinate} inherited
geom/Geometry.js, line 106 -
Return the closest point of the geometry to the passed point as
coordinate
.Name Type Description point
module:ol/coordinate~Coordinate Point.
closestPoint
module:ol/coordinate~Coordinate Closest point.
Returns:
Closest point.
-
Get the extent of the geometry.
Name Type Description extent
module:ol/extent~Extent Extent.
Returns:
extent Extent.
-
Return the first coordinate of the geometry.
Returns:
First coordinate.
-
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.
-
Return the point at the specified index.
Name Type Description index
number Index.
Returns:
Point.
-
Return the points of this multipoint.
Returns:
Points.
-
Get an object of all property names and values.
Returns:
Object.
-
Get the version number for this object. Each time the object is modified, its version number will be incremented.
Returns:
Revision.
-
Get the type of this geometry.
Returns:
Geometry type.
-
Returns true if this geometry includes the specified coordinate. If the coordinate is on the boundary of the geometry, returns false.
Name Type Description coordinate
module:ol/coordinate~Coordinate Coordinate.
Returns:
Contains coordinate.
-
Test if the geometry and the passed extent intersect.
Name Type Description extent
module:ol/extent~Extent Extent.
Returns:
true
if the geometry and the extent intersect.
-
on(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited
Observable.js, line 60 -
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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
once(type, listener){module:ol/events~EventsKey|Array.<module:ol/events~EventsKey>} inherited
Observable.js, line 82 -
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.
Returns:
Unique key for the listener. If called with an array of event types as the first argument, the return will be an array of keys.
-
Rotate the geometry around a given coordinate. This modifies the geometry coordinates in place.
Name Type Description angle
number Rotation angle in radians.
anchor
module:ol/coordinate~Coordinate The rotation center.
-
Scale the geometry (with an optional origin). This modifies the geometry coordinates in place.
Name Type Description sx
number The scaling factor in the x-direction.
sy
number The scaling factor in the y-direction (defaults to sx).
anchor
module:ol/coordinate~Coordinate The scale origin (defaults to the center of the geometry extent).
-
Sets a value.
Name Type Description key
string Key name.
value
* Value.
silent
boolean Update without triggering an event.
-
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.
silent
boolean Update without triggering an event.
-
Create a simplified version of this geometry. For linestrings, this uses the the
href="https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm">https://en.wikipedia.org/wiki/Ramer-Douglas-Peucker_algorithm Douglas Peucker
algorithm. For polygons, a quantization-based simplification is used to preserve topology.Name Type Description tolerance
number The tolerance distance for simplification.
Returns:
A new, simplified version of the original geometry.
-
transform(source, destination){module:ol/geom/Geometry~Geometry} inherited
geom/Geometry.js, line 258 -
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
module:ol/proj~ProjectionLike The current projection. Can be a string identifier or a
module:ol/proj/Projection~Projection
object.destination
module:ol/proj~ProjectionLike The desired projection. Can be a string identifier or a
module:ol/proj/Projection~Projection
object.Returns:
This geometry. Note that original geometry is modified in place.
-
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.
-
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.
-
Unsets a property.
Name Type Description key
string Key name.
silent
boolean Unset without triggering an event.