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

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

@@ -1,28 +1,32 @@
 import { IBarChartProps } from './bar-chart.interface';
+import { AlignOptions, Position } from '../common/helpers/enums';
 export declare const getDefaultProps: (props: IBarChartProps) => {
-    testId: string | null;
-    data: any;
+    testId: string;
+    data: {
+        labels: string[];
+        datasets: import("./bar-chart.interface").IBarChartDataset[];
+    };
     options: {
         title: string | string[];
         direction: "vertical" | "horizontal";
         axes: {
-            x: import("./bar-chart.interface").IBarChartAxes<"top" | "bottom">[];
-            y: import("./bar-chart.interface").IBarChartAxes<"left" | "right">[];
+            x: [{}] | import("../common/common.interface").ICommonAxis<"top" | "bottom">[];
+            y: [{}] | import("../common/common.interface").ICommonAxis<"left" | "right">[];
         };
         additionalAxesOptions: {
             chartScaleType: "linear" | "logarithmic";
             reverse: boolean;
             stacked: boolean;
             beginAtZero: boolean;
-            stepSize: number;
-            suggestedMin: number;
-            suggestedMax: number;
-            min: number;
-            max: number;
+            stepSize: number | undefined;
+            suggestedMin: number | undefined;
+            suggestedMax: number | undefined;
+            min: number | undefined;
+            max: number | undefined;
         };
         chartStyling: {
-            width: string | number;
-            height: string | number;
+            width: string | number | undefined;
+            height: string | number | undefined;
             maintainAspectRatio: boolean;
             staticChartHeight: boolean;
             performanceMode: boolean;
@@ -38,32 +42,32 @@ export declare const getDefaultProps: (props: IBarChartProps) => {
         annotations: {
             showAnnotations: boolean;
             controlAnnotation: boolean;
-            annotationsData: import("../../helpers/chart-interface").IChartAnnotationsData[];
+            annotationsData: import("../common/common.interface").ICommonAnnotationsData[];
         };
         legend: {
             display: boolean;
-            position: "top" | "bottom" | "right";
-            align: "start" | "center" | "end";
-            customLegend: import("../../helpers/chart-interface").ICustomLegend;
+            position: Position;
+            align: AlignOptions;
+            customLegend: import("../common/common.interface").ICommonCustomLegend<any>;
         };
         chartOptions: {
             enableZoom: boolean;
             enablePan: boolean;
         };
         interactions: {
-            onLegendClick: () => any;
-            onBarHover: any;
-            onBarUnhover: 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;
         };
         dragData: {
-            enableDragData: any;
-            showTooltip: any;
-            roundPoints: any;
-            dragX: any;
-            dragY: any;
-            onDragStart: any;
-            onDrag: any;
-            onDragEnd: any;
+            enableDragData: boolean;
+            showTooltip: boolean;
+            roundPoints: boolean;
+            dragX: boolean;
+            dragY: boolean;
+            onDragStart: (() => void) | undefined;
+            onDrag: (() => void) | undefined;
+            onDragEnd: (() => void) | undefined;
         };
     };
 };

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

@@ -1,82 +1,49 @@
-import { LinearScaleOptions } from 'chart.js';
-import { IChartAnnotations, IChartDraggableData, IChartInteractions, IChartLegend, IChartStyling } from '../../helpers/chart-interface';
-export interface IChartOptions {
-    enableZoom: boolean;
-    enablePan: boolean;
-}
-export interface IBarChartGraph {
-    showDataLabels: boolean;
-    showMinorGridlines: boolean;
-}
-export interface IBarChartTooltip {
-    tooltips: boolean;
-    showLabelsInTooltips: boolean;
-}
-export interface IBarChartAdditionalAxesOptions {
-    chartScaleType: 'linear' | 'logarithmic';
-    reverse: boolean;
-    beginAtZero: boolean;
-    stepSize: number;
-    stacked: boolean;
-    suggestedMin: number;
-    suggestedMax: number;
-    min: number;
-    max: number;
+import { ICommonAdditionalAxesOptions, ICommonAnnotations, ICommonAxis, ICommonCustomLegend, ICommonData, ICommonDataset, ICommonDragData, ICommonGraph, ICommonLegend, ICommonOptions, ICommonScales, ICommonStyling } from '../common/common.interface';
+export interface IBarStyling extends ICommonStyling {
+    squareAspectRatio?: boolean;
+    layoutPadding?: string | number | {
+        top: number;
+        bottom: number;
+        left: number;
+        right: number;
+    };
 }
-export interface IBarChartAxes<PositionType> {
-    label: string;
-    position: PositionType;
-    color: string;
-    unit: string;
+export interface IBarLegend extends ICommonLegend {
+    customLegend?: ICommonCustomLegend<any>;
 }
-export interface IBarScales {
-    x: LinearScaleOptions;
-    y: LinearScaleOptions;
+export interface IBarAxes {
+    x: ICommonAxis<'top' | 'bottom'>[] | [{}];
+    y: ICommonAxis<'left' | 'right'>[] | [{}];
+    [key: string]: ICommonAxis<any>[] | [{}];
 }
-export interface IBarChartOptions {
-    title: string | string[];
+export interface IBarOptions extends ICommonOptions {
     direction: 'vertical' | 'horizontal';
-    axes: {
-        x: IBarChartAxes<'top' | 'bottom'>[];
-        y: IBarChartAxes<'left' | 'right'>[];
-    };
-    scales: IBarScales;
-    additionalAxesOptions: IBarChartAdditionalAxesOptions;
-    chartStyling: IChartStyling;
-    tooltip: IBarChartTooltip;
-    graph: IBarChartGraph;
-    annotations: IChartAnnotations;
-    legend: IChartLegend;
-    chartOptions: IChartOptions;
-    interactions: IChartInteractions;
-    draggableData: IChartDraggableData;
-}
-export interface IBarDataPoint {
-    x: number;
-    y: number;
-    label?: string;
-}
-export interface IBarChartDataset {
-    label?: string;
-    data: number[] | number[][] | IBarDataPoint[];
-    borderSkipped?: string;
-    backgroundColor?: string[];
-    borderColor?: string[];
+    axes: IBarAxes;
+    scales?: ICommonScales;
+    additionalAxesOptions?: ICommonAdditionalAxesOptions;
+    chartStyling: IBarStyling;
+    graph?: ICommonGraph;
+    annotations?: ICommonAnnotations;
+    legend?: IBarLegend;
+    dragData?: ICommonDragData;
+}
+export interface IBarChartDataset extends ICommonDataset {
+    isAnnotation?: boolean;
+    annotationIndex?: number;
+    borderSkipped?: any;
     borderRadius?: number;
-    borderWidth?: number;
+    xAxisID?: string;
     yAxisID?: string;
-    stack?: number;
-    isAnnotation: boolean;
-    annotationIndex: number | string;
-    type: 'bar' | 'line';
+    hidden?: boolean;
+    displayGroup?: any;
+    type?: 'bar';
 }
-export interface IBarChartData {
-    testId: string | null;
+export interface IBarChartData extends ICommonData {
     data: {
-        labels?: string[];
+        labels: string[];
         datasets: IBarChartDataset[];
-    } | any;
-    options: IBarChartOptions;
+    };
+    options: IBarOptions;
 }
 export interface IBarChartProps {
     chart: IBarChartData;

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

@@ -1,17 +1,14 @@
-import { AlignOptions } from '../../helpers/enums';
-import { IBarChartOptions } from './bar-chart.interface';
+import { Options } from 'chartjs-plugin-datalabels';
+import { IBarOptions } from './bar-chart.interface';
+type ExtendedDisplayOptions = 'auto' | boolean;
+interface IExtendedDataLabelsOptions extends Options {
+    display: ExtendedDisplayOptions;
+}
 /**
- * @param {import('./bar-chart.interface').IBarChartOptions} options - bar chart options object
+ * Returns the data labels configuration for a bar chart.
+ *
+ * @param {IBarChartOptions} options - The options for the bar chart.
+ * @returns {Object} The data labels configuration for the chart.
  */
-declare const getBarChartDataLabels: (options: IBarChartOptions) => {
-    display: string;
-    align: AlignOptions;
-    anchor: AlignOptions;
-    formatter: (value: any, context: any) => string | number;
-} | {
-    display: boolean;
-    align?: undefined;
-    anchor?: undefined;
-    formatter?: undefined;
-};
+declare const getBarChartDataLabels: (options: IBarOptions) => IExtendedDataLabelsOptions;
 export default getBarChartDataLabels;

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

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

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

@@ -1,19 +1,6 @@
-import { ChartHoverMode } from '../../helpers/enums';
+import { IBarOptions } from './bar-chart.interface';
 /**
- * @param {import('./bar-chart.interface').IBarChartOptions} options - bar chart options object
+ * @param {IBarOptions} options - bar chart options object
  */
-declare const getBarChartToolTips: (options: any) => {
-    enabled: any;
-    mode: ChartHoverMode;
-    intersect: boolean;
-    padding: number;
-    boxWidth: number;
-    boxHeight: number;
-    boxPadding: number;
-    callbacks: {
-        title: (tooltipItem: any, data: any) => string;
-        label: (tooltipItem: any) => string;
-        afterLabel: (tooltipItem: any) => string;
-    };
-};
+declare const getBarChartToolTips: (options: IBarOptions) => Record<string, any>;
 export default getBarChartToolTips;

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

@@ -0,0 +1,139 @@
+import { ChartEvent, ChartTypeRegistry, LinearScaleOptions, Plugin } from 'chart.js';
+import { AlignOptions, Position } from './helpers/enums';
+export interface ICommonDataValue {
+    x: number;
+    y: number;
+    label?: string;
+}
+export interface ICommonDataset {
+    label?: string;
+    borderColor?: string;
+    backgroundColor?: string | string[];
+    borderWidth?: number;
+    data: ICommonDataValue[];
+}
+export interface ICommonScales extends Partial<Record<string, LinearScaleOptions>> {
+    x: LinearScaleOptions;
+    y: LinearScaleOptions;
+}
+export interface ICommonAnnotationsData {
+    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 ICommonStyling {
+    width?: number | string;
+    height?: number | string;
+    maintainAspectRatio?: boolean;
+    staticChartHeight?: boolean;
+    performanceMode?: boolean;
+}
+export interface ICommonLegend {
+    display: boolean;
+    position: Position;
+    align: AlignOptions;
+}
+export interface ICommonTooltip {
+    tooltips: boolean;
+    showLabelsInTooltips: boolean;
+}
+export interface ICommonAdditionalAxesOptions {
+    chartScaleType?: 'linear' | 'logarithmic';
+    reverse: boolean;
+    beginAtZero: boolean;
+    stepSize?: number;
+    stacked?: boolean;
+    suggestedMin?: number;
+    suggestedMax?: number;
+    min?: number;
+    max?: number;
+}
+export interface ICommonAnnotation {
+    showLabel: boolean;
+    text: string | string[];
+    position: string;
+    fontSize: number;
+    xOffset: number;
+    yOffset: number;
+    maxWidth: number;
+    lineHeight: number;
+}
+export interface ICommonAnnotations {
+    showAnnotations?: boolean;
+    controlAnnotation?: boolean;
+    annotationsData?: ICommonAnnotationsData[];
+    labelAnnotation?: ICommonAnnotation;
+}
+export interface ICommonGraph {
+    lineTension?: number;
+    spanGaps?: boolean;
+    showDataLabels?: boolean;
+    showMinorGridlines?: boolean;
+}
+export interface ICommonInteractions {
+    onLegendClick?: (text: string, hidden: boolean) => void;
+    onHover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: any[]) => void;
+    onUnhover?: (event?: ChartEvent, datasetIndex?: number, index?: number, generatedDataset?: any[]) => void;
+}
+export interface ICommonCustomLegend<T extends keyof ChartTypeRegistry> {
+    customLegendPlugin: Plugin<T> | null;
+    customLegendContainerID: string;
+}
+export interface ICommonChartOptions {
+    enableZoom: boolean;
+    enablePan: boolean;
+}
+export interface ICommonDragData {
+    enableDragData?: boolean;
+    showTooltip?: boolean;
+    roundPoints?: boolean;
+    dragX?: boolean;
+    dragY?: boolean;
+    onDragStart?: () => void;
+    onDrag?: () => void;
+    onDragEnd?: () => void;
+}
+export interface ICommonOptions {
+    title?: string | string[];
+    chartStyling?: ICommonStyling;
+    tooltip?: ICommonTooltip;
+    legend?: ICommonLegend;
+    chartOptions?: ICommonChartOptions;
+    interactions?: ICommonInteractions;
+    dragData?: ICommonDragData;
+}
+export interface ICommonData {
+    testId?: string;
+    data?: {
+        labels?: string[];
+        datasets?: ICommonDataset[];
+    };
+    options: ICommonOptions;
+}
+export interface ICommonHoveredItems {
+    index: number;
+    datasetIndex: number;
+}
+export interface ICommonChartPlugins {
+    legend: {
+        position: 'top' | 'right' | 'bottom' | 'left';
+    };
+    title: {
+        display: boolean;
+        text: string;
+    };
+}
+export interface ICommonAxis<PositionType> {
+    label: string;
+    position: PositionType;
+    color: string | string[];
+    unit: string;
+}

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

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

package/dist/src/{helpers → components/common/helpers}/enums.d.ts

@@ -57,7 +57,8 @@ export declare enum ChartHoverMode {
 export declare enum PanZoomMode {
     X = "x",
     Y = "y",
-    XY = "xy"
+    XY = "xy",
+    Z = "z"
 }
 export declare enum Key {
     Shift = "Shift"

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

@@ -0,0 +1,27 @@
+interface IAnnotationData {
+    annotationAxis?: string;
+    color?: string;
+    type?: string;
+    adjustScaleRange?: boolean;
+    label?: string;
+    value?: number;
+}
+interface IAnnotations {
+    annotationsData?: IAnnotationData[];
+    showAnnotations?: boolean;
+}
+interface IOptions {
+    annotations?: IAnnotations;
+}
+interface IState {
+    showAnnotationLineIndex?: number[];
+}
+/**
+ * @param {ICommonChartOptions} options - chart options object
+ * @param {IInitialState} state - chart state object controlled by useReducer or similar
+ * @return {{annotations: []}}
+ */
+declare const getAnnotation: (options: IOptions, state: IState) => {
+    annotations: IAnnotationData | undefined;
+};
+export default getAnnotation;

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

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

package/dist/src/{helpers → components/common/helpers}/range/range.d.ts

@@ -1,3 +1,8 @@
+interface IGetSuggestedAxisRange {
+    data: number[];
+    beginAtZero: boolean;
+    autoAxisPadding: boolean;
+}
 /**
  * Overrides the default chart.js axis range for some edge-cases:
  * - when no data -> default range
@@ -18,12 +23,7 @@
  * @param {boolean>} [args.autoAxisPadding]
  * @returns {object} returns {min, max} pair
  */
-interface IGetuggestedAxisRange {
-    data: any;
-    beginAtZero: boolean;
-    autoAxisPadding: boolean;
-}
-export declare const getSuggestedAxisRange: ({ data, beginAtZero, autoAxisPadding, }: IGetuggestedAxisRange) => {
+export declare const getSuggestedAxisRange: ({ data, beginAtZero, autoAxisPadding, }: IGetSuggestedAxisRange) => {
     min: number;
     max: number;
 } | {

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

@@ -1,3 +1,5 @@
+import { IState } from '../../state/state.interfaces';
+import { IAction, IFormState, IInitializeAxisFormState } from './axes-options-interfaces.ts';
 /**
  * Initialize local component form state for a custom loads density table
  *
@@ -6,8 +8,11 @@
  * @param {Array} [args.axes]
  * @returns {Object} formState
  */
-export declare const initializeFormState: ({ initialAxesRanges, axes }: any) => any;
-export declare const validateAxes: (formState: any) => any;
+export declare const initializeFormState: ({ initialAxesRanges, axes, }: Partial<IState>) => IInitializeAxisFormState;
+export declare const validateAxes: (formState: IFormState) => {
+    errors: never[];
+    valid: boolean;
+};
 /**
  * Local component form state reducer for a axes options form
  *
@@ -15,4 +20,4 @@ export declare const validateAxes: (formState: any) => any;
  * @param {Action} action Action with type and payload
  * @returns {Object} FormState
  */
-export declare const reducer: (state: any, action: any) => any;
+export declare const reducer: (state: IFormState, action: IAction) => IInitializeAxisFormState;

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

@@ -0,0 +1,52 @@
+import { IUnitOptions } from '../../line-chart.interface.ts';
+import { IAxisState, IInitAxisRange } from '../../state/state.interfaces.ts';
+export interface IDepthType {
+    selectedDepthType?: string;
+    setSelectedDepthType?: (type: string) => void;
+    options?: Array<string>;
+}
+export interface IAxisControlLabel {
+    id: string;
+    label: string;
+}
+export interface IAxesOptions {
+    initialAxesRanges: IInitAxisRange[];
+    axes: IAxisState[];
+    controlsAxesLabels: IAxisControlLabel[];
+    onUpdateAxes: (axes: IAxisState) => void;
+    onResetAxes: () => void;
+    depthType: IDepthType;
+    close?: () => void;
+}
+export interface IOnEdit {
+    name?: string;
+    value?: string;
+    id?: string;
+}
+export interface IAxisFormState {
+    id: string;
+    min: number | string;
+    max: number | string;
+    unit: string | IUnitOptions;
+}
+export type IInitializeAxisFormState = IAxisFormState[];
+export interface IError {
+    id: string;
+    min: string[];
+    max: string[];
+}
+export interface IFormState extends IInitializeAxisFormState {
+    errors?: IError[];
+    valid?: boolean;
+}
+type ActionType = 'reset' | 'valueUpdated' | 'unitUpdated';
+export type AxisKey = 'min' | 'max' | 'unit';
+interface ActionPayload extends IOnEdit {
+    initialAxesRanges?: IInitAxisRange[];
+    axes?: IAxisState[];
+}
+export interface IAction {
+    type: ActionType;
+    payload: ActionPayload;
+}
+export {};

package/dist/src/components/{controls → line-chart/controls}/axes-options/axes-options.d.ts

@@ -1,6 +1,6 @@
 import { IAxesOptions } from './axes-options-interfaces';
 interface IAxesOptionsWithTranslations extends IAxesOptions {
-    translations: any;
+    translations: Record<string, string>;
 }
 export declare const AxesOptions: (optionsPopover: IAxesOptionsWithTranslations) => JSX.Element;
 export {};

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

@@ -1,34 +1,20 @@
-interface IControlsProps {
-    headerComponent: Element;
-    subheaderComponent: Element;
-    table: Element;
-    controlsPortalId: string;
-}
-interface IControlsState {
-    enableDragPoints: boolean;
-    initialAxesRanges: Array<object>;
-    legendEnabled: boolean;
-    lineEnabled: boolean;
-    panEnabled: boolean;
-    pointsEnabled: boolean;
-    showTable: boolean;
-    zoomEnabled: boolean;
-}
-interface IControlsOptions {
-    dragData: {
-        enableDragData: boolean;
-    };
-    title: string;
-    depthType: any;
-}
+import { Dispatch, RefObject } from 'react';
+import { Chart } from 'chart.js';
+import { ILineChartDataset, ILineChartOptions } from '../line-chart.interface';
+import { IState } from '../state/state.interfaces';
 export interface IControls {
-    props: IControlsProps;
-    chartRef: any;
-    state: IControlsState;
-    options: IControlsOptions;
-    dispatch: () => any;
-    generatedDatasets: Array<object>;
-    translations: any;
-    controlsPortalId: any;
+    headerComponent?: Element;
+    subheaderComponent?: Element;
+    table?: Element;
+    chartRef: RefObject<Chart>;
+    state: IState;
+    options: ILineChartOptions;
+    dispatch: Dispatch<any>;
+    generatedDatasets: ILineChartDataset[];
+    translations: Record<string, string>;
+    controlsPortalId?: string;
+}
+export interface AxisControls {
+    id?: string;
+    label?: string;
 }
-export {};

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

@@ -1,2 +1,7 @@
-declare const ControlsPortal: ({ children, controlsPortalId }: any) => any;
+import { ReactElement } from 'react';
+interface ControlsPortalProps {
+    children: ReactElement;
+    controlsPortalId: string;
+}
+declare const ControlsPortal: ({ children, controlsPortalId, }: ControlsPortalProps) => JSX.Element;
 export default ControlsPortal;

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

@@ -2,5 +2,5 @@ import { IControls } from './controls-interfaces';
 /**
  * @param {import('./controls-interfaces').IControls} obj
  */
-declare const Controls: ({ props: { headerComponent, subheaderComponent, table }, chartRef, state, options, dispatch, generatedDatasets, translations, controlsPortalId, }: IControls) => JSX.Element;
+declare const Controls: ({ headerComponent, subheaderComponent, table, chartRef, state, options, dispatch, generatedDatasets, translations, controlsPortalId, }: IControls) => JSX.Element;
 export default Controls;