@gravity-ui/charts 1.1.0 → 1.2.0

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-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 {};

package/dist/esm/validation/index.js

@@ -95,6 +95,148 @@ const validateXYSeries = (args) => {
         }
     });
 };
+const validateAxisPlotValues = (args) => {
+    const { series, xAxis, yAxis = [] } = args;
+    const yAxisIndex = get(series, 'yAxis', 0);
+    const seriesYAxis = yAxis[yAxisIndex];
+    if (yAxisIndex !== 0 && typeof seriesYAxis === 'undefined') {
+        throw new ChartError({
+            code: CHART_ERROR_CODE.INVALID_DATA,
+            message: i18n('error', 'label_invalid-y-axis-index', {
+                index: yAxisIndex,
+            }),
+        });
+    }
+    const xPlotBands = get(xAxis, 'plotBands', []);
+    const yPlotBands = get(yAxis, 'plotBands', []);
+    if (!xPlotBands.length && !yPlotBands.length) {
+        return;
+    }
+    const xType = get(xAxis, 'type', DEFAULT_AXIS_TYPE);
+    const yType = get(seriesYAxis, 'type', DEFAULT_AXIS_TYPE);
+    xPlotBands.forEach(({ from = 0, to = 0 }) => {
+        const fromNotEqualTo = typeof to !== typeof from;
+        if (fromNotEqualTo) {
+            throw new ChartError({
+                code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                message: i18n('error', 'label_axis-plot-band-options-not-equal', {
+                    axis: 'x',
+                    option: 'from',
+                }),
+            });
+        }
+        switch (xType) {
+            case 'category': {
+                const invalidFrom = typeof from !== 'string' && typeof from !== 'number';
+                const invalidTo = typeof to !== 'string' && typeof to !== 'number';
+                if (invalidFrom) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'x',
+                            option: 'from',
+                        }),
+                    });
+                }
+                if (invalidTo) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'x',
+                            option: 'to',
+                        }),
+                    });
+                }
+                break;
+            }
+            case 'linear':
+            case 'datetime': {
+                const invalidFrom = typeof from !== 'number';
+                const invalidTo = typeof to !== 'number';
+                if (invalidFrom) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'x',
+                            option: 'from',
+                        }),
+                    });
+                }
+                if (invalidTo) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'x',
+                            option: 'to',
+                        }),
+                    });
+                }
+                break;
+            }
+        }
+    });
+    yPlotBands.forEach(({ from = 0, to = 0 }) => {
+        const fromNotEqualTo = typeof to !== typeof from;
+        if (fromNotEqualTo) {
+            throw new ChartError({
+                code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                message: i18n('error', 'label_axis-plot-band-options-not-equal', {
+                    axis: 'x',
+                    option: 'from',
+                }),
+            });
+        }
+        switch (yType) {
+            case 'category': {
+                const invalidFrom = typeof from !== 'string' && typeof from !== 'number';
+                const invalidTo = typeof to !== 'string' && typeof to !== 'number';
+                if (invalidFrom) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'y',
+                            option: 'from',
+                        }),
+                    });
+                }
+                if (invalidTo) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'y',
+                            option: 'to',
+                        }),
+                    });
+                }
+                break;
+            }
+            case 'linear':
+            case 'datetime': {
+                const invalidFrom = typeof from !== 'number';
+                const invalidTo = typeof to !== 'number';
+                if (invalidFrom) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'y',
+                            option: 'from',
+                        }),
+                    });
+                }
+                if (invalidTo) {
+                    throw new ChartError({
+                        code: CHART_ERROR_CODE.INVALID_OPTION_TYPE,
+                        message: i18n('error', 'label_invalid-axis-plot-band-option', {
+                            axis: 'y',
+                            option: 'to',
+                        }),
+                    });
+                }
+                break;
+            }
+        }
+    });
+};
 const validatePieSeries = ({ series }) => {
     series.data.forEach(({ value }) => {
         if (typeof value !== 'number') {
@@ -163,12 +305,14 @@ const validateSeries = (args) => {
         case 'area':
         case 'bar-y':
         case 'bar-x': {
+            validateAxisPlotValues({ series, xAxis, yAxis });
             validateXYSeries({ series, xAxis, yAxis });
             validateStacking({ series });
             break;
         }
         case 'line':
         case 'scatter': {
+            validateAxisPlotValues({ series, xAxis, yAxis });
             validateXYSeries({ series, xAxis, yAxis });
             break;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/charts",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "React component used to render charts",
   "license": "MIT",
   "main": "dist/cjs/index.js",