@gravity-ui/charts 1.35.1 → 1.36.0

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

@@ -1,6 +1,7 @@
 import type { DurationInput } from '@gravity-ui/date-utils';
 import type { AXIS_TYPE, DashStyle } from '../../constants';
 import type { FormatNumberOptions } from '../formatter';
+import type { MeaningfulAny } from '../misc';
 import type { BaseTextStyle } from './base';
 import type { ChartBrush } from './brush';
 export type ChartAxisType = (typeof AXIS_TYPE)[keyof typeof AXIS_TYPE];
@@ -94,6 +95,16 @@ export interface ChartAxisTitle {
      */
     maxRowCount?: number;
 }
+export interface ChartAxisTickMarks {
+    /** Enable or disable the tick marks on the axis.
+     * @default false
+     */
+    enabled?: boolean;
+    /** The length of the tick marks in pixels (perpendicular to the axis).
+     * @default 6
+     */
+    length?: number;
+}
 export interface ChartAxis {
     categories?: string[];
     /** Configure a crosshair that follows either the mouse pointer or the hovered point. */
@@ -161,6 +172,8 @@ export interface ChartAxis {
     plotLines?: AxisPlotLine[];
     /** An array of colored bands stretching across the plot area marking an interval on the axis. */
     plotBands?: AxisPlotBand[];
+    /** Small perpendicular marks on the axis line at each tick position. */
+    tickMarks?: ChartAxisTickMarks;
     /** Whether axis, including axis title, line, ticks and labels, should be visible. */
     visible?: boolean;
     /** Setting the order of the axis values. It is not applied by default.
@@ -226,6 +239,8 @@ export interface AxisPlot {
          * It is assigned as a data-qa attribute to an element. */
         qa?: string;
     };
+    /** Custom data associated with the plot line/band, accessible in tooltip renderer args. */
+    custom?: MeaningfulAny;
 }
 export interface AxisPlotLine extends AxisPlot {
     /** The position of the line in axis units. */
@@ -259,7 +274,7 @@ export interface AxisPlotBand extends AxisPlot {
      */
     to: number | string | null;
 }
-export interface AxisCrosshair extends Omit<AxisPlotLine, 'value' | 'label'> {
+export interface AxisCrosshair extends Omit<AxisPlotLine, 'value' | 'label' | 'custom'> {
     /** Whether the crosshair should snap to the point or follow the pointer independent of points.
      * @default true
      */
@@ -269,7 +284,7 @@ export interface AxisCrosshair extends Omit<AxisPlotLine, 'value' | 'label'> {
      */
     enabled?: boolean;
 }
-interface ChartYAxisTitle extends ChartAxisTitle {
+export interface ChartYAxisTitle extends ChartAxisTitle {
     /** Rotation of the title in degrees.
      * Currently, the available values are only for rotation in multiples of 90 degrees.
      *
@@ -297,4 +312,3 @@ export interface ChartYAxis extends ChartAxis {
     plotIndex?: number;
     title?: ChartYAxisTitle;
 }
-export {};

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

@@ -84,7 +84,7 @@ export interface BaseSeriesLegend extends ChartLegendItem {
 }
 export interface BaseTextStyle {
     fontSize: string;
-    fontWeight?: string;
+    fontWeight?: string | number;
     fontColor?: string;
 }
 export {};

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

@@ -1,7 +1,7 @@
 import type { TOOLTIP_TOTALS_BUILT_IN_AGGREGATION } from '../../constants';
 import type { MeaningfulAny } from '../misc';
 import type { AreaSeries, AreaSeriesData } from './area';
-import type { ChartXAxis, ChartYAxis } from './axis';
+import type { AxisPlotBand, AxisPlotLine, ChartXAxis, ChartYAxis } from './axis';
 import type { BarXSeries, BarXSeriesData } from './bar-x';
 import type { BarYSeries, BarYSeriesData } from './bar-y';
 import type { CustomFormat, ValueFormat } from './base';
@@ -91,6 +91,10 @@ export type TooltipDataChunk<T = MeaningfulAny> = (TooltipDataChunkBarX<T> | Too
 };
 export interface ChartTooltipRendererArgs<T = MeaningfulAny> {
     hovered: TooltipDataChunk<T>[];
+    /** Plot lines that intersect with the current pointer position. */
+    hoveredPlotLines?: AxisPlotLine[];
+    /** Plot bands that contain the current pointer position. */
+    hoveredPlotBands?: AxisPlotBand[];
     xAxis?: ChartXAxis | null;
     yAxis?: ChartYAxis;
 }

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

@@ -2,14 +2,12 @@ import type { AxisDomain, AxisScale, ScaleBand, ScaleTime } from 'd3';
 import type { ChartScale, PreparedAxis, PreparedAxisPlotBand, PreparedSplit } from '../../../hooks';
 import type { ChartAxis } from '../../../types';
 import type { AxisDirection } from '../types';
-type Ticks = number[] | string[] | Date[];
 export declare function getTicksCountByPixelInterval({ axis, axisWidth, }: {
     axis: PreparedAxis;
     axisWidth: number;
 }): number | undefined;
 export declare function isBandScale(scale?: ChartScale | AxisScale<AxisDomain>): scale is ScaleBand<string>;
 export declare function isTimeScale(scale?: ChartScale | AxisScale<AxisDomain>): scale is ScaleTime<number, number>;
-export declare function getScaleTicks(scale: ChartScale | AxisScale<AxisDomain>, ticksCount?: number): Ticks;
 export declare function getXAxisOffset(): 0 | 0.5;
 export declare function getXTickPosition({ scale, offset }: {
     scale: AxisScale<AxisDomain>;
@@ -19,7 +17,7 @@ export declare function getAxisItems({ scale, count, maxCount, }: {
     scale: ChartScale | AxisScale<AxisDomain>;
     count?: number;
     maxCount?: number;
-}): Ticks;
+}): number[] | string[] | Date[];
 export declare function getAxisHeight(args: {
     split: PreparedSplit;
     boundsHeight: number;

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

@@ -1,5 +1,6 @@
 import { ascending, descending, reverse, sort } from 'd3';
 import clamp from 'lodash/clamp';
+import { getScaleTicks } from '../ticks';
 export function getTicksCountByPixelInterval({ axis, axisWidth, }) {
     let ticksCount;
     if (axis.ticks.pixelInterval) {
@@ -16,15 +17,6 @@ export function isTimeScale(scale) {
     }
     return scale.domain()[0] instanceof Date;
 }
-export function getScaleTicks(scale, ticksCount) {
-    if ('ticks' in scale && typeof scale.ticks === 'function') {
-        return scale.ticks(ticksCount);
-    }
-    if (isBandScale(scale)) {
-        return scale.domain();
-    }
-    return [];
-}
 export function getXAxisOffset() {
     return typeof window !== 'undefined' && window.devicePixelRatio > 1 ? 0 : 0.5;
 }
@@ -42,7 +34,7 @@ export function getXTickPosition({ scale, offset }) {
     return isBandScale(scale) ? center(scale, offset) : number(scale);
 }
 export function getAxisItems({ scale, count, maxCount, }) {
-    let values = getScaleTicks(scale, count);
+    let values = getScaleTicks({ scale, ticksCount: count });
     if (maxCount && values.length > maxCount) {
         const step = Math.ceil(values.length / maxCount);
         values = values.filter((_, i) => i % step === 0);

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

@@ -1,5 +1,6 @@
 import { getMinSpaceBetween } from '../array';
 import { isSeriesWithNumericalXValues } from '../series-type-guards';
+import { getScaleTicks } from '../ticks';
 import { getTicksCountByPixelInterval, isBandScale, thinOut } from './common';
 const DEFAULT_TICKS_COUNT = 10;
 function getTicksCount(args) {
@@ -29,7 +30,7 @@ export function getXAxisTickValues({ axis, labelLineHeight, scale, series, }) {
             return [];
         }
         const scaleTicksCount = getTicksCount({ axis, axisWidth, series });
-        const scaleTicks = scale.ticks(scaleTicksCount);
+        const scaleTicks = getScaleTicks({ scale, ticksCount: scaleTicksCount });
         const originalTickValues = scaleTicks.map((t) => ({
             x: scale(t),
             value: t,
@@ -43,7 +44,7 @@ export function getXAxisTickValues({ axis, labelLineHeight, scale, series, }) {
         let ticksCount = result.length - 1;
         while (availableSpaceForLabel < labelLineHeight && result.length > 1) {
             ticksCount = ticksCount ? ticksCount - 1 : result.length - 1;
-            const newScaleTicks = scale.ticks(ticksCount);
+            const newScaleTicks = getScaleTicks({ scale, ticksCount });
             result = newScaleTicks.map((t) => ({
                 x: scale(t),
                 value: t,

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

@@ -2,7 +2,7 @@ import { dateTimeUtc } from '@gravity-ui/date-utils';
 import capitalize from 'lodash/capitalize';
 import { DEFAULT_DATE_FORMAT } from '../../constants';
 import { formatNumber, getDefaultUnit } from '../../libs';
-import { getDefaultDateFormat } from './time';
+import { DATETIME_LABEL_FORMATS, TIME_UNITS, getDefaultDateFormat, getDefaultTimeOnlyFormat, } from './time';
 const LETTER_MOUNTH_AT_START_FORMAT_REGEXP = /^M{3,}/;
 function getFormattedDate(args) {
     const { value, format = DEFAULT_DATE_FORMAT } = args;
@@ -43,7 +43,22 @@ export function formatAxisTickLabel(args) {
         }
         case 'datetime': {
             const date = value;
-            const format = axis.labels.dateFormat || getDefaultDateFormat(step);
+            let format;
+            if (axis.labels.dateFormat) {
+                format = axis.labels.dateFormat;
+            }
+            else if (step !== undefined && step < TIME_UNITS.day) {
+                const d = dateTimeUtc({ input: date });
+                const isMidnight = d.isValid() &&
+                    d.hour() === 0 &&
+                    d.minute() === 0 &&
+                    d.second() === 0 &&
+                    d.millisecond() === 0;
+                format = isMidnight ? DATETIME_LABEL_FORMATS.day : getDefaultTimeOnlyFormat(step);
+            }
+            else {
+                format = getDefaultDateFormat(step);
+            }
             return getFormattedDate({ value: date, format });
         }
         case 'linear':

package/dist/esm/utils/chart/get-hovered-plots.d.ts

@@ -0,0 +1,14 @@
+import type { PreparedXAxis, PreparedYAxis } from '../../hooks';
+import type { ChartScale } from '../../hooks/useAxisScales/types';
+import type { AxisPlotBand, AxisPlotLine } from '../../types';
+export declare function getHoveredPlots(args: {
+    pointerX: number;
+    pointerY: number;
+    xAxis?: PreparedXAxis | null;
+    yAxis: PreparedYAxis[];
+    xScale?: ChartScale;
+    yScale?: (ChartScale | undefined)[];
+}): {
+    plotLines: AxisPlotLine[];
+    plotBands: AxisPlotBand[];
+};

package/dist/esm/utils/chart/get-hovered-plots.js

@@ -0,0 +1,67 @@
+import { getBandsPosition, isBandScale } from './axis/common';
+const PLOT_LINE_HIT_THRESHOLD_PX = 4;
+function getHoveredAxisPlotBands(args) {
+    const { pointerPx, plotBands, scale, axis } = args;
+    const axisScale = scale;
+    const result = [];
+    for (const band of plotBands) {
+        const { from, to } = getBandsPosition({ band, axisScale, axis });
+        const startPx = Math.min(from, to);
+        const endPx = Math.max(from, to);
+        if (pointerPx >= startPx && pointerPx <= endPx) {
+            result.push(band);
+        }
+    }
+    return result;
+}
+function getHoveredAxisPlotLines(args) {
+    const { pointerPx, plotLines, scale } = args;
+    const result = [];
+    if (isBandScale(scale)) {
+        return result;
+    }
+    for (const line of plotLines) {
+        const linePx = Number(scale(line.value));
+        if (Math.abs(pointerPx - linePx) <= PLOT_LINE_HIT_THRESHOLD_PX + line.width / 2) {
+            result.push(line);
+        }
+    }
+    return result;
+}
+export function getHoveredPlots(args) {
+    const { pointerX, pointerY, xAxis, yAxis, xScale, yScale } = args;
+    const plotLines = [];
+    const plotBands = [];
+    if (xAxis && xScale) {
+        plotBands.push(...getHoveredAxisPlotBands({
+            pointerPx: pointerX,
+            plotBands: xAxis.plotBands,
+            scale: xScale,
+            axis: 'x',
+        }));
+        plotLines.push(...getHoveredAxisPlotLines({
+            pointerPx: pointerX,
+            plotLines: xAxis.plotLines,
+            scale: xScale,
+        }));
+    }
+    for (let i = 0; i < yAxis.length; i++) {
+        const yAxisItem = yAxis[i];
+        const yScaleItem = yScale === null || yScale === void 0 ? void 0 : yScale[i];
+        if (!yAxisItem || !yScaleItem) {
+            continue;
+        }
+        plotBands.push(...getHoveredAxisPlotBands({
+            pointerPx: pointerY,
+            plotBands: yAxisItem.plotBands,
+            scale: yScaleItem,
+            axis: 'y',
+        }));
+        plotLines.push(...getHoveredAxisPlotLines({
+            pointerPx: pointerY,
+            plotLines: yAxisItem.plotLines,
+            scale: yScaleItem,
+        }));
+    }
+    return { plotLines, plotBands };
+}

package/dist/esm/utils/chart/ticks/datetime.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Generates time ticks for the given interval.
+ *
+ * Based on d3's utcTicks algorithm (https://github.com/d3/d3-time/blob/main/src/ticks.js) with one modification:
+ * weeks are considered to start on Monday (ISO 8601 standard)
+ * instead of Sunday (d3 default).
+ */
+export declare function getDateTimeTicks(start: Date, stop: Date, count?: number): Date[];

package/dist/esm/utils/chart/ticks/datetime.js

@@ -0,0 +1,50 @@
+import { bisector, tickStep, utcDay, utcHour, utcMillisecond, utcMinute, utcMonth, utcSecond, utcMonday as utcWeek, utcYear, } from 'd3';
+import { DAY, HOUR, MINUTE, MONTH, SECOND, WEEK, YEAR } from '../../../constants';
+const tickIntervals = [
+    [utcSecond, 1, SECOND],
+    [utcSecond, 5, 5 * SECOND],
+    [utcSecond, 15, 15 * SECOND],
+    [utcSecond, 30, 30 * SECOND],
+    [utcMinute, 1, MINUTE],
+    [utcMinute, 5, 5 * MINUTE],
+    [utcMinute, 15, 15 * MINUTE],
+    [utcMinute, 30, 30 * MINUTE],
+    [utcHour, 1, HOUR],
+    [utcHour, 3, 3 * HOUR],
+    [utcHour, 6, 6 * HOUR],
+    [utcHour, 12, 12 * HOUR],
+    [utcDay, 1, DAY],
+    [utcDay, 2, 2 * DAY],
+    [utcWeek, 1, WEEK],
+    [utcMonth, 1, MONTH],
+    [utcMonth, 3, 3 * MONTH],
+    [utcYear, 1, YEAR],
+];
+function getDateTimeTickInterval(start, stop, count) {
+    const target = Math.abs(stop - start) / count;
+    const i = bisector(([, , step]) => step).right(tickIntervals, target);
+    if (i === tickIntervals.length) {
+        return utcYear.every(tickStep(start / YEAR, stop / YEAR, count));
+    }
+    if (i === 0) {
+        return utcMillisecond.every(Math.max(tickStep(start, stop, count), 1));
+    }
+    const [t, step] = tickIntervals[target / tickIntervals[i - 1][2] < tickIntervals[i][2] / target ? i - 1 : i];
+    return t.every(step);
+}
+/**
+ * Generates time ticks for the given interval.
+ *
+ * Based on d3's utcTicks algorithm (https://github.com/d3/d3-time/blob/main/src/ticks.js) with one modification:
+ * weeks are considered to start on Monday (ISO 8601 standard)
+ * instead of Sunday (d3 default).
+ */
+export function getDateTimeTicks(start, stop, count = 10) {
+    const reverse = stop < start;
+    if (reverse) {
+        [start, stop] = [stop, start];
+    }
+    const interval = getDateTimeTickInterval(start.getTime(), stop.getTime(), count);
+    const ticks = interval ? interval.range(start, new Date(Number(stop) + 1)) : [];
+    return reverse ? ticks.reverse() : ticks;
+}

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

@@ -0,0 +1,6 @@
+import type { AxisDomain, AxisScale } from 'd3';
+import type { ChartScale } from '../../../hooks';
+export declare function getScaleTicks({ scale, ticksCount, }: {
+    scale: ChartScale | AxisScale<AxisDomain>;
+    ticksCount?: number;
+}): string[] | number[] | Date[];

package/dist/esm/utils/chart/ticks/index.js

@@ -0,0 +1,17 @@
+import { getDateTimeTicks } from './datetime';
+export function getScaleTicks({ scale, ticksCount, }) {
+    const scaleDomain = scale.domain();
+    switch (typeof scaleDomain[0]) {
+        case 'number': {
+            return scale.ticks(ticksCount);
+        }
+        // datetime scale
+        case 'object': {
+            return getDateTimeTicks(scaleDomain[0], scaleDomain[scaleDomain.length - 1], ticksCount);
+        }
+        case 'string': {
+            return scaleDomain;
+        }
+    }
+    return [];
+}

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

@@ -1,3 +1,4 @@
 export declare const TIME_UNITS: Record<string, number>;
 export declare const DATETIME_LABEL_FORMATS: Record<keyof typeof TIME_UNITS, string>;
 export declare function getDefaultDateFormat(range?: number): string;
+export declare function getDefaultTimeOnlyFormat(step: number): string;

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

@@ -32,3 +32,12 @@ export function getDefaultDateFormat(range) {
     }
     return DATETIME_LABEL_FORMATS.day;
 }
+export function getDefaultTimeOnlyFormat(step) {
+    if (step < TIME_UNITS.second) {
+        return 'HH:mm:ss.SSS';
+    }
+    if (step < TIME_UNITS.minute) {
+        return 'HH:mm:ss';
+    }
+    return 'HH:mm';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/charts",
-  "version": "1.35.1",
+  "version": "1.36.0",
   "description": "A flexible JavaScript library for data visualization and chart rendering using React",
   "license": "MIT",
   "main": "dist/cjs/index.js",

package/dist/cjs/constants/date.d.ts

@@ -1 +0,0 @@
-export declare const DEFAULT_DATE_FORMAT = "DD.MM.YY";

package/dist/cjs/constants/date.js

@@ -1 +0,0 @@
-export const DEFAULT_DATE_FORMAT = 'DD.MM.YY';

package/dist/esm/constants/date.d.ts

@@ -1 +0,0 @@
-export declare const DEFAULT_DATE_FORMAT = "DD.MM.YY";

package/dist/esm/constants/date.js

@@ -1 +0,0 @@
-export const DEFAULT_DATE_FORMAT = 'DD.MM.YY';