-
Name Type Description altitudeMode
IGCZ (defaults to 'none') Altitude mode. Possible values are
'barometric'
,'gps'
, and'none'
.
Extends
Methods
-
Read the feature from the source.
Name Type Description source
Document | Element | Object | string Source.
options
Read options.
Name Type Description dataProjection
ProjectionLike | undefined 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 nodataProjection
is set for a format, the features will not be reprojected.extent
Extent | undefined 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
withTILE_PIXELS
asunits
and the tile's pixel extent asextent
needs to be provided.featureProjection
ProjectionLike | undefined Projection of the feature geometries created by the format reader. If not provided, features will be returned in the
dataProjection
.Returns:
Feature.
-
Read the features from the source.
Name Type Description source
Document | Element | Object | string Source.
options
Read options.
Name Type Description dataProjection
ProjectionLike | undefined 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 nodataProjection
is set for a format, the features will not be reprojected.extent
Extent | undefined 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
withTILE_PIXELS
asunits
and the tile's pixel extent asextent
needs to be provided.featureProjection
ProjectionLike | undefined 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 source
Document | Element | Object | string Source.
options
Read options.
Name Type Description dataProjection
ProjectionLike | undefined 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 nodataProjection
is set for a format, the features will not be reprojected.extent
Extent | undefined 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
withTILE_PIXELS
asunits
and the tile's pixel extent asextent
needs to be provided.featureProjection
ProjectionLike | undefined 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 the source.
Name Type Description source
Document | Element | Object | string Source.
Returns:
Projection.
-
Encode a feature as a string.
Name Type Description feature
Feature Feature.
options
Write options.
Name Type Description dataProjection
ProjectionLike | undefined Projection of the data we are writing. If not provided, the
dataProjection
of the format is assigned (where set). If nodataProjection
is set for a format, the features will be returned in thefeatureProjection
.featureProjection
ProjectionLike | undefined 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 | 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.decimals
number | 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:
Encoded feature.
-
Encode an array of features as string.
Name Type Description features
Array<Feature> Features.
options
Write options.
Name Type Description dataProjection
ProjectionLike | undefined Projection of the data we are writing. If not provided, the
dataProjection
of the format is assigned (where set). If nodataProjection
is set for a format, the features will be returned in thefeatureProjection
.featureProjection
ProjectionLike | undefined 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 | 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.decimals
number | 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:
Encoded features.
-
Write a single geometry.
Name Type Description geometry
Geometry Geometry.
options
Write options.
Name Type Description dataProjection
ProjectionLike | undefined Projection of the data we are writing. If not provided, the
dataProjection
of the format is assigned (where set). If nodataProjection
is set for a format, the features will be returned in thefeatureProjection
.featureProjection
ProjectionLike | undefined 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 | 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.decimals
number | 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.