@oliasoft-open-source/charts-library 5.0.0-beta-2 → 5.0.0

package/dist/line-chart/line-chart.test-case.stories.d.ts

@@ -0,0 +1,29 @@
+import { LineChart } from './line-chart';
+declare namespace _default {
+    export let title: string;
+    export { LineChart as component };
+    export namespace args {
+        export { basicChart as chart };
+    }
+}
+export default _default;
+export function TestLegendDropzoneResizing(): import("react/jsx-runtime").JSX.Element;
+export function PartialRangeWithSimilarValues(): import("react/jsx-runtime").JSX.Element;
+declare namespace basicChart {
+    namespace data {
+        let datasets: {
+            label: string;
+            data: {
+                x: number;
+                y: number;
+            }[];
+        }[];
+    }
+    namespace options {
+        let title_1: string;
+        export { title_1 as title };
+        export namespace chartStyling {
+            let height: string;
+        }
+    }
+}

package/dist/line-chart/plugins/chart-area-text-plugin.d.ts

@@ -0,0 +1,17 @@
+import { Chart, ChartConfiguration, Plugin } from 'chart.js';
+import { Position } from '../../common/helpers/enums';
+interface CustomChartConfiguration extends ChartConfiguration {
+    showLabel?: boolean;
+    text: string;
+    fontSize: number;
+    xOffset: number;
+    yOffset: number;
+    lineHeight: number;
+    maxWidth: number;
+    position: Position;
+}
+export declare const chartAreaTextPlugin: {
+    id: string;
+    beforeDraw: (chart: Chart, _args: Plugin, options: CustomChartConfiguration) => void;
+};
+export {};

package/dist/line-chart/plugins/line-chart.minor-gridlines-plugin.d.ts

@@ -0,0 +1,8 @@
+import { Chart, Scale } from 'chart.js';
+export declare const getLargestMajorTickWidth: (majorTickPositions: number[]) => number;
+export declare const isValidPosition: (minorTickPosition: number, majorTickPositions: number[], scale: Scale) => boolean;
+export declare const getMinorTickPositions: (majorTickPositions: number[], scale: Scale) => number[];
+export declare const chartMinorGridlinesPlugin: {
+    id: string;
+    beforeDatasetsDraw: (chart: Chart) => void;
+};

package/dist/line-chart/plugins/line-chart.minor-gridlines-plugin.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/plugins/plugin-constants.d.ts

@@ -0,0 +1,11 @@
+export declare const TextLabelPosition: {
+    TOP_LEFT: string;
+    TOP_CENTER: string;
+    TOP_RIGHT: string;
+    MIDDLE_LEFT: string;
+    MIDDLE_CENTER: string;
+    MIDDLE_RIGHT: string;
+    BOTTOM_LEFT: string;
+    BOTTOM_CENTER: string;
+    BOTTOM_RIGHT: string;
+};

package/dist/line-chart/plugins/plugins.interface.d.ts

@@ -0,0 +1,9 @@
+import { Position } from '../../common/helpers/enums';
+export interface IDrawText {
+    ctx: CanvasRenderingContext2D;
+    lines: Array<string>;
+    lineHeight: number;
+    x: number;
+    y: number;
+    position: Position;
+}

package/dist/line-chart/state/action-types.d.ts

@@ -0,0 +1,12 @@
+export declare const TOGGLE_ZOOM = "TOGGLE_ZOOM";
+export declare const TOGGLE_PAN = "TOGGLE_PAN";
+export declare const TOGGLE_POINTS = "TOGGLE_POINTS";
+export declare const TOGGLE_LINE = "TOGGLE_LINE";
+export declare const TOGGLE_LEGEND = "TOGGLE_LEGEND";
+export declare const TOGGLE_TABLE = "TOGGLE_TABLE";
+export declare const SAVE_INITIAL_AXES_RANGES = "SAVE_INITIAL_AXES_RANGES";
+export declare const RESET_AXES_RANGES = "RESET_AXES_RANGES";
+export declare const UPDATE_AXES_RANGES = "UPDATE_AXES_RANGES";
+export declare const TOGGLE_DRAG_POINTS = "TOGGLE_DRAG_POINTS";
+export declare const TOGGLE_DRAG_ANNOTATION = "TOGGLE_DRAG_ANNOTATION";
+export declare const DISABLE_DRAG_OPTIONS = "DISABLE_DRAG_OPTIONS";

package/dist/line-chart/state/initial-state.d.ts

@@ -0,0 +1,14 @@
+import { IState } from './state.interfaces';
+import { ILineChartOptions } from '../line-chart.interface';
+interface inputInitState {
+    options: ILineChartOptions;
+    persistenceId?: string;
+}
+/**
+ Initial chart state for the line chart.
+
+ @param {Object} options - The chart options.
+ @return {Object} The initial chart state.
+ */
+declare const initialState: ({ options, persistenceId }: inputInitState) => IState;
+export default initialState;

package/dist/line-chart/state/line-chart-reducer.d.ts

@@ -0,0 +1,2 @@
+import { IAction, IState } from './state.interfaces';
+export declare const reducer: (state: IState, action: IAction) => IState;

package/dist/line-chart/state/manage-state-in-local-storage.d.ts

@@ -0,0 +1,15 @@
+import { IState } from './state.interfaces';
+/**
+ * Retrieves the chart state from local storage.
+ *
+ * @param {string|''} persistenceId - The chart persistenceId.
+ * @returns {object|null} The chart state object or null if not found.
+ */
+export declare const getChartStateFromStorage: (persistenceId?: string) => any;
+/**
+ * Stores the chart state in local storage.
+ *
+ * @param {object} state - The chart state object to store.
+ * @param {string|''} persistenceId - The chart persistenceId.
+ */
+export declare const storeChartStateInStorage: (state: IState, persistenceId?: string) => void;

package/dist/line-chart/state/state.interfaces.d.ts

@@ -0,0 +1,34 @@
+import { IUnitOptions } from '../line-chart.interface';
+export interface IAxisState {
+    id?: string;
+    label?: string;
+    min?: number;
+    max?: number;
+    unit?: IUnitOptions | string;
+    axisType?: string;
+}
+export interface InitialState {
+    zoomEnabled: boolean;
+    panEnabled: boolean;
+    pointsEnabled: boolean;
+    lineEnabled: boolean;
+    legendEnabled: boolean;
+    axes: IAxisState[];
+    showAnnotationLineIndex?: number[];
+    showTable: boolean;
+    enableDragPoints: boolean;
+    enableDragAnnotation: boolean;
+}
+export interface IInitAxisRange {
+    id: string;
+    min: number;
+    max: number;
+    unit?: string;
+}
+export interface IState extends InitialState {
+    initialAxesRanges: IInitAxisRange[];
+}
+export interface IAction<T = string, P = any> {
+    type: T;
+    payload?: P;
+}

package/dist/line-chart/utils/__tests__/get-annotations-data.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/__tests__/get-axes-data-from-metasets.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/__tests__/get-axes-type-from-key.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/__tests__/get-axis-range-by-type.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/__tests__/get-line-chart-tooltips.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/axis-formatting/axis-formatting.d.ts

@@ -0,0 +1,2 @@
+import { Tick } from 'chart.js';
+export declare const formatAxisLabelNumbers: (tickValue: string | number, ticks: Tick[]) => string;

package/dist/line-chart/utils/axis-formatting/axis-formatting.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/axis-scales/axis-scales.d.ts

@@ -0,0 +1,11 @@
+import { RefObject } from 'react';
+import { Chart } from 'chart.js';
+import { ILineChartOptions, TGeneratedLineChartDatasets } from '../../line-chart.interface';
+import { IState } from '../../state/state.interfaces';
+/**
+ * Auto scales axis ranges (mix, max) if no explicit range is set
+ * - overrides some edge cases not handled well by default chart.js
+ * - supports optional padding when `autoAxisPadding` is set
+ * - otherwise does not set min/max (falls back to chart.js default)
+ */
+export declare const autoScale: (options: ILineChartOptions, state: IState, generatedDatasets: TGeneratedLineChartDatasets, chartRef: RefObject<Chart>) => {};

package/dist/line-chart/utils/axis-scales/axis-scales.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/check-custom-option/check-custom-option.d.ts

@@ -0,0 +1,12 @@
+import { IGeneratedLineChartDataset, TGeneratedLineChartDatasets } from '../../line-chart.interface';
+type TCustomOptionType = {
+    [key: string]: string;
+} | string | string[];
+type TDataType = IGeneratedLineChartDataset | Partial<IGeneratedLineChartDataset> | TGeneratedLineChartDatasets | Partial<TGeneratedLineChartDatasets> | any[];
+/**
+ * Checks if a single dataset or an array of datasets has a custom option.
+ * Iterates through each custom option defined in the customOptions parameter.
+ * Returns true if any dataset has any custom option, otherwise returns false.
+ */
+export declare const checkCustomOption: (data: TDataType, customOptions: TCustomOptionType) => boolean;
+export {};

package/dist/line-chart/utils/check-custom-option/check-custom-option.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/datalabels-alignment/__tests__/get-alignment-condition.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/datalabels-alignment/__tests__/get-alignment-data.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/datalabels-alignment/__tests__/get-datalabels-position.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/line-chart/utils/datalabels-alignment/datalabels-alignment.interface.d.ts

@@ -0,0 +1,20 @@
+interface IChartArea {
+    left: number | null;
+    right: number | null;
+    bottom: number | null;
+}
+interface IChartMeta {
+    data: Array<{
+        x: number | null;
+        y: number | null;
+    }>;
+}
+export interface IAlignmentContext {
+    chart: {
+        chartArea: IChartArea;
+        getDatasetMeta: (datasetIndex: number) => IChartMeta;
+    };
+    dataIndex: number;
+    datasetIndex: number;
+}
+export {};

package/dist/line-chart/utils/datalabels-alignment/get-alignment-condition.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Returning boolean condition depends on label position and chart area
+ */
+export declare const getCondition: (x: number | null, y: number | null, left: number | null, right: number | null, bottom: number | null) => {
+    overLeftSide: boolean;
+    overRightSide: boolean;
+    overBottomSide: boolean;
+};

package/dist/line-chart/utils/datalabels-alignment/get-alignment-data.d.ts

@@ -0,0 +1,11 @@
+import { IAlignmentContext } from './datalabels-alignment.interface';
+/**
+ * Returning destructured data from context
+ */
+export declare const getAlignmentData: (context: IAlignmentContext) => {
+    x: number | null;
+    y: number | null;
+    left: number | null;
+    right: number | null;
+    bottom: number | null;
+};

package/dist/line-chart/utils/datalabels-alignment/get-datalabels-position.d.ts

@@ -0,0 +1,6 @@
+import { AlignOptions } from '../../../common/helpers/enums';
+import { IAlignmentContext } from './datalabels-alignment.interface.ts';
+/**
+ * Returning position depends on condition
+ */
+export declare const getPosition: () => (context: IAlignmentContext) => AlignOptions.End | AlignOptions.Start | AlignOptions.Right | AlignOptions.Left;

package/dist/line-chart/utils/enums.d.ts

@@ -0,0 +1,4 @@
+export declare enum CUSTOM_OPTION {
+    showLine = "showLine",
+    showPoints = "showPoints"
+}

package/dist/line-chart/utils/generate-line-chart-datasets.d.ts

@@ -0,0 +1,8 @@
+import { IState } from '../state/state.interfaces';
+import { ILineChartOptions, TGeneratedLineChartDatasets } from '../line-chart.interface';
+/**
+ * Generates line chart datasets based on the provided datasets, state, and options.
+ */
+export declare const generateLineChartDatasets: (datasets: Array<any>, state: IState, options: ILineChartOptions, { label }: {
+    label: string;
+}) => TGeneratedLineChartDatasets;

package/dist/line-chart/utils/get-annotations-data.d.ts

@@ -0,0 +1 @@
+export function getAnnotationsData(data: any[]): Object;

package/dist/line-chart/utils/get-axes-data-from-metasets.d.ts

@@ -0,0 +1 @@
+export function getAxesDataFromMetasets(chartRef: Object, scalesKeys: any[], annotationsData: Object): Object;

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

@@ -0,0 +1,9 @@
+import { Chart } from 'chart.js';
+import { RefObject } from 'react';
+import { ILineChartAxes } from '../line-chart.interface';
+export declare const getAxesRangesFromChart: (chartRef: RefObject<Chart>, axes: ILineChartAxes) => {
+    unit?: import('../line-chart.interface').IUnitOptions | undefined;
+    id: string;
+    min: number;
+    max: number;
+}[];

package/dist/line-chart/utils/get-axis-range-by-type.d.ts

@@ -0,0 +1,10 @@
+import { RefObject } from 'react';
+import { Chart } from 'chart.js';
+import { ICommonAnnotationsData } from '../../common/common.interface.ts';
+export type TAxisType = 'x' | 'y' | 'x1' | 'y1';
+interface IMinMax {
+    min: number;
+    max: number;
+}
+export declare const getAxisRangeByType: (chartRef: RefObject<Chart>, axesType: TAxisType, annotationsData: ICommonAnnotationsData[]) => IMinMax | null;
+export {};

package/dist/line-chart/utils/get-generated-labels.d.ts

@@ -0,0 +1,2 @@
+import { Chart, LegendItem } from 'chart.js';
+export declare const getGeneratedLabels: (chart: Chart) => LegendItem[];

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

@@ -0,0 +1,19 @@
+import { TooltipItem } from 'chart.js';
+import { ILineChartOptions } from '../line-chart.interface';
+import { UnusedParameter } from '../../common/common.interface';
+/**
+ * adjusts the position of the label depends on chart area
+ *
+ * @param {import('../line-chart.interface').ILineChartOptions} options - line chart options object
+ * @return {object} - returning position, if label exist in datasets item
+ */
+declare const getLineChartDataLabels: (options: ILineChartOptions) => {
+    display: string;
+    align: (context: import('./datalabels-alignment/datalabels-alignment.interface').IAlignmentContext) => 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: (_: UnusedParameter, context: TooltipItem<any>) => any;
+} | {
+    display: boolean;
+    align?: undefined;
+    formatter?: undefined;
+};
+export default getLineChartDataLabels;

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

@@ -0,0 +1,4 @@
+import { IState } from '../state/state.interfaces';
+import { ILineChartOptions } from '../line-chart.interface';
+declare const getLineChartScales: (options: ILineChartOptions, state: IState) => {};
+export default getLineChartScales;

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

@@ -0,0 +1,20 @@
+import { TooltipItem } from 'chart.js';
+import { ChartHoverMode } from '../../common/helpers/enums';
+import { ILineChartOptions } from '../line-chart.interface';
+export declare const getUnitsFromLabel: (label: string) => string;
+declare const getLineChartToolTips: (options: ILineChartOptions) => {
+    enabled: boolean;
+    mode: ChartHoverMode;
+    intersect: boolean;
+    padding: number;
+    usePointStyle: boolean;
+    boxWidth: number;
+    boxHeight: number;
+    boxPadding: number;
+    callbacks: {
+        title: (tooltipItem: TooltipItem<any>[]) => string;
+        label: (tooltipItem: TooltipItem<any>) => string;
+        afterLabel: (tooltipItem: Record<string, any>) => string;
+    };
+};
+export default getLineChartToolTips;

package/dist/line-chart/utils/line-chart-utils.d.ts

@@ -0,0 +1,32 @@
+import { ILineRange } from '../line-chart.interface';
+import { TPrimitive } from '../../common/common.interface';
+export declare const toNum: (value: string | number) => any;
+export declare const isLessThanMax: (value: string | number, max: string | number) => boolean;
+export declare const isGreaterThanMin: (value: string | number, min: string | number) => boolean;
+/**
+ *
+ * @param {'x'|'y'} axisType
+ * @param {number} [index] - axis index; optional, 0 by default
+ * @param {boolean} [hasMultiAxes] - optional, false by default
+ * @return {string} - e.g. x if chart has singular axes; x, x2 - in case of multiple axes
+ */
+export declare const generateAxisId: (axisType: string, index?: number, hasMultiAxes?: boolean) => string;
+/**
+ Get axis type from a key string.
+ @param {string} string - The key string to extract from.
+ @returns {string} e.g. x1 => x
+ */
+export declare const getAxisTypeFromKey: (string: string) => string;
+/**
+ * Generates a key based on an array of values. The key changes
+ * if any of the values in the array change.
+ */
+export declare const generateKey: (values: Array<any>) => string;
+/**
+ * Checks if a value is a primitive value (which includes strings, numbers, booleans, and null).
+ */
+export declare const isPrimitiveValue: (value: TPrimitive) => value is string | number | boolean | null;
+/**
+ * Validates a range object to ensure none of its properties are null, undefined, or empty strings.
+ */
+export declare const isRangeValid: (r?: ILineRange) => boolean;

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

@@ -0,0 +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?: Partial<Record<keyof typeof defaultTranslations, string>>) => {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,50 @@
+import { ChartEvent } from 'chart.js';
+import { ICommonTooltip } from '../common/common.interface';
+import { IPieChartDataset, IPieOptions } from './pie-chart.interface';
+import { AlignOptions, Position } from '../common/helpers/enums';
+export interface IDefaultChartStyling {
+    width?: number | string;
+    height?: number | string;
+    maintainAspectRatio: boolean;
+    staticChartHeight: boolean;
+    performanceMode: boolean;
+}
+interface IDefaultPieGraph {
+    showDataLabels: boolean;
+    stacked: boolean;
+    cutout: number | string;
+}
+interface IDefaultPieLegend {
+    display: boolean;
+    useDataset: boolean;
+    position: Position;
+    align: AlignOptions;
+}
+interface IDefaultChartOptions {
+    enableZoom: boolean;
+    enablePan: boolean;
+}
+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?: IPieChartDataset[]) => void;
+}
+interface IDefaultChartData {
+    labels: string[];
+    datasets: IPieChartDataset[];
+}
+interface IDefaultPieOptions extends IPieOptions {
+    title: string | string[];
+    chartStyling: IDefaultChartStyling;
+    tooltip: ICommonTooltip;
+    graph: IDefaultPieGraph;
+    legend: IDefaultPieLegend;
+    chartOptions: IDefaultChartOptions;
+    interactions: IDefaultInteractions;
+}
+export interface IPieChartDefaultProps {
+    testId: string | null;
+    data: IDefaultChartData;
+    options: IDefaultPieOptions;
+}
+export {};

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

@@ -0,0 +1,3 @@
+import { IPieChartProps } from './pie-chart.interface';
+import { IPieChartDefaultProps } from './pie-chart-defalut-props.interface';
+export declare const getDefaultProps: (props: IPieChartProps) => IPieChartDefaultProps;

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

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

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

@@ -0,0 +1,70 @@
+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: IPieChartData;
+    testId?: string | null;
+}
+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;
+}
+export interface IGeneratedPieChartDataset {
+    label: string;
+    backgroundColor: string[];
+    borderColor: string;
+    borderWidth: number;
+    borderDash: number[];
+    annotationType?: string;
+    data: IPieDataValue[];
+    hideLegend?: boolean;
+    displayGroup?: string | number;
+    isAnnotation?: boolean;
+    annotationIndex?: number;
+}
+export type TGeneratedPieChartDatasets = IGeneratedPieChartDataset[];