Crate pluot 

This crate provides functionality for rendering visualizations.

Structs

AxisBandLayerParams

Layer params struct for AxisBandLayer.

AxisLinearLayerParams

Layer params struct for AxisLinearLayer.

BarPlotLayerParams

Layer params struct for BarPlotLayer.

BitmapLayerParams

Layer params struct for BitmapLayer.

CategoricalCustomParams

Specifies an RGB value per category and the category per instance.

CategoricalParams

Specifies a named categorical colormap and the category per instance.

ChannelSettings

Specify image channel settings, including the intensity window and an RGB color.

CurveLayerParams

Layer params struct for CurveLayer.

HistogramLayerParams

Layer params struct for HistogramLayer.

HttpStoreParams

Represents a remote Zarr store located on a standard HTTP static file server.

InstancedOpacityParams

Per-element opacity, one value (between 0.0 and 1.0) per element.

InstancedRgbInterleavedParams

Interleaved analog of InstancedRgbParams.

InstancedRgbParams

Explicitly specifies an RGB color per instance.

InstancedSizeParams

Per-element size (e.g., width or radius), one value per element.

LegendColormapQuantitativeLayerParams

Layer params struct for LegendColormapQuantitativeLayer.

LegendPointSizeQuantitativeLayerParams

Layer params struct for LegendPointSizeQuantitativeLayer.

LineLayerParams

Layer params struct for LineLayer.

LocalStoreParams

Represents a local, filesystem-backed Zarr directory store.

MarginParams

Define plot margins: left, right, top, bottom.

MemoryStoreParams

Represents an in-memory, ephemeral Zarr store.

OmeZarrBitmapLayerParams

Layer params struct for OmeZarrBitmapLayer.

OmeZarrMultiscaleLayerParams

Layer params struct for OmeZarrMultiscaleLayer.

Point3dLayerParams

Layer params struct for Point3dLayer.

PointLayerParams

Layer params struct for PointLayer.

PolygonLayerParams

Layer params struct for PolygonLayer.

QuantitativeParams

Specifies a named quantitative colormap and a scalar value per instance.

RawLayerParams

Layer parameters in their raw serde Value form.

RawLayeredPlotRenderParams

Specify LayerParams for rendering of one or more layers.

RawRenderParams

The params that are passed to the crate::render::render function.

RectLayerParams

Layer params struct for RectLayer.

RenderParams

Strongly-typed render params. Mirrors RawRenderParams but accepts layers as a typed LayerParams enum instead of RawLayerParams.

RequestInit

Specify additional options to pass when making HTTP requests.

StoreMap

A collection of Zarr stores keyed by store name.

TextLayerParams

Layer params struct for TextLayer.

ViewParams

Shared rendering parameters at the view level (i.e., not layer-specific).

ZarrBarPlotLayerParams

Layer params struct for ZarrBarPlotLayer.

ZarrHistogramLayerParams

Layer params struct for ZarrHistogramLayer.

ZarrPoint3dLayerParams

Layer params struct for ZarrPoint3dLayer.

ZarrPointLayerParams

Layer params struct for ZarrPointLayer.

ZarrStoreInfo

A serializable, cross-platform representation of a Zarr store and any associated extensions.

Enums

AspectRatioAlignmentMode

Determine what extra data is shown in Contain mode, and what data is hidden in Cover mode.

AspectRatioMode

Specifies how the camera and coordinate system should behave when the plotted region (within the margins) has a non-square aspect ratio.

AxisPosition

Determines where to render an axis layer: top, right, bottom, or left.

BarOrientation

Determines whether bar plot should be vertical or horizontal.

CategoricalColormap

Named categorical colormap functions.

CodeFormat

The code format for render-to-script outputs.

ColorMode

Specify uniform or instanced colors for rendered elements.

DimensionOrder

Specify the dimension order of an image array.

FontStyle

Specify the font style: normal, italique, or oblique.

FontWeight

Specify the font weight: normal or bold.

GraphicsFormat

The graphics format for outputs.

LayerParams

Strongly-typed layer params.

LegendOrientation

Determines whether legend should be vertical (left to right colormap) or horizontal (bottom to top colormap).

NumericData

Typed numeric array supporting multiple dtypes.

OpacityMode

Specify uniform or instanced opacity values for rendered elements.

PathCommand

A single drawing command, the post-parsed form of an SVG path segment. All coordinates are absolute.

PointShapeMode

Determine whether to render points as squares or circles.

QuantitativeColormap

Named quantitative colormap functions.

RawPlotParams

Specify how to render a plot.

SizeMode

Specify uniform or instanced size (e.g., width or radius) values for rendered elements.

TextAlignMode

Specify the horizontal alignment of a text element.

TextBaselineMode

Specify the vertical alignment of a text element.

UnitsMode

Determines whether size/position values are interpreted in pixel, data, or normalized space.

ViewMode

Whether displaying 2D versus 3D graphics.

ZarrStoreExtension

A serializable, cross-platform representation of a Zarr store extension.

ZarrStoreParams

A serializable, cross-platform representation of a Zarr store.

Functions

get_bounds

Calculate the visible data range based on camera view and other view parameters.

project

Projects data-space coordinates to pixel coordinates on screen.

render

Given plotting parameters as input, render a graphical (vector or bitmap) output.

render_to_script

Given plotting parameters as input, “render” them to code which can be used to reproduce the plot.

render_to_script_aux

A variant of render_to_script which allows to keep schema_version as None. This is only intended to prevent extra churn in for the snapshot tests in crates/pluot/tests/test_render_script.rs

render_with_stores

Similar to render, but also lets the caller pass Zarr store instances via a StoreMap.

unproject

Unproject pixel coordinates on screen into data-space coordinates.

Type Aliases

UniformOpacityParams

Static opacity (between 0.0 for fully transparent and 1.0 for fully opaque) shared by every element.

UniformRgbParams

Static (r, g, b) color shared by every instance.

UniformSizeParams

Static size (e.g., width or radius) shared by every element.