@oliasoft-open-source/charts-library 5.9.0-beta-5 → 5.9.0-beta-7

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

@@ -1,227 +0,0 @@
-import { ChartEvent, ChartTypeRegistry, LinearScaleOptions, Plugin } from 'chart.js';
-import { LabelOptions } from 'chartjs-plugin-annotation';
-import { GradientDirection } from './plugins/gradient-background-plugin/enums';
-import { AnnotationType, DragAxis } from './plugins/annotation-dragger-plugin/enums';
-import { AlignOptions, Position } from './helpers/enums';
-import { IVerticalMarkersAnnotation } from '../line-chart/plugins/vertical-markers-plugin/types';
-export type TAxisPosition = 'top' | 'bottom' | 'left' | 'right';
-export interface ICommonDataValue {
-    x: number;
-    y: number;
-    label?: string;
-}
-export interface ICommonDataset {
-    label?: string;
-    borderColor?: string;
-    backgroundColor?: string | string[];
-    borderWidth?: number;
-    data: ICommonDataValue[];
-    hidden?: boolean;
-}
-export interface ICommonScales extends Partial<Record<string, LinearScaleOptions>> {
-    x: LinearScaleOptions;
-    y: LinearScaleOptions;
-}
-export interface ICommonAnnotationElement {
-    id?: string;
-    display: boolean;
-    annotationIndex: number;
-    label: {
-        options: LabelOptions;
-        content: string;
-    };
-    options: {
-        id?: string;
-        scaleID?: string;
-        borderColor?: string;
-        borderWidth?: number;
-        radius?: number;
-        label?: {
-            content?: string;
-            position?: string;
-            enabled?: boolean;
-            xAdjust?: number;
-        };
-    };
-}
-export interface ICoordinates {
-    x: number;
-    y: number;
-}
-export interface ICommonAnnotationsData {
-    display?: boolean;
-    hideLegend?: boolean;
-    labelOffsetPx?: number;
-    id?: string;
-    adjustScaleRange: boolean;
-    annotationAxis: 'x' | 'y';
-    rotation: number;
-    color: string;
-    endValue: number;
-    borderWidth?: number;
-    backgroundColor?: string;
-    label: string;
-    labelConfig?: Record<string, any>;
-    type: AnnotationType;
-    value: number;
-    xMin: number;
-    xMax: number;
-    yMin: number;
-    yMax: number;
-    xValue?: number;
-    yValue?: number;
-    radius?: number;
-    enableDrag?: boolean;
-    onDragStart?: (coordinates: ICoordinates, annotation: ICommonAnnotationsData) => void;
-    onDrag?: (coordinates: ICoordinates, annotation: ICommonAnnotationsData) => void;
-    onDragEnd?: (coordinates: ICoordinates, annotation: ICommonAnnotationsData) => void;
-    dragAxis?: DragAxis;
-    pointStyle?: string;
-    resizable?: boolean;
-    dragRange?: {
-        x?: [number, number];
-        y?: [number, number];
-    };
-    displayDragCoordinates?: boolean;
-    xScaleID?: string;
-    yScaleID?: string;
-    opacity?: number;
-}
-export interface ICommonGradientColor {
-    offset: number;
-    color: string;
-}
-export interface ICommonGradient {
-    display: boolean;
-    gradientColors?: ICommonGradientColor[];
-    direction?: GradientDirection;
-}
-export interface ICommonStyling {
-    width?: number | string;
-    height?: number | string;
-    maintainAspectRatio?: boolean;
-    staticChartHeight?: boolean;
-    performanceMode?: boolean;
-    gradient?: ICommonGradient;
-}
-export interface ICommonLegend {
-    display: boolean;
-    position: Position;
-    align: AlignOptions;
-}
-export interface ICommonTooltipCallbacks {
-    title?: () => void;
-    label?: () => void;
-    afterLabel?: () => void;
-}
-export interface ICommonTooltip {
-    tooltips: boolean;
-    showLabelsInTooltips: boolean;
-    scientificNotation: boolean;
-    callbacks?: ICommonTooltipCallbacks;
-}
-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;
-    enableDragAnnotation?: boolean;
-    enableCalloutAnnotation?: boolean;
-    verticalMarkersAnnotation?: IVerticalMarkersAnnotation;
-    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;
-    annotations?: ICommonAnnotations;
-    plugins?: {
-        verticalMarkersPlugin?: {
-            enabled?: boolean;
-        };
-    };
-}
-export interface ICommonData {
-    testId?: string;
-    data?: {
-        labels?: string[];
-        datasets?: ICommonDataset[];
-    };
-    options: ICommonOptions;
-}
-export interface ICommonHoveredItems {
-    index: number;
-    datasetIndex: number;
-}
-export interface ICommonChartPlugins {
-    legend: {
-        position: TAxisPosition;
-    };
-    title: {
-        display: boolean;
-        text: string;
-    };
-}
-export interface ICommonAxis<PositionType = any> {
-    label: string;
-    position: PositionType;
-    color: string | string[];
-    unit?: string;
-    gridLines?: boolean;
-    stepSize?: number;
-}
-export type UnusedParameter = unknown | any;
-export type TPrimitive = string | number | boolean | null;

package/dist/src/components/common/controls-portal.d.ts

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

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

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

package/dist/src/components/common/helpers/add-transparency/add-transparency.d.ts

@@ -1 +0,0 @@
-export declare function addTransparency(input: string, alpha: number, out?: 'rgb' | 'hex'): string;

package/dist/src/components/common/helpers/callout-helpers/callout-helpers.d.ts

@@ -1,7 +0,0 @@
-import { ICommonAnnotationsData } from '../../common.interface';
-type TCalloutCfg = NonNullable<NonNullable<ICommonAnnotationsData['labelConfig']>['callout']>;
-export declare const isCalloutOverlapping: (ctx: any, refAnnotation: ICommonAnnotationsData, index: number) => boolean;
-export declare const resolveCalloutXValue: (ctx: any, refAnnotation: ICommonAnnotationsData, calloutCfg: TCalloutCfg, index: number) => number | undefined;
-export declare const resolveCalloutYValue: (ctx: any, refAnnotation: ICommonAnnotationsData, calloutCfg: TCalloutCfg, index: number) => number | undefined;
-export declare const isCalloutAnchorInChartArea: (ctx: any, refAnnotation: ICommonAnnotationsData, margin?: number) => boolean;
-export {};

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

@@ -1,16 +0,0 @@
-import { Chart } from 'chart.js';
-import { UnusedParameter } from '../common.interface';
-interface IChartAreaBorderPluginOptions {
-    borderColor: string;
-    borderWidth: number;
-    borderDash: number[];
-    borderDashOffset?: number;
-}
-/**
- * Chart border plugin config
- */
-export declare const chartAreaBorderPlugin: {
-    id: string;
-    beforeDraw(chart: Chart, _: UnusedParameter, options: IChartAreaBorderPluginOptions): void;
-};
-export {};

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

@@ -1,39 +0,0 @@
-import { ICommonGradientColor } from '../common.interface';
-export declare const BORDER_WIDTH: {
-    ZERO: number;
-    INITIAL: number;
-    HOVERED: number;
-    POINT_HOVERED: number;
-};
-export declare const BORDER_COLOR = "rgba(0,0,0,0.1)";
-export declare const ANNOTATION_DASH: number[];
-export declare const DEFAULT_FONT_SIZE = 12;
-export declare const DEFAULT_FONT_FAMILY = "\"Roobert\", \"Noto Sans\", sans-serif";
-export declare const DEFAULT_COLOR = "hsl(60, 10.34482759%, 12.5%)";
-export declare const LEGEND_LABEL_BOX_SIZE = 12;
-export declare const TOOLTIP_PADDING = 8;
-export declare const TOOLTIP_BOX_PADDING = 4;
-export declare const TRANSPARENT = "transparent";
-export declare const LOGARITHMIC_STEPS: number[];
-export declare const COLORS: string[];
-/**
- * @type {string}
- * @desc equivalent of 0.6 rgba alpha chanel
- */
-export declare const ALPHA_CHANEL = "99";
-/**
- * @type {number}
- * @desc #FFFFFF as decimal number
- */
-export declare const WHITE_COLOR_AS_DECIMAL = 16777215;
-export declare const AUTO = "auto";
-export declare const ANIMATION_DURATION: {
-    NO: number;
-    SLOW: number;
-    FAST: number;
-};
-export declare const DEFAULT_CHART_NAME = "new_chart";
-export declare const CUSTOM_LEGEND_PLUGIN_NAME = "htmlLegend";
-export declare const DECIMAL_POINT_TOLERANCE = 9;
-export declare const MAX_DECIMAL_DIFF: number;
-export declare const GRADIENT_COLORS: ICommonGradientColor[];

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

@@ -1,86 +0,0 @@
-import { ChartTypeRegistry, LegendItem, Plugin } from 'chart.js';
-import { ICommonCustomLegend, UnusedParameter } from '../common.interface';
-import { Position } from './enums';
-export interface IChartGraph {
-    showMinorGridlines: boolean;
-}
-interface IOptions {
-    title?: string | string[];
-    legend?: {
-        position: Position;
-        display?: boolean;
-        align?: string;
-        usePointStyle?: boolean;
-    };
-}
-interface IStyling {
-    width?: string | number;
-    height?: string | number;
-    squareAspectRatio?: number | boolean;
-    maintainAspectRatio?: boolean;
-    staticChartHeight?: boolean;
-    performanceMode?: boolean;
-}
-interface IAxis {
-    label?: string;
-}
-interface ILegend {
-    customLegend?: ICommonCustomLegend<any>;
-}
-/**
- * @param { graph } graph - graph data from chart options
- * @param { legend } legend
- * @return {[]}
- */
-export declare const getPlugins: <T extends keyof ChartTypeRegistry>(graph: IChartGraph, legend: ILegend) => Plugin<T>[] | any;
-/**
- * @param {string[]} colors - color schema
- * @return {string} - random color
- */
-export declare const generateRandomColor: (colors: string[]) => string[];
-/**
- * @param {ICommonChartOptions} options - chart options object
- * @return {{color: (string|undefined), display: boolean, text}|{}}
- */
-export declare const getTitle: (options: IOptions) => {
-    display: boolean;
-    text: string | string[];
-} | {
-    display?: undefined;
-    text?: undefined;
-};
-/**
- * @function isVertical
- */
-export declare const isVertical: (direction: "vertical" | "horizontal") => direction is "vertical";
-/**
- * @param {'x'|'y'} axisType
- * @param {number} i - index
- * @return {'top'|'bottom'|'left'|'right'|*}
- */
-export declare const getAxisPosition: (axisType: string, i: number) => Position;
-/**
- * @param {chartStyling} chartStyling
- * @param {Object} styles - styles imported form .less file
- * @return {string} - class name
- */
-export declare const getClassName: (chartStyling: IStyling, styles: Record<string, string>) => string;
-export declare const getLegend: (options: IOptions, clickHandler: (_: UnusedParameter, legendItem: LegendItem) => void) => {
-    position: any;
-    display: boolean | undefined;
-    align: "center" | "start" | "end";
-    labels: {
-        boxHeight: number;
-        boxWidth: number | undefined;
-        usePointStyle: boolean | undefined;
-    };
-    onClick: (_: UnusedParameter, legendItem: LegendItem) => void;
-};
-export declare const afterLabelCallback: (tooltipItem: Record<string, any>) => string;
-export declare const getTooltipLabel: (tooltipItem: Record<string, any>, showLabelsInTooltips: boolean) => string;
-export declare const sanitize: (str: string) => string;
-export declare const getChartFileName: (axes?: IAxis[]) => string;
-export declare const setDefaultTheme: () => void;
-export declare const isNilOrEmpty: <T>(value: T | null | undefined) => boolean;
-export declare const isEmptyString: (value: string) => value is "";
-export {};

package/dist/src/components/common/helpers/container.d.ts

@@ -1,18 +0,0 @@
-import { CSSProperties, ReactNode } from 'react';
-interface ContainerProps {
-    style?: CSSProperties;
-    children: ReactNode;
-    margin?: boolean;
-    deprecatedMessage?: string;
-    warningMessage?: string;
-}
-export declare const Container: {
-    ({ style, children, margin, deprecatedMessage, warningMessage, }: ContainerProps): import("react/jsx-runtime").JSX.Element;
-    defaultProps: {
-        style: {};
-        margin: boolean;
-        deprecatedMessage: null;
-        warningMessage: null;
-    };
-};
-export {};

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

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

package/dist/src/components/common/helpers/download-pgn.d.ts

@@ -1,3 +0,0 @@
-import { RefObject } from 'react';
-import { Chart } from 'chart.js';
-export declare const downloadPgn: (chartRef: RefObject<Chart>) => void;

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

@@ -1,81 +0,0 @@
-export declare enum AxisType {
-    X = "x",
-    Y = "y"
-}
-export declare enum Position {
-    Bottom = "bottom",
-    Top = "top",
-    Left = "left",
-    Right = "right",
-    TopRight = "top-right",
-    TopLeft = "top-left",
-    BottomLeft = "bottom-left",
-    BottomRight = "bottom-right"
-}
-export declare enum ChartType {
-    Line = "line",
-    Bar = "bar"
-}
-export declare enum CursorStyle {
-    Pointer = "pointer",
-    Initial = "initial",
-    Grab = "grab",
-    Grabbing = "grabbing",
-    Crosshair = "crosshair",
-    Move = "move"
-}
-export declare enum ScaleType {
-    Category = "category",
-    Linear = "linear",
-    Logarithmic = "logarithmic"
-}
-export declare enum ChartDirection {
-    Vertical = "vertical"
-}
-export declare enum TooltipLabel {
-    Y = "yLabel",
-    X = "xLabel"
-}
-export declare enum AlignOptions {
-    End = "end",
-    Start = "start",
-    Center = "center",
-    Right = "right",
-    Left = "left"
-}
-export declare enum PointType {
-    Casing = "casing"
-}
-export declare enum AnnotationType {
-    Box = "box",
-    Ellipse = "ellipse",
-    Line = "line",
-    Text = "text",
-    Label = "label"
-}
-export declare enum PointStyle {
-    Circle = "circle",
-    Square = "rect",
-    Diamond = "rectRot",
-    Triangle = "triangle"
-}
-export declare enum ChartHoverMode {
-    Nearest = "nearest"
-}
-export declare enum PanZoomMode {
-    X = "x",
-    Y = "y",
-    XY = "xy",
-    Z = "z"
-}
-export declare enum Key {
-    Shift = "Shift"
-}
-export declare enum Events {
-    Mousemove = "mousemove",
-    Mouseout = "mouseout",
-    Click = "click",
-    Touchstart = "touchstart",
-    Touchmove = "touchmove",
-    Dblclick = "dblclick"
-}

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

@@ -1,136 +0,0 @@
-import { Chart } from 'chart.js';
-import { AnnotationType } from '../plugins/annotation-dragger-plugin/enums';
-import { Position } from './enums';
-import { ICommonAnnotationElement, ICommonAnnotationsData, ICoordinates } from '../common.interface';
-export interface IGetAnnotationsProps {
-    showAnnotations: boolean;
-    annotationsData: ICommonAnnotationsData[];
-}
-interface TChart extends Chart {
-    hoveredAnnotationId?: string | null;
-}
-export declare const generateAnn: (ann: ICommonAnnotationsData, index: number) => {
-    display: boolean | undefined;
-    annotationIndex: number;
-    id: string;
-    scaleID: "x" | "y";
-    label: {
-        backgroundColor: string;
-        content: string;
-        display: boolean;
-        position: Position;
-        color?: undefined;
-        font?: undefined;
-        borderWidth?: undefined;
-        padding?: undefined;
-        borderRadius?: undefined;
-        borderColor?: undefined;
-    } | {
-        backgroundColor: any;
-        content: string;
-        display: any;
-        position: any;
-        color: any;
-        font: any;
-        borderWidth: number;
-        padding: number;
-        borderRadius: number;
-        borderColor: any;
-    } | {
-        position: {
-            x: string;
-            y: string;
-        } | undefined;
-        content: string;
-        display: boolean;
-        font: {
-            weight: string;
-        };
-        backgroundColor?: undefined;
-        color?: undefined;
-        borderWidth?: undefined;
-        padding?: undefined;
-        borderRadius?: undefined;
-        borderColor?: undefined;
-    } | {
-        position: {
-            x: string;
-            y: string;
-        } | undefined;
-        content: string;
-        display: boolean;
-        font: {
-            weight: string;
-        };
-        backgroundColor?: undefined;
-        color?: undefined;
-        borderWidth?: undefined;
-        padding?: undefined;
-        borderRadius?: undefined;
-        borderColor?: undefined;
-    } | {
-        position: {
-            x: string;
-            y: string;
-        } | undefined;
-        content: string;
-        display: boolean;
-        font: {
-            weight: string;
-        };
-        backgroundColor?: undefined;
-        color?: undefined;
-        borderWidth?: undefined;
-        padding?: undefined;
-        borderRadius?: undefined;
-        borderColor?: undefined;
-    };
-    backgroundColor: string;
-    borderColor: string;
-    borderWidth: number;
-    borderDash: number[] | undefined;
-    type: AnnotationType;
-    adjustScaleRange: boolean;
-    enter: ({ element, }: {
-        element: ICommonAnnotationElement;
-    }, { chart, }: {
-        chart: TChart;
-    }) => void;
-    leave: ({ element, }: {
-        element: ICommonAnnotationElement;
-    }, { chart, }: {
-        chart: TChart;
-    }) => void;
-    onDragStart: () => (cord: ICoordinates, annotation: ICommonAnnotationsData) => void;
-    onDrag: () => (cord: ICoordinates, annotation: ICommonAnnotationsData) => void;
-    onDragEnd: () => (cord: ICoordinates, annotation: ICommonAnnotationsData) => void;
-    pointStyle: string;
-    resizable: boolean;
-    displayDragCoordinates: boolean;
-    hideLegend?: boolean;
-    labelOffsetPx?: number;
-    annotationAxis: "x" | "y";
-    rotation: number;
-    color: string;
-    endValue: number;
-    labelConfig?: Record<string, any>;
-    value: number;
-    xMin: number;
-    xMax: number;
-    yMin: number;
-    yMax: number;
-    xValue?: number;
-    yValue?: number;
-    radius?: number;
-    enableDrag?: boolean;
-    dragAxis?: import('../plugins/annotation-dragger-plugin/enums').DragAxis;
-    dragRange?: {
-        x?: [number, number];
-        y?: [number, number];
-    };
-    xScaleID?: string;
-    yScaleID?: string;
-    opacity?: number;
-};
-export declare const getAnnotation: ({ showAnnotations, annotationsData, }: IGetAnnotationsProps) => any[];
-export {};

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

@@ -1 +0,0 @@
-export declare const getChartFromCtx: (ctx: any) => any;

package/dist/src/components/common/helpers/get-custom-legend-plugin-example.d.ts

@@ -1,8 +0,0 @@
-import { Chart, ChartConfiguration, Plugin } from 'chart.js';
-/**
- * Gets an example custom legend plugin for use in storybook.
- * @param {string} customLegendContainerID - the id of the div container to put the generated legend in
- */
-export declare const getCustomLegendPlugin: (customLegendContainerID: string) => {
-    afterUpdate(chart: Chart, _args: Plugin, _options: ChartConfiguration): void;
-};

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

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

package/dist/src/components/common/helpers/get-grouped-color-scheme/get-grouped-color-scheme.d.ts

@@ -1 +0,0 @@
-export declare const getGroupedColorScheme: (length: number, startingColor: string) => string[];

package/dist/src/components/common/helpers/range/estimate-data-series-have-close-values.d.ts

@@ -1,8 +0,0 @@
-import { TGeneratedLineChartDatasets } from '../../../line-chart/line-chart.interface';
-/**
- * Estimates whether any of the data series has values that are all close together
- * - checks only the first and last values in each series (i.e. assumes they are ordered)
- * - uses an equality check with tolerance for decimal precision noise
- * - this is just an inexpensive "guesstimate" (full min/max detection can be used afterwards)
- */
-export declare const estimateDataSeriesHaveCloseValues: (generatedDatasets: TGeneratedLineChartDatasets) => boolean;