new ol.format.Polyline(opt_options)
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Optional configuration object.
|
||||||||||
Extends
Methods
-
ol.format.Polyline.decodeDeltas(encoded, stride, opt_factor){Array.<number>}
src/ol/format/polyline.js, line 102 -
Decode a list of n-dimensional points from an encoded string
Name Type Description encodedstring An encoded string.
stridenumber The number of dimension of the points in the encoded string.
factornumber The factor by which the resulting numbers will be divided. Default is
1e5.Returns:
A list of n-dimensional points.
-
ol.format.Polyline.decodeFloats(encoded, opt_factor){Array.<number>}
src/ol/format/polyline.js, line 159 -
Decode a list of floating point numbers from an encoded string
Name Type Description encodedstring An encoded string.
factornumber The factor by which the result will be divided. Default is
1e5.Returns:
A list of floating point numbers.
-
ol.format.Polyline.encodeDeltas(numbers, stride, opt_factor){string}
src/ol/format/polyline.js, line 67 -
Encode a list of n-dimensional points and return an encoded string
Attention: This function will modify the passed array!
Name Type Description numbersArray.<number> A list of n-dimensional points.
stridenumber The number of dimension of the points in the list.
factornumber The factor by which the numbers will be multiplied. The remaining decimal places will get rounded away. Default is
1e5.Returns:
The encoded string.
-
ol.format.Polyline.encodeFloats(numbers, opt_factor){string}
src/ol/format/polyline.js, line 139 -
Encode a list of floating point numbers and return an encoded string
Attention: This function will modify the passed array!
Name Type Description numbersArray.<number> A list of floating point numbers.
factornumber The factor by which the numbers will be multiplied. The remaining decimal places will get rounded away. Default is
1e5.Returns:
The encoded string.
-
Read the feature from the Polyline source. The coordinates are assumed to be in two dimensions and in latitude, longitude order.
Name Type Description sourceDocument | Node | Object | string Source.
optionsRead options.
Name Type Description dataProjectionol.ProjectionLike Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the
defaultDataProjectionof the format is assigned (where set). If the projection can not be derived from the data and if nodefaultDataProjectionis set for a format, the features will not be reprojected.extentol.Extent Tile extent of the tile being read. This is only used and required for
ol.format.MVT. Required.featureProjectionol.ProjectionLike Projection of the feature geometries created by the format reader. If not provided, features will be returned in the
dataProjection.Returns:
Feature.
-
Read the feature from the source. As Polyline sources contain a single feature, this will return the feature in an array.
Name Type Description sourceDocument | Node | Object | string Source.
optionsRead options.
Name Type Description dataProjectionol.ProjectionLike Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the
defaultDataProjectionof the format is assigned (where set). If the projection can not be derived from the data and if nodefaultDataProjectionis set for a format, the features will not be reprojected.extentol.Extent Tile extent of the tile being read. This is only used and required for
ol.format.MVT. Required.featureProjectionol.ProjectionLike Projection of the feature geometries created by the format reader. If not provided, features will be returned in the
dataProjection.Returns:
Features.
-
Read the geometry from the source.
Name Type Description sourceDocument | Node | Object | string Source.
optionsRead options.
Name Type Description dataProjectionol.ProjectionLike Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the
defaultDataProjectionof the format is assigned (where set). If the projection can not be derived from the data and if nodefaultDataProjectionis set for a format, the features will not be reprojected.extentol.Extent Tile extent of the tile being read. This is only used and required for
ol.format.MVT. Required.featureProjectionol.ProjectionLike Projection of the feature geometries created by the format reader. If not provided, features will be returned in the
dataProjection.Returns:
Geometry.
-
Read the projection from a Polyline source.
Name Type Description sourceDocument | Node | Object | string Source.
Returns:
Projection.
-
writeGeometry(geometry, opt_options){string}
src/ol/format/polyline.js, line 383 -
Write a single geometry in Polyline format.
Name Type Description geometryol.geom.Geometry Geometry.
optionsWrite options.
Name Type Description dataProjectionol.ProjectionLike Projection of the data we are writing. If not provided, the
defaultDataProjectionof the format is assigned (where set). If nodefaultDataProjectionis set for a format, the features will be returned in thefeatureProjection.featureProjectionol.ProjectionLike Projection of the feature geometries that will be serialized by the format writer. If not provided, geometries are assumed to be in the
dataProjectionif that is set; in other words, they are not transformed.rightHandedboolean | undefined When writing geometries, follow the right-hand rule for linear ring orientation. This means that polygons will have counter-clockwise exterior rings and clockwise interior rings. By default, coordinates are serialized as they are provided at construction. If
true, the right-hand rule will be applied. Iffalse, the left-hand rule will be applied (clockwise for exterior and counter-clockwise for interior rings). Note that not all formats support this. The GeoJSON format does use this property when writing geometries.decimalsnumber | undefined Maximum number of decimal places for coordinates. Coordinates are stored internally as floats, but floating-point arithmetic can create coordinates with a large number of decimal places, not generally wanted on output. Set a number here to round coordinates. Can also be used to ensure that coordinates read in can be written back out with the same number of decimals. Default is no rounding.
Returns:
Geometry.
OpenLayers