@oliasoft-open-source/charts-library 4.1.11 → 4.2.1

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

@@ -9,7 +9,7 @@ export interface ICommonDataValue {
 }
 export interface ICommonDataset {
     label?: string;
-    borderColor?: string | string[];
+    borderColor?: string;
     backgroundColor?: string | string[];
     borderWidth?: number;
     data: ICommonDataValue[];

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

@@ -1,5 +1,10 @@
 export declare enum ChartType {
     LINE = "line",
     BAR = "bar",
-    PIE = "pie"
+    PIE = "pie",
+    SCATTER = "scatter"
+}
+export declare enum ChartDirection {
+    VERTICAL = "vertical",
+    HORIZONTAL = "horizontal"
 }

package/dist/src/components/common/helpers/custom-format-number.d.ts

@@ -0,0 +1 @@
+export declare const customFormatNumber: (labelNumber: number) => string;

package/dist/src/components/common/legend-component/legend-interface.d.ts

@@ -1,5 +1,6 @@
 import { MouseEventHandler, RefObject } from 'react';
 import { Chart, ChartArea } from 'chart.js';
+import { IGeneratedScatterChartDataset, TGeneratedScatterChartDatasets, IScatterOptions } from '../../scatter-chart/scatter-chart.interface';
 import { Position } from '../helpers/enums';
 import { IGeneratedLineChartDataset, ILineChartOptions, TGeneratedLineChartDatasets } from '../../line-chart/line-chart.interface';
 import { IBarOptions, IGenerateBarChartDataset, TGenerateBarChartDatasets } from '../../bar-chart/bar-chart.interface';
@@ -22,9 +23,9 @@ export interface ILegendDropZones {
         height?: number;
     };
 }
-export type TLegendDataset = IGeneratedLineChartDataset | IGenerateBarChartDataset | IGeneratedPieChartDataset;
-export type TLegendDatasets = TGeneratedLineChartDatasets | TGenerateBarChartDatasets | TGeneratedPieChartDatasets;
-export type TChartsOption = ILineChartOptions | IBarOptions | IPieOptions;
+export type TLegendDataset = IGeneratedLineChartDataset | IGenerateBarChartDataset | IGeneratedPieChartDataset | IGeneratedScatterChartDataset;
+export type TLegendDatasets = TGeneratedLineChartDatasets | TGenerateBarChartDatasets | TGeneratedPieChartDatasets | TGeneratedScatterChartDatasets;
+export type TChartsOption = ILineChartOptions | IBarOptions | IPieOptions | IScatterOptions;
 export interface ILegendItem {
     hidden: boolean;
     dataset: TLegendDataset;

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

@@ -30,7 +30,7 @@ interface IDefaultChartOptions {
 interface IDefaultInteractions {
     onLegendClick?: (text: string, hidden: boolean) => void;
     onHover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: IPieChartDataset[]) => void;
-    onUnhover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: any[]) => void;
+    onUnhover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: IPieChartDataset[]) => void;
 }
 interface IDefaultChartData {
     labels: string[];

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

@@ -16,7 +16,7 @@ export interface IPieDataValue extends ICommonDataValue {
     borderWidth: string | number;
     value: number;
     backgroundColor?: string | string[];
-    borderColor?: string | string[];
+    borderColor?: string;
     labels: string[];
 }
 export interface IPieChartDataset extends ICommonDataset {
@@ -57,7 +57,7 @@ export interface IPiesDataLabelsOptions {
 export interface IGeneratedPieChartDataset {
     label: string;
     backgroundColor: string[];
-    borderColor: string[];
+    borderColor: string;
     borderWidth: number;
     borderDash: number[];
     annotationType?: string;

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

@@ -8,7 +8,7 @@ interface ILegendPlugin extends Plugin {
 export declare const usePieChartConfig: (chart: IPieChartDefaultProps) => {
     generatedDatasets: {
         borderWidth: number;
-        borderColor: string | string[];
+        borderColor: string;
         backgroundColor: string | string[];
         data: IPieDataValue[];
         hideLegend?: boolean | undefined;

package/dist/src/components/scatter-chart/scatter-chart-default-props.interface.d.ts

@@ -0,0 +1,69 @@
+import { ChartEvent } from 'chart.js';
+import { ICommonAdditionalAxesOptions, ICommonAnnotations, ICommonCustomLegend, ICommonLegend } from '../common/common.interface';
+import { ChartDirection } from '../common/enums';
+import { IScatterAxes, IScatterChartDataset } from './scatter-chart.interface';
+interface IDefaultChartStyling {
+    width?: number | string;
+    height?: number | string;
+    maintainAspectRatio: boolean;
+    staticChartHeight: boolean;
+    performanceMode: boolean;
+}
+interface IDefaultTooltip {
+    enabled: boolean;
+    tooltips: boolean;
+    showLabelsInTooltips: boolean;
+    backgroundColor: string;
+    displayColors: boolean;
+}
+interface IDefaultScatterGraph {
+    showMinorGridlines: boolean;
+    showDataLabels: boolean;
+}
+export interface IDefaultScatterLegend extends ICommonLegend {
+    customLegend?: ICommonCustomLegend<any>;
+}
+interface IDefaultChartOptions {
+    enableZoom: boolean;
+    enablePan: boolean;
+}
+interface IDefaultInteractions {
+    onLegendClick?: (text: string, hidden: boolean) => void;
+    onHover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: IScatterChartDataset[]) => void;
+    onUnhover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: any[]) => void;
+}
+interface IDefaultChartData {
+    labels: string[];
+    datasets: IScatterChartDataset[];
+}
+export interface IDefaultScatterOptions {
+    title: string | string[];
+    chartStyling: IDefaultChartStyling;
+    tooltip: IDefaultTooltip;
+    graph: IDefaultScatterGraph;
+    axes: IScatterAxes;
+    additionalAxesOptions: ICommonAdditionalAxesOptions;
+    legend: IDefaultScatterLegend;
+    chartOptions: IDefaultChartOptions;
+    interactions: IDefaultInteractions;
+    annotations?: ICommonAnnotations;
+    direction: ChartDirection;
+}
+export interface IScatterChartDefaultProps {
+    testId: string | null;
+    data: IDefaultChartData;
+    options: {
+        title: string | string[];
+        chartStyling: IDefaultChartStyling;
+        tooltip: IDefaultTooltip;
+        graph: IDefaultScatterGraph;
+        axes: IScatterAxes;
+        additionalAxesOptions: ICommonAdditionalAxesOptions;
+        legend: IDefaultScatterLegend;
+        chartOptions: IDefaultChartOptions;
+        interactions: IDefaultInteractions;
+        annotations?: ICommonAnnotations;
+        direction: ChartDirection;
+    };
+}
+export {};

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

@@ -0,0 +1,3 @@
+import { IScatterChartDefaultProps } from '../scatter-chart/scatter-chart-default-props.interface';
+import { IScatterChartProps } from './scatter-chart.interface';
+export declare const getDefaultProps: (props: IScatterChartProps) => IScatterChartDefaultProps;

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

@@ -0,0 +1,3 @@
+import { IScatterChartProps } from '../scatter-chart/scatter-chart.interface';
+declare const ScatterChartWithLegend: (props: IScatterChartProps) => import("react/jsx-runtime").JSX.Element;
+export { ScatterChartWithLegend as ScatterChart };

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

@@ -0,0 +1,80 @@
+import { ChartDirection } from '../common/enums.ts';
+import { ICommonAdditionalAxesOptions, ICommonAxis, ICommonData, ICommonDataset, ICommonDataValue, ICommonLegend, ICommonOptions } from '../common/common.interface';
+export interface IScatterLegend extends ICommonLegend {
+    useDataset?: boolean;
+}
+export interface IScatterGraph {
+    showMinorGridlines?: boolean;
+    showDataLabels?: boolean;
+}
+export interface IScatterTooltip {
+    enabled?: boolean;
+    tooltips?: boolean;
+    showLabelsInTooltips: boolean;
+    backgroundColor?: string;
+    displayColors?: boolean;
+}
+export interface IScatterAxes {
+    x: ICommonAxis<'top' | 'bottom'>[];
+    y: ICommonAxis<'left' | 'right'>[];
+    [key: string]: ICommonAxis[];
+}
+export interface IScatterOptions extends ICommonOptions {
+    graph?: IScatterGraph;
+    legend?: IScatterLegend;
+    axes?: IScatterAxes;
+    additionalAxesOptions?: ICommonAdditionalAxesOptions;
+    direction: ChartDirection;
+}
+export interface IScatterDataValue extends ICommonDataValue {
+    label?: string;
+}
+export interface IScatterChartDataset extends ICommonDataset {
+    data: IScatterDataValue[];
+    hideLegend?: boolean;
+}
+export interface IScatterData {
+    labels?: string[];
+    datasets?: IScatterChartDataset[];
+    xUnit?: string;
+    yUnit?: string;
+}
+export interface IScatterChartData extends ICommonData {
+    data: IScatterData;
+    options: IScatterOptions;
+}
+export interface IScatterChartProps {
+    chart: IScatterChartData;
+    testId?: string | null;
+}
+export interface IScatterGeneratedLabel {
+    text: string;
+    fillStyle: string;
+    strokeStyle: string;
+    index: number;
+}
+export interface IScatterLegendItemFilter {
+    index: number;
+    datasetIndex: number;
+    hidden: boolean;
+}
+export interface IScatterDataLabelsOptions {
+    display?: 'auto' | boolean;
+    align?: 'center';
+    anchor?: 'center';
+    formatter?: (_value: any, context: any) => any;
+}
+export interface IGeneratedScatterChartDataset {
+    label: string;
+    backgroundColor: string[];
+    borderColor: string;
+    borderWidth: number;
+    borderDash: number[];
+    annotationType?: string;
+    data: IScatterDataValue[];
+    hideLegend?: boolean;
+    displayGroup?: string | number;
+    isAnnotation?: boolean;
+    annotationIndex?: number;
+}
+export type TGeneratedScatterChartDatasets = IGeneratedScatterChartDataset[];

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

@@ -0,0 +1,205 @@
+declare namespace _default {
+    export const title: string;
+    export { ScatterChart as component };
+    export namespace args {
+        export { singleScatterChart as chart };
+    }
+}
+export default _default;
+export function Default(args: any): import("react/jsx-runtime").JSX.Element;
+export namespace Default {
+    export namespace args_1 {
+        export { singleScatterChart as chart };
+    }
+    export { args_1 as args };
+}
+export function StyledChart(args: any): import("react/jsx-runtime").JSX.Element;
+export namespace StyledChart {
+    export namespace args_2 {
+        export { styledScatterChart as chart };
+    }
+    export { args_2 as args };
+}
+export function MultipleDatasets(args: any): import("react/jsx-runtime").JSX.Element;
+export namespace MultipleDatasets {
+    export namespace args_3 {
+        export { multipleScatterData as chart };
+    }
+    export { args_3 as args };
+}
+export function WithDataLabels(args: any): import("react/jsx-runtime").JSX.Element;
+export namespace WithDataLabels {
+    export namespace args_4 {
+        export { scatterWithDataLabels as chart };
+    }
+    export { args_4 as args };
+}
+export function WithTooltips(args: any): import("react/jsx-runtime").JSX.Element;
+export namespace WithTooltips {
+    export namespace args_5 {
+        export { scatterWithTooltips as chart };
+    }
+    export { args_5 as args };
+}
+export function WithAnnotation(args: any): import("react/jsx-runtime").JSX.Element;
+export namespace WithAnnotation {
+    export namespace args_6 {
+        export { scatterWithAnnotation as chart };
+    }
+    export { args_6 as args };
+}
+export function WithAxesLabels(args: any): import("react/jsx-runtime").JSX.Element;
+export namespace WithAxesLabels {
+    export namespace args_7 {
+        export { scatterWithAxesLabels as chart };
+    }
+    export { args_7 as args };
+}
+import { ScatterChart } from './scatter-chart';
+declare namespace singleScatterChart {
+    namespace data {
+        export { labels1 as labels };
+        export const datasets: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+    }
+}
+declare namespace styledScatterChart {
+    export namespace data_1 {
+        export { labels1 as labels };
+        const datasets_1: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+        export { datasets_1 as datasets };
+    }
+    export { data_1 as data };
+    export namespace options {
+        namespace chartStyling {
+            const width: string;
+        }
+    }
+}
+declare namespace multipleScatterData {
+    export namespace data_2 {
+        export { labels1 as labels };
+        const datasets_2: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+        export { datasets_2 as datasets };
+    }
+    export { data_2 as data };
+}
+declare namespace scatterWithDataLabels {
+    export namespace data_3 {
+        export { labels1 as labels };
+        const datasets_3: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+        export { datasets_3 as datasets };
+    }
+    export { data_3 as data };
+    export namespace options_1 {
+        const title_1: string;
+        export { title_1 as title };
+        export namespace graph {
+            const showDataLabels: boolean;
+        }
+    }
+    export { options_1 as options };
+}
+declare namespace scatterWithTooltips {
+    export namespace data_4 {
+        export { labels1 as labels };
+        const datasets_4: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+        export { datasets_4 as datasets };
+    }
+    export { data_4 as data };
+    export namespace options_2 {
+        const title_2: string;
+        export { title_2 as title };
+        export namespace tooltip {
+            const title_3: string;
+            export { title_3 as title };
+            export const showLabelsInTooltips: boolean;
+        }
+    }
+    export { options_2 as options };
+}
+declare namespace scatterWithAnnotation {
+    export namespace data_5 {
+        export { labels1 as labels };
+        const datasets_5: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+        export { datasets_5 as datasets };
+    }
+    export { data_5 as data };
+    export namespace options_3 {
+        const title_4: string;
+        export { title_4 as title };
+        export namespace annotations {
+            const showAnnotations: boolean;
+            const annotationsData: {
+                annotationAxis: string;
+                label: string;
+                value: number;
+                color: string;
+            }[];
+        }
+    }
+    export { options_3 as options };
+}
+declare namespace scatterWithAxesLabels {
+    export namespace data_6 {
+        export { labels1 as labels };
+        const datasets_6: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+        export { datasets_6 as datasets };
+    }
+    export { data_6 as data };
+    export namespace options_4 {
+        const title_5: string;
+        export { title_5 as title };
+        export namespace axes {
+            const x: {
+                label: string;
+            }[];
+            const y: {
+                label: string;
+            }[];
+        }
+    }
+    export { options_4 as options };
+}
+declare const labels1: string[];

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

@@ -0,0 +1,49 @@
+import { IDefaultScatterOptions } from '../../scatter-chart/scatter-chart-default-props.interface';
+export declare const getScatterChartScales: (options: IDefaultScatterOptions) => {
+    x: {
+        type: "linear";
+        position: any;
+        beginAtZero: boolean;
+        reverse: boolean;
+        suggestedMax: number | undefined;
+        suggestedMin: number | undefined;
+        min: number | undefined;
+        max: number | undefined;
+        title: {
+            display: boolean;
+            text: string | undefined;
+            padding: number;
+        };
+        ticks: {
+            includeBounds: boolean;
+            font: {
+                size: number;
+            };
+            stepSize: number | undefined;
+        };
+        grid: {};
+    };
+    y: {
+        type: "linear";
+        position: any;
+        beginAtZero: boolean;
+        reverse: boolean;
+        suggestedMax: number | undefined;
+        suggestedMin: number | undefined;
+        min: number | undefined;
+        max: number | undefined;
+        title: {
+            display: boolean;
+            text: string | undefined;
+            padding: number;
+        };
+        ticks: {
+            includeBounds: boolean;
+            font: {
+                size: number;
+            };
+            stepSize: number | undefined;
+        };
+        grid: {};
+    };
+};

package/dist/src/components/scatter-chart/utils/get-tooltip-config.d.ts

@@ -0,0 +1,20 @@
+import { TooltipItem } from 'chart.js';
+import { IDefaultScatterOptions } from '../../scatter-chart/scatter-chart-default-props.interface';
+interface IRawData {
+    x: number;
+    y: number;
+}
+interface IScatterTooltipItem extends TooltipItem<'scatter'> {
+    raw: IRawData;
+}
+export declare const getTooltipsConfig: (options: IDefaultScatterOptions) => {
+    enabled: boolean;
+    callbacks: {
+        title: (tooltipItems: TooltipItem<'scatter'>[]) => string | undefined;
+        label: (tooltipItem: IScatterTooltipItem) => string;
+    };
+    backgroundColor: string;
+    displayColors: boolean;
+    padding: number;
+};
+export {};

package/package.json

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