@gravity-ui/charts 1.39.1 → 1.41.0

package/dist/esm/components/Tooltip/DefaultTooltipContent/utils.js

@@ -130,6 +130,47 @@ export function getPreparedAggregation(args) {
     }
     return 'sum';
 }
+export function getSortedHovered(args) {
+    var _a;
+    const { hovered, sorting, xAxis, yAxis } = args;
+    if (!sorting) {
+        return hovered;
+    }
+    if (typeof sorting === 'function') {
+        return [...hovered].sort(sorting);
+    }
+    switch (sorting.key) {
+        case 'value': {
+            const values = getHoveredValues({ hovered, xAxis, yAxis });
+            const direction = (_a = sorting.direction) !== null && _a !== void 0 ? _a : 'asc';
+            const compareValue = (a, b) => {
+                const aNil = a === null || a === undefined;
+                const bNil = b === null || b === undefined;
+                if (aNil && bNil) {
+                    return 0;
+                }
+                if (aNil) {
+                    return -1;
+                }
+                if (bNil) {
+                    return 1;
+                }
+                if (typeof a === 'number' && typeof b === 'number') {
+                    return a - b;
+                }
+                return String(a).localeCompare(String(b));
+            };
+            const indices = hovered.map((_, i) => i);
+            indices.sort((i, j) => direction === 'asc'
+                ? compareValue(values[i], values[j])
+                : compareValue(values[j], values[i]));
+            return indices.map((i) => hovered[i]);
+        }
+        default: {
+            return hovered;
+        }
+    }
+}
 export function getTooltipRowColorSymbol({ series, color, height = 8, width = 16, }) {
     if ((series === null || series === void 0 ? void 0 : series.type) === 'line') {
         const colorSymbol = create('svg').attr('height', height).attr('width', width);

package/dist/esm/components/Tooltip/index.js

@@ -10,6 +10,8 @@ export const Tooltip = (props) => {
     const { hovered, hoveredPlotLines, hoveredPlotBands, pointerPosition } = useTooltip({
         dispatcher,
         tooltip,
+        xAxis,
+        yAxis,
     });
     const containerRect = (svgContainer === null || svgContainer === void 0 ? void 0 : svgContainer.getBoundingClientRect()) || { left: 0, top: 0 };
     const left = ((pointerPosition === null || pointerPosition === void 0 ? void 0 : pointerPosition[0]) || 0) + containerRect.left;

package/dist/esm/components/Tooltip/styles.css

@@ -3,8 +3,12 @@
   background-color: var(--g-color-infographics-tooltip-bg);
   box-shadow: 0 2px 12px var(--g-color-sfx-shadow);
 }
+tr.gcharts-tooltip__content-row {
+  display: table-row;
+  padding: 0;
+}
+
 .gcharts-tooltip__popup-content {
-  max-width: 450px;
   text-wrap: nowrap;
   border-radius: 4px;
 }
@@ -20,7 +24,13 @@
 .gcharts-tooltip__content-rows_pinned {
   overflow: auto;
 }
+.gcharts-tooltip__content-rows-table {
+  width: 100%;
+  padding: 0;
+  border-collapse: collapse;
+}
 .gcharts-tooltip__series-name {
+  max-width: 450px;
   padding: 2px 14px 6px;
   font-size: 13px;
   font-weight: 600;
@@ -45,8 +55,23 @@
   font-weight: 600;
   background-color: var(--g-color-base-info-medium);
 }
-.gcharts-tooltip__content-row-label {
+.gcharts-tooltip__content-row_totals {
+  color: var(--g-color-text-complementary);
+}
+.gcharts-tooltip__content-row-totals-label {
   overflow: hidden;
+  max-width: 400px;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+}
+.gcharts-tooltip__content-row-totals-value {
+  flex-shrink: 0;
+  margin-inline-start: auto;
+}
+.gcharts-tooltip__content-row-label-cell {
+  overflow: hidden;
+  max-width: 400px;
+  padding: 2px 4px;
   white-space: nowrap;
   text-overflow: ellipsis;
 }
@@ -58,12 +83,13 @@
   border-radius: 2px;
   background-color: #dddddd;
 }
-.gcharts-tooltip__content-row-value {
-  flex-shrink: 0;
-  margin-inline-start: auto;
+.gcharts-tooltip__content-row-color-cell {
+  width: 16px;
+  padding: 2px 4px 2px 14px;
 }
-.gcharts-tooltip__content-row-totals {
-  color: var(--g-color-text-complementary);
+.gcharts-tooltip__content-row-value-cell {
+  padding: 2px 14px 2px 4px;
+  text-align: end;
 }
 .gcharts-tooltip__content-row-totals-divider {
   margin-block: 5px 5px;

package/dist/esm/components/index.d.ts

@@ -1,8 +1,11 @@
 import React from 'react';
 import type { ChartData } from '../types';
 export * from './Tooltip/ChartTooltipContent';
+export interface ChartReflowOptions {
+    immediate?: boolean;
+}
 export interface ChartRef {
-    reflow: () => void;
+    reflow: (options?: ChartReflowOptions) => void;
 }
 export interface ChartDimentions {
     height: number;

package/dist/esm/components/index.js

@@ -30,10 +30,15 @@ export const Chart = React.forwardRef(function Chart(props, forwardedRef) {
         return debounced.current;
     }, [handleResize]);
     React.useImperativeHandle(forwardedRef, () => ({
-        reflow() {
-            debuncedHandleResize();
+        reflow(options) {
+            if (options === null || options === void 0 ? void 0 : options.immediate) {
+                handleResize();
+            }
+            else {
+                debuncedHandleResize();
+            }
         },
-    }), [debuncedHandleResize]);
+    }), [debuncedHandleResize, handleResize]);
     React.useEffect(() => {
         // dimensions initialize
         handleResize();

package/dist/esm/hooks/useAxis/index.d.ts

@@ -16,43 +16,7 @@ interface UseAxesProps {
 }
 export declare function getAxes(props: UseAxesProps): Promise<{
     xAxis: import("./types").PreparedXAxis | null;
-    yAxis: (Omit<import("../..").ChartAxis, "type" | "labels" | "plotLines" | "plotBands"> & {
-        type: import("../..").ChartAxisType;
-        labels: Omit<import("../..").ChartAxisLabels, "style" | "enabled" | "padding" | "autoRotation"> & Required<Pick<import("../..").ChartAxisLabels, "margin" | "enabled" | "html" | "rotation" | "padding">> & {
-            style: import("../..").BaseTextStyle;
-            rotation: number;
-            height: number;
-            width: number;
-            lineHeight: number;
-            maxWidth: number;
-        };
-        title: {
-            height: number;
-            width: number;
-            text: string;
-            margin: number;
-            style: import("../..").BaseTextStyle;
-            align: import("../..").ChartAxisTitleAlignment;
-            maxRowCount: number;
-            rotation: number;
-            maxWidth: number;
-            html: boolean;
-        };
-        min?: number;
-        grid: {
-            enabled: boolean;
-        };
-        maxPadding: number;
-        ticks: {
-            pixelInterval?: number;
-        };
-        tickMarks: import("./types").PreparedAxisTickMarks;
-        position: "left" | "right" | "top" | "bottom";
-        plotIndex: number;
-        plotLines: import("./types").PreparedAxisPlotLine[];
-        plotBands: import("./types").PreparedAxisPlotBand[];
-        crosshair: Required<import("../..").AxisCrosshair>;
-    })[];
+    yAxis: import("./types").PreparedYAxis[];
 }>;
 export declare function useAxis(props: UseAxesProps): AxesState;
 export {};

package/dist/esm/hooks/useAxis/types.d.ts

@@ -1,5 +1,5 @@
 import type { DashStyle } from '../../constants';
-import type { AxisCrosshair, AxisPlotBand, BaseTextStyle, ChartAxis, ChartAxisLabels, ChartAxisRangeSlider, ChartAxisTitleAlignment, ChartAxisType, DeepRequired, MeaningfulAny, PlotLayerPlacement } from '../../types';
+import type { AxisCrosshair, AxisPlotBand, BaseTextStyle, ChartAxis, ChartAxisLabels, ChartAxisRangeSlider, ChartAxisTitleAlignment, ChartAxisTitleRotation, ChartAxisType, DeepRequired, MeaningfulAny, PlotLayerPlacement } from '../../types';
 type PreparedAxisLabels = Omit<ChartAxisLabels, 'enabled' | 'padding' | 'style' | 'autoRotation'> & Required<Pick<ChartAxisLabels, 'enabled' | 'padding' | 'margin' | 'rotation' | 'html'>> & {
     style: BaseTextStyle;
     rotation: number;
@@ -51,7 +51,7 @@ type PreparedBaseAxis = Omit<ChartAxis, 'type' | 'labels' | 'plotLines' | 'plotB
         style: BaseTextStyle;
         align: ChartAxisTitleAlignment;
         maxRowCount: number;
-        rotation: number;
+        rotation: ChartAxisTitleRotation;
         maxWidth: number;
         html: boolean;
     };
@@ -64,7 +64,6 @@ type PreparedBaseAxis = Omit<ChartAxis, 'type' | 'labels' | 'plotLines' | 'plotB
         pixelInterval?: number;
     };
     tickMarks: PreparedAxisTickMarks;
-    position: 'left' | 'right' | 'top' | 'bottom';
     plotIndex: number;
     plotLines: PreparedAxisPlotLine[];
     plotBands: PreparedAxisPlotBand[];
@@ -72,8 +71,11 @@ type PreparedBaseAxis = Omit<ChartAxis, 'type' | 'labels' | 'plotLines' | 'plotB
 };
 export type PreparedXAxis = PreparedBaseAxis & {
     rangeSlider: PreparedRangeSlider;
+    position: 'bottom';
+};
+export type PreparedYAxis = PreparedBaseAxis & {
+    position: 'left' | 'right';
 };
-export type PreparedYAxis = PreparedBaseAxis;
 export type PreparedAxis = PreparedXAxis | PreparedYAxis;
 export type AxesState = {
     xAxis: PreparedXAxis | null;

package/dist/esm/hooks/useAxisScales/index.d.ts

@@ -1,4 +1,4 @@
-import type { PreparedAxis, PreparedSeries, PreparedSplit, RangeSliderState, ZoomState } from '../../hooks';
+import type { PreparedAxis, PreparedSeries, PreparedSplit, PreparedYAxis, RangeSliderState, ZoomState } from '../../hooks';
 import type { ChartScale } from './types';
 export { createXScale } from './x-scale';
 export { createYScale } from './y-scale';
@@ -7,7 +7,7 @@ type Args = {
     boundsHeight: number;
     series: PreparedSeries[];
     xAxis: PreparedAxis | null;
-    yAxis: PreparedAxis[];
+    yAxis: PreparedYAxis[];
     split: PreparedSplit;
     isRangeSlider?: boolean;
     rangeSliderState?: RangeSliderState;

package/dist/esm/hooks/useShapes/bar-x/prepare-data.js

@@ -162,6 +162,7 @@ export const prepareBarXData = async (args) => {
                             : yAxisTop + base + negativeStackHeight,
                         width: rectWidth,
                         height: shapeHeight,
+                        _height: height,
                         opacity: get(yValue.data, 'opacity', null),
                         data: yValue.data,
                         series: yValue.series,
@@ -178,9 +179,9 @@ export const prepareBarXData = async (args) => {
                 }
                 if (series.some((s) => s.stacking === 'percent')) {
                     let acc = 0;
-                    const ratio = plotHeight / (positiveStackHeight - stackItems.length);
+                    const ratio = plotHeight / positiveStackHeight;
                     stackItems.forEach((item) => {
-                        item.height = item.height * ratio;
+                        item.height = item._height * ratio;
                         item.y = plotHeight - item.height - acc;
                         acc += item.height + 1;
                     });

package/dist/esm/hooks/useShapes/bar-x/types.d.ts

@@ -10,4 +10,9 @@ export type PreparedBarXData = Omit<TooltipDataChunkBarX, 'series'> & {
     label?: LabelData;
     htmlElements: HtmlItem[];
     isLastStackItem: boolean;
+    /**
+     * the utility field for storing the original height (for recalculations, etc.)
+     * should not be used for displaying
+     */
+    _height: number;
 };

package/dist/esm/hooks/useTooltip/index.d.ts

@@ -1,11 +1,14 @@
 import type { Dispatch } from 'd3';
 import type { AxisPlotBand, AxisPlotLine, PointPosition, TooltipDataChunk } from '../../types';
 import type { PreparedTooltip } from '../types';
+import type { PreparedXAxis, PreparedYAxis } from '../useAxis/types';
 type Args = {
     dispatcher: Dispatch<object>;
     tooltip: PreparedTooltip;
+    xAxis?: PreparedXAxis | null;
+    yAxis?: PreparedYAxis;
 };
-export declare const useTooltip: ({ dispatcher, tooltip }: Args) => {
+export declare const useTooltip: ({ dispatcher, tooltip, xAxis, yAxis }: Args) => {
     hovered: TooltipDataChunk[] | undefined;
     hoveredPlotLines: AxisPlotLine[] | undefined;
     hoveredPlotBands: AxisPlotBand[] | undefined;

package/dist/esm/hooks/useTooltip/index.js

@@ -1,21 +1,28 @@
 import React from 'react';
 import isEqual from 'lodash/isEqual';
-export const useTooltip = ({ dispatcher, tooltip }) => {
+import { getSortedHovered } from '../../components/Tooltip/DefaultTooltipContent/utils';
+export const useTooltip = ({ dispatcher, tooltip, xAxis, yAxis }) => {
     const [{ hovered, hoveredPlotLines, hoveredPlotBands, pointerPosition }, setTooltipState] = React.useState({});
     const prevHovered = React.useRef(hovered);
     React.useEffect(() => {
         if (tooltip === null || tooltip === void 0 ? void 0 : tooltip.enabled) {
             dispatcher.on('hover-shape.tooltip', (nextHovered, nextPointerPosition, nextHoveredPlots) => {
                 const filteredNextHovered = nextHovered === null || nextHovered === void 0 ? void 0 : nextHovered.filter((item) => 'y' in item.data ? item.data.y !== null : true);
-                const isHoveredChanged = !isEqual(prevHovered.current, filteredNextHovered);
+                const sortedHovered = getSortedHovered({
+                    hovered: filteredNextHovered !== null && filteredNextHovered !== void 0 ? filteredNextHovered : [],
+                    sorting: tooltip === null || tooltip === void 0 ? void 0 : tooltip.sorting,
+                    xAxis,
+                    yAxis,
+                });
+                const isHoveredChanged = !isEqual(prevHovered.current, sortedHovered);
                 const newTooltipState = {
-                    hovered: isHoveredChanged ? filteredNextHovered : prevHovered.current,
+                    hovered: isHoveredChanged ? sortedHovered : prevHovered.current,
                     hoveredPlotLines: nextHoveredPlots === null || nextHoveredPlots === void 0 ? void 0 : nextHoveredPlots.lines,
                     hoveredPlotBands: nextHoveredPlots === null || nextHoveredPlots === void 0 ? void 0 : nextHoveredPlots.bands,
                     pointerPosition: nextPointerPosition,
                 };
                 if (isHoveredChanged) {
-                    prevHovered.current = filteredNextHovered;
+                    prevHovered.current = sortedHovered;
                 }
                 setTooltipState(newTooltipState);
             });
@@ -25,7 +32,7 @@ export const useTooltip = ({ dispatcher, tooltip }) => {
                 dispatcher.on('hover-shape.tooltip', null);
             }
         };
-    }, [dispatcher, tooltip]);
+    }, [dispatcher, tooltip, xAxis, yAxis]);
     return {
         hovered,
         hoveredPlotLines,

package/dist/esm/types/chart/axis.d.ts

@@ -6,6 +6,7 @@ import type { BaseTextStyle } from './base';
 import type { ChartBrush } from './brush';
 export type ChartAxisType = (typeof AXIS_TYPE)[keyof typeof AXIS_TYPE];
 export type ChartAxisTitleAlignment = 'left' | 'center' | 'right';
+export type ChartAxisTitleRotation = 0 | 90 | -90;
 export interface ChartAxisLabels {
     /** Enable or disable the axis labels. */
     enabled?: boolean;
@@ -314,7 +315,7 @@ export interface ChartYAxisTitle extends ChartAxisTitle {
      *
      * The default values are -90 for the left axis and 90 for the right.
      */
-    rotation?: 0 | 90 | -90;
+    rotation?: ChartAxisTitleRotation;
     /**
      * Interval of the tick marks(absolute or relative to the chart area).
      *

package/dist/esm/types/chart/tooltip.d.ts

@@ -113,8 +113,13 @@ export type ChartTooltipRowRendererArgs = {
     value: string | number | null | undefined;
     formattedValue?: string;
     hovered?: TooltipDataChunk<unknown>[];
+    /**
+     * CSS class name pre-built with active/striped modifiers.
+     * Apply it to the root `<tr>` element of the returned row: `<tr className={className}>`.
+     */
     className?: string;
 };
+export type ChartTooltipSortComparator<T = MeaningfulAny> = (a: TooltipDataChunk<T>, b: TooltipDataChunk<T>) => number;
 export interface ChartTooltip<T = MeaningfulAny> {
     enabled?: boolean;
     /** Specifies the renderer for the tooltip. If returned null default tooltip renderer will be used. */
@@ -122,7 +127,26 @@ export interface ChartTooltip<T = MeaningfulAny> {
     /**
      * Defines the way a single data/series is displayed (corresponding to a separate selected point/ruler/shape on the chart).
      * It is useful in cases where you need to display additional information, but keep the general format of the tooltip.
-     * If a string is returned, it will be interpreted as raw HTML and inserted without escaping.
+     *
+     * The returned React element must be a `<tr>` so that it fits into the table layout used by the tooltip.
+     * Apply the `className` arg to the root `<tr>` to get the correct active/striped styles.
+     *
+     * If a string is returned, it will be parsed as HTML and rendered as-is — the string must be a complete
+     * `<tr>...</tr>` element.
+     * @example React element
+     * ```tsx
+     * rowRenderer: ({id, name, value, className}) => (
+     *   <tr key={id} className={className}>
+     *     <td>{name}</td>
+     *     <td>{value}</td>
+     *   </tr>
+     * )
+     * ```
+     * @example Raw HTML string
+     * ```ts
+     * rowRenderer: ({name, value, className}) =>
+     *   `<tr class="${className}"><td>${name}</td><td>${value}</td></tr>`
+     * ```
      */
     rowRenderer?: ((args: ChartTooltipRowRendererArgs) => React.ReactElement | string) | null;
     pin?: {
@@ -158,4 +182,23 @@ export interface ChartTooltip<T = MeaningfulAny> {
      * It is assigned as a data-qa attribute to an element.
      */
     qa?: string;
+    /**
+     * Controls the order of tooltip rows. Applied to `hovered` before rendering.
+     * Use a custom comparator `(a, b) => number` for arbitrary ordering.
+     */
+    sorting?: {
+        /**
+         * Determines what data should be used to sort by.
+         * `'value'` uses the numeric value of each series point: `y` for most series
+         * (line, area, bar-x, scatter, waterfall), `x` for bar-y, and `value` for
+         * pie, radar, heatmap, treemap, funnel. `null` values are sorted as lowest.
+         * @default undefined (sorting disabled)
+         */
+        key?: 'value' | undefined;
+        /**
+         * Sorting direction.
+         * @default 'asc'
+         */
+        direction?: 'asc' | 'desc';
+    } | ChartTooltipSortComparator<T>;
 }

package/dist/esm/utils/chart/zoom.js

@@ -50,9 +50,9 @@ export function getZoomedSeriesData(args) {
     }
     const zoomedSeriesData = [];
     const zoomedShapesSeriesData = [];
-    let prevPointInRange = false;
-    let currentPointInRange = false;
     seriesData.forEach((seriesItem) => {
+        let prevPointInRange = false;
+        let currentPointInRange = false;
         const filteredData = [];
         const filteredShapesData = SERIES_TYPE_WITH_HIDDEN_POINTS.includes(seriesItem.type) && (xAxis === null || xAxis === void 0 ? void 0 : xAxis.type) !== 'category'
             ? []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/charts",
-  "version": "1.39.1",
+  "version": "1.41.0",
   "description": "A flexible JavaScript library for data visualization and chart rendering using React",
   "license": "MIT",
   "main": "dist/cjs/index.js",
@@ -73,6 +73,7 @@
     "d3": "^7.9.0",
     "d3-sankey": "^0.12.3",
     "d3-selection": "^3.0.0",
+    "html-react-parser": "^5.2.17",
     "lodash": "^4.17.21",
     "tslib": "^2.6.2"
   },