@gravity-ui/chartkit 4.3.0 → 4.4.0

package/build/plugins/d3/renderer/components/Chart.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import type { ChartKitWidgetData } from '../../../../types/widget-data';
+import type { ChartKitWidgetData } from '../../../../types';
 import './styles.css';
 type Props = {
     top: number;

package/build/plugins/d3/renderer/components/Chart.js

@@ -37,6 +37,7 @@ export const Chart = (props) => {
         boundsWidth,
         boundsHeight,
         series: preparedSeries,
+        seriesOptions: data.series.options,
         xAxis,
         xScale,
         yAxis,

package/build/plugins/d3/renderer/hooks/useShapes/bar-x.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
+import type { ChartKitWidgetSeriesOptions } from '../../../../../types';
 import type { ChartScale } from '../useAxisScales';
 import type { ChartOptions } from '../useChartOptions/types';
 import type { OnSeriesMouseLeave, OnSeriesMouseMove } from '../useTooltip/types';
@@ -7,6 +8,7 @@ type Args = {
     top: number;
     left: number;
     series: PreparedBarXSeries[];
+    seriesOptions?: ChartKitWidgetSeriesOptions;
     xAxis: ChartOptions['xAxis'];
     xScale: ChartScale;
     yAxis: ChartOptions['yAxis'];

package/build/plugins/d3/renderer/hooks/useShapes/bar-x.js

@@ -1,18 +1,35 @@
-import { max, pointer, select } from 'd3';
+import { ascending, descending, max, pointer, select, sort } from 'd3';
 import React from 'react';
 import get from 'lodash/get';
 import { block } from '../../../../../utils/cn';
 import { getDataCategoryValue } from '../../utils';
-const RECT_PADDING = 0.1;
+import { DEFAULT_BAR_X_SERIES_OPTIONS } from './defaults';
 const MIN_RECT_GAP = 1;
-const MAX_RECT_WIDTH = 50;
-const GROUP_PADDING = 0.1;
 const MIN_GROUP_GAP = 1;
 const DEFAULT_LABEL_PADDING = 7;
 const b = block('d3-bar-x');
 function prepareData(args) {
-    const { series, xAxis, xScale, yScale } = args;
+    const { series, seriesOptions, xAxis, xScale, yScale } = args;
     const categories = get(xAxis, 'categories', []);
+    const { barMaxWidth: defaultBarMaxWidth, barPadding: defaultBarPadding, groupPadding: defaultGroupPadding, } = DEFAULT_BAR_X_SERIES_OPTIONS;
+    const barMaxWidth = get(seriesOptions, 'bar-x.barMaxWidth', defaultBarMaxWidth);
+    const barPadding = get(seriesOptions, 'bar-x.barPadding', defaultBarPadding);
+    const groupPadding = get(seriesOptions, 'bar-x.groupPadding', defaultGroupPadding);
+    const sortingOptions = get(seriesOptions, 'bar-x.dataSorting');
+    const comparator = (sortingOptions === null || sortingOptions === void 0 ? void 0 : sortingOptions.direction) === 'desc' ? descending : ascending;
+    const sortKey = (() => {
+        switch (sortingOptions === null || sortingOptions === void 0 ? void 0 : sortingOptions.key) {
+            case 'y': {
+                return 'data.y';
+            }
+            case 'name': {
+                return 'series.name';
+            }
+            default: {
+                return undefined;
+            }
+        }
+    })();
     const data = {};
     series.forEach((s) => {
         s.data.forEach((d) => {
@@ -52,17 +69,20 @@ function prepareData(args) {
         });
     }
     const maxGroupSize = max(Object.values(data), (d) => Object.values(d).length) || 1;
-    const groupGap = Math.max(bandWidth * GROUP_PADDING, MIN_GROUP_GAP);
-    const maxGroupWidth = bandWidth - groupGap;
-    const rectGap = Math.max((maxGroupWidth / maxGroupSize) * RECT_PADDING, MIN_RECT_GAP);
-    const rectWidth = Math.min(maxGroupWidth / maxGroupSize - rectGap, MAX_RECT_WIDTH);
+    const groupGap = Math.max(bandWidth * groupPadding, MIN_GROUP_GAP);
+    const groupWidth = bandWidth - groupGap;
+    const rectGap = Math.max(bandWidth * barPadding, MIN_RECT_GAP);
+    const rectWidth = Math.min(groupWidth / maxGroupSize - rectGap, barMaxWidth);
     const result = [];
     Object.entries(data).forEach(([xValue, val]) => {
         const stacks = Object.values(val);
         const currentGroupWidth = rectWidth * stacks.length + rectGap * (stacks.length - 1);
         stacks.forEach((yValues, groupItemIndex) => {
             let stackHeight = 0;
-            yValues.forEach((yValue) => {
+            const sortedData = sortKey
+                ? sort(yValues, (a, b) => comparator(get(a, sortKey), get(b, sortKey)))
+                : yValues;
+            sortedData.forEach((yValue) => {
                 let xCenter;
                 if (xAxis.type === 'category') {
                     const xBandScale = xScale;
@@ -91,7 +111,7 @@ function prepareData(args) {
     return result;
 }
 export function BarXSeriesShapes(args) {
-    const { top, left, series, xAxis, xScale, yAxis, yScale, onSeriesMouseMove, onSeriesMouseLeave, svgContainer, } = args;
+    const { top, left, series, seriesOptions, xAxis, xScale, yAxis, yScale, onSeriesMouseMove, onSeriesMouseLeave, svgContainer, } = args;
     const ref = React.useRef(null);
     React.useEffect(() => {
         if (!ref.current) {
@@ -101,6 +121,7 @@ export function BarXSeriesShapes(args) {
         svgElement.selectAll('*').remove();
         const shapes = prepareData({
             series,
+            seriesOptions,
             xAxis,
             xScale,
             yAxis,

package/build/plugins/d3/renderer/hooks/useShapes/defaults.d.ts

@@ -0,0 +1,5 @@
+export declare const DEFAULT_BAR_X_SERIES_OPTIONS: {
+    barMaxWidth: number;
+    barPadding: number;
+    groupPadding: number;
+};

package/build/plugins/d3/renderer/hooks/useShapes/defaults.js

@@ -0,0 +1,5 @@
+export const DEFAULT_BAR_X_SERIES_OPTIONS = {
+    barMaxWidth: 50,
+    barPadding: 0.1,
+    groupPadding: 0.2,
+};

package/build/plugins/d3/renderer/hooks/useShapes/index.d.ts

@@ -1,4 +1,5 @@
 import React from 'react';
+import type { ChartKitWidgetSeriesOptions } from '../../../../../types';
 import type { ChartOptions } from '../useChartOptions/types';
 import type { ChartScale } from '../useAxisScales';
 import type { PreparedSeries } from '../';
@@ -10,6 +11,7 @@ type Args = {
     boundsWidth: number;
     boundsHeight: number;
     series: PreparedSeries[];
+    seriesOptions?: ChartKitWidgetSeriesOptions;
     xAxis: ChartOptions['xAxis'];
     yAxis: ChartOptions['yAxis'];
     svgContainer: SVGSVGElement | null;

package/build/plugins/d3/renderer/hooks/useShapes/index.js

@@ -7,7 +7,7 @@ import { ScatterSeriesShape } from './scatter';
 import { PieSeriesComponent } from './pie';
 import './styles.css';
 export const useShapes = (args) => {
-    const { top, left, boundsWidth, boundsHeight, series, xAxis, xScale, yAxis, yScale, svgContainer, onSeriesMouseMove, onSeriesMouseLeave, } = args;
+    const { top, left, boundsWidth, boundsHeight, series, seriesOptions, xAxis, xScale, yAxis, yScale, svgContainer, onSeriesMouseMove, onSeriesMouseLeave, } = args;
     const shapes = React.useMemo(() => {
         const visibleSeries = getOnlyVisibleSeries(series);
         const groupedSeries = group(visibleSeries, (item) => item.type);
@@ -16,7 +16,7 @@ export const useShapes = (args) => {
             switch (seriesType) {
                 case 'bar-x': {
                     if (xScale && yScale) {
-                        acc.push(React.createElement(BarXSeriesShapes, { key: "bar-x", series: chartSeries, xAxis: xAxis, xScale: xScale, yAxis: yAxis, yScale: yScale, top: top, left: left, svgContainer: svgContainer, onSeriesMouseMove: onSeriesMouseMove, onSeriesMouseLeave: onSeriesMouseLeave }));
+                        acc.push(React.createElement(BarXSeriesShapes, { key: "bar-x", series: chartSeries, seriesOptions: seriesOptions, xAxis: xAxis, xScale: xScale, yAxis: yAxis, yScale: yScale, top: top, left: left, svgContainer: svgContainer, onSeriesMouseMove: onSeriesMouseMove, onSeriesMouseLeave: onSeriesMouseLeave }));
                     }
                     break;
                 }

package/build/types/widget-data/series.d.ts

@@ -15,4 +15,35 @@ export type ChartKitWidgetSeriesOptions = {
         /** Callback function to render the data label */
         renderer?: (args: DataLabelRendererData) => React.SVGTextElementAttributes<SVGTextElement>;
     };
+    'bar-x'?: {
+        /** The maximum allowed pixel width for a column.
+         * This prevents the columns from becoming too wide when there is a small number of points in the chart.
+         *
+         * @default 50
+         */
+        barMaxWidth?: number;
+        /** Padding between each column or bar, in x axis units.
+         *
+         * @default 0.1
+         * */
+        barPadding?: number;
+        /** Padding between each value groups, in x axis units
+         *
+         * @default 0.2
+         */
+        groupPadding?: number;
+        dataSorting?: {
+            /** Determines what data value should be used to sort by.
+             * Possible values are undefined to disable, "name" to sort by series name or "y"
+             *
+             * @default undefined
+             * */
+            key?: 'name' | 'y' | undefined;
+            /** Sorting direction.
+             *
+             * @default 'asc'
+             * */
+            direction?: 'asc' | 'desc';
+        };
+    };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/chartkit",
-  "version": "4.3.0",
+  "version": "4.4.0",
   "description": "React component used to render charts based on any sources you need",
   "license": "MIT",
   "repository": "git@github.com:gravity-ui/ChartKit.git",