Skip to content

Documentation / @ripl/charts / BaseChartOptions

Interface: BaseChartOptions ​

Defined in: charts/src/core/chart.ts:120

Base options shared by all chart types.

Extended by ​

Properties ​

PropertyTypeDescriptionDefined in
animation?boolean | Partial<ChartAnimationOptions>Animation configuration, or a boolean toggling all transitions. See ChartAnimationOptions.charts/src/core/chart.ts:128
autoRender?booleanWhether the chart renders automatically on construction and after every Chart.update. Defaults to true.charts/src/core/chart.ts:122
description?stringAccessible description announced by screen readers (sets the rendering element's ARIA label). Defaults to the title text.charts/src/core/chart.ts:132
padding?PaddingInputSpace 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.charts/src/core/chart.ts:124
theme?string | ThemeTheme for this chart: a registered name ('light'/'dark'/'auto'), or a Theme. Falls back to the module default (see setDefaultTheme).charts/src/core/chart.ts:130
title?string | Partial<ChartTitleOptions>Chart title as plain text, or a ChartTitleOptions object for full control.charts/src/core/chart.ts:126