API Reference

This section documents the public classes of TauPlot.

Entry point

• TauPlot: The plot node.

Data classes

• Dataset: Data container holding series and samples.
• DatasetChange: Payload of the Dataset.changed signal, describing one mutation.
• ColorBuffer: Per-sample Color buffer.
• Float32Buffer: Per-sample float32 buffer.
• Float64Buffer: Per-sample float64 buffer.
• Int32Buffer: Per-sample int32 buffer.
• StringBuffer: Per-sample String buffer.

Series binding

• TauXYSeriesBinding: Maps a dataset series to a pane, overlay, and y axis.

Plot configuration

• TauXYConfig: Top-level XY plot configuration.
• TauPaneConfig: Pane configuration.
• TauAxisConfig: Axis configuration.
• TauPaneOverlayConfig: Abstract base class of overlay configurations.
• TauBarConfig: Bar-specific rendering configuration.
• TauScatterConfig: Scatter-specific rendering configuration.
• TauLineConfig: Line-specific rendering configuration.

Additional configuration

• TauLegendConfig: Legend configuration including position, flow direction, and style.
• TauGridLineConfig: Grid line configuration.
• TauHoverConfig: Hover configuration including highlight, tooltip and crosshair.
• SampleHit: Read-only data object produced by the hover inspection system.

Style resources

• TauStyle: Abstract base class of styles.
• TauXYStyle: Visual appearance of the plot.
• TauPaneStyle: Visual appearance of a pane.
• TauBarStyle: Visual appearance of BAR overlays.
• TauScatterStyle: Visual appearance of SCATTER overlays.
• TauLineStyle: Visual appearance of LINE overlays.
• TauLineFill: Area painted around the curve of one series in a LINE overlay.
• TauLegendStyle: Visual appearance of the legend.
• TauTooltipStyle: Tooltip visual style.
• TauCrosshairStyle: Crosshair visual style.

Per-sample visual attributes (data-driven)

• VisualAttributes: Abstract base class of per-sample attributes.
• BarVisualAttributes: Per-sample attributes for BAR overlays.
• ScatterVisualAttributes: Per-sample attributes for SCATTER overlays.
• LineVisualAttributes: Per-sample attributes for LINE overlays.

Per-sample visual callbacks (code-driven)

• VisualCallbacks: Abstract base class of per-sample callbacks.
• BarVisualCallbacks: Per-sample callbacks for BAR overlays.
• ScatterVisualCallbacks: Per-sample callbacks for SCATTER overlays.
• LineVisualCallbacks: Per-sample callbacks for LINE overlays.