ALKMaps.Format.GeoJSON

Read and write GeoJSON.  Create a new parser with the ALKMaps.Format.GeoJSON constructor.

Inherits from

Summary
ALKMaps.Format.GeoJSONRead and write GeoJSON.
Properties
ignoreExtraDims{Boolean} Ignore dimensions higher than 2 when reading geometry coordinates.
Constructor
ALKMaps.Format.GeoJSONCreate a new parser for GeoJSON.
Functions
readDeserialize a GeoJSON string.
isValidTypeCheck if a GeoJSON object is a valid representative of the given type.
parseFeatureConvert a feature object from GeoJSON into an ALKMaps.Feature.Vector.
parseGeometryConvert a geometry object from GeoJSON into an ALKMaps.Geometry.
Properties
parseCoordsObject with properties corresponding to the GeoJSON geometry types.
Functions
parseCoords.pointConvert a coordinate array from GeoJSON into an ALKMaps.Geometry.
parseCoords.multipointConvert a coordinate array from GeoJSON into an ALKMaps.Geometry.
parseCoords.linestringConvert a coordinate array from GeoJSON into an ALKMaps.Geometry.
parseCoords.multilinestringConvert a coordinate array from GeoJSON into an ALKMaps.Geometry.
parseCoords.polygonConvert a coordinate array from GeoJSON into an ALKMaps.Geometry.
parseCoords.multipolygonConvert a coordinate array from GeoJSON into an ALKMaps.Geometry.
parseCoords.boxConvert a coordinate array from GeoJSON into an ALKMaps.Geometry.
writeSerialize a feature, geometry, array of features into a GeoJSON string.
createCRSObjectCreate the CRS object for an object.
Properties
extractObject with properties corresponding to the GeoJSON types.
Functions
extract.featureReturn a partial GeoJSON object representing a single feature.
extract.geometryReturn a GeoJSON object representing a single geometry.
extract.pointReturn an array of coordinates from a point.
extract.multipointReturn an array of point coordinates from a multipoint.
extract.linestringReturn an array of coordinate arrays from a linestring.
extract.multilinestringReturn an array of linestring arrays from a linestring.
extract.polygonReturn an array of linear ring arrays from a polygon.
extract.multipolygonReturn an array of polygon arrays from a multipolygon.
extract.collectionReturn an array of geometries from a geometry collection.

Properties

ignoreExtraDims

{Boolean} Ignore dimensions higher than 2 when reading geometry coordinates.

Constructor

ALKMaps.Format.GeoJSON

Create a new parser for GeoJSON.

Parameters

options{Object} An optional object whose properties will be set on this instance.

Functions

read

read: function(json,
type,
filter)

Deserialize a GeoJSON string.

Parameters

json{String} A GeoJSON string
type{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 ALKMaps.Feature.Vector.  If type is “Geometry”, the input json must represent a single geometry, and the return will be an ALKMaps.Geometry.  If type is “Feature”, the input json must represent a single feature, and the return will be an ALKMaps.Feature.Vector.

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 an ALKMaps.Feature.Vector.

Parameters

obj{Object} An object created from a GeoJSON object

Returns

{ALKMaps.Feature.Vector} A feature.

parseGeometry

parseGeometry: function(obj)

Convert a geometry object from GeoJSON into an ALKMaps.Geometry.

Parameters

obj{Object} An object created from a GeoJSON object

Returns

{ALKMaps.Geometry} A geometry.

Properties

parseCoords

Object with properties corresponding to the GeoJSON geometry types.  Property values are functions that do the actual parsing.

Functions

parseCoords.point

Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.

Parameters

array{Object} The coordinates array from the GeoJSON fragment.

Returns

{ALKMaps.Geometry} A geometry.

parseCoords.multipoint

Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.

Parameters

array{Object} The coordinates array from the GeoJSON fragment.

Returns

{ALKMaps.Geometry} A geometry.

parseCoords.linestring

Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.

Parameters

array{Object} The coordinates array from the GeoJSON fragment.

Returns

{ALKMaps.Geometry} A geometry.

parseCoords.multilinestring

Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.

Parameters

array{Object} The coordinates array from the GeoJSON fragment.

Returns

{ALKMaps.Geometry} A geometry.

parseCoords.polygon

Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.

Returns

{ALKMaps.Geometry} A geometry.

parseCoords.multipolygon

Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.

Parameters

array{Object} The coordinates array from the GeoJSON fragment.

Returns

{ALKMaps.Geometry} A geometry.

parseCoords.box

Convert a coordinate array from GeoJSON into an ALKMaps.Geometry.

Parameters

array{Object} The coordinates array from the GeoJSON fragment.

Returns

{ALKMaps.Geometry} A geometry.

write

write: function(obj,
pretty)

Serialize a feature, geometry, array of features into a GeoJSON string.

Parameters

obj{Object} An ALKMaps.Feature.Vector, ALKMaps.Geometry, or an array of features.
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{ALKMaps.Feature.Vector}

Returns

{Object} An object which can be assigned to the crs property of a GeoJSON object.

Properties

extract

Object with properties corresponding to the GeoJSON types.  Property values are functions that do the actual value extraction.

Functions

extract.feature

Return a partial GeoJSON object representing a single feature.

Parameters

feature{ALKMaps.Feature.Vector}

Returns

{Object} An object representing the point.

extract.geometry

Return a GeoJSON object representing a single geometry.

Parameters

geometry{ALKMaps.Geometry}

Returns

{Object} An object representing the geometry.

extract.point

Return an array of coordinates from a point.

Parameters

point{ALKMaps.Geometry.Point}

Returns

{Array} An array of coordinates representing the point.

extract.multipoint

Return an array of point coordinates from a multipoint.

Parameters

multipoint{ALKMaps.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{ALKMaps.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{ALKMaps.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{ALKMaps.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{ALKMaps.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{ALKMaps.Geometry.Collection}

Returns

{Array} An array of geometry objects representing the geometry collection.

read: function(json,
type,
filter)
Deserialize a GeoJSON string.
isValidType: function(obj,
type)
Check if a GeoJSON object is a valid representative of the given type.
parseFeature: function(obj)
Convert a feature object from GeoJSON into an ALKMaps.Feature.Vector.
Vector features use the ALKMaps.Geometry classes as geometry description.
parseGeometry: function(obj)
Convert a geometry object from GeoJSON into an ALKMaps.Geometry.
A Geometry is a description of a geographic object.
write: function(obj,
pretty)
Serialize a feature, geometry, array of features into a GeoJSON string.
createCRSObject: function(object)
Create the CRS object for an object.
Create a new parser for GeoJSON.
A parser to read/write JSON safely.
Point geometry class.
MultiPoint is a collection of Points.
A LineString is a Curve which, once two points have been added to it, can never be less than two points long.
A MultiLineString is a geometry with multiple ALKMaps.Geometry.LineString components.
Polygon is a collection of Geometry.LinearRings.
MultiPolygon is a geometry with multiple ALKMaps.Geometry.Polygon components.
A Collection is exactly what it sounds like: A collection of different Geometries.
Close