@object-ui/plugin-charts 16.1.0 → 17.2.0

package/dist/ChartRenderer.d.ts

@@ -23,7 +23,19 @@ export interface ChartRendererProps {
         chartType?: 'bar' | 'column' | 'horizontal-bar' | 'line' | 'area' | 'pie' | 'donut' | 'radar' | 'scatter' | 'funnel' | 'combo' | 'treemap' | 'sankey';
         data?: Array<Record<string, any>>;
         config?: Record<string, any>;
+        /** Internal binding. Authors write the spec `xAxis: { field }` (or the
+         *  report surface's bare string); `normalizeChartSchema` resolves both. */
         xAxisKey?: string;
+        /**
+         * Plotted series — **both shapes**, unlike the bindings below.
+         *
+         * `series` is the one binding the spec and the internal contract spell with
+         * the same key, so declaring only the internal shape here made
+         * `series: [{ name: 'total' }]` a type error on an author who was writing
+         * the protocol correctly — and, until #2945, one whose chart also rendered
+         * blank. `normalizeChartSchema` translates; an array that already speaks the
+         * internal shape passes through untouched.
+         */
         series?: Array<{
             dataKey: string;
             label?: string;
@@ -31,12 +43,46 @@ export interface ChartRendererProps {
             opacity?: number;
             dashArray?: string;
             chartType?: 'bar' | 'line' | 'area';
+            stack?: string;
+            yAxis?: 'left' | 'right';
+            color?: string;
+        } | {
+            name: string;
+            label?: unknown;
+            type?: string;
+            variant?: 'current' | 'comparison' | 'primary';
+            opacity?: number;
+            dashArray?: string;
+            stack?: string;
+            yAxis?: 'left' | 'right';
+            color?: string;
         }>;
+        /** Spec `ChartConfig` shape — honored via `normalizeChartSchema`
+         *  (objectui#2880). Listed here so the author-facing contract type-checks;
+         *  the internal props above win when both are present. */
+        xAxis?: unknown;
+        yAxis?: unknown;
+        showLegend?: boolean;
+        showDataLabels?: boolean;
+        title?: unknown;
+        subtitle?: unknown;
+        description?: unknown;
+        height?: number;
+        annotations?: Array<Record<string, any>>;
+        interaction?: Record<string, any>;
+        /** An author `type` rescued from the SDUI envelope's discriminator
+         *  collision by the react-page wrapper — see `normalizeChartSchema`. */
+        specType?: string;
         colors?: string[];
         /** Per-category colour map (value/label → colour). Wins over `colors` per
          *  category; see AdvancedChartImpl. Set by ObjectChart from select/lookup
          *  dimension option colours and/or an explicit author map. */
         categoryColors?: Record<string, string>;
+        /** Declared category order (value/label keys, in domain order) for
+         *  ordered-sequence charts — funnel/pyramid stages. Set by DatasetWidget
+         *  from the dimension's picklist order or an explicit `stageOrder`; see
+         *  AdvancedChartImpl. Omitted → the funnel's value-descending default. */
+        categoryOrder?: string[];
         /** Pass `false` for a deterministic, export-safe render with no entrance
          *  animation (see AdvancedChartImpl). Omitted → animated default. */
         isAnimationActive?: boolean;

package/dist/ObjectChart.d.ts

@@ -4,13 +4,29 @@ import { default as React } from 'react';
  * Local implementation to avoid a dependency on @object-ui/fields.
  */
 export declare function humanizeLabel(value: string): string;
+/**
+ * The result column an object-bound `aggregate` projects its value under
+ * (framework#3701, `chartAggregateValueKey` in `@objectstack/spec/ui`).
+ *
+ * The raw `field` name — an object-bound aggregate does NOT decorate it the way
+ * a dataset measure is named (`sum_amount`). Only `count` may omit `field`, and
+ * it then lands under the literal `'count'`, which is the alias the engine
+ * projects `COUNT(*)` under. Exported so every path that builds these rows
+ * agrees on one key instead of each re-deriving it.
+ */
+export declare function aggregateValueKey(aggregate: {
+    field?: string;
+    function?: string;
+}): string;
+/** Suffix the previous-window value carries under a compareTo overlay. */
+export declare const COMPARISON_SUFFIX = "__comparison";
 /**
  * Client-side aggregation for fetched records.
  * Groups records by `groupBy` field and applies the aggregation function
  * to the `field` values in each group.
  */
 export declare function aggregateRecords(records: any[], aggregate: {
-    field: string;
+    field?: string;
     function: string;
     groupBy: string;
 }): any[];