Documentation
Reference
2.1.53 (current version)
collection
interactivityModel
Interfaces

ILineStringGeometry

Extends IGeometry, ILineStringGeometryAccess.

Interface for the "Polyline" geometry.

Constructor | Fields | Events | Methods

Constructor

ILineStringGeometry()

Fields

NameTypeDescription
eventsIEventManager

Event manager.

Inherited from IEventEmitter.

optionsIOptionManager

Options manager.

Inherited from ICustomizable.

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.

Inherited from ILineStringGeometryAccess.

mapchange

Map reference changed. Instance of the Event class. Names of fields that are available via the Event#get method:

  • oldMap - Old map.
  • newMap - New map.

Inherited from IGeometry.

optionschange

Change to the object options.

Inherited from ICustomizable.

pixelgeometrychange

The pixel geometry changed. Instance of the Event class. Names of fields that are available via the Event#get method:

Inherited from IGeometry.

Methods

NameReturnsDescription
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 ILineStringGeometryAccess.

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 southwest corner of the area; the second item is the northeast corner.

Inherited from IGeometry.

getChildGeometry(index)

IPointGeometryAccess

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

Inherited from ILineStringGeometryAccess.

getClosest(anchorPosition)

Object

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

Inherited from ILineStringGeometryAccess.

getCoordinates()

Number[][]

Returns an array of geometry coordinates.

Inherited from ILineStringGeometryAccess.

getLength()

Integer

Returns the number of points in the geometry.

Inherited from ILineStringGeometryAccess.

getMap()

Map|null

Returns the current map.

Inherited from IGeometry.

getPixelGeometry([options])

IPixelGeometry

Returns the pixel geometry corresponding to the given geometry, its options, and the map state.

Inherited from IGeometry.

getType()

String

Returns the "LineString" string.

insert(index, coordinates)

ILineStringGeometryAccess

Adds a new point with the specified index.

Inherited from ILineStringGeometryAccess.

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

set(index, coordinates)

ILineStringGeometryAccess

Sets coordinates of the point with the specified index.

Inherited from ILineStringGeometryAccess.

setCoordinates(coordinates)

ILineStringGeometryAccess

Sets an array of geometry coordinates.

Inherited from ILineStringGeometryAccess.

setMap(map)

Sets the map.

Inherited from IGeometry.

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

unfreeze()

IFreezable

Switches the object to active mode.

Inherited from IFreezable.

Methods details

getType

{String} getType()

Returns the "LineString" string.