geometry.LineString
Extends ILineStringGeometry.
"Polyline" geometry.
See Polyline
Constructor | Fields | Events | Methods
Constructor
geometry.LineString([coordinates[, options]])
Parameters:
Parameter |
Default value |
Description |
[] |
Type: Number[][] Geometry coordinates. |
|
— |
Type: Object Geometry options. |
|
— |
Type: String String ID defining the algorithm for recalculating geometry coordinates as pixel coordinates. For the "Polyline" geometry, can accept one of two values:
|
|
false |
Type: Boolean Enables display using geodesic lines. |
|
"jumpy" |
Type: String Method for calculating pixel coordinates of the shape in cycled projections. This option accepts one of the following values:
|
|
— |
Type: IProjection Projection. |
|
true |
Type: Boolean Enables simplification during rendering of a pixel geometry. |
Example:
// Instantiates the point geometry (specifying coordinates).
var lineStringGeometry = new ymaps.geometry.LineString([
[30, 50], [31, 51], [32, 52]
]);
// Instantiating the geo object and passing our geometry to the constructor.
var lineStringGeoObject = new ymaps.GeoObject({ geometry: lineStringGeometry });
lineStringGeometry.events.add('change', function (e) {
alert([e.get('newCoordinates'), e.get('oldCoordinates')]);
});
// Changing vertexes via the geo object's "geometry" property (setting new coordinates for the second point on the line).
lineStringGeoObject.geometry
.set(1, [20, 40])
.remove(2);
// Or directly.
lineStringGeometry
.set(1, [20, 40])
.remove(2);
// You can also access lineStringGeometry via lineStringGeoObject.geometry.
Fields
Name |
Type |
Description |
Event manager. Inherited from IEventEmitter. |
||
Options manager. Inherited from ICustomizable. |
Events
Name |
Description |
Changed coordinates. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from ILineStringGeometryAccess. |
|
Map reference changed. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
|
Change to the object options. Inherited from ICustomizable. |
|
The pixel geometry changed. Instance of the Event class. Names of fields that are available via the Event.get method:
Inherited from IGeometry. |
Methods
Name |
Returns |
Description |
freeze() |
Switches the object to "frozen" mode. Inherited from IFreezable. |
|
Number[] |
Returns coordinates of the point with the specified index. Inherited from ILineStringGeometryAccess. |
|
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. |
|
Creates and returns an IPointGeometryAccess object for the specified vertex on the polyline. Inherited from ILineStringGeometryAccess. |
||
Object |
Searches for a point on the polyline closest to the anchorPosition. Inherited from ILineStringGeometryAccess. |
|
Number[][] |
Returns an array of geometry coordinates. Inherited from ILineStringGeometryAccess. |
|
getDistance([from[, to]]) |
Number |
Returns the length of the specified line segment, or the whole line, if the delimiter is not set. |
Integer |
Returns the number of points in the geometry. Inherited from ILineStringGeometryAccess. |
|
getMap() |
Map|null |
Returns the current map. Inherited from IGeometry. |
Returns the pixel geometry corresponding to the given geometry, its options, and the map state. Inherited from IGeometry. |
||
getType() |
String |
Returns the "LineString" string. Inherited from ILineStringGeometry. |
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. |
Number[] |
Removes the point with the specified index. Inherited from ILineStringGeometryAccess. |
|
Sets coordinates of the point with the specified index. Inherited from ILineStringGeometryAccess. |
||
Sets an array of geometry coordinates. Inherited from ILineStringGeometryAccess. |
||
Sets the map. Inherited from IGeometry. |
||
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() |
Switches the object to active mode. Inherited from IFreezable. |
Methods details
getDistance
{Number} getDistance([from[, to]])
Returns the length of the specified line segment, or the whole line, if the delimiter is not set.
Parameters:
Parameter |
Default value |
Description |
0 |
Type: Number Specifies the start point for calculating the length. |
|
— |
Type: Number Specifies the end point for calculating the length. If not specified, the last point is used. |
Example:
var lineStringGeometry = new ymaps.geometry.LineString([[30, 50], [31, 51], [32, 52]]);
var geoObject = new ymaps.GeoObject({ geometry: lineStringGeometry });
myMap.geoObjects.add(geoObject);
// The total length of the line.
console.log(geoObject.geometry.getDistance());
// The length of the segment from the first to the second point.
console.log(geoObject.geometry.getDistance(0, 1));