@gravity-ui/charts 1.1.0 → 1.3.0

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

@@ -1,5 +1,5 @@
 import type { DashStyle } from 'src/constants';
-import type { AxisPlotLine, BaseTextStyle, ChartAxis, ChartAxisLabels, ChartAxisTitleAlignment, ChartAxisType, ChartData, ChartMargin } from '../../types';
+import type { AxisPlotBand, BaseTextStyle, ChartAxis, ChartAxisLabels, ChartAxisTitleAlignment, ChartAxisType, ChartData, ChartMargin, PlotLayerPlacement } from '../../types';
 type PreparedAxisLabels = Omit<ChartAxisLabels, 'enabled' | 'padding' | 'style' | 'autoRotation'> & Required<Pick<ChartAxisLabels, 'enabled' | 'padding' | 'margin' | 'rotation'>> & {
     style: BaseTextStyle;
     rotation: number;
@@ -11,15 +11,16 @@ type PreparedAxisLabels = Omit<ChartAxisLabels, 'enabled' | 'padding' | 'style'
 export type PreparedChart = {
     margin: ChartMargin;
 };
+export type PreparedAxisPlotBand = Required<AxisPlotBand>;
 export type PreparedAxisPlotLine = {
     value: number;
     color: string;
     width: number;
     dashStyle: DashStyle;
     opacity: number;
-    layerPlacement: AxisPlotLine['layerPlacement'];
+    layerPlacement: PlotLayerPlacement;
 };
-export type PreparedAxis = Omit<ChartAxis, 'type' | 'labels' | 'plotLines'> & {
+export type PreparedAxis = Omit<ChartAxis, 'type' | 'labels' | 'plotLines' | 'plotBands'> & {
     type: ChartAxisType;
     labels: PreparedAxisLabels;
     title: {
@@ -42,6 +43,7 @@ export type PreparedAxis = Omit<ChartAxis, 'type' | 'labels' | 'plotLines'> & {
     position: 'left' | 'right' | 'top' | 'bottom';
     plotIndex: number;
     plotLines: PreparedAxisPlotLine[];
+    plotBands: PreparedAxisPlotBand[];
 };
 export type PreparedTitle = ChartData['title'] & {
     height: number;

package/dist/esm/hooks/useChartOptions/x-axis.js

@@ -110,6 +110,13 @@ export const getPreparedXAxis = ({ xAxis, series, width, }) => {
             opacity: get(d, 'opacity', 1),
             layerPlacement: get(d, 'layerPlacement', 'before'),
         })),
+        plotBands: get(xAxis, 'plotBands', []).map((d) => ({
+            color: get(d, 'color', 'var(--g-color-base-brand)'),
+            opacity: get(d, 'opacity', 1),
+            from: get(d, 'from', 0),
+            to: get(d, 'to', 0),
+            layerPlacement: get(d, 'layerPlacement', 'before'),
+        })),
         visible: get(xAxis, 'visible', true),
     };
     const { height, rotation } = getLabelSettings({

package/dist/esm/hooks/useChartOptions/y-axis.js

@@ -1,6 +1,6 @@
 import get from 'lodash/get';
 import { DEFAULT_AXIS_LABEL_FONT_SIZE, DEFAULT_AXIS_TYPE, DashStyle, axisLabelsDefaults, yAxisTitleDefaults, } from '../../constants';
-import { CHART_SERIES_WITH_VOLUME_ON_Y_AXIS, formatAxisTickLabel, getClosestPointsRange, getHorisontalSvgTextHeight, getLabelsSize, getScaleTicks, getWaterfallPointSubtotal, wrapText, } from '../../utils';
+import { CHART_SERIES_WITH_VOLUME_ON_Y_AXIS, formatAxisTickLabel, getClosestPointsRange, getHorisontalSvgTextHeight, getLabelsSize, getScaleTicks, getWaterfallPointSubtotal, isAxisRelatedSeries, wrapText, } from '../../utils';
 import { createYScale } from '../useAxisScales';
 const getAxisLabelMaxWidth = (args) => {
     const { axis, series } = args;
@@ -45,6 +45,10 @@ function getAxisMin(axis, series) {
 export const getPreparedYAxis = ({ series, yAxis, height, }) => {
     const axisByPlot = [];
     const axisItems = yAxis || [{}];
+    const hasAxisRelatedSeries = series.some(isAxisRelatedSeries);
+    if (!hasAxisRelatedSeries) {
+        return [];
+    }
     return axisItems.map((axisItem) => {
         const plotIndex = get(axisItem, 'plotIndex', 0);
         const firstPlotAxis = !axisByPlot[plotIndex];
@@ -116,6 +120,13 @@ export const getPreparedYAxis = ({ series, yAxis, height, }) => {
                 opacity: get(d, 'opacity', 1),
                 layerPlacement: get(d, 'layerPlacement', 'before'),
             })),
+            plotBands: get(axisItem, 'plotBands', []).map((d) => ({
+                color: get(d, 'color', 'var(--g-color-base-brand)'),
+                opacity: get(d, 'opacity', 1),
+                from: get(d, 'from', 0),
+                to: get(d, 'to', 0),
+                layerPlacement: get(d, 'layerPlacement', 'before'),
+            })),
             visible: get(axisItem, 'visible', true),
         };
         if (labelsEnabled) {

package/dist/esm/hooks/useSeries/prepare-legend.js

@@ -50,6 +50,7 @@ export const getPreparedLegend = (args) => {
     const legendWidth = get(legend, 'width', CONTINUOUS_LEGEND_SIZE.width);
     return {
         align: get(legend, 'align', legendDefaults.align),
+        justifyContent: get(legend, 'justifyContent', legendDefaults.justifyContent),
         enabled,
         height,
         itemDistance: get(legend, 'itemDistance', legendDefaults.itemDistance),

package/dist/esm/hooks/useShapes/HtmlLayer.js

@@ -17,6 +17,7 @@ export const HtmlLayer = (props) => {
         return null;
     }
     return (React.createElement(Portal, { container: htmlLayout }, items.map((item, index) => {
-        return (React.createElement("div", { key: index, dangerouslySetInnerHTML: { __html: item.content }, style: { position: 'absolute', left: item.x, top: item.y } }));
+        const style = Object.assign(Object.assign({}, item.style), { position: 'absolute', left: item.x, top: item.y });
+        return (React.createElement("div", { key: index, dangerouslySetInnerHTML: { __html: item.content }, style: style }));
     })));
 };

package/dist/esm/hooks/useShapes/area/prepare-data.js

@@ -111,6 +111,7 @@ export const prepareAreaData = (args) => {
                             y: l.y,
                             content: l.text,
                             size: { width: labelSize.maxWidth, height: labelSize.maxHeight },
+                            style,
                         };
                     });
                     htmlElements.push(...htmlLabels);

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

@@ -139,6 +139,7 @@ export const prepareBarXData = (args) => {
                         y: label.y,
                         content: label.text,
                         size: label.size,
+                        style: label.style,
                     });
                 }
                 else {

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

@@ -71,6 +71,7 @@ function setLabel(prepared) {
             y: y - height / 2,
             content,
             size: { width, height },
+            style: dataLabels.style,
         });
     }
     else {

package/dist/esm/hooks/useShapes/line/prepare-data.js

@@ -35,6 +35,7 @@ function getHtmlLabel(point, series, xMax) {
         y: Math.max(0, point.y - series.dataLabels.padding - size.maxHeight),
         content,
         size: { width: size.maxWidth, height: size.maxHeight },
+        style: series.dataLabels.style,
     };
 }
 export const prepareLineData = (args) => {

package/dist/esm/hooks/useShapes/pie/index.js

@@ -75,7 +75,7 @@ export function PieSeriesShapes(args) {
             .selectAll('text')
             .data((pieData) => pieData.labels)
             .join('text')
-            .text((d) => d.text)
+            .html((d) => d.text)
             .attr('class', b('label'))
             .attr('x', (d) => d.x)
             .attr('y', (d) => d.y)

package/dist/esm/hooks/useShapes/pie/prepare-data.js

@@ -17,7 +17,10 @@ const getCenter = (boundsWidth, boundsHeight, center) => {
 };
 export function preparePieData(args) {
     const { series: preparedSeries, boundsWidth, boundsHeight } = args;
-    const maxRadius = Math.min(boundsWidth, boundsHeight) / 2;
+    const haloSize = preparedSeries[0].states.hover.halo.enabled
+        ? preparedSeries[0].states.hover.halo.size
+        : 0;
+    const maxRadius = Math.min(boundsWidth, boundsHeight) / 2 - haloSize;
     const groupedPieSeries = group(preparedSeries, (pieSeries) => pieSeries.stackId);
     const prepareItem = (stackId, items) => {
         var _a;
@@ -184,6 +187,7 @@ export function preparePieData(args) {
                         y: Math.max(0, data.center[1] + label.y),
                         content: label.text,
                         size: label.size,
+                        style: label.style,
                     });
                 }
                 else {
@@ -209,19 +213,20 @@ export function preparePieData(args) {
             series: items,
         });
         const segmentMaxRadius = Math.max(...data.segments.map((s) => s.data.radius));
-        const top = Math.min(data.center[1] - segmentMaxRadius, ...preparedLabels.labels.map((l) => l.y + data.center[1]), ...preparedLabels.htmlLabels.map((l) => l.y));
+        const topAdjustment = Math.min(data.center[1] - segmentMaxRadius, ...preparedLabels.labels.map((l) => l.y + data.center[1]), ...preparedLabels.htmlLabels.map((l) => l.y));
         const bottom = Math.max(data.center[1] + segmentMaxRadius, ...preparedLabels.labels.map((l) => l.y + data.center[1] + l.size.height), ...preparedLabels.htmlLabels.map((l) => l.y + l.size.height));
-        const topAdjustment = Math.floor(top - data.halo.size);
         if (topAdjustment > 0) {
             data.segments.forEach((s) => {
-                s.data.radius += topAdjustment / 2;
+                const nextPossibleRadius = s.data.radius + topAdjustment / 2;
+                s.data.radius = Math.min(nextPossibleRadius, maxRadius);
             });
             data.center[1] -= topAdjustment / 2;
         }
-        const bottomAdjustment = Math.floor(boundsHeight - bottom - data.halo.size);
+        const bottomAdjustment = Math.floor(boundsHeight - bottom);
         if (bottomAdjustment > 0) {
             data.segments.forEach((s) => {
-                s.data.radius += bottomAdjustment / 2;
+                const nextPossibleRadius = s.data.radius + bottomAdjustment / 2;
+                s.data.radius = Math.min(nextPossibleRadius, maxRadius);
             });
             data.center[1] += bottomAdjustment / 2;
         }

package/dist/esm/hooks/useShapes/radar/prepare-data.js

@@ -146,6 +146,7 @@ export function prepareRadarData(args) {
                     y: label.y,
                     content: label.text,
                     size: label.size,
+                    style: label.style,
                 }));
             }
         }

package/dist/esm/hooks/useShapes/treemap/index.js

@@ -38,7 +38,7 @@ export const TreemapSeriesShape = (props) => {
             .selectAll('tspan')
             .data(labelData)
             .join('text')
-            .text((d) => d.text)
+            .html((d) => d.text)
             .attr('class', b('label'))
             .attr('x', (d) => d.x)
             .attr('y', (d) => d.y)

package/dist/esm/hooks/useShapes/treemap/prepare-data.js

@@ -10,23 +10,28 @@ function getLabels(args) {
         texts.forEach((text, index) => {
             var _a;
             const label = getFormattedValue(Object.assign({ value: text }, args.options));
-            const { maxHeight: lineHeight, maxWidth: labelWidth } = (_a = getLabelsSize({ labels: [label], html })) !== null && _a !== void 0 ? _a : {};
+            const { maxHeight: lineHeight, maxWidth: labelMaxWidth } = (_a = getLabelsSize({ labels: [label], html })) !== null && _a !== void 0 ? _a : {};
             const left = d.x0 + padding;
             const right = d.x1 - padding;
-            const width = Math.max(0, right - left);
+            const spaceWidth = Math.max(0, right - left);
+            const spaceHeight = Math.max(0, d.y1 - d.y0 - padding);
             let x = left;
             const y = index * lineHeight + d.y0 + padding;
+            const labelWidth = Math.min(labelMaxWidth, spaceWidth);
+            if (!labelWidth || lineHeight > spaceHeight) {
+                return;
+            }
             switch (align) {
                 case 'left': {
                     x = left;
                     break;
                 }
                 case 'center': {
-                    x = Math.max(left, left + (width - labelWidth) / 2);
+                    x = Math.max(left, left + (spaceWidth - labelMaxWidth) / 2);
                     break;
                 }
                 case 'right': {
-                    x = Math.max(left, right - labelWidth);
+                    x = Math.max(left, right - labelMaxWidth);
                     break;
                 }
             }
@@ -35,13 +40,13 @@ function getLabels(args) {
                     content: label,
                     x,
                     y,
-                    size: { width, height: lineHeight },
+                    size: { width: labelWidth, height: lineHeight },
                 }
                 : {
                     text: label,
                     x,
                     y,
-                    width,
+                    width: labelWidth,
                     nodeData: d.data,
                 };
             acc.push(item);
@@ -94,10 +99,11 @@ export function prepareTreemapData(args) {
     let labelData = [];
     const htmlElements = [];
     if ((_a = series.dataLabels) === null || _a === void 0 ? void 0 : _a.enabled) {
-        const { html } = series.dataLabels;
+        const { html, style: dataLabelsStyle } = series.dataLabels;
         const labels = getLabels({ data: leaves, options: series.dataLabels });
         if (html) {
-            htmlElements.push(...labels);
+            const htmlItems = labels.map((l) => (Object.assign({ style: dataLabelsStyle }, l)));
+            htmlElements.push(...htmlItems);
         }
         else {
             labelData = labels;

package/dist/esm/i18n/keysets/en.json

@@ -11,6 +11,8 @@
     "label_invalid-series-property": "It seems you are trying to use inappropriate value for \"{{key}}\", or defined it incorrectly. Available values: [{{values}}].",
     "label_invalid-treemap-redundant-value": "It seems you are trying to set \"value\" for container node. Check node with this properties: { id: \"{{id}}\", name: \"{{name}}\" }",
     "label_invalid-treemap-missing-value": "It seems you are trying to use node without \"value\". Check node with this properties: { id: \"{{id}}\", name: \"{{name}}\" }",
-    "label_invalid-y-axis-index": "It seems you are trying to use inappropriate index for Y axis: \"{{index}}\""
+    "label_invalid-y-axis-index": "It seems you are trying to use inappropriate index for Y axis: \"{{index}}\"",
+    "label_invalid-axis-plot-band-option": "It seems you are trying to use inappropriate type for \"{{axis}}\" axis plot band option: \"{{option}}\"",
+    "label_axis-plot-band-options-not-equal": "It seems you are trying to use different type for \"{{axis}}\" axis plot band options"
   }
 }

package/dist/esm/i18n/keysets/ru.json

@@ -11,6 +11,8 @@
     "label_invalid-series-property": "Похоже, что вы пытаетесь использовать недопустимое значение для \"{{key}}\", или указали его неверно. Доступные значения: [{{values}}].",
     "label_invalid-treemap-redundant-value": "Похоже, что вы пытаетесь установить значение \"value\" для узла, используемого в качестве контейнера. Проверьте узел с этими свойствами: { id: \"{{id}}\", name: \"{{name}}\" }",
     "label_invalid-treemap-missing-value": "Похоже, что вы пытаетесь использовать узел без значения \"value\". Проверьте узел с этими свойствами: { id: \"{{id}}\", name: \"{{name}}\" }",
-    "label_invalid-y-axis-index": "Похоже, что вы пытаетесь использовать некорректный индекс для оси Y: \"{{index}}\""
+    "label_invalid-y-axis-index": "Похоже, что вы пытаетесь использовать некорректный индекс для оси Y: \"{{index}}\"",
+    "label_invalid-axis-plot-band-option": "Похоже, что вы пытаетесь использовать некорректный тип для параметра полосы: \"{{option}}\" для оси \"{{axis}}\"",
+    "label_axis-plot-band-options-not-equal": "Похоже, что вы пытаетесь использовать разные типы для для параметра полосы для оси \"{{axis}}\""
   }
 }

package/dist/esm/libs/chart-error/index.d.ts

@@ -7,6 +7,7 @@ export declare const CHART_ERROR_CODE: {
     NO_DATA: string;
     INVALID_DATA: string;
     UNKNOWN: string;
+    INVALID_OPTION_TYPE: string;
 };
 export declare class ChartError extends Error {
     readonly code: number | string;

package/dist/esm/libs/chart-error/index.js

@@ -2,6 +2,7 @@ export const CHART_ERROR_CODE = {
     NO_DATA: 'ERR.CK.NO_DATA',
     INVALID_DATA: 'ERR.CK.INVALID_DATA',
     UNKNOWN: 'ERR.CK.UNKNOWN_ERROR',
+    INVALID_OPTION_TYPE: 'ERR.CK.INVALID_OPTION_TYPE',
 };
 export class ChartError extends Error {
     constructor({ originalError, message, code = CHART_ERROR_CODE.UNKNOWN } = {}) {

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

@@ -75,12 +75,27 @@ export interface ChartAxis {
     maxPadding?: number;
     /** An array of lines stretching across the plot area, marking a specific value */
     plotLines?: AxisPlotLine[];
+    /** An array of colored bands stretching across the plot area marking an interval on the axis. */
+    plotBands?: AxisPlotBand[];
     /** Whether axis, including axis title, line, ticks and labels, should be visible. */
     visible?: boolean;
 }
 export interface ChartXAxis extends ChartAxis {
 }
-export interface AxisPlotLine {
+export type PlotLayerPlacement = 'before' | 'after';
+export interface AxisPlot {
+    /** Place the line behind or above the chart. */
+    layerPlacement?: PlotLayerPlacement;
+    /** The color of the plot line (hex, rgba). */
+    color?: string;
+    /**
+     * Individual opacity for the line.
+     *
+     * @default 1
+     * */
+    opacity?: number;
+}
+export interface AxisPlotLine extends AxisPlot {
     /** The position of the line in axis units. */
     value?: number;
     /** The color of the plot line (hex, rgba). */
@@ -92,14 +107,22 @@ export interface AxisPlotLine {
     width?: number;
     /** Option for line stroke style. */
     dashStyle?: `${DashStyle}`;
+}
+export interface AxisPlotBand extends AxisPlot {
     /**
-     * Individual opacity for the line.
+     * The start position of the plot band in axis units.
      *
-     * @default 1
-     * */
-    opacity?: number;
-    /** Place the line behind or above the chart. */
-    layerPlacement?: 'before' | 'after';
+     * Can be a number, a string (e.g., a category), or a timestamp if representing a date.
+     * When representing a date, the value **must be a timestamp** (number of milliseconds since Unix epoch).
+     */
+    from: number | string;
+    /**
+     * The end position of the plot band in axis units.
+     *
+     * Can be a number, a string (e.g., a category), or a timestamp if representing a date.
+     * When representing a date, the value **must be a timestamp** (number of milliseconds since Unix epoch).
+     */
+    to: number | string;
 }
 export interface ChartYAxis extends ChartAxis {
     /** Axis location.

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

@@ -15,6 +15,12 @@ export interface ChartLegend {
      * @default center
      * */
     align?: 'left' | 'center' | 'right';
+    /**
+     * Defines how items should be positioned in the legend when overflowing (moving to the next line).
+     *
+     * @default center
+     * */
+    justifyContent?: 'start' | 'center';
     /**
      * Defines the pixel distance between each legend item
      *

package/dist/esm/types/chart-ui.d.ts

@@ -22,6 +22,7 @@ export interface HtmlItem {
         width: number;
         height: number;
     };
+    style?: BaseTextStyle;
 }
 export interface ShapeDataWithHtmlItems {
     htmlElements: HtmlItem[];

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

@@ -1,6 +1,7 @@
 import type { AxisDomain, AxisScale, ScaleBand } from 'd3';
-import type { PreparedAxis, PreparedSplit } from '../../hooks';
+import type { PreparedAxis, PreparedAxisPlotBand, PreparedSplit } from '../../hooks';
 import type { TextRow } from './text';
+import type { AxisDirection } from './types';
 export declare function getTicksCount({ axis, range }: {
     axis: PreparedAxis;
     range: number;
@@ -29,3 +30,13 @@ export declare function getAxisTitleRows(args: {
     axis: PreparedAxis;
     textMaxWidth: number;
 }): TextRow[];
+interface GetBandsPositionArgs {
+    band: PreparedAxisPlotBand;
+    axisScale: AxisScale<AxisDomain>;
+    axis: AxisDirection;
+}
+export declare function getBandsPosition(args: GetBandsPositionArgs): {
+    from: number;
+    to: number;
+};
+export {};

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

@@ -1,3 +1,4 @@
+import clamp from 'lodash/clamp';
 import { wrapText } from './text';
 export function getTicksCount({ axis, range }) {
     let ticksCount;
@@ -69,3 +70,37 @@ export function getAxisTitleRows(args) {
         return acc;
     }, []);
 }
+export function getBandsPosition(args) {
+    var _a, _b, _c;
+    const { band, axisScale } = args;
+    const scalePosTo = axisScale(band.to);
+    const scalePosFrom = axisScale(band.from);
+    const isX = args.axis === 'x';
+    if (scalePosTo !== undefined && scalePosFrom !== undefined) {
+        return {
+            from: Math.max(scalePosFrom, 0),
+            to: Math.max(scalePosTo, 0),
+        };
+    }
+    if (typeof band.from !== 'number' || typeof band.to !== 'number') {
+        throw new Error('Filed to create plot band');
+    }
+    const category = axisScale.domain();
+    const bandwidth = (_b = (_a = axisScale.bandwidth) === null || _a === void 0 ? void 0 : _a.call(axisScale)) !== null && _b !== void 0 ? _b : 1;
+    const halfBandwidth = bandwidth / 2;
+    const calcPosition = (value) => {
+        var _a, _b;
+        if (value >= category.length) {
+            return ((_a = axisScale(category[category.length - 1])) !== null && _a !== void 0 ? _a : 0) + halfBandwidth * (isX ? 1 : -1);
+        }
+        return (((_b = axisScale(category[clamp(Math.floor(value), 0, category.length - 1)])) !== null && _b !== void 0 ? _b : 0) +
+            bandwidth * (value - Math.floor(Math.abs(value))) * (isX ? 1 : -1));
+    };
+    const to = calcPosition(band.to);
+    const from = calcPosition(band.from);
+    const maxPos = ((_c = axisScale(category[isX ? category.length - 1 : 0])) !== null && _c !== void 0 ? _c : 0) + halfBandwidth;
+    return {
+        from: clamp(from, -halfBandwidth, maxPos),
+        to: clamp(to, -halfBandwidth, maxPos),
+    };
+}

package/dist/esm/utils/chart/index.d.ts

@@ -1,6 +1,7 @@
 import type { AxisDomain } from 'd3';
 import type { PreparedAxis } from '../../hooks';
 import type { BaseTextStyle, ChartSeries, ChartSeriesData } from '../../types';
+import type { AxisDirection } from './types';
 export * from './math';
 export * from './text';
 export * from './time';
@@ -12,7 +13,6 @@ export * from './series';
 export * from './color';
 export declare const CHART_SERIES_WITH_VOLUME_ON_Y_AXIS: ChartSeries['type'][];
 export declare const CHART_SERIES_WITH_VOLUME_ON_X_AXIS: ChartSeries['type'][];
-export type AxisDirection = 'x' | 'y';
 type UnknownSeries = {
     type: ChartSeries['type'];
     data: unknown;
@@ -76,3 +76,4 @@ export declare const getDataCategoryValue: (args: {
     data: ChartSeriesData;
 }) => string;
 export declare function getClosestPointsRange(axis: PreparedAxis, points: AxisDomain[]): number | undefined;
+export { AxisDirection };

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

@@ -0,0 +1 @@
+export type AxisDirection = 'x' | 'y';

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

@@ -0,0 +1 @@
+export {};