Interface Maidr

Unique identifier for the chart. Used for DOM element IDs.

Chart title displayed in text descriptions.

Chart subtitle.

Chart caption.

2D grid of subplots. Each row is an array of subplots. For a single chart, use [[{ layers: [...] }]].

Enables live/realtime mode for this chart. When true:

• React consumers can update the data prop to replace the chart data in place.
• Script-tag consumers can push updates via window.maidrLive.setData() / window.maidrLive.appendData().
• The 'M' key toggles monitor mode, which auto-sonifies and announces newly appended data points.

Static charts (the default) are unaffected.

Sliding window size for streaming data. When set, appending a data point beyond this width drops the oldest point(s), keeping at most maxWidth points per series. Only applies to appendData updates.

Optional callback invoked when the active data point changes. Used by canvas-based charting libraries (e.g., Chart.js) for visual highlighting, since canvas elements cannot be targeted with CSS selectors.

This field is not serializable as JSON; it is only available when constructing MAIDR data programmatically (e.g., via the Chart.js plugin or React API).