IChartCartesianProps
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
Définition
La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.
Héritage
Hérite de
Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.
API
Propriétés
Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.
- typeTChartCartesianKind'line'
- Cartesian visualisation primitive. Default 'line'.
- stackedbooleanfalse
- Stack series on top of each other. Applies to bar, column, and area. Default false.
- stackingTChartStacking
- Stacking mode when stacked=true. 'normal' = raw absolute values. 'percent' = every stack normalised to 100%.
- smoothingTChartSmoothing
- Smoothing strategy for line / area / spline. Default 'none' for line/area, 'monotone' for spline.
- yMinnumber
- Override the auto-computed Y min.
- yMaxnumber
- Override the auto-computed Y max.
- showGridbooleantrue
- Render grid lines behind the plot. Default true.
- showAxisbooleantrue
- Render X / Y axes + tick labels. Default true.
- showTooltipbooleantrue
- 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.
- secondaryYAxisIChartSecondaryYAxis
- Configuration for the secondary (right-hand) Y axis. Series with yAxis: 1 are projected against this scale.
- plotBandsArray<IChartPlotBand>
- Coloured rectangular zones drawn behind or above the chart data.
- plotLinesArray<IChartPlotLine>
- Threshold lines drawn at a fixed axis value.
- drilldownIChartDrilldownProps
- Drilldown configuration. Data points carrying an IChartDrilldownLink trigger chart-level navigation on click.
- zoomablebooleanfalse
- Enable zoom / pan interactions: drag to zoom, shift+scroll, ctrl+drag. Default false.
- zoomResetLabelstring
- rangeSelectorIChartRangeSelector
- Optional band-style range-selector toolbar with preset zoom buttons (1w, 1m, 3m, 6m, 1y, all).
- annotationsArray<IChartAnnotation>
- Overlay annotations drawn on top of the series layer. Four kinds: 'arrow', 'label', 'circle', 'bracket'.
Écosystème
Utilisé par
Composants et composables qui étendent ou consomment cette interface.
Usage
Exemples
Extraits de code prêts à coller utilisant cette interface.
Stacked column chart with zoom and a plot line