Liking cljdoc? Tell your friends :D

scicloj.plotje.impl.render


*format-asked*clj

The format name the caller wrote, where it differs from the name the renderer dispatches on. pj/save writes a file, so its vocabulary names the file format: a .png path reaches the :bufimg renderer, and a message naming :bufimg sends the reader looking for a word they never wrote. Bound by pj/save; nil everywhere else, where the two vocabularies agree.

Which formats draw interaction is still read from interactive-formats alone -- this only changes the name the message prints.

The format name the caller wrote, where it differs from the name the
renderer dispatches on. `pj/save` writes a file, so its vocabulary
names the file format: a `.png` path reaches the `:bufimg` renderer,
and a message naming `:bufimg` sends the reader looking for a word
they never wrote. Bound by `pj/save`; nil everywhere else, where the
two vocabularies agree.

Which formats draw interaction is still read from
`interactive-formats` alone -- this only changes the name the
message prints.
sourceraw docstring

interactive-formatsclj

The formats whose output can carry the :tooltip and :brush aesthetics. Both are drawn by a browser reading the figure, so the SVG renderer is the only one that answers them today. A renderer that draws interaction adds its format here.

The formats whose output can carry the `:tooltip` and `:brush`
aesthetics. Both are drawn by a browser reading the figure, so the
SVG renderer is the only one that answers them today. A renderer
that draws interaction adds its format here.
sourceraw docstring

membrane->plotcljmultimethod

Convert a membrane drawable tree into a figure for the given format. Dispatches on the format keyword (:svg, etc.).

The :default defmethod loads renderer namespaces on demand for formats listed in known-render-namespaces.

Convert a membrane drawable tree into a figure for the given format.
Dispatches on the format keyword (:svg, etc.).

The :default defmethod loads renderer namespaces on demand for
formats listed in `known-render-namespaces`.
sourceraw docstring

plan->plotcljmultimethod

Convert a plan into a figure for the given format. Returns format-specific output (e.g., SVG hiccup, Plotly spec). Dispatches on the format keyword (:svg, :plotly, etc.).

The :default defmethod loads renderer namespaces on demand for formats listed in known-render-namespaces.

Convert a plan into a figure for the given format.
Returns format-specific output (e.g., SVG hiccup, Plotly spec).
Dispatches on the format keyword (:svg, :plotly, etc.).

The :default defmethod loads renderer namespaces on demand for
formats listed in `known-render-namespaces`.
sourceraw docstring

warn-interaction-ignored!clj

(warn-interaction-ignored! plan format opts)

Warn when a plot asks for hover text or a brush and the format it is rendered to draws neither.

plan/warn-unread-tooltip-mappings reports the same fact reached the other way -- a :tooltip that reaches no mark that draws one. This is the half that said nothing: a raster render returned an image, drew no hover text and no brush, and printed nothing at all.

Called by each plan->plot method and by pj/plot, which are the calls that know the format. Passing every format and letting interactive-formats decide means a renderer added later is covered without a second list naming it.

Warn when a plot asks for hover text or a brush and the format it is
rendered to draws neither.

`plan/warn-unread-tooltip-mappings` reports the same fact reached
the other way -- a `:tooltip` that reaches no mark that draws one.
This is the half that said nothing: a raster render returned an
image, drew no hover text and no brush, and printed nothing at all.

Called by each `plan->plot` method and by `pj/plot`, which are the
calls that know the format. Passing every format and letting
`interactive-formats` decide means a renderer added later is covered
without a second list naming it.
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