Documentation / @ripl/charts / RealtimeChartOptions
Interface: RealtimeChartOptions
Defined in: charts/src/charts/realtime.ts:93
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:89 |
autoRender? | boolean | Whether the chart renders automatically on construction and after every Chart.update. Defaults to true. | BaseChartOptions.autoRender | charts/src/core/chart.ts:83 |
axis? | ChartAxisInput | Axis configuration (labels, ticks, title). | - | charts/src/charts/realtime.ts:107 |
crosshair? | ChartCrosshairInput | Crosshair overlay configuration. | - | charts/src/charts/realtime.ts:101 |
grid? | ChartGridInput | Background grid line configuration. | - | charts/src/charts/realtime.ts:99 |
legend? | ChartLegendInput | Series legend configuration. | - | charts/src/charts/realtime.ts:105 |
padding? | Partial<ChartPadding> | Space reserved around the chart, per edge, in pixels. | BaseChartOptions.padding | charts/src/core/chart.ts:85 |
series | RealtimeChartSeriesOptions[] | The series to stream, one line/area per entry. | - | charts/src/charts/realtime.ts:95 |
showYAxis? | boolean | Show the y-axis. Defaults to true. | - | charts/src/charts/realtime.ts:109 |
title? | string | Partial<ChartTitleOptions> | Chart title as plain text, or a ChartTitleOptions object for full control. | BaseChartOptions.title | charts/src/core/chart.ts:87 |
tooltip? | ChartTooltipInput | Hover tooltip configuration. | - | charts/src/charts/realtime.ts:103 |
transitionDuration? | number | Duration in milliseconds of the transition applied on each push. Defaults to 300. | - | charts/src/charts/realtime.ts:115 |
windowSize? | number | Number of samples kept in the sliding window before the oldest scrolls off. Defaults to 60. | - | charts/src/charts/realtime.ts:97 |
yMax? | number | Fixed upper bound for the y-axis (otherwise derived from the windowed data). | - | charts/src/charts/realtime.ts:113 |
yMin? | number | Fixed lower bound for the y-axis (otherwise derived from the windowed data). | - | charts/src/charts/realtime.ts:111 |