@oliasoft-open-source/charts-library 3.6.1 → 3.6.2

package/dist/src/components/bar-chart/get-bar-chart-data-labels.d.ts

@@ -1,7 +1,6 @@
-import { Options } from 'chartjs-plugin-datalabels';
 import { IBarOptions } from './bar-chart.interface';
 type ExtendedDisplayOptions = 'auto' | boolean;
-interface IExtendedDataLabelsOptions extends Options {
+interface IExtendedDataLabelsOptions {
     display: ExtendedDisplayOptions;
 }
 /**

package/dist/src/components/bar-chart/get-bar-chart-scales.d.ts

@@ -1,6 +1,5 @@
-import { Chart } from 'chart.js';
 /**
  * @param {IBarChartData} chart - chart data
  */
-declare const getBarChartScales: (chart: Chart) => any;
+declare const getBarChartScales: (chart: any) => any;
 export default getBarChartScales;

package/dist/src/components/common/common.interface.d.ts

@@ -1,5 +1,6 @@
 import { ChartEvent, ChartTypeRegistry, LinearScaleOptions, Plugin } from 'chart.js';
 import { AlignOptions, Position } from './helpers/enums';
+export type TAxisPosition = 'top' | 'bottom' | 'left' | 'right';
 export interface ICommonDataValue {
     x: number;
     y: number;
@@ -124,7 +125,7 @@ export interface ICommonHoveredItems {
 }
 export interface ICommonChartPlugins {
     legend: {
-        position: 'top' | 'right' | 'bottom' | 'left';
+        position: TAxisPosition;
     };
     title: {
         display: boolean;

package/dist/src/components/common/helpers/chart-border-plugin.d.ts

@@ -1,8 +1,8 @@
-import { Chart, ChartConfiguration, Plugin } from 'chart.js';
+import { Plugin } from 'chart.js';
 /**
  * Chart border plugin config
  */
 export declare const chartAreaBorderPlugin: {
     id: string;
-    beforeDraw(chart: Chart, _args: Plugin, options: ChartConfiguration): void;
+    beforeDraw(chart: any, _args: Plugin, options: any): void;
 };

package/dist/src/components/common/helpers/chart-utils.d.ts

@@ -0,0 +1,91 @@
+import { ChartTypeRegistry, Plugin } from 'chart.js';
+import { ICommonAnnotationsData, ICommonCustomLegend } from '../common.interface';
+import { Position } from './enums';
+interface IChartGraph {
+    showMinorGridlines: boolean;
+}
+interface IOptions {
+    title?: string | string[];
+    legend?: {
+        position: Position;
+        display?: boolean;
+        align?: string;
+        usePointStyle?: boolean;
+    };
+}
+interface IStyling {
+    width?: string | number;
+    height?: string | number;
+    squareAspectRatio?: number | boolean;
+    maintainAspectRatio?: boolean;
+    staticChartHeight?: boolean;
+    performanceMode?: boolean;
+}
+interface IAxis {
+    label: string;
+}
+interface ILegend {
+    customLegend?: ICommonCustomLegend<any>;
+}
+/**
+ * @param { graph } graph - graph data from chart options
+ * @param { legend } legend
+ * @return {[]}
+ */
+export declare const getPlugins: <T extends keyof ChartTypeRegistry>(graph: IChartGraph, legend: ILegend) => any;
+/**
+ * @param {string[]} colors - color schema
+ * @return {string} - random color
+ */
+export declare const generateRandomColor: (colors: string[]) => string[];
+/**
+ * @param {annotationsData[]} annotationsData
+ * @return {number[]|*[]}
+ */
+export declare const setAnnotations: (annotationsData: ICommonAnnotationsData[]) => number[];
+/**
+ * @param {ICommonChartOptions} options - chart options object
+ * @return {{color: (string|undefined), display: boolean, text}|{}}
+ */
+export declare const getTitle: (options: IOptions) => {
+    display: boolean;
+    text: string | string[] | undefined;
+} | {
+    display?: undefined;
+    text?: undefined;
+};
+/**
+ * @function isVertical
+ * @param {'vertical'|'horizontal'|string} direction
+ * @return {boolean} returns true if chart direction is vertical
+ */
+export declare const isVertical: (direction: string) => boolean;
+/**
+ * @param {'x'|'y'} axisType
+ * @param {number} i - index
+ * @return {'top'|'bottom'|'left'|'right'|*}
+ */
+export declare const getAxisPosition: (axisType: string, i: number) => Position;
+/**
+ * @param {chartStyling} chartStyling
+ * @param {Object} styles - styles imported form .less file
+ * @return {string} - class name
+ */
+export declare const getClassName: (chartStyling: IStyling, styles: Record<string, string>) => string;
+export declare const getLegend: (options: IOptions, clickHandler: (_e: any, legendItem: any) => void) => {
+    position: Position;
+    display: boolean | undefined;
+    align: string | undefined;
+    labels: {
+        boxHeight: number;
+        boxWidth: number | undefined;
+        usePointStyle: boolean | undefined;
+    };
+    onClick: (_e: any, legendItem: any) => void;
+};
+export declare const afterLabelCallback: (tooltipItem: Record<string, any>) => string;
+export declare const getTooltipLabel: (tooltipItem: Record<string, any>, showLabelsInTooltips: boolean) => string;
+export declare const getChartFileName: (axes: IAxis[]) => string;
+export declare const setDefaultTheme: () => void;
+export declare const isNilOrEmpty: (value: any) => boolean;
+export {};

package/dist/src/components/common/helpers/get-custom-legend-plugin-example.d.ts

@@ -1,4 +1,4 @@
-import { Chart, Plugin, ChartConfiguration } from 'chart.js';
+import { Chart, ChartConfiguration, Plugin } from 'chart.js';
 /**
  * Gets an example custom legend plugin for use in storybook.
  * @param {string} customLegendContainerID - the id of the div container to put the generated legend in

package/dist/src/components/line-chart/controls/axes-options/axes-options-interfaces.d.ts

@@ -15,7 +15,7 @@ export interface IAxesOptions {
     controlsAxesLabels: IAxisControlLabel[];
     onUpdateAxes: (axes: IAxisState) => void;
     onResetAxes: () => void;
-    depthType: IDepthType;
+    depthType?: IDepthType | object;
     close?: () => void;
 }
 export interface IOnEdit {
@@ -27,7 +27,7 @@ export interface IAxisFormState {
     id: string;
     min: number | string;
     max: number | string;
-    unit: string | IUnitOptions;
+    unit?: string | IUnitOptions;
 }
 export type IInitializeAxisFormState = IAxisFormState[];
 export interface IError {

package/dist/src/components/line-chart/controls/controls-interfaces.d.ts

@@ -1,9 +1,9 @@
-import { Dispatch, RefObject } from 'react';
+import { Dispatch, ReactNode, RefObject } from 'react';
 import { Chart } from 'chart.js';
 import { ILineChartDataset, ILineChartOptions } from '../line-chart.interface';
 import { IState } from '../state/state.interfaces';
 export interface IControls {
-    headerComponent?: Element;
+    headerComponent?: ReactNode;
     subheaderComponent?: Element;
     table?: Element;
     chartRef: RefObject<Chart>;

package/dist/src/components/line-chart/controls/drag-options-interfaces.d.ts

@@ -4,7 +4,7 @@ export interface IDragOptions {
     panEnabled: boolean;
     zoomEnabled: boolean;
     enableDragPoints: boolean;
-    isDragDataAllowed: boolean;
+    isDragDataAllowed?: boolean;
     onToggleDragPoints: () => void;
     onDisableDragOptions: () => void;
     translations: Record<string, string>;

package/dist/src/components/line-chart/hooks/use-chart-functions.d.ts

@@ -2,7 +2,7 @@ import { Dispatch, RefObject } from 'react';
 import { Chart, ChartEvent } from 'chart.js';
 import { ICommonHoveredItems } from '../../common/common.interface';
 import { ILineChartDataset, ILineChartOptions } from '../line-chart.interface';
-import { IState } from '../state/state.interfaces';
+import { InitialState, IState } from '../state/state.interfaces';
 interface IUseChartFunctions {
     chartRef: RefObject<Chart>;
     state: IState;
@@ -40,8 +40,6 @@ export declare const useChartFunctions: ({ chartRef, state, options, dispatch, g
     }[];
     updateAxesRangesFromChart: () => void;
     onResetAxes: () => void;
-    onUpdateAxes: ({ axes }: {
-        axes: any;
-    }) => void;
+    onUpdateAxes: ({ axes }: InitialState) => void;
 };
 export {};

package/dist/src/components/line-chart/hooks/use-chart-plugins.d.ts

@@ -0,0 +1,7 @@
+import { ILineChartOptions } from '../line-chart.interface';
+interface IUseChartPlugins {
+    options: ILineChartOptions;
+    resetZoom: () => void;
+}
+export declare const useChartPlugins: ({ options, resetZoom }: IUseChartPlugins) => any[];
+export {};

package/dist/src/components/line-chart/legend/legend-interface.d.ts

@@ -31,7 +31,7 @@ export interface ILegend {
     options: ILineChartOptions;
     dispatch: Dispatch<any>;
     generatedDatasets: ILineChartDataset[];
-    translations: Record<string, string>;
+    translations?: Record<string, string>;
 }
 export interface ILegendPanel extends ILegend {
     legendPosition: Position;

package/dist/src/components/line-chart/line-chart-get-default-props.d.ts

@@ -1,99 +1,2 @@
-import { ILineChartProps } from './line-chart.interface';
-import { AlignOptions, Position } from '../common/helpers/enums';
-export declare const getDefaultProps: (props: ILineChartProps) => {
-    persistenceId: string;
-    controlsPortalId: string;
-    testId: string | null;
-    data: {
-        datasets: import("./line-chart.interface").ILineChartDataset[];
-    } | undefined;
-    options: {
-        title: string | string[];
-        scales: import("../common/common.interface").ICommonScales;
-        axes: {
-            x: import("./line-chart.interface").ILineChartAxis<"bottom" | "top">[] | {}[];
-            y: import("./line-chart.interface").ILineChartAxis<"left" | "right">[] | {}[];
-        };
-        additionalAxesOptions: {
-            chartScaleType: "linear" | "logarithmic";
-            reverse: boolean;
-            beginAtZero: boolean;
-            stepSize: number | undefined;
-            suggestedMin: number | undefined;
-            suggestedMax: number | undefined;
-            range: import("./line-chart.interface").ILineRange | undefined;
-            autoAxisPadding: boolean;
-        };
-        chartStyling: {
-            width: string | number | undefined;
-            height: string | number | undefined;
-            maintainAspectRatio: boolean;
-            staticChartHeight: boolean;
-            performanceMode: boolean;
-            squareAspectRatio: number | boolean;
-            layoutPadding: string | number | {
-                top: number;
-                bottom: number;
-                left: number;
-                right: number;
-            };
-        };
-        tooltip: {
-            tooltips: boolean;
-            showLabelsInTooltips: boolean;
-            hideSimulationName: boolean;
-        };
-        graph: {
-            lineTension: number;
-            spanGaps: boolean;
-            showDataLabels: boolean;
-            showMinorGridlines: boolean;
-        };
-        annotations: {
-            labelAnnotation: {
-                showLabel: boolean;
-                text: string | string[];
-                position: string;
-                fontSize: number;
-                xOffset: number;
-                yOffset: number;
-                maxWidth: number;
-                lineHeight: number;
-            };
-            showAnnotations: boolean;
-            controlAnnotation: boolean;
-            annotationsData: import("../common/common.interface").ICommonAnnotationsData[];
-        };
-        legend: {
-            display: boolean;
-            position: Position;
-            align: AlignOptions;
-            customLegend: import("../common/common.interface").ICommonCustomLegend<any>;
-            usePointStyle: boolean;
-        };
-        chartOptions: {
-            showPoints: boolean;
-            enableZoom: boolean;
-            enablePan: boolean;
-            showLine: boolean;
-            closeOnOutsideClick: boolean;
-        };
-        interactions: {
-            onLegendClick: ((text: string, hidden: boolean) => void) | undefined;
-            onHover: ((event?: import("chart.js").ChartEvent | undefined, datasetIndex?: number | undefined, index?: number | undefined, generatedDataset?: any[] | undefined) => void) | undefined;
-            onUnhover: ((event?: import("chart.js").ChartEvent | undefined, datasetIndex?: number | undefined, index?: number | undefined, generatedDataset?: any[] | undefined) => void) | undefined;
-            onAnimationComplete: (() => void) | undefined;
-        };
-        dragData: {
-            enableDragData: boolean;
-            showTooltip: boolean;
-            roundPoints: boolean;
-            dragX: boolean;
-            dragY: boolean;
-            onDragStart: (() => void) | undefined;
-            onDrag: (() => void) | undefined;
-            onDragEnd: (() => void) | undefined;
-        };
-        depthType: import("./line-chart.interface").IDepthType;
-    };
-};
+import { ILineChartData, ILineChartProps } from './line-chart.interface';
+export declare const getDefaultProps: (props: ILineChartProps) => ILineChartData;

package/dist/src/components/line-chart/line-chart.interface.d.ts

@@ -39,7 +39,7 @@ export interface ILineChartAxis<PositionType> {
     label: string;
     position: PositionType;
     color: string | string[];
-    unit: IUnitOptions;
+    unit?: IUnitOptions;
 }
 export interface ILineChartAxes {
     x: ILineChartAxis<'top' | 'bottom'>[];
@@ -52,7 +52,7 @@ export interface IDepthType {
     setSelectedUnit: () => void;
 }
 export interface ILineChartStyling extends ICommonStyling {
-    squareAspectRatio?: number;
+    squareAspectRatio?: number | boolean;
     layoutPadding?: string | number | {
         top: number;
         bottom: number;
@@ -80,7 +80,7 @@ export interface ILineChartOptions extends ICommonOptions {
     chartOptions: ILChartOptions;
     interactions: ILineInteractions;
     dragData?: ICommonDragData;
-    depthType: IDepthType;
+    depthType?: IDepthType | object;
 }
 export interface ILineChartDataset extends ICommonDataset {
     lineTension?: number;

package/dist/src/components/line-chart/state/initial-state.d.ts

@@ -1,14 +1,7 @@
-import { ILChartOptions, ILineChartAdditionalAxesOptions, ILineChartAxes, ILineLegend } from '../line-chart.interface';
-import { ICommonAnnotations, ICommonDragData } from '../../common/common.interface';
+import { IState } from './state.interfaces';
+import { ILineChartOptions } from '../line-chart.interface';
 interface inputInitState {
-    options: {
-        additionalAxesOptions: ILineChartAdditionalAxesOptions;
-        annotations: ICommonAnnotations;
-        axes: ILineChartAxes;
-        chartOptions: ILChartOptions;
-        legend: ILineLegend;
-        dragData: ICommonDragData;
-    };
+    options: ILineChartOptions;
     persistenceId?: string;
 }
 /**
@@ -17,20 +10,5 @@ interface inputInitState {
  @param {Object} options - The chart options.
  @return {Object} The initial chart state.
  */
-declare const initialState: ({ options, persistenceId }: inputInitState) => {
-    zoomEnabled: any;
-    panEnabled: any;
-    pointsEnabled: any;
-    lineEnabled: any;
-    legendEnabled: any;
-    axes: {
-        unit?: import("../line-chart.interface").IUnitOptions | undefined;
-        max?: number | undefined;
-        min?: number | undefined;
-        id: string;
-    }[];
-    showAnnotationLineIndex: number[];
-    showTable: boolean;
-    enableDragPoints: any;
-};
+declare const initialState: ({ options, persistenceId }: inputInitState) => IState;
 export default initialState;

package/dist/src/components/line-chart/utils/axis-formatting/axis-formatting.d.ts

@@ -1 +1 @@
-export declare const formatAxisLabelNumbers: (tickValue: number, ticks: Array<any>, locale?: string) => string;
+export declare const formatAxisLabelNumbers: (tickValue: number, ticks: Array<any>) => string;

package/dist/src/components/line-chart/utils/get-generated-labels.d.ts

@@ -0,0 +1 @@
+export declare const getGeneratedLabels: (chart: any) => any;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oliasoft-open-source/charts-library",
-  "version": "3.6.1",
+  "version": "3.6.2",
   "description": "React Chart Library (based on Chart.js and react-chart-js-2)",
   "homepage": "https://gitlab.com/oliasoft-open-source/charts-library",
   "resolutions": {
@@ -56,7 +56,7 @@
     "react-use": "^17.4.0"
   },
   "devDependencies": {
-    "@oliasoft-open-source/react-ui-library": "^3.6.5",
+    "@oliasoft-open-source/react-ui-library": "^3.11.9",
     "@oliasoft-open-source/units": "^3.4.2",
     "@storybook/addon-actions": "^7.0.18",
     "@storybook/addon-docs": "^7.0.18",
@@ -64,6 +64,7 @@
     "@storybook/react": "^7.0.18",
     "@storybook/react-vite": "^7.0.18",
     "@storybook/testing-library": "^0.2.2",
+    "@types/jest": "^29.5.6",
     "@types/react": "^18.2.24",
     "@typescript-eslint/parser": "^6.7.4",
     "@vitejs/plugin-react-swc": "^3.3.2",