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

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.

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.

Functions

component(word)

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

components()

The palette's rows in the order shown: the four components, then a mark of every type.

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.

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]}.

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.

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.