@turquoisehealth/pit-viper 2.216.1-dev.0 → 2.217.1-dev.0

package/pv-components/dist/vue/visualizations/components/charts/PvDataTableWithChart/helpers.d.ts

@@ -30,6 +30,21 @@ export declare const computeNoDataOverlayText: ({ currentRowGroupColumnsLength,
      */
     yAxisOptionCount?: number;
 }) => string;
+/**
+ * True when a column represents a point in time. A date column on the x-axis is
+ * always plotted chronologically (see `sortChartDataChronologically`) - ordering
+ * dates by their series value would make the chart unreadable.
+ */
+export declare const isChronologicalColDef: (colDef: ColDef | null | undefined) => boolean;
+/**
+ * Orders chart data oldest to newest by its category (x-axis) field. Used when the
+ * x-axis column has the `date` data type, where chronological order is the only
+ * meaningful order regardless of the user's chart sort selection.
+ *
+ * Values that can't be parsed as dates sink to the end (ordered by their raw string
+ * value) so an unexpected category never displaces the real timeline.
+ */
+export declare const sortChartDataChronologically: (data: AgChartOptions["data"], categoryField: string) => AgChartOptions["data"];
 export declare const generateStackSeriesKey: (seriesField: string, stackField: string) => string;
 export declare const generateStackSecondaryCategoryKey: (stackField: string) => string;
 export declare const buildStackedChartData: (data: AgChartOptions["data"], categoryField: string, stackField: string, seriesColumns: OptionWithFormatterAndDataType[], supplementaryChartingColumns?: OptionWithFormatterAndDataType[]) => {

package/pv-components/dist/vue/visualizations/components/charts/PvDataTableWithChart/types.d.ts

@@ -38,6 +38,19 @@ export interface VerticalLineOverlay {
     label: string;
     /** The line color as a hex code. */
     color?: string;
+    /**
+     * When true, this overlay still renders as a chip but is dropped from the chart's
+     * crosslines - e.g. a dollar-denominated benchmark while the chart is grouped by percent,
+     * where the value has no valid position on the current x-axis.
+     */
+    excludeFromCrossline?: boolean;
+    /**
+     * Formats this overlay's raw `value` for display in its chip and crossline tooltip. Falls
+     * back to the group's `formatValue`, then to the chart's own axis formatter - use this when
+     * an overlay's unit doesn't match the chart's current x-axis (e.g. a dollar benchmark shown
+     * while the chart is grouped by percent), so it isn't run through the wrong formatter.
+     */
+    formatValue?: (value: number) => string | number;
     /**
      * Set by `resolveCrosslineOverlays` (not an authoring field) to the same identifier used
      * for this overlay's chip, so a hovered chip can be matched back to its crossline.
@@ -73,8 +86,13 @@ export interface CrosslineOverlayGroup {
      * placeholder (one per group, regardless of `overlays`) instead of chip content.
      */
     loading?: boolean;
+    /**
+     * Formatter used for every overlay in this group's chips/tooltip, unless an overlay sets
+     * its own `formatValue`. Falls back to the chart's own axis formatter when unset.
+     */
+    formatValue?: (value: number) => string | number;
 }
-export interface BenchmarkChip extends Partial<Pick<VerticalLineOverlay, "label" | "color">> {
+export interface BenchmarkChip extends Partial<Pick<VerticalLineOverlay, "label" | "color" | "excludeFromCrossline">> {
     key: string;
     loading: boolean;
     formattedValue?: string | number;

package/pv-components/dist/vue/visualizations/components/charts/widgetOptions.d.ts

@@ -34,6 +34,22 @@ export declare const getScrollableChartMinHeight: (params: {
     isHorizontalScrollingChart: boolean;
     itemHeight?: number;
 }) => number;
+/**
+ * Overflow for a scrollable chart container, locked to the one axis the chart can grow
+ * along: a horizontal-bar chart only ever grows taller, every other chart only ever
+ * grows wider. Leaving both axes scrollable lets a chart that already fits scroll in the
+ * direction it never overflows in, which reads as a stuck or jittery chart.
+ *
+ * Pair with the `pv-scrollbar-visible` utility - the platform's overlay scrollbars take
+ * no layout space and stay hidden until a scroll gesture, so the affordance is invisible
+ * without it. That utility also reserves a permanent scrollbar gutter, which is right for
+ * a text panel but costs a chart 8px of dead plot area, so it is reset here: the chart
+ * canvas resizes with the container anyway, so there is no layout shift to guard against.
+ */
+export declare const getChartScrollOverflowStyle: (params: {
+    enableChartScrolling: boolean;
+    isHorizontalScrollingChart: boolean;
+}) => Record<string, string> | undefined;
 /**
  * Inline style for the scrollable chart content: horizontal-bar charts grow vertically
  * per data point; all other charts grow horizontally, never below `minContentWidth`.