Visualize.Chart.Builder.Place (Visualize v0.8.0)

Where a drop on the graph lands, and what a component means there (spec/14 §18.16).

A drop is a point in chart coordinates; region/2 classifies it against the frame the preview drew — the plot area, or one of the four margins — and node/4 says what the dropped component becomes in that region: an axis on that side with the scale it needs, a title or a label at the anchor the region implies, a legend at the nearest position, a mark of a type. home/1 is the region the keyboard twin and the + menu place in.

Every function here is pure; the builder inserts what node/4 returns.

This module compiles only when Phoenix.Component is loaded (spec/10 §1.1, D-45, D-85).

Summary

Types

component()

What the palette offers: a component, or a mark of a type.

frame_geometry()

Where a frame is drawn in the graph: its pixel box, its size and its margin.

region()

A region of the frame a drop lands in.

site()

A site to insert: its kind, its body under the kind's key, and its key if named.

spot()

A point on the graph read in the frame under it (spec/14 §18.16).

Functions

component(word)

A component from the word its row carries, or :error.

components()

The palette's rows in the order shown: the five components — a frame among them (#616) — then a mark of every type.

frames(design, arg)

Every frame of a design as the graph draws it at size (spec/14 §18.4, §18.16): its name, its pixel box (x, y, size) and its margin, in drawing order — z, then name, so the last is the one on top (§4.7). The box is Visualize.Chart.Frame.box_of/3 of the frame, its cell resolved over the design's layout; a frame whose placement does not read yet is drawn over the whole box, as it would be with none. A design with no frame is one frame named as Visualize.Chart.Fragment.frame_name/1 names it.

geometry(design)

The size and margin the preview draws a design at: the size is the render's own default, since a design records none (spec/14 §4.2), and the margin is the design's over the schema's default.

grid(design, size)

The design's layout as the graph draws it at a size (spec/14 §2.8, §18.16, #617): each column's {x, w} and each row's {y, h} as fractions, the gap taken out of the cells as Visualize.Chart.Frame.box_of/3 takes it; nil for a design with no layout, or one whose weights do not read.

guess(design, type)

A mark type's data and channels guessed over the composed design (spec/14 §18.16): the chart's first source — the one the last mark binds, else the first declared by name — and its fields in order over the type's required channels; fewer fields leave the rest unbound; no source, nothing.

home(arg1)

The region a component is placed in from the keyboard or the + menu: an axis at the bottom, a title at the top, a label at the bottom, a legend and a mark in the plot.

movable?(arg1)

Whether a drawn node's label names a node that is moved on the graph (spec/14 §18.16): an axis, the legend, a label. A mark's position is its data; the frame does not move.

moved(kind, body, region, point, design \\ %{})

A node moved to a region at a point over the composed design (spec/14 §18.16): its body with the placement key rewritten — an axis's side, a legend's position, a label's anchor — or :same when the region names what it already is, or :unmovable for a kind with no placement. An axis whose orientation changes takes the scale its new side reads — the one another axis on that orientation reads, else x or y — since a scale's range is set by its name (§4.3); a scale the design lacks is brought as a drop brings it, {:ok, body, [scale_site]}. The point is a spot/3 or a bare point, as node/4 reads one.

new_frame(design, arg2, arg3)

A new frame dropped on the graph at a point (spec/14 §18.16, #616): a fresh name — main in a design with none, else the first free frame_<n> from 2 — and a box a quarter of the graph, half its width and half its height, centered on the point and kept inside, as fractions rounded to four places. :center is the graph's center, where the keyboard twin and + frame place one.

node(arg1, region, design, point)

What a component becomes in a region of the composed design, dropped at a point: {:sites, sites} — lowest first, so an axis's scale comes before the axis — or {:legend, node} for the frame's legend, or {:error, :no_scale} for a legend on a design with no ordinal scale. The point is a spot/3 — read in the frame under it — or a bare point, read in the design's frame at the render's default size.

placed(fragment, region)

A library entry's body placed: an axis's side, a label's anchor set from the region where the region names one; anything else, and a drop in the plot, as the entry wrote it.

region(arg, map)

The region a point in chart coordinates falls in: inside the plot area is :plot; otherwise the top or bottom band, then the left or right — so a corner is the top's or the bottom's, where the title and the x axis live.

several?(arg1)

Whether a design has several frames (spec/14 §2.1), so that what is placed on the graph says which one it belongs to (#615).

spot(design, size, arg)

A point on the graph, in chart coordinates, read in the frame under it (spec/14 §18.16): the topmost frame whose box holds the point — else the nearest — with the point in that frame's own coordinates and the frame's size and margin, which region/2 classifies.

spot_in(design, size, frame)

A spot in a named frame, at its origin (#615): what the keyboard twin places with, which names a region and no point — the open node's frame, at the graph's size. A frame the design does not draw is read as spot/3 reads the origin.