Visualize.Shape.Area (Visualize v0.2.35)

Area generator for creating filled areas between two lines.

Useful for area charts, stacked areas, and range visualizations.

Examples

data = [
  %{date: ~D[2024-01-01], value: 10},
  %{date: ~D[2024-01-02], value: 25},
  %{date: ~D[2024-01-03], value: 15}
]

area = Visualize.Shape.Area.new()
  |> Visualize.Shape.Area.x(fn d -> scale_x.(d.date) end)
  |> Visualize.Shape.Area.y0(fn _d -> height end)  # baseline
  |> Visualize.Shape.Area.y1(fn d -> scale_y.(d.value) end)
  |> Visualize.Shape.Area.curve(:monotone_x)

path_data = Visualize.Shape.Area.generate(area, data)

Summary

Functions

curve(area, curve_type, opts \\ [])

Sets the curve type

defined(area, predicate)

Sets the defined predicate: a falsy result breaks the area into separate rings

generate(area, data)

Generates the SVG path data string.

generate_path(area, data)

Generates a Path struct.

new()

Creates a new area generator

x0(area, accessor)

Sets the x0 accessor (left edge)

x1(area, accessor)

Sets the x1 accessor (right edge)

x(area, accessor)

Sets the x accessor (used for both x0 and x1)

y0(area, accessor)

Sets the y0 accessor (bottom edge / baseline)

y1(area, accessor)

Sets the y1 accessor (top edge)

y(area, accessor)

Sets the y accessor (used for both y0 and y1)

Types

accessor()

@type accessor() :: (any() -> number()) | atom() | number()

t()

@type t() :: %Visualize.Shape.Area{
  curve: Visualize.Shape.Curve.curve_type(),
  curve_opts: keyword(),
  defined: (any() -> boolean()) | nil,
  x: accessor() | nil,
  x0: accessor() | nil,
  x1: accessor() | nil,
  y: accessor() | nil,
  y0: accessor() | nil,
  y1: accessor() | nil
}