Class: WKT

ol.format.WKT

new ol.format.WKT(opt_options)

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}

Read a feature from a WKT source.

Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.

options

Read options.

Name Type Description
dataProjection ol.proj.ProjectionLike | undefined

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

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

Read all features from a WKT source.

Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.

options

Read options.

Name Type Description
dataProjection ol.proj.ProjectionLike | undefined

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

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}

Read a single geometry from a WKT source.

Name Type Description
source ArrayBuffer | Document | Node | Object | string

Source.

options

Read options.

Name Type Description
dataProjection ol.proj.ProjectionLike | undefined

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

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}

Encode a feature as a WKT string.

Name Type Description
feature ol.Feature

Feature.

options

Write options.

Name Type Description
dataProjection ol.proj.ProjectionLike | undefined

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.

Returns:
WKT string.

writeFeatures(features, opt_options){string}

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

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.

Returns:
WKT string.

writeGeometry(geometry){string}

Write a single geometry as a WKT string.

Name Type Description
geometry ol.geom.Geometry

Geometry.

Returns:
WKT string.