OpenLayers v5.3.0 API - Class: LinearRing

Class: LinearRing

ol/geom/LinearRing~LinearRing

import LinearRing from 'ol/geom/LinearRing';

Linear ring geometry. Only used as part of polygon; cannot be rendered on its own.

new LinearRing(coordinates, opt_layout)

geom/LinearRing.js, line 21

Name	Type	Description
`coordinates`	Array.<module:ol/coordinate~Coordinate> \| Array.<number>	Coordinates. For internal use, flat coordinates in combination with `opt_layout` are also accepted.
`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

module:ol/geom/SimpleGeometry~SimpleGeometry

Methods

applyTransform(transformFn) inherited geom/SimpleGeometry.js, line 200

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.

clone(){module:ol/geom/LinearRing~LinearRing} geom/LinearRing.js, line 58

Make a complete copy of the geometry.

Returns:

Clone.

getArea(){number} geom/LinearRing.js, line 84

Return the area of the linear ring on projected plane.

Returns:

Area (on projected plane).

getCoordinates(){Array.<module:ol/coordinate~Coordinate>} geom/LinearRing.js, line 94

Return the coordinates of the linear ring.

Returns:

Coordinates.

getFirstCoordinate(){module:ol/coordinate~Coordinate} inherited geom/SimpleGeometry.js, line 65

Return the first coordinate of the geometry.

Returns:

First coordinate.

getLastCoordinate(){module:ol/coordinate~Coordinate} inherited geom/SimpleGeometry.js, line 81

Return the last coordinate of the geometry.

Returns:

Last point.

getLayout(){module:ol/geom/Geometry~GeometryLayout} inherited geom/SimpleGeometry.js, line 90

Return the layout of the geometry.

Returns:

Layout.

getType(){module:ol/geom/GeometryType} geom/LinearRing.js, line 114

Get the type of this geometry.

Returns:

Geometry type.

rotate(angle, anchor) inherited geom/SimpleGeometry.js, line 211

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(sx, opt_sy, opt_anchor) inherited geom/SimpleGeometry.js, line 226

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

setCoordinates(coordinates, opt_layout) geom/LinearRing.js, line 132

Set the coordinates of the linear ring.

Name	Type	Description
`coordinates`	Array.<module:ol/coordinate~Coordinate>	Coordinates.
`layout`	module:ol/geom/GeometryLayout	Layout.

translate(deltaX, deltaY) inherited geom/SimpleGeometry.js, line 249

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.