@gravity-ui/chartkit 4.14.0 → 4.15.0

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

@@ -1,6 +1,7 @@
 import type { BaseSeries, BaseSeriesData } from './base';
 import type { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
 import type { PointMarkerOptions } from './marker';
+import { DashStyle, LineCap, SeriesType } from '../../constants';
 export type LineSeriesData<T = any> = BaseSeriesData<T> & {
     /**
      * The `x` value of the point. Depending on the context , it may represents:
@@ -24,7 +25,7 @@ export type LineMarkerOptions = PointMarkerOptions & {
     symbol?: LineMarkerSymbol;
 };
 export type LineSeries<T = any> = BaseSeries & {
-    type: 'line';
+    type: typeof SeriesType.Line;
     data: LineSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
     name: string;
@@ -41,4 +42,8 @@ export type LineSeries<T = any> = BaseSeries & {
     };
     /** Options for the point markers of line series */
     marker?: LineMarkerOptions;
+    /** Option for line stroke style */
+    dashStyle?: `${DashStyle}`;
+    /** Option for line cap style */
+    linecap?: `${LineCap}`;
 };

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

@@ -8,11 +8,3 @@ export type PointMarkerOptions = {
     /** The width of the point marker's border */
     borderWidth?: number;
 };
-export type PointMarkerHalo = {
-    /** Enable or disable the halo appearing around the point */
-    enabled?: boolean;
-    /** The Opacity of the point halo */
-    opacity?: number;
-    /** The radius of the point halo */
-    radius?: number;
-};

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

@@ -1,3 +1,4 @@
+import { SeriesType } from '../../constants';
 import type { BaseSeries, BaseSeriesData } from './base';
 import { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
 export type PieSeriesData<T = any> = BaseSeriesData<T> & {
@@ -13,7 +14,7 @@ export type PieSeriesData<T = any> = BaseSeriesData<T> & {
 export type ConnectorShape = 'straight-line' | 'polyline';
 export type ConnectorCurve = 'linear' | 'basic';
 export type PieSeries<T = any> = BaseSeries & {
-    type: 'pie';
+    type: typeof SeriesType.Pie;
     data: PieSeriesData<T>[];
     /**
      * The color of the border surrounding each segment.

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

@@ -1,3 +1,4 @@
+import { SeriesType } from '../../constants';
 import type { BaseSeries, BaseSeriesData } from './base';
 import type { ChartKitWidgetLegend, RectLegendSymbolOptions } from './legend';
 export type ScatterSeriesData<T = any> = BaseSeriesData<T> & {
@@ -24,7 +25,7 @@ export type ScatterSeriesData<T = any> = BaseSeriesData<T> & {
     radius?: number;
 };
 export type ScatterSeries<T = any> = BaseSeries & {
-    type: 'scatter';
+    type: typeof SeriesType.Scatter;
     data: ScatterSeriesData<T>[];
     /** The name of the series (used in legend, tooltip etc) */
     name: string;

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

@@ -4,8 +4,10 @@ import type { ScatterSeries, ScatterSeriesData } from './scatter';
 import type { BarXSeries, BarXSeriesData } from './bar-x';
 import type { LineSeries, LineSeriesData, LineMarkerOptions } from './line';
 import type { BarYSeries, BarYSeriesData } from './bar-y';
-import type { PointMarkerOptions, PointMarkerHalo } from './marker';
+import type { PointMarkerOptions } from './marker';
 import type { AreaSeries, AreaSeriesData } from './area';
+import type { Halo } from './halo';
+import { DashStyle, LineCap } from '../../constants';
 export type ChartKitWidgetSeries<T = any> = ScatterSeries<T> | PieSeries<T> | BarXSeries<T> | BarYSeries<T> | LineSeries<T> | AreaSeries<T>;
 export type ChartKitWidgetSeriesData<T = any> = ScatterSeriesData<T> | PieSeriesData<T> | BarXSeriesData<T> | BarYSeriesData<T> | LineSeriesData<T> | AreaSeriesData<T>;
 export type DataLabelRendererData<T = any> = {
@@ -125,7 +127,10 @@ export type ChartKitWidgetSeriesOptions = {
     pie?: {
         /** Options for the series states that provide additional styling information to the series. */
         states?: {
-            hover?: BasicHoverState;
+            hover?: BasicHoverState & {
+                /** Options for the halo appearing outside the hovered slice */
+                halo?: Halo;
+            };
             inactive?: BasicInactiveState;
         };
     };
@@ -147,13 +152,23 @@ export type ChartKitWidgetSeriesOptions = {
             hover?: BasicHoverState & {
                 marker?: PointMarkerOptions & {
                     /** Options for the halo appearing around the hovered point */
-                    halo?: PointMarkerHalo;
+                    halo?: Halo;
                 };
             };
             inactive?: BasicInactiveState;
         };
         /** Options for the point markers of line series */
         marker?: LineMarkerOptions;
+        /** 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.
@@ -166,7 +181,7 @@ export type ChartKitWidgetSeriesOptions = {
             hover?: BasicHoverState & {
                 marker?: PointMarkerOptions & {
                     /** Options for the halo appearing around the hovered point */
-                    halo?: PointMarkerHalo;
+                    halo?: Halo;
                 };
             };
             inactive?: BasicInactiveState;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gravity-ui/chartkit",
-  "version": "4.14.0",
+  "version": "4.15.0",
   "description": "React component used to render charts based on any sources you need",
   "license": "MIT",
   "repository": "git@github.com:gravity-ui/ChartKit.git",
@@ -120,6 +120,11 @@
     "lint:prettier": "prettier --check --loglevel=error '**/*.{js,jsx,ts,tsx,scss}'",
     "lint": "run-p lint:*",
     "typecheck": "tsc --noEmit",
+    "docs:deps": "cd ./documentation && npm ci",
+    "docs:start": "cd ./documentation && npm run start",
+    "docs:start:ru": "cd ./documentation && npm run start:ru",
+    "docs:build": "cd ./documentation && npm run build",
+    "docs:serve": "cd ./documentation && npm run serve",
     "prepublishOnly": "npm run build"
   },
   "husky": {