Documentation
Reference
2.1.50 (current version)
collection
interactivityModel
Interfaces

IBaseLinearRingGeometry

Extends IBaseGeometry, ILinearRingGeometryAccess.

Interface for the "Closed contour" geometry.

Constructor | Fields | Events | Methods

Constructor

IBaseLinearRingGeometry()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

Events

NameDescription
change

Changed coordinates. Instance of the Event class. Names of fields that are available via the Event.get method:

  • oldCoordinates - Old coordinates
  • newCoordinates - New coordinates.
  • oldFillRule - Old fill rule.
  • newFillRule - New fill rule.

Inherited from ILinearRingGeometryAccess.

Methods

NameReturnsDescription
contains(position)

Boolean

Checks whether the passed point is located inside the contour.

Inherited from ILinearRingGeometryAccess.

freeze()

IFreezable

Switches the object to "frozen" mode.

Inherited from IFreezable.

get(index)

Number[]

Returns coordinates of the point with the specified index.

Inherited from ILinearRingGeometryAccess.

getBounds()

Number[][]|null

Returns coordinates of the two opposite corners of the area that surrounds the geometry. The first item in the array is the corner with the smallest coordinate values relative to the rest of the points in the area; the second item is the corner with the largest coordinate values.

Inherited from IBaseGeometry.

getChildGeometry(index)

IPointGeometryAccess

Creates and returns an IPointGeometryAccess object for the specified contour on the polyline.

Inherited from ILinearRingGeometryAccess.

getClosest(anchorPosition)

Object

Searches for a point on the contour closest to the anchorPosition.

Inherited from ILinearRingGeometryAccess.

getCoordinates()

Number[][]

Returns an array of geometry coordinates.

Inherited from ILinearRingGeometryAccess.

getFillRule()

String

Returns ID of the fill rule.

Inherited from ILinearRingGeometryAccess.

getLength()

Integer

Returns the number of points in the geometry.

Inherited from ILinearRingGeometryAccess.

getType()

String

Returns the "LinearRing" string.

insert(index, coordinates)

ILinearRingGeometryAccess

Adds a new point with the specified index.

Inherited from ILinearRingGeometryAccess.

isFrozen()

Boolean

Returns true if the object is in "frozen" mode, otherwise false.

Inherited from IFreezable.

remove(index)

Number[]

Removes the point with the specified index.

Inherited from ILinearRingGeometryAccess.

set(index, coordinates)

ILinearRingGeometryAccess

Sets coordinates of the point with the specified index.

Inherited from ILinearRingGeometryAccess.

setCoordinates(coordinates)

ILinearRingGeometryAccess

Sets an array of geometry coordinates.

Inherited from ILinearRingGeometryAccess.

setFillRule(fillRule)

ILinearRingGeometryAccess

Sets the contour fill rule.

Inherited from ILinearRingGeometryAccess.

splice(index, number)

Number[][]

Deletes a defined number of points, starting from the specified index. New points can be added in place of the deleted ones. Coordinates of the new points can be passed as additional arguments after the "number" parameter.

Inherited from ILinearRingGeometryAccess.

unfreeze()

IFreezable

Switches the object to active mode.

Inherited from IFreezable.

Methods details

getType

{String} getType()

Returns the "LinearRing" string.