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

Methods for interacting with ArangoDB GeoJSON and geo related functions

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

Link to this section Summary

Functions

Generates a Geo linestring

Generates a Geo multi linestring

Generates a Geo multi point

Generates a Geo multi polygon

Generates a Geo point

Generates a Geo polygon

Sanitizes coordinates to ensure they are valid

Link to this section Types

Specs

coordinate() :: number()

Link to this section Functions

Link to this macro

is_coordinate(coordinate)

View Source (macro)
Link to this macro

is_latitude(coordinate)

View Source (macro)
Link to this macro

is_longitude(coordinate)

View Source (macro)

Specs

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

Generates a Geo linestring

Link to this function

multi_linestring(coords)

View Source

Specs

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

Generates a Geo multi linestring

Specs

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

Generates a Geo multi point

Specs

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

Generates a Geo multi polygon

Specs

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

Generates a Geo point

Specs

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

Generates a Geo polygon

Specs

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