Class: GeoJSON

ol.format.GeoJSON

Feature format for reading and writing data in the GeoJSON format.

new ol.format.GeoJSON(opt_options)

Name Type Description
options

Options.

Name Type Description
defaultDataProjection ol.proj.ProjectionLike

Default data projection.

geometryName string | undefined

Geometry name to use when creating features.

Extends

Methods

readFeature(source, opt_options){ol.Feature}

Read a feature from a GeoJSON Feature source. Only works for Feature, use readFeatures to read FeatureCollection 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 GeoJSON source. Works with both Feature and FeatureCollection sources.

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 geometry from a GeoJSON 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.

Read the projection from a GeoJSON source.

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

Source.

Returns:
Projection.

writeFeature(feature, options){GeoJSONFeature}

Encode a feature as a GeoJSON Feature object.

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

writeFeatures(features, options){GeoJSONObject}

Encode an array of features as GeoJSON.

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

writeGeometry(geometry, options){GeoJSONGeometry|GeoJSONGeometryCollection}

Encode a geometry as GeoJSON.

Name Type Description
geometry ol.geom.Geometry

Geometry.

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