@oliasoft-open-source/charts-library 3.4.5 → 3.4.7-beta-1

package/dist/src/components/line-chart/utils/get-axes-ranges-from-chart.d.ts

@@ -1,6 +1,13 @@
-export declare const getAxesRangesFromChart: (chartRef: any, axes: any) => {
-    unit?: any;
+import { Chart } from 'chart.js';
+import { RefObject } from 'react';
+import { IInitAxisRange } from '../state/state.interfaces';
+interface IAxes {
+    [key: string]: IInitAxisRange[];
+}
+export declare const getAxesRangesFromChart: (chartRef: RefObject<Chart>, axes: IAxes) => {
+    unit?: string | undefined;
     id: any;
     min: any;
     max: any;
 }[];
+export {};

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

@@ -1,3 +1,4 @@
+import { TooltipItem } from 'chart.js';
 import { ILineChartOptions } from '../line-chart.interface';
 /**
  * adjusts the position of the label depends on chart area
@@ -7,8 +8,8 @@ import { ILineChartOptions } from '../line-chart.interface';
  */
 declare const getLineChartDataLabels: (options: ILineChartOptions) => {
     display: string;
-    align: (context: any) => import("../../../helpers/enums").AlignOptions.End | import("../../../helpers/enums").AlignOptions.Start | import("../../../helpers/enums").AlignOptions.Right | import("../../../helpers/enums").AlignOptions.Left;
-    formatter: (_value: any, context: any) => any;
+    align: (context: any) => import("../../common/helpers/enums").AlignOptions.End | import("../../common/helpers/enums").AlignOptions.Start | import("../../common/helpers/enums").AlignOptions.Right | import("../../common/helpers/enums").AlignOptions.Left;
+    formatter: (_value: any, context: TooltipItem<any>) => any;
 } | {
     display: boolean;
     align?: undefined;

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

@@ -1,9 +1,9 @@
+import { IState } from '../state/state.interfaces';
 import { ILineChartOptions } from '../line-chart.interface';
-import { IInitialState } from '../../../helpers/chart-interface';
 /**
  *
- * @param {import('../line-chart.interface').ILineChartOptions} options - line chart options object
- * @param {import('../../../helpers/chart-interface').IInitialState} state - chart state object controlled by useReducer or similar
+ * @param {ILineChartOptions} options - line chart options object
+ * @param {IState} state - chart state object controlled by useReducer or similar
  */
-declare const getLineChartScales: (options: ILineChartOptions, state: IInitialState) => any;
+declare const getLineChartScales: (options: ILineChartOptions, state: IState) => any;
 export default getLineChartScales;

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

@@ -1,4 +1,4 @@
-import { ChartHoverMode } from '../../../helpers/enums';
+import { ChartHoverMode } from '../../common/helpers/enums';
 import { ILineChartOptions } from '../line-chart.interface';
 export declare const getUnitsFromLabel: (label: string) => string;
 /**
@@ -16,7 +16,7 @@ declare const getLineChartToolTips: (options: ILineChartOptions) => {
     callbacks: {
         title: (tooltipItem: any, _data: any) => string;
         label: (tooltipItem: any) => string;
-        afterLabel: (tooltipItem: any) => string;
+        afterLabel: (tooltipItem: Record<string, any>) => string;
     };
 };
 export default getLineChartToolTips;

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

@@ -1,7 +1,8 @@
+import { defaultTranslations } from '../../constants/default-translations';
 /**
  * Merges custom getTranslations with the default getTranslations.
  * If a custom translation is provided for a key, it will override the default one.
  * @param {object} translations - Custom getTranslations.
  * @returns {object} - The resulting getTranslations object, containing both default and custom getTranslations.
  */
-export declare const getTranslations: (translations?: any) => {};
+export declare const getTranslations: (translations?: Partial<Record<keyof typeof defaultTranslations, string>>) => {};

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

@@ -1,12 +1,16 @@
 import { IPieChartProps } from './pie-chart.interface';
+import { AlignOptions, Position } from '../common/helpers/enums';
 export declare const getDefaultProps: (props: IPieChartProps) => {
     testId: string | null;
-    data: import("./pie-chart.interface").IChartData;
+    data: {
+        labels: string[];
+        datasets: import("./pie-chart.interface").IPieChartDataset[];
+    };
     options: {
         title: string | string[];
         chartStyling: {
-            width: string | number;
-            height: string | number;
+            width: string | number | undefined;
+            height: string | number | undefined;
             maintainAspectRatio: boolean;
             staticChartHeight: boolean;
             performanceMode: boolean;
@@ -23,17 +27,17 @@ export declare const getDefaultProps: (props: IPieChartProps) => {
         legend: {
             display: boolean;
             useDataset: boolean;
-            position: "top" | "bottom" | "right";
-            align: "start" | "center" | "end";
+            position: Position;
+            align: AlignOptions;
         };
         chartOptions: {
             enableZoom: boolean;
             enablePan: boolean;
         };
         interactions: {
-            onLegendClick: (legendItem: string, hidden: boolean) => any;
-            onPieHover: (evt: Event, datasetIndex: string | number, index: string | number, generatedDataset: any) => any;
-            onPieUnhover: (evt: Event) => any;
+            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;
         };
     };
 };

package/dist/src/components/pie-chart/pie-chart.d.ts

@@ -1,8 +1,7 @@
 import { IPieChartProps } from './pie-chart.interface';
 /**
  * this is a pie chart component
- * @param {} props
- * @param {import('./pie-chart.interface').IPieChartProps} IPieChartProps
+ * @param {props: IPieChartProps} IPieChartProps
  * ./pie-chart.interface
  */
 declare const PieChart: (props: IPieChartProps) => JSX.Element;

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

@@ -1,54 +1,55 @@
-export interface IChartInteractions {
-    onLegendClick: (legendItem: string, hidden: boolean) => any;
-    onPointHover: () => any;
-    onPointUnhover: () => any;
-    onPieHover: (evt: Event, datasetIndex: string | number, index: string | number, generatedDataset: any) => any;
-    onPieUnhover: (evt: Event) => any;
-}
-export interface IChartOptions {
-    enableZoom: boolean;
-    enablePan: boolean;
-}
-export interface IChartLegend {
-    display: boolean;
-    position: 'top' | 'bottom' | 'right';
-    align: 'start' | 'center' | 'end';
-    useDataset: boolean;
-}
-export interface IChartGraph {
-    showDataLabels: boolean;
-    stacked: boolean;
-    cutout: number | string;
-}
-export interface IChartTooltip {
-    tooltips: boolean;
-    showLabelsInTooltips: boolean;
-}
-export interface IChartStyling {
-    width: number | string;
-    height: number | string;
-    maintainAspectRatio: boolean;
-    staticChartHeight: boolean;
-    performanceMode: boolean;
-}
-export interface IOptions {
-    title: string | string[];
-    chartStyling: IChartStyling;
-    tooltip: IChartTooltip;
-    graph: IChartGraph;
-    legend: IChartLegend;
-    chartOptions: IChartOptions;
-    interactions: IChartInteractions;
-}
-export interface IChartData {
-    labels: string;
-    datasets: any[];
-}
-export interface IChartProps {
-    testId: string | null;
-    data: IChartData;
-    options: IOptions;
+import { ICommonData, ICommonDataset, ICommonDataValue, ICommonLegend, ICommonOptions } from '../common/common.interface';
+export interface IPieLegend extends ICommonLegend {
+    useDataset?: boolean;
+}
+export interface IPieGraph {
+    showDataLabels?: boolean;
+    stacked?: boolean;
+    cutout?: number | string;
+}
+export interface IPieOptions extends ICommonOptions {
+    graph?: IPieGraph;
+    legend?: IPieLegend;
+}
+export interface IPieDataValue extends ICommonDataValue {
+    label: string;
+    borderWidth: string | number;
+    value: number;
+    backgroundColor?: string | string[];
+    borderColor?: string;
+    labels: string[];
+}
+export interface IPieChartDataset extends ICommonDataset {
+    data: IPieDataValue[];
+    hideLegend?: boolean;
+}
+export interface IPieData {
+    labels?: string[];
+    datasets?: IPieChartDataset[];
+    xUnit?: string;
+    yUnit?: string;
+}
+export interface IPieChartData extends ICommonData {
+    data?: IPieData;
+    options: IPieOptions;
 }
 export interface IPieChartProps {
-    chart: IChartProps;
+    chart: IPieChartData;
+}
+export interface IPieGeneratedLabel {
+    text: string;
+    fillStyle: string;
+    strokeStyle: string;
+    index: number;
+}
+export interface IPieLegendItemFilter {
+    index: number;
+    datasetIndex: number;
+    hidden: boolean;
+}
+export interface IPiesDataLabelsOptions {
+    display?: 'auto' | boolean;
+    align?: 'center';
+    anchor?: 'center';
+    formatter?: (_value: any, context: any) => any;
 }

package/dist/src/components/scatter-chart/scatter-chart.d.ts

@@ -1,7 +1,7 @@
 import { IScatterChartProps } from './scatter-chart.intefrace';
 /**
  *
- * @param {import('./scatter-chart.intefrace').IScatterChartProps} props
+ * @param {IScatterChartProps} props
  */
 declare const ScatterChart: (props: IScatterChartProps) => JSX.Element;
 export default ScatterChart;

package/dist/src/components/scatter-chart/scatter-chart.intefrace.d.ts

@@ -1,23 +1,13 @@
-import { IChartPlugins } from '../../helpers/chart-interface';
-export interface IScatterChartOptions {
+import { ICommonChartPlugins, ICommonData, ICommonDataset, ICommonOptions } from '../common/common.interface';
+export interface IScatterChartOptions extends Partial<ICommonOptions> {
     responsive: boolean;
     maintainAspectRatio: boolean;
-    plugins: IChartPlugins;
+    plugins: ICommonChartPlugins;
 }
-export interface IScatterChartPoint {
-    x: number | string;
-    y: number | string;
-    label?: string;
+export interface IScatterChartDataset extends ICommonDataset {
+    showLine: boolean;
 }
-export interface IScatterChartDataset {
-    label: string;
-    data: IScatterChartPoint[];
-    borderColor: string;
-    backgroundColor: string;
-    showLine: Boolean;
-}
-export interface IScatterChartData {
-    testId: string | null;
+export interface IScatterChartData extends ICommonData {
     data: {
         datasets: IScatterChartDataset[];
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oliasoft-open-source/charts-library",
-  "version": "3.4.5",
+  "version": "3.4.7-beta-1",
   "description": "React Chart Library (based on Chart.js and react-chart-js-2)",
   "homepage": "https://gitlab.com/oliasoft-open-source/charts-library",
   "bugs": {

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

@@ -1,19 +0,0 @@
-export interface IDepthType {
-    selectedDepthType: string;
-    setSelectedDepthType: (obj: any) => any;
-    options: Array<string>;
-}
-export interface IAxesOptions {
-    initialAxesRanges: Array<Object>;
-    axes: Array<any>;
-    controlsAxesLabels: Array<Object>;
-    onUpdateAxes: (obj: any) => any;
-    onResetAxes: () => any;
-    depthType: IDepthType;
-    close?: () => any;
-}
-export interface IOnEdit {
-    name: string;
-    value: string;
-    id: string;
-}

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

@@ -1,13 +0,0 @@
-export interface IHooksInterface {
-    chartRef: {
-        current: any;
-    };
-    state: any;
-    options: any;
-    dispatch: (obj: object) => any;
-    generatedDatasets: Array<Object>;
-}
-export interface IUseChartPluginsInterface {
-    options: any;
-    resetZoom: any;
-}

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

@@ -1,37 +0,0 @@
-import { ChartHoverMode, Events, PointStyle } from '../../../helpers/enums';
-import { IHooksInterface } from './hooks.interface';
-/**
- * Custom hook to generate chart options.
- * @function
- * @param {Object} chartRef - The chart reference.
- * @param {Object} state - The chart state.
- * @param {Object} options - The chart options.
- * @param {Function} dispatch - The dispatch function for state management.
- * @param {Array} generatedDatasets - The generated datasets.
- * @returns {Object} The chart options object.
- */
-export declare const useChartOptions: ({ chartRef, state, options, dispatch, generatedDatasets, }: IHooksInterface) => {
-    layout: {
-        padding: any;
-    };
-    onHover: (evt: Event, hoveredItems: any[]) => void;
-    maintainAspectRatio: any;
-    aspectRatio: number | null;
-    animation: boolean | {
-        duration: number;
-        onComplete: any;
-    };
-    hover: {
-        mode: ChartHoverMode;
-        intersect: boolean;
-    };
-    elements: {
-        line: {
-            pointStyle: PointStyle;
-            showLine: any;
-        };
-    };
-    scales: any;
-    plugins: any;
-    events: Events[];
-};

package/dist/src/components/pie-chart/pie-chart-utils.d.ts

@@ -1,2 +0,0 @@
-export declare const colors: string[];
-export declare const generateRandomColor: () => string;

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

@@ -1,7 +0,0 @@
-/**
- * Chart border plugin config
- */
-export declare const chartAreaBorderPlugin: {
-    id: string;
-    beforeDraw(chart: any, args: any, options: any): void;
-};

package/dist/src/helpers/chart-interface.d.ts

@@ -1,85 +0,0 @@
-import { Plugin } from 'chart.js';
-export interface IChartDraggableData {
-    enableDragData: boolean;
-    showTooltip: boolean;
-    roundPoints: boolean;
-    dragX: boolean;
-    dragY: boolean;
-    onDragStart: () => any;
-    onDrag: () => any;
-    onDragEnd: () => any;
-}
-export interface IChartAnnotationsData {
-    adjustScaleRange: boolean;
-    annotationAxis: 'x' | 'y';
-    color: string;
-    endValue: number;
-    label: string;
-    type: string;
-    value: number;
-    xMin: number;
-    xMax: number;
-    yMin: number;
-    yMax: number;
-}
-export interface ILabelAnnotation {
-    showLabel: boolean;
-    text: string | string[];
-    position?: string;
-    fontSize?: number;
-    xOffset?: number;
-    yOffset?: number;
-    maxWidth?: number;
-    lineHeight?: number;
-}
-export interface IChartAnnotations {
-    showAnnotations: boolean;
-    controlAnnotation: boolean;
-    annotationsData: IChartAnnotationsData[];
-    labelAnnotation: ILabelAnnotation;
-}
-export interface IChartStyling {
-    width: number | string;
-    height: number | string;
-    maintainAspectRatio: boolean;
-    squareAspectRatio?: boolean;
-    staticChartHeight: boolean;
-    performanceMode: boolean;
-    layoutPadding: any;
-}
-export interface ICustomLegend {
-    customLegendPlugin: Plugin | null;
-    customLegendContainerID: string;
-}
-export interface IChartLegend {
-    display: boolean;
-    position: 'top' | 'bottom' | 'right';
-    align: 'start' | 'center' | 'end';
-    customLegend?: ICustomLegend;
-    usePointStyle: boolean;
-}
-export interface IChartInteractions {
-    onLegendClick: () => any;
-    onPointHover: () => any;
-    onPointUnhover: () => any;
-    onAnimationComplete: () => any;
-}
-export interface IInitialState {
-    zoomEnabled?: boolean;
-    panEnabled?: boolean;
-    pointsEnabled?: boolean;
-    lineEnabled?: boolean;
-    legendEnabled?: boolean;
-    axes?: any;
-    showAnnotationLineIndex: [];
-    enableDragData?: boolean;
-}
-export interface IChartPlugins {
-    legend: {
-        position: 'top' | 'right' | 'bottom' | 'left';
-    };
-    title: {
-        display: boolean;
-        text: string;
-    };
-}

package/dist/src/helpers/get-chart-annotation.d.ts

@@ -1,12 +0,0 @@
-import { ILineChartOptions } from '../components/line-chart/line-chart.interface';
-import { IInitialState } from './chart-interface';
-/**
- * @param {import('../components/bar-chart/bar-chart.interface').IBarChartOptions |
- * import('../components/line-chart/line-chart.interface').ILineChartOptions} options - chart options object
- * @param {import('./chart-interface').IInitialState} state - chart state object controlled by useReducer or similar
- * @return {{annotations: []}}
- */
-declare const getAnnotation: (options: ILineChartOptions, state: IInitialState) => {
-    annotations: {} | null;
-};
-export default getAnnotation;

package/dist/src/helpers/get-draggableData.d.ts

@@ -1,18 +0,0 @@
-import { ILineChartOptions } from '../components/line-chart/line-chart.interface';
-/**
- * @param {import('./line-chart.interface').ILineChartOptions} options - line chart options object
- */
-declare const getDraggableData: (options: ILineChartOptions) => {
-    dragData: {
-        dragX: any;
-        dragY: any;
-        round: any;
-        showTooltip: any;
-        onDragStart: any;
-        onDrag: any;
-        onDragEnd: any;
-    };
-} | {
-    dragData?: undefined;
-};
-export default getDraggableData;