ZOO.Format.GeoJSON¶
Read and write GeoJSON.
Inherits from
Properties¶
NAME | DESCRIPTION |
---|---|
ZOO.Format.GeoJSON | Create a new parser for GeoJSON. |
read | Deserialize a GeoJSON string. |
isValidType | Check if a GeoJSON object is a valid representative of the given type. |
parseFeature | Convert a feature object from GeoJSON into an ZOO.Feature. |
parseGeometry | Convert a geometry object from GeoJSON into an ZOO.Geometry. |
parseCoords Properties¶
NAME | DESCRIPTION |
---|---|
parseCoords | Object with properties corresponding to the GeoJSON geometry types. |
parseCoords Functions¶
NAME | DESCRIPTION |
---|---|
parseCoords.point | Convert a coordinate array from GeoJSON into an ZOO.Geometry.Point. |
parseCoords.multipoint | Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPoint. |
parseCoords.linestring | Convert a coordinate array from GeoJSON into an ZOO.Geometry.LineString. |
parseCoords.multilinestring | Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiLineString. |
parseCoords.polygon | Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon. |
parseCoords.multipolygon | Convert a coordinate array from GeoJSON into an ZOO.Geometry.MultiPolygon. |
parseCoords.box | Convert a coordinate array from GeoJSON into an ZOO.Geometry.Polygon. |
write | Serialize a feature, geometry, array of features into a GeoJSON string. |
createCRSObject | Create the CRS object for an object. |
extract Properties¶
NAME | DESCRIPTION |
---|---|
extract | Object with properties corresponding to the GeoJSON types. |
extract Functions¶
NAME | DESCRIPTION |
---|---|
extract.feature | Return a partial GeoJSON object representing a single feature. |
extract.geometry | Return a GeoJSON object representing a single geometry. |
extract.point | Return an array of coordinates from a point. |
extract.multipoint | Return an array of coordinates from a multipoint. |
extract.linestring | Return an array of coordinate arrays from a linestring. |
extract.multilinestring | Return an array of linestring arrays from a linestring. |
extract.polygon | Return an array of linear ring arrays from a polygon. |
extract.multipolygon | Return an array of polygon arrays from a multipolygon. |
extract.collection | Return an array of geometries from a geometry collection. |
Functions
- ZOO.Format.GeoJSON
Create a new parser for GeoJSON.
Parameters
options {Object}
An optional object whose properties will be set on this instance.
- read
read: function(json,type,filter)
Deserialize a GeoJSON string.
Parameters
json {String}
A GeoJSON stringtype {String}
Optional string that determines the structure of the output. Supported values are “Geometry”, “Feature”, and “FeatureCollection”. If absent or null, a default of “FeatureCollection” is assumed.filter {Function}
A function which will be called for every key and value at every level of the final result. Each value will be replaced by the result of the filter function. This can be used to reform generic objects into instances of classes, or to transform date strings into Date objects.Returns
{Object}
The return depends on the value of the type argument. If type is “FeatureCollection” (the default), the return will be an array of ZOO.Feature. If type is “Geometry”, the input json must represent a single geometry, and the return will be an ZOO.Geometry. If type is “Feature”, the input json must represent a single feature, and the return will be an ZOO.Feature.
- isValidType
isValidType: function(obj,type)
Check if a GeoJSON object is a valid representative of the given type.
Returns
{Boolean}
The object is valid GeoJSON object of the given type.
- parseFeature
parseFeature: function(obj)
Convert a feature object from GeoJSON into a ZOO.Feature.
Parameters
obj {Object}
An object created from a GeoJSON objectReturns
{ZOO.Feature} A feature.
- parseGeometry
parseGeometry: function(obj)
Convert a geometry object from GeoJSON into a ZOO.Geometry.
Parameters
obj {Object}
An object created from a GeoJSON objectReturns
{ZOO.Geometry} A geometry.
parseCoords Properties
- parseCoords
- Object with properties corresponding to the GeoJSON geometry types. Property values are functions that do the actual parsing.
parseCoords Functions
- parseCoords.point
Convert a coordinate array from GeoJSON into a ZOO.Geometry.Point.
Parameters
array {Object}
The coordinates array from the GeoJSON fragment.Returns
{ZOO.Geometry.Point} A geometry.
- parseCoords.multipoint
Convert a coordinate array from GeoJSON into a ZOO.Geometry.MultiPoint.
Parameters
array {Object}
The coordinates array from the GeoJSON fragment.Returns
{ZOO.Geometry.MultiPoint} A geometry.
- parseCoords.linestring
Convert a coordinate array from GeoJSON into a ZOO.Geometry.LineString.
Parameters
array {Object}
The coordinates array from the GeoJSON fragment.Returns
{ZOO.Geometry.LineString} A geometry.
- parseCoords.multilinestring
Convert a coordinate array from GeoJSON into a ZOO.Geometry.MultiLineString.
Parameters
array {Object}
The coordinates array from the GeoJSON fragment.Returns
{ZOO.Geometry.MultiLineString} A geometry.
- parseCoords.polygon
Convert a coordinate array from GeoJSON into a ZOO.Geometry.Polygon.
Parameters
array {Object}
The coordinates array from the GeoJSON fragment.Returns
{ZOO.Geometry.Polygon} A geometry.
- parseCoords.multipolygon
Convert a coordinate array from GeoJSON into a ZOO.Geometry.MultiPolygon.
Parameters
array {Object}
The coordinates array from the GeoJSON fragment.Returns
{ZOO.Geometry.MultiPolygon} A geometry.
- parseCoords.box
Convert a coordinate array from GeoJSON into a ZOO.Geometry.Polygon.
Parameters
array {Object}
The coordinates array from the GeoJSON fragment.Returns
{ZOO.Geometry.Polygon} A geometry.
- write
write: function(obj,pretty)
Serialize a feature, geometry, array of features into a GeoJSON string.
Parameters
pretty {Boolean}
Structure the output with newlines and indentation. Default is false.Returns
{String}
The GeoJSON string representation of the input geometry, features, or array of features.
- createCRSObject
createCRSObject: function(object)
Create the CRS object for an object.
Parameters
object
{ZOO.Feature}Returns
{Object}
An object which can be assigned to the crs property of a GeoJSON object.
extract Properties
- extract
- Object with properties corresponding to the GeoJSON types. Property values are functions that do the actual value extraction.
extract Functions
- extract.feature
Return a partial GeoJSON object representing a single feature.
Parameters
feature
{ZOO.Feature}Returns
{Object}
An object representing the point.
- extract.geometry
Return a GeoJSON object representing a single geometry.
Parameters
geometry
{ZOO.Geometry}Returns
{Object}
An object representing the geometry.
- extract.point
Return an array of coordinates from a point.
Parameters
point
{ZOO.Geometry.Point}Returns
{Array}
An array of coordinates representing the point.
- extract.multipoint
Return an array of coordinates from a multipoint.
Parameters
multipoint
{ZOO.Geometry.MultiPoint}Returns
{Array}
An array of point coordinate arrays representing the multipoint.
- extract.linestring
Return an array of coordinate arrays from a linestring.
Parameters
linestring
{ZOO.Geometry.LineString}Returns
{Array}
An array of coordinate arrays representing the linestring.
- extract.multilinestring
Return an array of linestring arrays from a linestring.
Parameters
multilinestring
{ZOO.Geometry.MultiLineString}Returns
{Array}
An array of linestring arrays representing the multilinestring.
- extract.polygon
Return an array of linear ring arrays from a polygon.
Parameters
polygon
{ZOO.Geometry.Polygon}Returns
{Array}
An array of linear ring arrays representing the polygon.
- extract.multipolygon
Return an array of polygon arrays from a multipolygon.
Parameters
multipolygon
{ZOO.Geometry.MultiPolygon}Returns
{Array}
An array of polygon arrays representing the multipolygon
- extract.collection
Return an array of geometries from a geometry collection.
Parameters
collection
{ZOO.Geometry.Collection}Returns
{Array}
An array of geometry objects representing the geometry collection.