View Source ArangoXEcto.GeoData (ArangoX Ecto v2.0.0)

Methods for interacting with ArangoDB GeoJSON and geo related functions

The methods within this module are really just helpers to generate Geo structs.

Summary

coordinate()

Generates a Geo linestring

Generates a Geo multi linestring

Generates a Geo multi point

Generates a Geo multi polygon

point(lat, lon)

Generates a Geo point

polygon(coords)

Generates a Geo polygon

sanitize(coords)

Sanitizes coordinates to ensure they are valid

@type coordinate() :: number()

(macro)

(macro)

(macro)

@spec linestring([{coordinate(), coordinate()}]) :: Geo.LineString.t()

Generates a Geo linestring

@spec multi_linestring([[{coordinate(), coordinate()}]]) :: Geo.MultiLineString.t()

Generates a Geo multi linestring

@spec multi_point([{coordinate(), coordinate()}]) :: Geo.MultiPoint.t()

Generates a Geo multi point

@spec multi_polygon([[[{coordinate(), coordinate()}]]]) :: Geo.MultiPolygon.t()

Generates a Geo multi polygon

@spec point(coordinate(), coordinate()) :: Geo.Point.t()

Generates a Geo point

@spec polygon([[{coordinate(), coordinate()}]]) :: Geo.Polygon.t()

Generates a Geo polygon

@spec sanitize(list() | {coordinate(), coordinate()}) ::
  list() | {coordinate(), coordinate()}

Sanitizes coordinates to ensure they are valid

This function is not automatically applied to Geo constructors and must be applied before hand