Skip to content

API reference

Key types

  • PlotView — plot item: layout, pan and zoom, coordinate conversion, grid, and series collection. QML applications use its Plot wrapper.
  • Axis — ranges, log scale, ticks, labels, and per-axis pan and zoom.
  • PlotRectangleZoom — gesture configuration, selection styling, and read-only selection state.
  • LineCurve — GPU-rendered lines and markers, data ingestion, effects, transitions, gaps, and hover.
  • PointCloud — large sets of unconnected points as markers, colored uniformly or by per-point values.
  • HeatmapSeries — a uniform grid of values as cells colored through a colormap.
  • ColorBar — continuous key for the colormap and value range of a point cloud or heatmap.
  • BandSeries — filled area between a low and a high value at each X, with optional edge lines.
  • ErrorBarSeries — capped lines from a low to a high bound at each data point, vertical or horizontal.
  • RectangleSeries — many data-space rectangles in one item: spans and state timelines.
  • BarSeries — vertical, horizontal, and grouped bar charts, and ranged bars such as histogram bins.
  • Histogram — samples counted into bins, as data for a BarSeries.
  • DataAnchor — QML overlays at data coordinates.
  • PlotMouseEvent — the mouse event of PlotView's mouse signals, in item pixels; accept() skips the built-in pan, rectangle zoom, or rescale.
  • LegendModel — legend entries of the visible series that have one, each a LegendEntry.
  • SeriesInspection — per-series data queries: nearest data points, brackets, region statistics, and index pages.
  • PlotInspector — cursor state and one model row per series for crosshairs and tooltips.
  • SelectionTool — data-space box and range selection with per-series statistics.

See Data inspection for usage and readiness.

Feeding curve data

  • setData() — QML data or double-precision C++ containers.
  • setDataF(std::vector<float>&&, count) — large interleaved buffers on the curve's thread.
  • postData() — completed buffers from a worker thread.
  • PlotSeries::DataBounds — passed with the data when its extents are already known.
  • NaN marks a missing data point; gaps.nanMode breaks or connects the curve. See Invalid data points and gaps.

See Select the data path.