Geo v3.0.0 Geo.JSON View Source

Converts Geo structs to and from a map representing GeoJSON.

You are responsible to encoding and decoding of JSON. This is so that you can use any JSON parser you want as well as making it so that you can use the resulting GeoJSON structure as a property in larger JSON structures.

#Using Poison as the JSON parser for these examples

json = "{ \"type\": \"Point\", \"coordinates\": [100.0, 0.0] }"
geom = Poison.decode!(json) |> Geo.JSON.decode!(json)
Geo.Point[coordinates: {100.0, 0.0}, srid: nil]

Geo.JSON.encode!(geom) |> Poison.encode!
"{ \"type\": \"Point\", \"coordinates\": [100.0, 0.0] }"

Geo.JSON.encode!(geom)
%{ "type" => "Point", "coordinates" => [100.0, 0.0] }

Link to this section Summary

Functions

decode(geo_json)

Takes a map representing GeoJSON and returns a Geometry

decode!(geo_json)

Takes a map representing GeoJSON and returns a Geometry

encode(geom)

Takes a Geometry and returns a map representing the GeoJSON

encode!(geom)

Takes a Geometry and returns a map representing the GeoJSON

Link to this section Functions

decode(geo_json)

decode(Map.t()) ::
  {:ok, Geo.geometry()} | {:error, Geo.JSON.Decoder.DecodeError.t()}

Takes a map representing GeoJSON and returns a Geometry

decode!(geo_json)

decode!(Map.t()) :: Geo.geometry() | no_return()

Takes a map representing GeoJSON and returns a Geometry

encode(geom)

encode(Geo.geometry()) ::
  {:ok, Map.t()} | {:error, Geo.JSON.Encoder.EncodeError.t()}

Takes a Geometry and returns a map representing the GeoJSON

encode!(geom)

encode!(Geo.geometry()) :: Map.t() | no_return()

Takes a Geometry and returns a map representing the GeoJSON