View Source Geometry.LineString (Geometry v0.4.0)

A line-string struct, representing a 2D line.

A none empty line-string requires at least two points.

Link to this section Summary

t()

new()

Creates an empty LineString.

new(points)

Creates a LineString from the given Geometry.Points.

@type t() :: %Geometry.LineString{points: Geometry.coordinates()}

@spec new() :: t()

Creates an empty LineString.

iex> LineString.new()
%LineString{points: []}

@spec new([Geometry.Point.t()]) :: t()

Creates a LineString from the given Geometry.Points.

iex> LineString.new([Point.new(1, 2), Point.new(3, 4)])
%LineString{points: [[1, 2], [3, 4]]}