@oliasoft-open-source/charts-library 5.2.0 → 5.2.1-beta-1

package/dist/scatter-chart/hooks/use-scatter-chart-config.d.ts

@@ -0,0 +1,113 @@
+import { ActiveElement, AnimationSpec, Chart, ChartEvent } from 'chart.js';
+import { IScatterChartDefaultProps } from '../scatter-chart-default-props.interface';
+import { MutableRefObject } from '../../../../node_modules/react';
+import { ICommonHoveredItems } from '../../common/common.interface';
+import { TGeneratedScatterChartDatasets } from '../scatter-chart.interface';
+export declare const useScatterChartConfig: (chart: IScatterChartDefaultProps, chartRef: MutableRefObject<Chart | null>) => {
+    generatedDatasets: TGeneratedScatterChartDatasets;
+    scatterOptions: {
+        interactions: {
+            onLegendClick: (_: import('../../common/common.interface').UnusedParameter, legendItem: import('chart.js').LegendItem) => void;
+            onHover: (evt: ChartEvent, hoveredItems: ICommonHoveredItems[]) => void;
+        };
+        scales: {
+            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: {};
+            };
+        };
+        animation: Partial<AnimationSpec<"scatter">>;
+        plugins: {
+            legend: {
+                display: boolean;
+                events: never[];
+                position: any;
+                align: "center" | "start" | "end";
+                labels: {
+                    boxHeight: number;
+                    boxWidth: number | undefined;
+                    usePointStyle: boolean | undefined;
+                };
+                onClick: (_: import('../../common/common.interface').UnusedParameter, legendItem: import('chart.js').LegendItem) => void;
+            };
+            customLegendPlugin: {
+                htmlLegend: any;
+            };
+            title: {
+                display: boolean;
+                text: string | string[];
+            } | {
+                display?: undefined;
+                text?: undefined;
+            };
+            annotation: {
+                annotations: {};
+            };
+            chartAreaBorder: {
+                borderColor: string;
+            };
+            datalabels: {
+                display: boolean;
+            };
+            tooltip: {
+                enabled: boolean;
+                callbacks: {
+                    title: (tooltipItems: import('chart.js').TooltipItem<"scatter">[]) => string | undefined;
+                    label: (tooltipItems: import('../utils/get-tooltip-config').IScatterTooltipItem) => string;
+                };
+                backgroundColor: string;
+                displayColors: boolean;
+                padding: number;
+            };
+        };
+        width?: number | string;
+        height?: number | string;
+        maintainAspectRatio: boolean;
+        staticChartHeight: boolean;
+        performanceMode: boolean;
+        onClick: (_evt: ChartEvent, _elements: ActiveElement[], chartInstance: Chart) => void;
+        onHover: (evt: ChartEvent, hoveredItems: ICommonHoveredItems[]) => void;
+    };
+};

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

@@ -0,0 +1,71 @@
+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';
+export 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;
+    scientificNotation: boolean;
+}
+interface IDefaultScatterGraph {
+    showMinorGridlines: boolean;
+    showDataLabels: boolean;
+}
+export interface IDefaultScatterLegend extends ICommonLegend {
+    customLegend?: ICommonCustomLegend<any>;
+}
+interface IDefaultChartOptions {
+    enableZoom: boolean;
+    enablePan: boolean;
+}
+export 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;
+    onAnimationComplete?: () => 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/scatter-chart/scatter-chart-get-default-props.d.ts

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

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

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

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

@@ -0,0 +1,81 @@
+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;
+    scientificNotation?: 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/scatter-chart/utils/get-scales-config.d.ts

@@ -0,0 +1,49 @@
+import { IDefaultScatterOptions } from '../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/scatter-chart/utils/get-tooltip-config.d.ts

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

package/package.json

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