IChartCartesianProps

interface
Chart

Props for <OrigamChartCartesian> — the cartesian family component. Owns the X+Y plotting area and all cartesian topologies: line, area, bar, column, scatter, spline, stepped-line. Supports stacking, smoothing, drilldown, zoom, annotations, plot bands/lines, and a secondary Y axis.

TypeScript

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

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.

type
TChartCartesianKind
'line'
Cartesian visualisation primitive. Default 'line'.
stacked
boolean
false
Stack series on top of each other. Applies to bar, column, and area. Default false.
stacking
TChartStacking
Stacking mode when stacked=true. 'normal' = raw absolute values. 'percent' = every stack normalised to 100%.
smoothing
TChartSmoothing
Smoothing strategy for line / area / spline. Default 'none' for line/area, 'monotone' for spline.
yMin
number
Override the auto-computed Y min.
yMax
number
Override the auto-computed Y max.
showGrid
boolean
true
Render grid lines behind the plot. Default true.
showAxis
boolean
true
Render X / Y axes + tick labels. Default true.
showTooltip
boolean
true
Toggle the hover tooltip. Default true.
xAxisFormat
(value: string | number) => string
Formatter applied to X-axis tick labels.
yAxisFormat
(value: number) => string
Formatter applied to Y-axis tick labels.
secondaryYAxis
IChartSecondaryYAxis
Configuration for the secondary (right-hand) Y axis. Series with yAxis: 1 are projected against this scale.
plotBands
Array<IChartPlotBand>
Coloured rectangular zones drawn behind or above the chart data.
plotLines
Array<IChartPlotLine>
Threshold lines drawn at a fixed axis value.
drilldown
IChartDrilldownProps
Drilldown configuration. Data points carrying an IChartDrilldownLink trigger chart-level navigation on click.
zoomable
boolean
false
Enable zoom / pan interactions: drag to zoom, shift+scroll, ctrl+drag. Default false.
zoomResetLabel
string
rangeSelector
IChartRangeSelector
Optional band-style range-selector toolbar with preset zoom buttons (1w, 1m, 3m, 6m, 1y, all).
annotations
Array<IChartAnnotation>
Overlay annotations drawn on top of the series layer. Four kinds: 'arrow', 'label', 'circle', 'bracket'.

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Stacked column chart with zoom and a plot line

vue