Class: Polyline

ol/format/Polyline~Polyline 


import Polyline from 'ol/format/Polyline';

Feature format for reading and writing data in the Encoded Polyline Algorithm Format.

When reading features, the coordinates are assumed to be in two dimensions and in [latitude, longitude] order.

As Polyline sources contain a single feature, module:ol/format/Polyline~Polyline#readFeatures will return the feature in an array.

new Polyline(opt_options)

format/Polyline.js, line 36
Name Type Description
options

Optional configuration object.

Name Type Description
factor number (defaults to 1e5)

The factor by which the coordinates values will be scaled.
geometryLayout module:ol/geom/GeometryLayout (defaults to 'XY')

Layout of the feature geometries created by the format reader.

Extends

Methods

readFeature(source, opt_options){module:ol/Feature~Feature} inherited

format/TextFeature.js, line 36

Read the feature from the source.

Name Type Description
source Document | Element | Object | string

Source.
options

Read options.

Name Type Description
dataProjection module:ol/proj~ProjectionLike

Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the dataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no dataProjection is set for a format, the features will not be reprojected.
extent module:ol/extent~Extent

Tile extent in map units of the tile being read. This is only required when reading data with tile pixels as geometry units. When configured, a dataProjection with TILE_PIXELS as units and the tile's pixel extent as extent needs to be provided.
featureProjection module:ol/proj~ProjectionLike

Projection of the feature geometries created by the format reader. If not provided, features will be returned in the dataProjection.
Returns:
Feature.

readFeatures(source, opt_options){Array.<module:ol/Feature~Feature>} inherited

format/TextFeature.js, line 62

Read the features from the source.

Name Type Description
source Document | Element | Object | string

Source.
options

Read options.

Name Type Description
dataProjection module:ol/proj~ProjectionLike

Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the dataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no dataProjection is set for a format, the features will not be reprojected.
extent module:ol/extent~Extent

Tile extent in map units of the tile being read. This is only required when reading data with tile pixels as geometry units. When configured, a dataProjection with TILE_PIXELS as units and the tile's pixel extent as extent needs to be provided.
featureProjection module:ol/proj~ProjectionLike

Projection of the feature geometries created by the format reader. If not provided, features will be returned in the dataProjection.
Returns:
Features.

readGeometry(source, opt_options){module:ol/geom/Geometry~Geometry} inherited

format/TextFeature.js, line 88

Read the geometry from the source.

Name Type Description
source Document | Element | Object | string

Source.
options

Read options.

Name Type Description
dataProjection module:ol/proj~ProjectionLike

Projection of the data we are reading. If not provided, the projection will be derived from the data (where possible) or the dataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no dataProjection is set for a format, the features will not be reprojected.
extent module:ol/extent~Extent

Tile extent in map units of the tile being read. This is only required when reading data with tile pixels as geometry units. When configured, a dataProjection with TILE_PIXELS as units and the tile's pixel extent as extent needs to be provided.
featureProjection module:ol/proj~ProjectionLike

Projection of the feature geometries created by the format reader. If not provided, features will be returned in the dataProjection.
Returns:
Geometry.

readProjection(source){module:ol/proj/Projection~Projection|undefined} inherited

format/TextFeature.js, line 113

Read the projection from the source.

Name Type Description
source Document | Element | Object | string

Source.
Returns:
Projection.

writeFeature(feature, opt_options){string} inherited

format/TextFeature.js, line 134

Encode a feature as a string.

Name Type Description
feature module:ol/Feature~Feature

Feature.
options

Write options.

Name Type Description
dataProjection module:ol/proj~ProjectionLike

Projection of the data we are writing. If not provided, the dataProjection of the format is assigned (where set). If no dataProjection is set for a format, the features will be returned in the featureProjection.
featureProjection module:ol/proj~ProjectionLike

Projection of the feature geometries that will be serialized by the format writer. If not provided, geometries are assumed to be in the dataProjection if that is set; in other words, they are not transformed.
rightHanded boolean

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. If false, 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.
decimals number

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:
Encoded feature.

writeFeatures(features, opt_options){string} inherited

format/TextFeature.js, line 157

Encode an array of features as string.

Name Type Description
features Array.<module:ol/Feature~Feature>

Features.
options

Write options.

Name Type Description
dataProjection module:ol/proj~ProjectionLike

Projection of the data we are writing. If not provided, the dataProjection of the format is assigned (where set). If no dataProjection is set for a format, the features will be returned in the featureProjection.
featureProjection module:ol/proj~ProjectionLike

Projection of the feature geometries that will be serialized by the format writer. If not provided, geometries are assumed to be in the dataProjection if that is set; in other words, they are not transformed.
rightHanded boolean

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. If false, 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.
decimals number

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:
Encoded features.

writeGeometry(geometry, opt_options){string} inherited

format/TextFeature.js, line 180

Write a single geometry.

Name Type Description
geometry module:ol/geom/Geometry~Geometry

Geometry.
options

Write options.

Name Type Description
dataProjection module:ol/proj~ProjectionLike

Projection of the data we are writing. If not provided, the dataProjection of the format is assigned (where set). If no dataProjection is set for a format, the features will be returned in the featureProjection.
featureProjection module:ol/proj~ProjectionLike

Projection of the feature geometries that will be serialized by the format writer. If not provided, geometries are assumed to be in the dataProjection if that is set; in other words, they are not transformed.
rightHanded boolean

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. If false, 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.
decimals number

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.