Liking cljdoc? Tell your friends :D

scicloj.plotje.impl.plan-schema

Malli schemas for the plan data model.

Malli schemas for the plan data model.
raw docstring

AlphaLegendclj

source

AlphaLegendEntryclj

source

Annotationclj

A reference line or band annotation. Dispatched on :mark: rule-h requires :y-intercept; rule-v requires :x-intercept; band-h requires :y-min and :y-max; band-v requires :x-min and :x-max. :color must be a literal string (not a column reference); pose-level column-mapped aesthetics are filtered before annotations reach the plan.

A reference line or band annotation. Dispatched on :mark:
rule-h requires :y-intercept; rule-v requires :x-intercept;
band-h requires :y-min and :y-max; band-v requires :x-min and :x-max.
:color must be a literal string (not a column reference); pose-level
column-mapped aesthetics are filtered before annotations reach the plan.
sourceraw docstring

BarBinclj

source

BarGroupclj

source

BoxplotBoxclj

A single boxplot box with five-number summary.

A single boxplot box with five-number summary.
sourceraw docstring

Colorclj

RGBA color vector [r g b a], values 0-1.

RGBA color vector [r g b a], values 0-1.
sourceraw docstring

CompositeChromeclj

Resolved chrome geometry on a CompositePlan. All inputs the plan->membrane CompositePlan defmethod needs to render -- title, grid-rect, strip labels and dimensions, shared-legend spec, and the per-leaf rect map.

Resolved chrome geometry on a CompositePlan. All inputs the
plan->membrane CompositePlan defmethod needs to render -- title,
grid-rect, strip labels and dimensions, shared-legend spec, and
the per-leaf rect map.
sourceraw docstring

CompositePlanSchemaclj

A fully resolved composite plan. Tiles per-leaf plans by rect with shared chrome (title band, strip labels, shared legend) on top. Canonical contract for the CompositePlan defrecord in impl/resolve.clj.

A fully resolved composite plan. Tiles per-leaf plans by rect with
shared chrome (title band, strip labels, shared legend) on top.
Canonical contract for the `CompositePlan` defrecord in
`impl/resolve.clj`.
sourceraw docstring

CountEntryclj

source

ErrorbarGroupclj

Error bars at data positions.

Error bars at data positions.
sourceraw docstring

explainclj

(explain plan)

Explain why a plan is invalid.

Explain why a plan is invalid.
sourceraw docstring

FiniteNumberclj

A finite number. Rejects NaN and Infinity, which would render as silently-invisible annotations at unresolvable axis positions.

A finite number. Rejects NaN and Infinity, which would render as
silently-invisible annotations at unresolvable axis positions.
sourceraw docstring

GradientStopclj

source

Layoutclj

source

LeafPlanSchemaclj

A fully resolved leaf plan -- the geometry for a single composable pose with one or more panels (one per facet variant). Data-space geometry, no membrane types, no datasets. Numeric arrays (xs, ys, etc.) may be dtype-next buffers. Canonical contract for the Plan defrecord in impl/resolve.clj.

A fully resolved leaf plan -- the geometry for a single
composable pose with one or more panels (one per facet variant).
Data-space geometry, no membrane types, no datasets.
Numeric arrays (xs, ys, etc.) may be dtype-next buffers.
Canonical contract for the `Plan` defrecord in `impl/resolve.clj`.
sourceraw docstring

Legendclj

source

LegendEntryclj

source

LineSegmentGroupclj

Regression line segment.

Regression line segment.
sourceraw docstring

MarkStyleclj

source

Panelclj

A single plot panel.

A single plot panel.
sourceraw docstring

PlanLayerclj

A plan-layer: a rendered mark with data-space geometry. Canonical contract for the PlanLayer defrecord in impl/resolve.clj.

A plan-layer: a rendered mark with data-space geometry. Canonical
contract for the `PlanLayer` defrecord in `impl/resolve.clj`.
sourceraw docstring

PlanSchemaclj

Top-level plan schema -- accepts either shape.

Top-level plan schema -- accepts either shape.
sourceraw docstring

PointGroupclj

Data-space positions for a :point layer. :xs and :ys are :sequential any? rather than number? because either axis may be categorical (strings travel through a band scale); per-panel scales enforce what values are valid at render time.

Data-space positions for a :point layer. :xs and :ys are
:sequential any? rather than number? because either axis may be
categorical (strings travel through a band scale); per-panel
scales enforce what values are valid at render time.
sourceraw docstring

PolylineGroupclj

Connected points. :xs/:ys are any? for the same reason as PointGroup.

Connected points. :xs/:ys are any? for the same reason as PointGroup.
sourceraw docstring

Rectclj

A pixel rectangle as [x y w h].

A pixel rectangle as `[x y w h]`.
sourceraw docstring

RectCountGroupclj

source

RectValueGroupclj

source

ScaleSpecclj

Scale specification.

Scale specification.
sourceraw docstring

SizeLegendclj

source

SizeLegendEntryclj

source

SubPlotclj

One entry in a CompositePlan's :sub-plots: a leaf plan placed at a pose-tree path with its rect inside the composite.

One entry in a CompositePlan's :sub-plots: a leaf plan placed at a
pose-tree path with its rect inside the composite.
sourceraw docstring

TextGroupclj

Text labels at data positions. :xs/:ys are any? for the same reason as PointGroup.

Text labels at data positions. :xs/:ys are any? for the same reason as PointGroup.
sourceraw docstring

TickInfoclj

Tick values and labels for an axis.

Tick values and labels for an axis.
sourceraw docstring

TileEntryclj

A single tile (heatmap cell) with bounds and fill color.

A single tile (heatmap cell) with bounds and fill color.
sourceraw docstring

valid?clj

(valid? plan)

Check if a plan is valid (leaf or composite).

Check if a plan is valid (leaf or composite).
sourceraw docstring

ViolinEntryclj

A single violin curve with category and mirrored density.

A single violin curve with category and mirrored density.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close