@factorialco/f0-react 8.25.0 → 8.27.0

package/dist/f0.d.ts

@@ -5407,6 +5407,9 @@ export declare const defaultTranslations: {
         readonly language: "Language";
         readonly audio: "Audio";
     };
+    readonly swipeDeck: {
+        readonly label: "Swipe deck";
+    };
     readonly meetingCard: {
         readonly today: "Today";
         readonly yesterday: "Yesterday";
@@ -6130,6 +6133,7 @@ export declare const defaultTranslations: {
             readonly description: "Try a different date or fewer filters";
         };
         readonly windowedCategories: "Showing {{count}} of {{total}} categories";
+        readonly noData: "No data";
         readonly tooltip: {
             readonly ofTotal: "of total";
             readonly total: "total";
@@ -10097,7 +10101,7 @@ declare interface F0DataChartBaseProps extends F0DataChartCommonProps, F0DataCha
 /**
  * Props shared by every `F0DataChart` variant.
  */
-declare interface F0DataChartCommonProps {
+declare interface F0DataChartCommonProps<Point extends F0DataChartPointClick = F0DataChartMarkPointClick> {
     /** Customize or opt out of the empty state shown when data is empty. */
     emptyState?: F0DataChartEmptyStateProps;
     /**
@@ -10107,9 +10111,10 @@ declare interface F0DataChartCommonProps {
      * Line charts accept a click anywhere in the plot area, since a line is too
      * thin to hit — the same allowance their axis-triggered tooltip already
      * makes — and answer with the whole category in
-     * {@link F0DataChartPointClick.series}, matching what the tooltip showed.
+     * {@link F0DataChartPointClickBase.series}, matching what the tooltip
+     * showed.
      */
-    onPointClick?: (point: F0DataChartPointClick) => void;
+    onPointClick?: (point: Point) => void;
 }
 
 /**
@@ -10343,6 +10348,21 @@ export declare interface F0DataChartLineSeries {
 /** Line interpolation type */
 export declare type F0DataChartLineType = "linear" | "smooth" | "step";
 
+/** A click on any chart except a radar. */
+export declare interface F0DataChartMarkPointClick extends F0DataChartPointClickBase {
+    /**
+     * Every number the mark carries, in series order: `[42]` for a bar or a
+     * slice, `[x, y]` for a scatter point, `[xIndex, yIndex, value]` for a
+     * heatmap cell.
+     *
+     * {@link value} is the last entry, which is the measure for every type
+     * except scatter — there both entries are measures, and quoting only the
+     * last one drops half the point. Read this when the chart type has more
+     * than one number to say.
+     */
+    values: number[];
+}
+
 /**
  * A single data point in a pie chart.
  */
@@ -10399,38 +10419,43 @@ export declare interface F0DataChartPieSeries {
     color?: ChartColorToken;
 }
 
+/** What a click on any chart type resolved to. */
+export declare type F0DataChartPointClick = F0DataChartMarkPointClick | F0DataChartRadarPointClick;
+
 /**
  * What a click resolved to — one bar segment, one slice, one point, or (for a
  * line, where the click can land anywhere in the plot area) a whole category.
  *
  * The top-level fields always name a single series, so a consumer that wants
- * one number has one. {@link F0DataChartPointClick.series} carries everything
- * the click resolved, which for a line is every series at that category — the
- * same rows its tooltip shows.
+ * one number has one. {@link F0DataChartPointClickBase.series} carries
+ * everything the click resolved, which for a line is every series at that
+ * category — the same rows its tooltip shows.
  */
-export declare interface F0DataChartPointClick {
+declare interface F0DataChartPointClickBase {
     /** Interaction surface that resolved the point. */
     source: "pointer";
-    /** Configured series name for the mark. Empty when ECharts does not report one. */
+    /**
+     * Configured series name for the mark. Empty when ECharts does not report one.
+     *
+     * For a radar it is the clicked polygon's name: a click picks a whole
+     * polygon, never one spoke. For a heatmap it is the cell's y-axis category,
+     * so a row reads like a series.
+     */
     seriesName: string;
     /**
      * Mark name reported by ECharts: an axis category, pie slice, funnel stage,
-     * scatter label, or gauge/radar item name. Empty when the mark has no name.
+     * scatter label, or gauge item name. For a heatmap it is the cell's x-axis
+     * category. Empty for a radar, whose polygon spans every indicator, and
+     * whenever the mark has no name.
      */
     category: string;
-    /** Raw, unformatted value. Consumers apply their own formatting. */
-    value: number;
     /**
-     * Every number the mark carries, in series order: `[42]` for a bar or a
-     * slice, `[x, y]` for a scatter point, `[xIndex, yIndex, value]` for a
-     * heatmap cell.
+     * Raw, unformatted value. Consumers apply their own formatting.
      *
-     * {@link value} is the last entry, which is the measure for every type
-     * except scatter — there both entries are measures, and quoting only the
-     * last one drops half the point. Read this when the chart type has more
-     * than one number to say.
+     * For a radar this is the last indicator that has data, not a single
+     * observation — read {@link values} instead.
      */
-    values: number[];
+    value: number;
     /**
      * Every series the click resolved, in the order they are configured.
      *
@@ -10484,12 +10509,21 @@ export declare interface F0DataChartRadarIndicator {
     max?: number;
 }
 
+/** A click on a radar, which picks a whole polygon. */
+export declare interface F0DataChartRadarPointClick extends F0DataChartPointClickBase {
+    /**
+     * One entry per indicator, in indicator order. `null` is an indicator with
+     * no data; {@link value} is then the last indicator that has one.
+     */
+    values: (number | null)[];
+}
+
 /**
  * Radar chart variant props.
  *
  * Radar charts use a polar coordinate system — no cartesian axes.
  */
-export declare interface F0DataChartRadarProps extends F0DataChartCommonProps, F0DataChartLegendInteractionProps {
+export declare interface F0DataChartRadarProps extends F0DataChartCommonProps<F0DataChartRadarPointClick>, F0DataChartLegendInteractionProps {
     /** Chart type */
     type: "radar";
     /** Axes of the radar — defines the dimensions to compare */
@@ -10521,8 +10555,12 @@ export declare interface F0DataChartRadarProps extends F0DataChartCommonProps, F
 export declare interface F0DataChartRadarSeries {
     /** Display name used in legend and tooltip (e.g. "Team A", "Team B") */
     name: string;
-    /** Values — one per indicator, in the same order */
-    data: number[];
+    /**
+     * Values — one per indicator, in the same order. `null` marks an indicator
+     * with no data: the tooltip reads "No data" and no vertex label is drawn.
+     * ECharts still draws that vertex at the centre, the same place as `0`.
+     */
+    data: (number | null)[];
     /** Override color for this series. Must be an F0 design token name. */
     color?: ChartColorToken;
 }