IChartBaseProps
interface
Chart
Props shared across every origam chart type — extends ICommonsComponentProps, IDimensionProps, IMarginProps, IPaddingProps, IRoundedProps, IElevationProps and IBgColorProps. Covers series data, legend, tooltip, animation, color scheme and aspect ratio.
TypeScript
Definition
The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.
Inheritance
Extends
Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.
API
Properties
Every property declared by this interface, with its type, optionality and default.
- seriesrequiredArray<IChartSeries>
- Data series — one or more. An empty array renders the #empty slot.
- categoriesArray<string>
- X axis labels (for line/area/bar/column/radar). Length should match the longest series; missing entries fall back to the numeric index. Ignored for pie/donut/scatter.
- titlestring
- Optional title rendered above the plotting area.
- subtitlestring
- Optional subtitle rendered below the title.
- showLegendboolean
- Toggle the legend block. Default true.
- legendPositionTChartLegendPosition
- Anchor of the legend block. Default bottom.
- showTooltipboolean
- Toggle the hover tooltip. Default true.
- animatedboolean
- Animate paths/bars/slices on first paint and on data changes. Respects prefers-reduced-motion. Default true.
- animationDurationnumber
- Animation duration in ms. Default 600.
- colorSchemeArray<TIntent | string>
- Palette used when a series does not pin its own color. Accepts intent strings or raw CSS colours. Default cycles through the 8 origam intents.
- aspectRatiostring
- CSS aspect-ratio shortcut ('16/9', '4/3', '1/1'). When set, overrides height and lets the chart breathe with the container width.
Ecosystem
Used by
Components and composables that extend or consume this interface.
Usage
Examples
Ready-to-paste code snippets using this interface.
Bar chart using the shared base props