@oliasoft-open-source/charts-library 3.3.8 → 3.4.0-beta-1

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

@@ -0,0 +1,69 @@
+import { IBarChartProps } from './bar-chart.interface';
+export declare const getDefaultProps: (props: IBarChartProps) => {
+    testId: string | null;
+    data: any;
+    options: {
+        title: string | string[];
+        direction: "vertical" | "horizontal";
+        axes: {
+            x: import("./bar-chart.interface").IBarChartAxes<"top" | "bottom">[];
+            y: import("./bar-chart.interface").IBarChartAxes<"left" | "right">[];
+        };
+        additionalAxesOptions: {
+            chartScaleType: "linear" | "logarithmic";
+            reverse: boolean;
+            stacked: boolean;
+            beginAtZero: boolean;
+            stepSize: number;
+            suggestedMin: number;
+            suggestedMax: number;
+            min: number;
+            max: number;
+        };
+        chartStyling: {
+            width: string | number;
+            height: string | number;
+            maintainAspectRatio: boolean;
+            staticChartHeight: boolean;
+            performanceMode: boolean;
+        };
+        tooltip: {
+            tooltips: boolean;
+            showLabelsInTooltips: boolean;
+        };
+        graph: {
+            showDataLabels: boolean;
+            showMinorGridlines: boolean;
+        };
+        annotations: {
+            showAnnotations: boolean;
+            controlAnnotation: boolean;
+            annotationsData: import("../../helpers/chart-interface").IChartAnnotationsData[];
+        };
+        legend: {
+            display: boolean;
+            position: "top" | "bottom" | "right";
+            align: "start" | "center" | "end";
+            customLegend: import("../../helpers/chart-interface").ICustomLegend;
+        };
+        chartOptions: {
+            enableZoom: boolean;
+            enablePan: boolean;
+        };
+        interactions: {
+            onLegendClick: () => any;
+            onBarHover: any;
+            onBarUnhover: any;
+        };
+        dragData: {
+            enableDragData: any;
+            showTooltip: any;
+            roundPoints: any;
+            dragX: any;
+            dragY: any;
+            onDragStart: any;
+            onDrag: any;
+            onDragEnd: any;
+        };
+    };
+};

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

@@ -0,0 +1,3 @@
+import { IBarChartProps } from './bar-chart.interface';
+declare const BarChart: (props: IBarChartProps) => JSX.Element;
+export { BarChart };

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

@@ -0,0 +1,83 @@
+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;
+}
+export interface IBarChartAxes<PositionType> {
+    label: string;
+    position: PositionType;
+    color: string;
+    unit: string;
+}
+export interface IBarScales {
+    x: LinearScaleOptions;
+    y: LinearScaleOptions;
+}
+export interface IBarChartOptions {
+    title: string | string[];
+    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[];
+    borderRadius?: number;
+    borderWidth?: number;
+    yAxisID?: string;
+    stack?: number;
+    isAnnotation: boolean;
+    annotationIndex: number | string;
+    type: 'bar' | 'line';
+}
+export interface IBarChartData {
+    testId: string | null;
+    data: {
+        labels?: string[];
+        datasets: IBarChartDataset[];
+    } | any;
+    options: IBarChartOptions;
+}
+export interface IBarChartProps {
+    chart: IBarChartData;
+}

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

@@ -0,0 +1,16 @@
+import { IBarChartOptions } from './bar-chart.interface';
+/**
+ * @param {import('./bar-chart.interface').IBarChartOptions} options - bar chart options object
+ */
+declare const getBarChartDataLabels: (options: IBarChartOptions) => {
+    display: string;
+    align: "start" | "center" | "end";
+    anchor: "start" | "center" | "end";
+    formatter: (value: any, context: any) => string | number;
+} | {
+    display: boolean;
+    align?: undefined;
+    anchor?: undefined;
+    formatter?: undefined;
+};
+export default getBarChartDataLabels;

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

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

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

@@ -0,0 +1,15 @@
+/**
+ * @param {import('./bar-chart.interface').IBarChartOptions} options - bar chart options object
+ */
+declare const getBarChartToolTips: (options: any) => {
+    enabled: any;
+    mode: "nearest";
+    intersect: boolean;
+    padding: number;
+    callbacks: {
+        title: (tooltipItem: any, data: any) => string;
+        label: (tooltipItem: any) => string;
+        afterLabel: (tooltipItem: any) => string;
+    };
+};
+export default getBarChartToolTips;

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

@@ -0,0 +1,19 @@
+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/constants/default-translations.d.ts

@@ -0,0 +1,24 @@
+export declare const defaultTranslations: Readonly<{
+    label: "Label";
+    pointsLines: "Points & lines";
+    linesOnly: "Lines only";
+    pointsOnly: "Points only";
+    axesOptions: "Axes options";
+    resetAxes: "Reset Axes";
+    done: "Done";
+    downloadAsPNG: "Download as PNG";
+    showChart: "Show chart";
+    showTable: "Show table";
+    dragToZoom: "Drag to zoom";
+    dragToPan: "Drag to pan";
+    dragToMovePoints: "Drag to move points";
+    dragDisabled: "Drag disabled";
+    hideLegend: "Hide Legend";
+    showLegend: "Show Legend";
+    mustHaveAValue: "Must have a value";
+    mustBeANumber: "Must be a number";
+    mustBeLessThanMax: "Must be less than max";
+    mustBeGreaterThanMin: "Must be greater than min";
+    doubleClickToReset: "Double click on canvas to reset";
+    orDoubleClickToCanvas: "or double click on canvas";
+}>;

package/dist/src/components/line-chart/constants/line-chart-consts.d.ts

@@ -0,0 +1,12 @@
+export declare const DEFAULT_POINT_RADIUS = 2;
+export declare const DEFAULT_HOVER_RADIUS = 5;
+export declare const DEFAULT_BORDER_WIDTH = 1;
+export declare const BORDER_JOIN_STYLE = "round";
+export declare const DEFAULT_LINE_POINT_RADIUS = 0;
+export declare const DEFAULT_BACKGROUND_COLOR = "transparent";
+export declare const ZOOM_BOX_BACKGROUND_COLOR = "rgba(0, 0, 0, 0.1)";
+export declare const DOUBLE_CLICK = "dblclick";
+export declare const INIT_KEYS: {
+    TRANSLATIONS: string;
+    LANGUAGE_KEY: string;
+};

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

@@ -0,0 +1,5 @@
+export declare const actionTypes: Readonly<{
+    reset: "reset";
+    valueUpdated: "valueUpdated";
+    unitUpdated: "unitUpdated";
+}>;

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

@@ -0,0 +1,18 @@
+/**
+ * Initialize local component form state for a custom loads density table
+ *
+ * @param {Object} args
+ * @param {Object} args.initialAxesRanges
+ * @param {Array} [args.axes]
+ * @returns {Object} formState
+ */
+export declare const initializeFormState: ({ initialAxesRanges, axes }: any) => any;
+export declare const validateAxes: (formState: any) => any;
+/**
+ * Local component form state reducer for a axes options form
+ *
+ * @param {Object} state Local component form state
+ * @param {Action} action Action with type and payload
+ * @returns {Object} FormState
+ */
+export declare const reducer: (state: any, action: any) => any;

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

@@ -0,0 +1,34 @@
+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;
+}
+export interface IControls {
+    props: IControlsProps;
+    chartRef: any;
+    state: IControlsState;
+    options: IControlsOptions;
+    dispatch: () => any;
+    generatedDatasets: Array<object>;
+    translations: any;
+    controlsPortalId: any;
+}
+export {};

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

@@ -0,0 +1,2 @@
+declare const ControlsPortal: ({ children, controlsPortalId }: any) => any;
+export default ControlsPortal;

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

@@ -0,0 +1,6 @@
+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;
+export default Controls;

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

@@ -0,0 +1,11 @@
+export interface IDragOptions {
+    onTogglePan: () => any;
+    onToggleZoom: () => any;
+    panEnabled: boolean;
+    zoomEnabled: boolean;
+    enableDragPoints: boolean;
+    isDragDataAllowed: boolean;
+    onToggleDragPoints: () => any;
+    onDisableDragOptions: () => any;
+    translations: any;
+}

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

@@ -0,0 +1,5 @@
+import { IDragOptions } from './drag-options-interfaces';
+/**
+ * @param {import('./drag-options-interfaces').IDragOptions} obj
+ */
+export declare const DragOptions: ({ onTogglePan, onToggleZoom, panEnabled, zoomEnabled, enableDragPoints, isDragDataAllowed, onToggleDragPoints, onDisableDragOptions, translations: { dragToZoom, doubleClickToReset, dragToPan, orDoubleClickToCanvas, dragToMovePoints, dragDisabled, }, }: IDragOptions) => JSX.Element;

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

@@ -0,0 +1 @@
+export declare const LineOptions: ({ lineEnabled, onToggleLine, onTogglePoints, pointsEnabled, translations, }: any) => JSX.Element;

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

@@ -0,0 +1,13 @@
+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-functions.d.ts

@@ -0,0 +1,23 @@
+import { IHooksInterface } from './hooks.interface';
+/**
+ * Custom hook that encapsulates the chart-related functions and their dependencies
+ * @param {Object} chartRef - Chart reference
+ * @param {Object} state - The component state
+ * @param {Object} options - Chart options
+ * @param {Function} dispatch - Dispatch function from useReducer
+ * @param {Array} generatedDatasets - Chart datasets
+ * @returns {Object} An object containing the chart-related functions
+ */
+export declare const useChartFunctions: ({ chartRef, state, options, dispatch, generatedDatasets, }: IHooksInterface) => {
+    legendClick: (e: any, legendItem: any) => void;
+    resetZoom: () => void;
+    onHover: (hoveredPoint: any, setHoveredPoint: any) => (evt: Event, hoveredItems: Array<any>) => void;
+    handleDownload: () => void;
+    handleKeyDown: (evt: any) => void;
+    handleKeyUp: (evt: any) => void;
+    controlsAxes: any;
+    controlsAxesLabels: any[];
+    updateAxesRangesFromChart: () => void;
+    onResetAxes: () => void;
+    onUpdateAxes: ({ axes }: any) => void;
+};

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

@@ -0,0 +1,36 @@
+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: "nearest";
+        intersect: boolean;
+    };
+    elements: {
+        line: {
+            pointStyle: "circle";
+            showLine: any;
+        };
+    };
+    scales: any;
+    plugins: any;
+    events: readonly string[];
+};

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

@@ -0,0 +1,10 @@
+export declare const useToggleHandlers: (dispatch: any) => {
+    onToggleLegend: () => void;
+    onToggleLine: () => void;
+    onTogglePan: () => void;
+    onTogglePoints: () => void;
+    onToggleTable: () => void;
+    onToggleZoom: () => void;
+    onToggleDragPoints: () => void;
+    onDisableDragOptions: () => void;
+};

package/dist/src/components/line-chart/initialize/config.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Retrieve the value for the given key from the config object.
+ * @param {string} key - The key to access the corresponding value in the config object.
+ * @returns {*} - The value associated with the given key in the config object or config.
+ */
+export declare const getConfig: any;
+/**
+ * Set a new value for the given key in the config object.
+ * @param {string} key - The key to access the corresponding value in the config object.
+ * @param {*} newValue - The new value to be set for the given key.
+ */
+export declare const setConfig: (key: string, newValue: any) => void;

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

@@ -0,0 +1,12 @@
+/**
+ * Initialize the charts library with the provided configurations.
+ * This function will store the configuration options in a config object.
+ * @param {object} options - An object containing the configuration options for the library.
+ * @param {object} options.translations - The translations to be used in the library.
+ * @param {string} options.languageKey - The language key to be stored in the config object, used for translations.
+ * @param {...object} options - Any additional options to be stored in the config object.
+ */
+export declare const initializeLineChart: ({ languageKey, ...options }: {
+    [x: string]: any;
+    languageKey?: string | undefined;
+}) => void;

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

@@ -0,0 +1 @@
+export declare const LEGEND_MARGIN = 4;

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

@@ -0,0 +1,3 @@
+import { ILegendDropZones } from './legend-interface';
+declare const LegendDropZones: (legendDropZonesProps: ILegendDropZones) => JSX.Element;
+export default LegendDropZones;

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

@@ -0,0 +1,3 @@
+import { ILegendItem } from './legend-interface';
+declare const LegendItem: ({ hidden, dataset, handleClick }: ILegendItem) => JSX.Element;
+export default LegendItem;

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

@@ -0,0 +1,4 @@
+import React from 'react';
+import { ILegendPanel } from './legend-interface';
+declare const LegendPanel: React.ForwardRefExoticComponent<ILegendPanel & React.RefAttributes<unknown>>;
+export default LegendPanel;

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

@@ -0,0 +1,3 @@
+import { ILegend } from './legend-interface';
+declare const Legend: ({ chartRef, state, options, dispatch, generatedDatasets, }: ILegend) => JSX.Element | null;
+export default Legend;

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

@@ -0,0 +1,91 @@
+import { ILineChartProps } from './line-chart.interface';
+export declare const getDefaultProps: (props: ILineChartProps) => {
+    persistenceId: string;
+    controlsPortalId: string | null;
+    testId: string | null;
+    data: any;
+    options: {
+        title: string | string[];
+        scales: any;
+        axes: {
+            x: any;
+            y: any;
+        };
+        additionalAxesOptions: {
+            chartScaleType: any;
+            reverse: any;
+            beginAtZero: any;
+            stepSize: any;
+            suggestedMin: any;
+            suggestedMax: any;
+            range: any;
+            autoAxisPadding: any;
+        };
+        chartStyling: {
+            width: string | number;
+            height: string | number;
+            maintainAspectRatio: boolean;
+            staticChartHeight: boolean;
+            performanceMode: boolean;
+            squareAspectRatio: boolean;
+            layoutPadding: any;
+        };
+        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("../../helpers/chart-interface").IChartAnnotationsData[];
+        };
+        legend: {
+            display: boolean;
+            position: "top" | "bottom" | "right";
+            align: "start" | "center" | "end";
+            customLegend: import("../../helpers/chart-interface").ICustomLegend;
+            usePointStyle: boolean;
+        };
+        chartOptions: {
+            showPoints: boolean;
+            enableZoom: true;
+            enablePan: boolean;
+            showLine: boolean;
+            closeOnOutsideClick: boolean;
+        };
+        interactions: {
+            onLegendClick: () => any;
+            onPointHover: () => any;
+            onPointUnhover: () => any;
+            onAnimationComplete: () => any;
+        };
+        depthType: import("./line-chart.interface").IDepthType;
+        dragData: {
+            enableDragData: boolean;
+            showTooltip: true;
+            roundPoints: true;
+            dragX: true;
+            dragY: true;
+            onDragStart: () => any;
+            onDrag: () => any;
+            onDragEnd: () => any;
+        };
+    };
+};

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

@@ -0,0 +1,3 @@
+import { ILineChartProps } from './line-chart.interface';
+declare const LineChart: (props: ILineChartProps) => JSX.Element;
+export { LineChart };