LiveFlow.Types (LiveFlow v0.4.0)

Type definitions for LiveFlow.

This module contains all the base types used throughout the LiveFlow library.

Summary

Types

background_pattern()

Background pattern type

bounds()

Bounding box with min/max coordinates

connection_mode()

Connection mode for edges

coordinate()

2D coordinate point

dimensions()

Dimensions of an element

edge_marker()

Edge marker configuration

edge_type()

Type of edge path rendering

extent()

Extent constraint for node movement

handle_type()

Type of handle (source emits connections, target receives)

id()

Unique identifier for nodes and edges

marker_type()

Marker type for edge endpoints

node_type()

Node type identifier

position()

Position of a handle on a node

rect()

Rectangle with position and dimensions

Functions

horizontal?(arg1)

Checks if a position is horizontal (left or right).

opposite_position(atom)

Returns the opposite position.

vertical?(arg1)

Checks if a position is vertical (top or bottom).

Types

background_pattern()

@type background_pattern() :: :dots | :lines | :cross | nil

Background pattern type

bounds()

@type bounds() :: %{min: coordinate(), max: coordinate()}

Bounding box with min/max coordinates

connection_mode()

@type connection_mode() :: :strict | :loose

Connection mode for edges

coordinate()

@type coordinate() :: %{x: number(), y: number()}

2D coordinate point

dimensions()

@type dimensions() :: %{width: number(), height: number()}

Dimensions of an element

edge_marker()

@type edge_marker() :: %{
  optional(:type) => marker_type(),
  optional(:color) => String.t(),
  optional(:width) => number(),
  optional(:height) => number(),
  optional(:stroke_width) => number()
}

Edge marker configuration

edge_type()

@type edge_type() :: :bezier | :straight | :step | :smoothstep | atom()

Type of edge path rendering

extent()

@type extent() :: :parent | bounds() | nil

Extent constraint for node movement

handle_type()

@type handle_type() :: :source | :target

Type of handle (source emits connections, target receives)

id()

@type id() :: String.t()

Unique identifier for nodes and edges

marker_type()

@type marker_type() ::
  :arrow
  | :arrow_closed
  | :circle
  | :circle_filled
  | :diamond
  | :diamond_filled
  | :none
  | atom()

Marker type for edge endpoints

node_type()

@type node_type() :: :default | :input | :output | atom()

Node type identifier

position()

@type position() :: :top | :bottom | :left | :right

Position of a handle on a node

rect()

@type rect() :: %{x: number(), y: number(), width: number(), height: number()}

Rectangle with position and dimensions

Functions

horizontal?(arg1)

@spec horizontal?(position()) :: boolean()

Checks if a position is horizontal (left or right).

opposite_position(atom)

@spec opposite_position(position()) :: position()

Returns the opposite position.

Examples

iex> LiveFlow.Types.opposite_position(:top)
:bottom

iex> LiveFlow.Types.opposite_position(:left)
:right

vertical?(arg1)

@spec vertical?(position()) :: boolean()

Checks if a position is vertical (top or bottom).