Documentation / @ripl/charts / RealtimeChartOptions
Interface: RealtimeChartOptions ​
Defined in: charts/src/charts/realtime.ts:100
Options for configuring a RealtimeChart.
Extends ​
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
animation? | boolean | Partial<ChartAnimationOptions> | Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions. | BaseChartOptions.animation | charts/src/core/chart.ts:128 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:122 |
axis? | ChartAxisInput | Axis configuration (labels, ticks, title). | - | charts/src/charts/realtime.ts:114 |
crosshair? | ChartCrosshairInput | Crosshair overlay configuration. | - | charts/src/charts/realtime.ts:108 |
description? | string | Accessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text. | BaseChartOptions.description | charts/src/core/chart.ts:132 |
format? | ValueFormatInput | Format applied to the y-axis tick labels (a per-axis axis.y.format takes precedence). | - | charts/src/charts/realtime.ts:116 |
grid? | ChartGridInput | Background grid line configuration. | - | charts/src/charts/realtime.ts:106 |
legend? | ChartLegendInput | Series legend configuration. | - | charts/src/charts/realtime.ts:112 |
padding? | PaddingInput | Space reserved around the chart, in pixels. A single number applies to all four edges; a [top, right, bottom, left] tuple or a partial { top, right, bottom, left } object sets individual edges, leaving unspecified edges at the default. Defaults to 16. | BaseChartOptions.padding | charts/src/core/chart.ts:124 |
series | RealtimeChartSeriesOptions[] | The series to stream, one line/area per entry. | - | charts/src/charts/realtime.ts:102 |
showYAxis? | boolean | Show the y-axis. Defaults to true. | - | charts/src/charts/realtime.ts:118 |
theme? | string | Theme | Theme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme). | BaseChartOptions.theme | charts/src/core/chart.ts:130 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:126 |
tooltip? | ChartTooltipInput | Hover tooltip configuration. | - | charts/src/charts/realtime.ts:110 |
transitionDuration? | number | Duration in milliseconds of the transition applied on each push. Defaults to 300. | - | charts/src/charts/realtime.ts:124 |
windowSize? | number | Number of samples kept in the sliding window before the oldest scrolls off. Defaults to 60. | - | charts/src/charts/realtime.ts:104 |
yMax? | number | Fixed upper bound for the y-axis (otherwise derived from the windowed data). | - | charts/src/charts/realtime.ts:122 |
yMin? | number | Fixed lower bound for the y-axis (otherwise derived from the windowed data). | - | charts/src/charts/realtime.ts:120 |