@gravity-ui/chartkit 5.21.0 → 5.22.1

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

@@ -1,56 +0,0 @@
-import { DashStyle, LineCap, SeriesType } from '../../constants';
-import type { BaseSeries, BaseSeriesData } from './base';
-import type { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
-import type { PointMarkerOptions } from './marker';
-export type LineSeriesData<T = any> = BaseSeriesData<T> & {
-    /**
-     * The `x` value of the point. Depending on the context , it may represents:
-     * - numeric value (for `linear` x axis)
-     * - timestamp value (for `datetime` x axis)
-     * - x axis category value (for `category` x axis). If the type is a string, then it is a category value itself. If the type is a number, then it is the index of an element in the array of categories described in `xAxis.categories`
-     */
-    x?: string | number;
-    /**
-     * The `y` value of the point. Depending on the context , it may represents:
-     * - numeric value (for `linear` y axis)
-     * - timestamp value (for `datetime` y axis)
-     * - y axis category value (for `category` y axis). If the type is a string, then it is a category value itself. If the type is a number, then it is the index of an element in the array of categories described in `yAxis[0].categories`
-     */
-    y?: string | number;
-    /** Data label value of the point. If not specified, the y value is used. */
-    label?: string | number;
-    marker?: {
-        states?: {
-            normal?: {
-                enabled: boolean;
-            };
-        };
-    };
-};
-export type LineSeries<T = any> = BaseSeries & {
-    type: typeof SeriesType.Line;
-    data: LineSeriesData<T>[];
-    /** The name of the series (used in legend, tooltip etc) */
-    name: string;
-    /** The main color of the series (hex, rgba) */
-    color?: string;
-    /** Pixel width of the graph line.
-     *
-     * @default 1
-     * */
-    lineWidth?: number;
-    /** Individual series legend options. Has higher priority than legend options in widget data */
-    legend?: ChartKitWidgetLegend & {
-        symbol?: RectLegendSymbolOptions;
-    };
-    /** Options for the point markers of line series */
-    marker?: PointMarkerOptions;
-    /** Option for line stroke style */
-    dashStyle?: `${DashStyle}`;
-    /** Option for line cap style */
-    linecap?: `${LineCap}`;
-    /** Individual opacity for the line. */
-    opacity?: number;
-    /** Y-axis index (when using two axes) */
-    yAxis?: number;
-};

package/build/types/widget-data/line.js

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

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

@@ -1,12 +0,0 @@
-import { SymbolType } from '../../constants';
-export type PointMarkerOptions = {
-    /** Enable or disable the point marker */
-    enabled?: boolean;
-    /** The radius of the point marker */
-    radius?: number;
-    /** The color of the point marker's border */
-    borderColor?: string;
-    /** The width of the point marker's border */
-    borderWidth?: number;
-    symbol?: `${SymbolType}`;
-};

package/build/types/widget-data/marker.js

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

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

@@ -1,87 +0,0 @@
-import type { BaseType } from 'd3';
-import { SeriesType } from '../../constants';
-import type { BaseSeries, BaseSeriesData } from './base';
-import { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
-export type PieSeriesData<T = any> = BaseSeriesData<T> & {
-    /** The value of the pie segment. */
-    value: number;
-    /** The name of the pie segment (used in legend, tooltip etc). */
-    name: string;
-    /** Initial visibility of the pie segment. */
-    visible?: boolean;
-    /** Initial data label of the pie segment. If not specified, the value is used. */
-    label?: string;
-    /** Individual opacity for the pie segment. */
-    opacity?: number;
-};
-export type ConnectorShape = 'straight-line' | 'polyline';
-export type ConnectorCurve = 'linear' | 'basic';
-export type PieSeries<T = any> = BaseSeries & {
-    type: typeof SeriesType.Pie;
-    data: PieSeriesData<T>[];
-    /**
-     * The color of the border surrounding each segment.
-     * @default `--g-color-base-background` from @gravity-ui/uikit.
-     */
-    borderColor?: string;
-    /**
-     * The width of the border surrounding each segment.
-     * @default '1px'
-     */
-    borderWidth?: number;
-    /**
-     * The corner radius of the border surrounding each segment.
-     * @default 0
-     */
-    borderRadius?: number;
-    /** The center of the pie chart relative to the chart area. */
-    center?: [string | number | null, string | number | null];
-    /**
-     * The inner radius of the pie.
-     * @default 0
-     */
-    innerRadius?: string | number;
-    /** The radius of the pie relative to the chart area. The default behaviour is to scale to the chart area. */
-    radius?: string | number;
-    /** Individual series legend options. Has higher priority than legend options in widget data */
-    legend?: ChartKitWidgetLegend & {
-        symbol?: RectLegendSymbolOptions;
-    };
-    dataLabels?: BaseSeries['dataLabels'] & {
-        /**
-         * The distance of the data label from the pie's edge.
-         *
-         * @default 30
-         * */
-        distance?: number;
-        /**
-         * The distance from the data label to the connector.
-         *
-         * @default 5
-         * */
-        connectorPadding?: number;
-        /**
-         * The method that is used to generate the connector path.
-         *
-         * @default 'polyline'
-         * */
-        connectorShape?: ConnectorShape;
-        /**
-         * How to interpolate between two-dimensional [x, y] points for a connector.
-         * Works only if connectorShape equals to 'polyline'
-         *
-         * @default 'basic'
-         * */
-        connectorCurve?: ConnectorCurve;
-    };
-    /**
-     * Function for adding custom svg nodes for a series
-     *
-     * @return BaseType
-     * */
-    renderCustomShape?: (args: {
-        series: {
-            innerRadius: number;
-        };
-    }) => BaseType;
-};

package/build/types/widget-data/pie.js

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

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

@@ -1,45 +0,0 @@
-import { SeriesType, SymbolType } from '../../constants';
-import type { BaseSeries, BaseSeriesData } from './base';
-import type { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
-export type ScatterSeriesData<T = any> = BaseSeriesData<T> & {
-    /**
-     * The `x` value of the point. Depending on the context , it may represents:
-     * - numeric value (for `linear` x axis)
-     * - timestamp value (for `datetime` x axis)
-     * - x axis category value (for `category` x axis). If the type is a string, then it is a category value itself. If the type is a number, then it is the index of an element in the array of categories described in `xAxis.categories`
-     */
-    x?: string | number;
-    /**
-     * The `y` value of the point. Depending on the context , it may represents:
-     * - numeric value (for `linear` y axis)
-     * - timestamp value (for `datetime` y axis)
-     * - y axis category value (for `category` y axis). If the type is a string, then it is a category value itself. If the type is a number, then it is the index of an element in the array of categories described in `yAxis[0].categories`
-     */
-    y?: string | number;
-    /**
-     * Corresponding value of axis category.
-     *
-     * @deprecated use `x` or `y` instead
-     */
-    category?: string;
-    /** Individual radius for the point. */
-    radius?: number;
-    /** Individual opacity for the point. */
-    opacity?: number;
-};
-export type ScatterSeries<T = any> = BaseSeries & {
-    type: typeof SeriesType.Scatter;
-    data: ScatterSeriesData<T>[];
-    /** The name of the series (used in legend, tooltip etc) */
-    name: string;
-    /** The main color of the series (hex, rgba) */
-    color?: string;
-    /** A predefined shape or symbol for the dot */
-    symbolType?: `${SymbolType}`;
-    /** Individual series legend options. Has higher priority than legend options in widget data */
-    legend?: ChartKitWidgetLegend & {
-        symbol?: RectLegendSymbolOptions;
-    };
-    /** Y-axis index (when using two axes) */
-    yAxis?: number;
-};

package/build/types/widget-data/scatter.js

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

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

@@ -1,225 +0,0 @@
-import React from 'react';
-import { DashStyle, LineCap } from '../../constants';
-import type { AreaSeries, AreaSeriesData } from './area';
-import type { BarXSeries, BarXSeriesData } from './bar-x';
-import type { BarYSeries, BarYSeriesData } from './bar-y';
-import type { Halo } from './halo';
-import type { LineSeries, LineSeriesData } from './line';
-import type { PointMarkerOptions } from './marker';
-import type { PieSeries, PieSeriesData } from './pie';
-import type { ScatterSeries, ScatterSeriesData } from './scatter';
-import type { TreemapSeries, TreemapSeriesData } from './treemap';
-import type { WaterfallSeries, WaterfallSeriesData } from './waterfall';
-export type ChartKitWidgetSeries<T = any> = ScatterSeries<T> | PieSeries<T> | BarXSeries<T> | BarYSeries<T> | LineSeries<T> | AreaSeries<T> | TreemapSeries<T> | WaterfallSeries<T>;
-export type ChartKitWidgetSeriesData<T = any> = ScatterSeriesData<T> | PieSeriesData<T> | BarXSeriesData<T> | BarYSeriesData<T> | LineSeriesData<T> | AreaSeriesData<T> | TreemapSeriesData<T> | WaterfallSeriesData<T>;
-export type DataLabelRendererData<T = any> = {
-    data: ChartKitWidgetSeriesData<T>;
-};
-type BasicHoverState = {
-    /**
-     * Enable separate styles for the hovered series.
-     *
-     * @default true
-     * */
-    enabled?: boolean;
-    /**
-     * How much to brighten/darken the point on hover. Use positive to brighten, negative to darken.
-     * The behavior of this property is dependent on the implementing color space ([more details](https://d3js.org/d3-color#color_brighter)).
-     * For example in case of using rgb color you can use floating point number from `-5.0` to `5.0`.
-     * Rgb color space is used by default.
-     *
-     * @default 0.3
-     */
-    brightness?: number;
-};
-export type BasicInactiveState = {
-    /**
-     * Enable separate styles for the inactive series.
-     *
-     * @default true
-     * */
-    enabled?: boolean;
-    /**
-     * Opacity of series elements (bars, data labels)
-     *
-     * @default 0.5
-     * */
-    opacity?: number;
-};
-export type ChartKitWidgetSeriesOptions = {
-    /** Individual data label for each point. */
-    dataLabels?: {
-        /** Enable or disable the data labels */
-        enabled?: boolean;
-        /** 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';
-        };
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState;
-            inactive?: BasicInactiveState;
-        };
-    };
-    'bar-y'?: {
-        /** 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 "x"
-             *
-             * @default undefined
-             * */
-            key?: 'name' | 'x' | undefined;
-            /** Sorting direction.
-             *
-             * @default 'asc'
-             * */
-            direction?: 'asc' | 'desc';
-        };
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState;
-            inactive?: BasicInactiveState;
-        };
-    };
-    pie?: {
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState & {
-                /** Options for the halo appearing outside the hovered slice */
-                halo?: Halo;
-            };
-            inactive?: BasicInactiveState;
-        };
-    };
-    scatter?: {
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState & {
-                marker?: PointMarkerOptions & {
-                    /** Options for the halo appearing around the hovered point */
-                    halo?: Halo;
-                };
-            };
-            inactive?: BasicInactiveState;
-        };
-    };
-    line?: {
-        /** Pixel width of the graph line.
-         *
-         * @default 1
-         * */
-        lineWidth?: number;
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState & {
-                marker?: PointMarkerOptions & {
-                    /** Options for the halo appearing around the hovered point */
-                    halo?: Halo;
-                };
-            };
-            inactive?: BasicInactiveState;
-        };
-        /** Options for the point markers of line series */
-        marker?: PointMarkerOptions;
-        /** Options for line style
-         *
-         * @default 'Solid'
-         * */
-        dashStyle?: `${DashStyle}`;
-        /** Options for line cap style
-         *
-         * @default 'round' when dashStyle is not 'solid', 'none' when dashStyle is not 'solid'
-         * */
-        linecap?: `${LineCap}`;
-    };
-    area?: {
-        /** Pixel width of the graph line.
-         *
-         * @default 1
-         * */
-        lineWidth?: number;
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState & {
-                marker?: PointMarkerOptions & {
-                    /** Options for the halo appearing around the hovered point */
-                    halo?: Halo;
-                };
-            };
-            inactive?: BasicInactiveState;
-        };
-        /** Options for the point markers of line series */
-        marker?: PointMarkerOptions;
-    };
-    treemap?: {
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState;
-            inactive?: BasicInactiveState;
-        };
-    };
-    waterfall?: {
-        /** 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;
-        /** Options for the series states that provide additional styling information to the series. */
-        states?: {
-            hover?: BasicHoverState;
-            inactive?: BasicInactiveState;
-        };
-    };
-};
-export {};

package/build/types/widget-data/series.js

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

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

@@ -1,13 +0,0 @@
-import type { BaseTextStyle } from './base';
-export type SplitPlotOptions = {
-    title?: {
-        text: string;
-        style?: Partial<BaseTextStyle>;
-    };
-};
-export type ChartKitWidgetSplit = {
-    enable: boolean;
-    layout?: 'vertical';
-    gap?: string | number;
-    plots?: SplitPlotOptions[];
-};

package/build/types/widget-data/split.js

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

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

@@ -1,5 +0,0 @@
-import type { BaseTextStyle } from './base';
-export type ChartKitWidgetTitle = {
-    text: string;
-    style?: Partial<BaseTextStyle>;
-};

package/build/types/widget-data/title.js

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

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

@@ -1,67 +0,0 @@
-/// <reference types="react" />
-import type { AreaSeries, AreaSeriesData } from './area';
-import type { BarXSeries, BarXSeriesData } from './bar-x';
-import type { BarYSeries, BarYSeriesData } from './bar-y';
-import type { LineSeries, LineSeriesData } from './line';
-import type { PieSeries, PieSeriesData } from './pie';
-import type { ScatterSeries, ScatterSeriesData } from './scatter';
-import type { TreemapSeries, TreemapSeriesData } from './treemap';
-import type { WaterfallSeries, WaterfallSeriesData } from './waterfall';
-export type TooltipDataChunkBarX<T = any> = {
-    data: BarXSeriesData<T>;
-    series: BarXSeries<T>;
-};
-export type TooltipDataChunkBarY<T = any> = {
-    data: BarYSeriesData<T>;
-    series: BarYSeries<T>;
-};
-export type TooltipDataChunkPie<T = any> = {
-    data: PieSeriesData<T>;
-    series: {
-        type: PieSeries['type'];
-        id: string;
-        name: string;
-    };
-};
-export type TooltipDataChunkScatter<T = any> = {
-    data: ScatterSeriesData<T>;
-    series: {
-        type: ScatterSeries['type'];
-        id: string;
-        name: string;
-    };
-};
-export type TooltipDataChunkLine<T = any> = {
-    data: LineSeriesData<T>;
-    series: {
-        type: LineSeries['type'];
-        id: string;
-        name: string;
-    };
-};
-export type TooltipDataChunkArea<T = any> = {
-    data: AreaSeriesData<T>;
-    series: {
-        type: AreaSeries['type'];
-        id: string;
-        name: string;
-    };
-};
-export type TooltipDataChunkTreemap<T = any> = {
-    data: TreemapSeriesData<T>;
-    series: TreemapSeries<T>;
-};
-export type TooltipDataChunkWaterfall<T = any> = {
-    data: WaterfallSeriesData<T>;
-    series: WaterfallSeries<T>;
-};
-export type TooltipDataChunk<T = any> = (TooltipDataChunkBarX<T> | TooltipDataChunkBarY<T> | TooltipDataChunkPie<T> | TooltipDataChunkScatter<T> | TooltipDataChunkLine<T> | TooltipDataChunkArea<T> | TooltipDataChunkTreemap<T> | TooltipDataChunkWaterfall<T>) & {
-    closest?: boolean;
-};
-export type ChartKitWidgetTooltip<T = any> = {
-    enabled?: boolean;
-    /** Specifies the renderer for the tooltip. If returned null default tooltip renderer will be used. */
-    renderer?: (args: {
-        hovered: TooltipDataChunk<T>[];
-    }) => React.ReactElement | null;
-};

package/build/types/widget-data/tooltip.js

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

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

@@ -1,45 +0,0 @@
-import { LayoutAlgorithm, SeriesType } from '../../constants';
-import type { BaseSeries, BaseSeriesData } from './base';
-import { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
-export type TreemapSeriesData<T = any> = BaseSeriesData<T> & {
-    /** The name of the node (used in legend, tooltip etc). */
-    name: string | string[];
-    /** The value of the node. All nodes should have this property except nodes that have children. */
-    value?: number;
-    /** An id for the node. Used to group children. */
-    id?: string;
-    /**
-     * Parent id. Used to build a tree structure. The value should be the id of the node which is the parent.
-     * If no nodes has a matching id, or this option is undefined, then the parent will be set to the root.
-     */
-    parentId?: string;
-};
-export type TreemapSeries<T = any> = BaseSeries & {
-    type: typeof SeriesType.Treemap;
-    data: TreemapSeriesData<T>[];
-    /** The name of the series (used in legend, tooltip etc). */
-    name: string;
-    /** The main color of the series (hex, rgba). */
-    color?: string;
-    /** Individual series legend options. Has higher priority than legend options in widget data. */
-    legend?: ChartKitWidgetLegend & {
-        symbol?: RectLegendSymbolOptions;
-    };
-    /** Set options on specific levels. Takes precedence over series options, but not point options. */
-    levels?: {
-        /** Decides which level takes effect from the options set in the levels object. */
-        index: number;
-        /** Can set the padding between all points which lies on the same level. */
-        padding?: number;
-        /** Can set a color on all points which lies on the same level. */
-        color?: string;
-    }[];
-    layoutAlgorithm?: `${LayoutAlgorithm}`;
-    /**
-     * Options for the series data labels, appearing next to each data point.
-     * */
-    dataLabels?: BaseSeries['dataLabels'] & {
-        /** Horizontal alignment of the data label inside the tile. */
-        align?: 'left' | 'center' | 'right';
-    };
-};

package/build/types/widget-data/treemap.js

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

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

@@ -1,39 +0,0 @@
-import { SeriesType } from '../../constants';
-import type { BaseSeries, BaseSeriesData } from './base';
-import { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
-export type WaterfallSeriesData<T = any> = BaseSeriesData<T> & {
-    /**
-     * The `x` value. Depending on the context , it may represents:
-     * - numeric value (for `linear` x axis)
-     * - timestamp value (for `datetime` x axis)
-     * - x axis category value (for `category` x axis). If the type is a string, then it is a category value itself. If the type is a number, then it is the index of an element in the array of categories described in `xAxis.categories`
-     */
-    x?: string | number;
-    /**
-     * The `y` value. Depending on the context , it may represents:
-     * - numeric value (for `linear` y axis)
-     */
-    y?: number;
-    /** Data label value of the point. If not specified, the y value is used. */
-    label?: string | number;
-    /** Individual opacity for the point. */
-    opacity?: number;
-    /** When this property is true, the point display the total sum across the entire series. */
-    total?: boolean;
-};
-export type WaterfallSeries<T = any> = BaseSeries & {
-    type: typeof SeriesType.Waterfall;
-    data: WaterfallSeriesData<T>[];
-    /** The name of the series (used in legend, tooltip etc). */
-    name: string;
-    /** The main color of the series (hex, rgba). */
-    color?: string;
-    /** The color used for positive values. If it is not specified, the general color of the series is used. */
-    positiveColor?: string;
-    /** The color used for negative values. If it is not specified, the general color of the series is used. */
-    negativeColor?: string;
-    /** Individual series legend options. Has higher priority than legend options in widget data. */
-    legend?: ChartKitWidgetLegend & {
-        symbol?: RectLegendSymbolOptions;
-    };
-};

package/build/types/widget-data/waterfall.js

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