Class: WKT

ol.format.WKT

Geometry format for reading and writing data in the WellKnownText (WKT) format.

new ol.format.WKT(opt_options)

src/ol/format/wktformat.js, line 30
Name Type Description
options

Options.

Name Type Description
splitCollection boolean | undefined

Whether to split GeometryCollections into multiple features on reading. Default is false.

Extends

Methods

readFeature(source, opt_options){ol.Feature}

src/ol/format/wktformat.js, line 221

Read a feature from a WKT source.

Name Type Description
source Document | Node | Object | string

Source.

options

Read options.

Name Type Description
dataProjection 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 defaultDataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no defaultDataProjection is set for a format, the features will not be reprojected.

featureProjection 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.<ol.Feature>}

src/ol/format/wktformat.js, line 247

Read all features from a WKT source.

Name Type Description
source Document | Node | Object | string

Source.

options

Read options.

Name Type Description
dataProjection 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 defaultDataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no defaultDataProjection is set for a format, the features will not be reprojected.

featureProjection 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){ol.geom.Geometry}

src/ol/format/wktformat.js, line 282

Read a single geometry from a WKT source.

Name Type Description
source Document | Node | Object | string

Source.

options

Read options.

Name Type Description
dataProjection 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 defaultDataProjection of the format is assigned (where set). If the projection can not be derived from the data and if no defaultDataProjection is set for a format, the features will not be reprojected.

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

writeFeature(feature, opt_options){string}

src/ol/format/wktformat.js, line 308

Encode a feature as a WKT string.

Name Type Description
feature ol.Feature

Feature.

options

Write options.

Name Type Description
dataProjection ol.proj.ProjectionLike

Projection of the data we are writing. If not provided, the defaultDataProjection of the format is assigned (where set). If no defaultDataProjection is set for a format, the features will be returned in the featureProjection.

featureProjection ol.proj.ProjectionLike

Projection of the feature geometries that will be serialized by the format writer.

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

Returns:
WKT string.

writeFeatures(features, opt_options){string}

src/ol/format/wktformat.js, line 332

Encode an array of features as a WKT string.

Name Type Description
features Array.<ol.Feature>

Features.

options

Write options.

Name Type Description
dataProjection ol.proj.ProjectionLike

Projection of the data we are writing. If not provided, the defaultDataProjection of the format is assigned (where set). If no defaultDataProjection is set for a format, the features will be returned in the featureProjection.

featureProjection ol.proj.ProjectionLike

Projection of the feature geometries that will be serialized by the format writer.

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

Returns:
WKT string.

writeGeometry(geometry){string}

src/ol/format/wktformat.js, line 359

Write a single geometry as a WKT string.

Name Type Description
geometry ol.geom.Geometry

Geometry.

Returns:
WKT string.