ExRatatui.Widgets.Canvas.Circle (ExRatatui v0.8.2)

Copy Markdown View Source

A circle outline to paint on a ExRatatui.Widgets.Canvas.

:x and :y pin the center in canvas coordinates. Only the circumference is drawn (ratatui's Canvas shape has no fill).

Fields

  • :x - center x coordinate (required)
  • :y - center y coordinate (required)
  • :radius - non-negative radius in canvas units (required)
  • :color - ExRatatui.Style.color() for the outline (required)

Examples

iex> alias ExRatatui.Widgets.Canvas.Circle
iex> %Circle{x: 5.0, y: 5.0, radius: 3.0, color: :yellow}
%ExRatatui.Widgets.Canvas.Circle{
  x: 5.0,
  y: 5.0,
  radius: 3.0,
  color: :yellow
}

Summary

Types

t()

@type t() :: %ExRatatui.Widgets.Canvas.Circle{
  color: ExRatatui.Style.color(),
  radius: number(),
  x: number(),
  y: number()
}