new ol.format.GeoJSON(opt_options)
Name | Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
options |
Options.
|
Extends
Methods
-
readFeature(source, opt_options){ol.Feature}
src/ol/format/geojsonformat.js, line 384 -
Read a feature from a GeoJSON Feature source. Only works for Feature, use
readFeatures
to read FeatureCollection 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 nodefaultDataProjection
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/geojsonformat.js, line 397 -
Read all features from a GeoJSON source. Works with both Feature and FeatureCollection sources.
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 nodefaultDataProjection
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/geojsonformat.js, line 461 -
Read a geometry from a GeoJSON 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 nodefaultDataProjection
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.
-
readProjection(source){ol.proj.Projection}
src/ol/format/geojsonformat.js, line 482 -
Read the projection from a GeoJSON source.
Name Type Description source
Document | Node | Object | string Source.
Returns:
Projection.
-
writeFeature(feature, opt_options){string}
src/ol/format/geojsonformat.js, line 519 -
Encode a feature as a GeoJSON Feature 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 nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.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. 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.Returns:
GeoJSON.
-
writeFeatureObject(feature, opt_options){Object}
src/ol/format/geojsonformat.js, line 530 -
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 Projection of the data we are writing. If not provided, the
defaultDataProjection
of the format is assigned (where set). If nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.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. 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.Returns:
Object.
-
writeFeatures(features, opt_options){string}
src/ol/format/geojsonformat.js, line 565 -
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 Projection of the data we are writing. If not provided, the
defaultDataProjection
of the format is assigned (where set). If nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.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. 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.Returns:
GeoJSON.
-
writeFeaturesObject(features, opt_options){Object}
src/ol/format/geojsonformat.js, line 576 -
Encode an array of features as a GeoJSON object.
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 nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.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. 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.Returns:
GeoJSON Object.
-
writeGeometry(geometry, opt_options){string}
src/ol/format/geojsonformat.js, line 600 -
Encode a geometry as a GeoJSON string.
Name Type Description geometry
ol.geom.Geometry Geometry.
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 nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.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. 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.Returns:
GeoJSON.
-
writeGeometryObject(geometry, opt_options){GeoJSONGeometry|GeoJSONGeometryCollection}
src/ol/format/geojsonformat.js, line 611 -
Encode a geometry as a GeoJSON object.
Name Type Description geometry
ol.geom.Geometry Geometry.
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 nodefaultDataProjection
is set for a format, the features will be returned in thefeatureProjection
.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. 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.Returns:
Object.