Hakushi.Change (Hakushi v0.6.0)

Copy Markdown View Source

A change to a canvas: what a person did, or what the app does.

Every change goes the same way, whoever makes it: the canvas applies it to its graph (Hakushi.Graph.apply/2), checks its rules (Hakushi.Rules), asks the app (on_change), and only then shows it, to the person and to everyone else on the canvas. A change the server refuses goes back in the browser, with the reason.

op is one of:

  • :add - nodes is a list of Hakushi.Nodes, edges a list of Hakushi.Edges between them or others: a node dropped on the canvas, a paste, a duplicate, an undone delete.
  • :connect - edges is a list of Hakushi.Edges, drawn by a person from a handle to a handle.
  • :move - nodes is a list of maps with :id, :x and :y, :width and :height for a node that was resized, and :parent for a node dropped into a group (an id) or out of one (nil). The nodes in a moved node move with it: Hakushi.Graph.apply/2 lists them.
  • :reconnect - edges is a list of maps with :id and the new ends (:source, :source_handle, :target, :target_handle): an edge's end dragged to another handle.
  • :update - nodes is a list of maps with :id and the keys that change (:data, :type, :locked, and :x, :y, :width and :height for an edit that moves its node too), edges a list of maps with :id and the keys that change (:label, :path, :marker, :animated, :data).
  • :delete - nodes and edges are lists of ids. Deleting a node deletes the nodes in it and the edges of all of them: the change that Hakushi.Graph.apply/2 gives back lists them.
  • :paper - paper is the canvas's paper (Hakushi.Paper), chosen with the canvas's picker, or nil for the canvas's own background and grid.

by is the user of the canvas that made it (a map with an :id), or nil for the app's own.

Summary

Types

op()
t()

Functions

add(nodes, edges \\ [])

Adds nodes, and edges.

connect(edges)

Connects two nodes: an edge, or a list of them.

delete(opts)

Deletes nodes (with their edges) and edges, by id.

ids(change)

The ids of the nodes a change touches, and of its edges, as two lists.

move(places)

Moves nodes: [{id, x, y}] or maps with :id, :x and :y.

paper(paper)

Changes the canvas's paper: its pattern and the size of its squares (Hakushi.Paper.new/1), or nil for the canvas's own.

reconnect(ends)

Moves the ends of edges: maps with the edge's :id and its new :source, :source_handle, :target or :target_handle.

update(opts)

Changes nodes and edges: maps with an :id and the keys that change.

Types

op()

@type op() :: :add | :connect | :move | :reconnect | :update | :delete | :paper

t()

@type t() :: %Hakushi.Change{
  by: map() | nil,
  edges: [Hakushi.Edge.t() | map() | Hakushi.Edge.id()],
  nodes: [Hakushi.Node.t() | map() | Hakushi.Node.id()],
  op: op(),
  paper: Hakushi.Paper.t() | nil
}

Functions

add(nodes, edges \\ [])

@spec add([Hakushi.Node.t() | map()], [Hakushi.Edge.t() | map()]) :: t()

Adds nodes, and edges.

connect(edges)

@spec connect(Hakushi.Edge.t() | map() | [Hakushi.Edge.t() | map()]) :: t()

Connects two nodes: an edge, or a list of them.

delete(opts)

@spec delete(keyword()) :: t()

Deletes nodes (with their edges) and edges, by id.

ids(change)

@spec ids(t()) :: {[Hakushi.Node.id()], [Hakushi.Edge.id()]}

The ids of the nodes a change touches, and of its edges, as two lists.

move(places)

@spec move([{Hakushi.Node.id(), number(), number()} | map()]) :: t()

Moves nodes: [{id, x, y}] or maps with :id, :x and :y.

paper(paper)

@spec paper(map() | keyword() | nil) :: t()

Changes the canvas's paper: its pattern and the size of its squares (Hakushi.Paper.new/1), or nil for the canvas's own.

Hakushi.Change.paper(background: :lines, grid: 24)

reconnect(ends)

@spec reconnect([map()]) :: t()

Moves the ends of edges: maps with the edge's :id and its new :source, :source_handle, :target or :target_handle.

update(opts)

@spec update(keyword()) :: t()

Changes nodes and edges: maps with an :id and the keys that change.

Hakushi.Change.update(nodes: [%{id: "users", data: %{name: "people"}}])