@cascivo/charts 0.16.1 → 0.17.1

package/dist/index.d.ts

@@ -55,9 +55,20 @@ interface TimeScale {
   map(value: Date): number;
   invert(position: number): Date;
   ticks(count?: number): Date[];
-  tickInterval(): 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
-  tickFormat(): Intl.DateTimeFormatOptions;
+  /**
+   * The unit the ticks step in at the given density. Pass the same `count` you pass to
+   * {@link TimeScale.ticks} — a 24-hour domain steps in hours at `count: 6` and in days at
+   * `count: 1`, so a hardcoded density would disagree with the ticks actually drawn.
+   */
+  tickInterval(count?: number): IntervalUnit;
+  /**
+   * `Intl.DateTimeFormat` options that make the ticks at this density distinguishable.
+   * Sub-day steps format as times, day/week steps as dates, and so on — formatting a
+   * 3-hourly axis with a day format renders the same string on every tick.
+   */
+  tickFormat(count?: number): Intl.DateTimeFormatOptions;
 }
+type IntervalUnit = 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
 declare function timeScale(domain: [Date, Date], range: [number, number]): TimeScale;
 type Point = readonly [x: number, y: number];
 /**
@@ -1619,6 +1630,19 @@ interface AreaChartSeries<Datum> {
   color?: string;
   /** Which y-axis this series is measured against (ignored when `stacked`). Default 'left'. */
   axis?: 'left' | 'right';
+  /**
+   * Draw this series as a stroked line with no fill.
+   *
+   * The case this exists for: a dual-axis chart plotting requests (left) against errors
+   * (right). As two areas the smaller series hides behind the larger one, and `fill` is
+   * chart-level so it cannot make just the second translucent. `ComboChart` does not help —
+   * it is bar+line, not area+line (2026-08-08 report A).
+   *
+   * Ignored when `stacked`, where every series must be an area for the stack to read.
+   *
+   * @defaultValue `'area'`
+   */
+  type?: 'area' | 'line';
   /**
    * Per-series Y accessor. Overrides the chart-level `y` for this series only —
    * use it to plot two series from one shared `data` row against different fields
@@ -1980,12 +2004,18 @@ interface SparklineBaseProps {
    * 120px rather than a container-filling chart. Pass a number to change it. The
    * catalogue-wide "omit for a responsive chart" note does not apply to this chart.
    *
-   * @defaultValue `80`
+   * @defaultValue `120`
    * @see the component manifest
    */
   width?: number;
   height?: number;
   color?: string;
+  /**
+   * Show dot at last data point
+   *
+   * @defaultValue `true`
+   * @see the component manifest
+   */
   endDot?: boolean;
 }
 /**
@@ -2094,6 +2124,23 @@ interface KpiProps {
   sparkline?: readonly number[];
   className?: string;
 }
+/**
+ * A metric tile with its own card chrome: label, then value and delta on one line, then an
+ * optional sparkline below.
+ *
+ * ## `Kpi` or `Stat`? Pick one per app.
+ *
+ * `Stat` (`@cascivo/react`) is the sibling tile, and they are **not two skins of one
+ * component**. `Kpi` takes a numeric `delta` and formats it for you (sign, arrow, colour,
+ * unit) and always brings card chrome. `Stat` takes a pre-formatted `string` delta, stacks
+ * value → delta → help text, puts its `visual` in a trailing slot, and is layout-only unless
+ * you set `card`.
+ *
+ * `<Stat card>` matches this component's **chrome** — surface, border, radius, padding — and
+ * not its layout, so a `Stat` row and a `Kpi` row in one app still read as two tile designs
+ * (2026-08-14 report §6). Use `Kpi` when you have a numeric delta and a sparkline; use `Stat`
+ * otherwise; do not mix them.
+ */
 declare function Kpi({
   value,
   label,
@@ -2275,7 +2322,12 @@ interface ComboChartProps {
   line: ComboChartPoint[];
   title: string;
   description?: string;
-  /** Measure the line on its own right-hand axis (use when the two metrics differ in scale). */
+  /**
+   * Render line on a secondary right y-axis
+   *
+   * @defaultValue `false`
+   * @see the component manifest
+   */
   secondAxis?: boolean;
   /** Legend label for the bar series. Defaults to `'Bars'`. */
   barsLabel?: string;
@@ -3060,4 +3112,4 @@ declare function Gauge({
   className,
   plain
 }: GaugeProps): import("react").JSX.Element;
-export { AXIS_CHAR_PX, AXIS_LINE_PX, AggOp, AggregateSpec, AngleBand, Annotation, AnnotationContext, AnnotationScale, AreaChart, AreaChartProps, AreaChartSeries, AreaDecimateOptions, Axis, AxisProps, BandScale, BarChart, BarChartProps, BarChartSeries, Bin, BoundStream, BoxStats, Boxplot, BoxplotProps, BoxplotSeries, Brush, BrushProps, BubbleChart, BubbleChartProps, BubbleDatum, BubbleSeries, Bullet, BulletProps, CalendarHeatmap, CalendarHeatmapDatum, CalendarHeatmapProps, Candlestick, CandlestickDatum, CandlestickProps, CanvasLayer, CanvasLayerProps, CanvasPaint, CanvasSize, CategoryDatum, CategoryMapping, ChartDefs, ChartDefsProps, ChartFrame, ChartFrameProps, ChartSize, ComboChart, ComboChartBar, ComboChartPoint, ComboChartProps, Curve, DEFAULT_MARGINS, DataLabel, DataLabelProps, DataZoom, DataZoomProps, DecimateMethod, DecimateOptions, DefSeries, EncodeMapping, EncodedResult, EncodedSeries, FillKind, Funnel, FunnelProps, FunnelStage, Gauge, GaugeProps, GaugeThreshold, Glyph, GlyphProps, GlyphShape, GridLines, GridLinesProps, Heatmap, HeatmapDatum, HeatmapProps, HierNode, Histogram, HistogramBin, HistogramProps, Kpi, KpiProps, LabelOptions, LaidLink, LaidNode, Legend, LegendProps, LegendSeries, LineChart, LineChartProps, LineChartSeries, LinearScale, LogScale, Meter, MeterProps, MeterThresholds, PLAIN_MARGINS, PartitionedNode, PatternKind, PieChart, PieChartDatum, PieChartProps, Point, Polar, PolarDatum, PolarProps, Pt, Radar, RadarProps, RadarSeries, RadialBar, RadialBarDatum, RadialBarProps, RampKind, Rect, RegressionResult, RegressionType, ResolvedLabelOptions, Row, Sankey, SankeyLayout, SankeyLink, SankeyNode, SankeyOptions, SankeyProps, ScatterChart, ScatterChartProps, ScatterChartSeries, ScatterDatum, Sparkline, SparklineProps, StackedRow, StackedSegment, Stream, StreamDecimate, StreamOffset, StreamProps, StreamSeries, StreamSeriesOptions, StreamSource, Sunburst, SunburstProps, SyncGroup, Text, TextProps, TimeScale, Toolbox, ToolboxOptions, ToolboxProps, Treemap, TreemapDatum, TreemapNode, TreemapProps, TreemapRect, Vec, VisualChannel, VisualMap, VisualMapOptions, VisualMapProps, VisualMode, VisualResult, ZoomConfig, _syncGroupCount, aggregate, angleBand, annotationSummary, arcPath, areaPath, autoLabelStride, bandScale, bin, binValues, bindStream, boxStats, cellPath, decimate$1 as decimate, divergingRamp, download, encode, encodeCategory, extent, fillFor, filter, getSyncGroup, glyphPath, gradientId, isZoomed, leftMarginForLabels, linePath, linearScale, linkPath, logScale, lttb, mapVisual, maxDepth, minmax, nearestIndex, niceTicks, panWindow, partition, patternId, pieceIndex, polarPoint, quantize, radiusScale, rampLightness, rampOf, rampStops, regression, releaseSyncGroup, renderAnnotation, renderAnnotations, resolveColor, resolveLabels, rightMarginForLabels, sankeyLayout, sequentialRamp, serializeSvg, sort, splitDefined, sqrtScale, squarify, stackSeries, streamExtent, streamLayout, sumValue, svgToPngBlob, timeScale, toStackedSeries, useChartSize, useStreamSeries, visualVisible, voronoiCells, voronoiFind, wrapText, zoomWindow };
+export { AXIS_CHAR_PX, AXIS_LINE_PX, AggOp, AggregateSpec, AngleBand, Annotation, AnnotationContext, AnnotationScale, AreaChart, AreaChartProps, AreaChartSeries, AreaDecimateOptions, Axis, AxisProps, BandScale, BarChart, BarChartProps, BarChartSeries, Bin, BoundStream, BoxStats, Boxplot, BoxplotProps, BoxplotSeries, Brush, BrushProps, BubbleChart, BubbleChartProps, BubbleDatum, BubbleSeries, Bullet, BulletProps, CalendarHeatmap, CalendarHeatmapDatum, CalendarHeatmapProps, Candlestick, CandlestickDatum, CandlestickProps, CanvasLayer, CanvasLayerProps, CanvasPaint, CanvasSize, CategoryDatum, CategoryMapping, ChartDefs, ChartDefsProps, ChartFrame, ChartFrameProps, ChartSize, ComboChart, ComboChartBar, ComboChartPoint, ComboChartProps, Curve, DEFAULT_MARGINS, DataLabel, DataLabelProps, DataZoom, DataZoomProps, DecimateMethod, DecimateOptions, DefSeries, EncodeMapping, EncodedResult, EncodedSeries, FillKind, Funnel, FunnelProps, FunnelStage, Gauge, GaugeProps, GaugeThreshold, Glyph, GlyphProps, GlyphShape, GridLines, GridLinesProps, Heatmap, HeatmapDatum, HeatmapProps, HierNode, Histogram, HistogramBin, HistogramProps, IntervalUnit, Kpi, KpiProps, LabelOptions, LaidLink, LaidNode, Legend, LegendProps, LegendSeries, LineChart, LineChartProps, LineChartSeries, LinearScale, LogScale, Meter, MeterProps, MeterThresholds, PLAIN_MARGINS, PartitionedNode, PatternKind, PieChart, PieChartDatum, PieChartProps, Point, Polar, PolarDatum, PolarProps, Pt, Radar, RadarProps, RadarSeries, RadialBar, RadialBarDatum, RadialBarProps, RampKind, Rect, RegressionResult, RegressionType, ResolvedLabelOptions, Row, Sankey, SankeyLayout, SankeyLink, SankeyNode, SankeyOptions, SankeyProps, ScatterChart, ScatterChartProps, ScatterChartSeries, ScatterDatum, Sparkline, SparklineProps, StackedRow, StackedSegment, Stream, StreamDecimate, StreamOffset, StreamProps, StreamSeries, StreamSeriesOptions, StreamSource, Sunburst, SunburstProps, SyncGroup, Text, TextProps, TimeScale, Toolbox, ToolboxOptions, ToolboxProps, Treemap, TreemapDatum, TreemapNode, TreemapProps, TreemapRect, Vec, VisualChannel, VisualMap, VisualMapOptions, VisualMapProps, VisualMode, VisualResult, ZoomConfig, _syncGroupCount, aggregate, angleBand, annotationSummary, arcPath, areaPath, autoLabelStride, bandScale, bin, binValues, bindStream, boxStats, cellPath, decimate$1 as decimate, divergingRamp, download, encode, encodeCategory, extent, fillFor, filter, getSyncGroup, glyphPath, gradientId, isZoomed, leftMarginForLabels, linePath, linearScale, linkPath, logScale, lttb, mapVisual, maxDepth, minmax, nearestIndex, niceTicks, panWindow, partition, patternId, pieceIndex, polarPoint, quantize, radiusScale, rampLightness, rampOf, rampStops, regression, releaseSyncGroup, renderAnnotation, renderAnnotations, resolveColor, resolveLabels, rightMarginForLabels, sankeyLayout, sequentialRamp, serializeSvg, sort, splitDefined, sqrtScale, squarify, stackSeries, streamExtent, streamLayout, sumValue, svgToPngBlob, timeScale, toStackedSeries, useChartSize, useStreamSeries, visualVisible, voronoiCells, voronoiFind, wrapText, zoomWindow };