Geo.JSON (Geo v3.4.3) 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.

Examples

# Using Jason as the JSON parser for these examples

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

iex> geom = %Geo.Point{coordinates: {100.0, 0.0}, srid: nil}
...> Jason.encode!(geom)
"{\"coordinates\":[100.0,0.0],\"type\":\"Point\"}"

iex> geom = %Geo.Point{coordinates: {100.0, 0.0}, srid: nil}
...> 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, opts)

See Geo.JSON.Encoder.encode/2.

encode!(geom)

Takes a Geometry and returns a map representing the GeoJSON.

encode!(geom, opts)

See Geo.JSON.Encoder.encode!/2.

Link to this section Functions

decode(geo_json)

Specs

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

Takes a map representing GeoJSON and returns a Geometry.

decode!(geo_json)

Specs

decode!(map()) :: Geo.geometry()

Takes a map representing GeoJSON and returns a Geometry.

encode(geom)

Specs

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

Takes a Geometry and returns a map representing the GeoJSON.

encode(geom, opts)

See Geo.JSON.Encoder.encode/2.

encode!(geom)

Specs

encode!(Geo.geometry()) :: map()

Takes a Geometry and returns a map representing the GeoJSON.

encode!(geom, opts)

See Geo.JSON.Encoder.encode!/2.