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

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

@@ -1,55 +1,54 @@
-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 IChartInteractions {
+    onLegendClick: (legendItem: string, hidden: boolean) => any;
+    onPointHover: () => any;
+    onPointUnhover: () => any;
+    onPieHover: (evt: Event, datasetIndex: string | number, index: string | number, generatedDataset: any) => any;
+    onPieUnhover: (evt: Event) => any;
+}
+export interface IChartOptions {
+    enableZoom: boolean;
+    enablePan: boolean;
+}
+export interface IChartLegend {
+    display: boolean;
+    position: 'top' | 'bottom' | 'right';
+    align: 'start' | 'center' | 'end';
+    useDataset: boolean;
+}
+export interface IChartGraph {
+    showDataLabels: boolean;
+    stacked: boolean;
+    cutout: number | string;
+}
+export interface IChartTooltip {
+    tooltips: boolean;
+    showLabelsInTooltips: boolean;
+}
+export interface IChartStyling {
+    width: number | string;
+    height: number | string;
+    maintainAspectRatio: boolean;
+    staticChartHeight: boolean;
+    performanceMode: boolean;
+}
+export interface IOptions {
+    title: string | string[];
+    chartStyling: IChartStyling;
+    tooltip: IChartTooltip;
+    graph: IChartGraph;
+    legend: IChartLegend;
+    chartOptions: IChartOptions;
+    interactions: IChartInteractions;
+}
+export interface IChartData {
+    labels: string;
+    datasets: any[];
+}
+export interface IChartProps {
+    testId: string | null;
+    data: IChartData;
+    options: IOptions;
 }
 export interface IPieChartProps {
-    chart: IPieChartData;
-}
-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;
+    chart: IChartProps;
 }

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

@@ -1,7 +1,7 @@
 import { IScatterChartProps } from './scatter-chart.intefrace';
 /**
  *
- * @param {IScatterChartProps} props
+ * @param {import('./scatter-chart.intefrace').IScatterChartProps} props
  */
 declare const ScatterChart: (props: IScatterChartProps) => JSX.Element;
 export default ScatterChart;

package/dist/src/components/scatter-chart/scatter-chart.intefrace.d.ts

@@ -1,13 +1,23 @@
-import { ICommonChartPlugins, ICommonData, ICommonDataset, ICommonOptions } from '../common/common.interface';
-export interface IScatterChartOptions extends Partial<ICommonOptions> {
+import { IChartPlugins } from '../../helpers/chart-interface';
+export interface IScatterChartOptions {
     responsive: boolean;
     maintainAspectRatio: boolean;
-    plugins: ICommonChartPlugins;
+    plugins: IChartPlugins;
 }
-export interface IScatterChartDataset extends ICommonDataset {
-    showLine: boolean;
+export interface IScatterChartPoint {
+    x: number | string;
+    y: number | string;
+    label?: string;
 }
-export interface IScatterChartData extends ICommonData {
+export interface IScatterChartDataset {
+    label: string;
+    data: IScatterChartPoint[];
+    borderColor: string;
+    backgroundColor: string;
+    showLine: Boolean;
+}
+export interface IScatterChartData {
+    testId: string | null;
     data: {
         datasets: IScatterChartDataset[];
     };

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

@@ -0,0 +1,7 @@
+/**
+ * Chart border plugin config
+ */
+export declare const chartAreaBorderPlugin: {
+    id: string;
+    beforeDraw(chart: any, args: any, options: any): void;
+};

package/dist/src/helpers/chart-interface.d.ts

@@ -0,0 +1,85 @@
+import { Plugin } from 'chart.js';
+export interface IChartDraggableData {
+    enableDragData: boolean;
+    showTooltip: boolean;
+    roundPoints: boolean;
+    dragX: boolean;
+    dragY: boolean;
+    onDragStart: () => any;
+    onDrag: () => any;
+    onDragEnd: () => any;
+}
+export interface IChartAnnotationsData {
+    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 ILabelAnnotation {
+    showLabel: boolean;
+    text: string | string[];
+    position?: string;
+    fontSize?: number;
+    xOffset?: number;
+    yOffset?: number;
+    maxWidth?: number;
+    lineHeight?: number;
+}
+export interface IChartAnnotations {
+    showAnnotations: boolean;
+    controlAnnotation: boolean;
+    annotationsData: IChartAnnotationsData[];
+    labelAnnotation: ILabelAnnotation;
+}
+export interface IChartStyling {
+    width: number | string;
+    height: number | string;
+    maintainAspectRatio: boolean;
+    squareAspectRatio?: boolean;
+    staticChartHeight: boolean;
+    performanceMode: boolean;
+    layoutPadding: any;
+}
+export interface ICustomLegend {
+    customLegendPlugin: Plugin | null;
+    customLegendContainerID: string;
+}
+export interface IChartLegend {
+    display: boolean;
+    position: 'top' | 'bottom' | 'right';
+    align: 'start' | 'center' | 'end';
+    customLegend?: ICustomLegend;
+    usePointStyle: boolean;
+}
+export interface IChartInteractions {
+    onLegendClick: () => any;
+    onPointHover: () => any;
+    onPointUnhover: () => any;
+    onAnimationComplete: () => any;
+}
+export interface IInitialState {
+    zoomEnabled?: boolean;
+    panEnabled?: boolean;
+    pointsEnabled?: boolean;
+    lineEnabled?: boolean;
+    legendEnabled?: boolean;
+    axes?: any;
+    showAnnotationLineIndex: [];
+    enableDragData?: boolean;
+}
+export interface IChartPlugins {
+    legend: {
+        position: 'top' | 'right' | 'bottom' | 'left';
+    };
+    title: {
+        display: boolean;
+        text: string;
+    };
+}

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

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

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

@@ -0,0 +1,12 @@
+import { ILineChartOptions } from '../components/line-chart/line-chart.interface';
+import { IInitialState } from './chart-interface';
+/**
+ * @param {import('../components/bar-chart/bar-chart.interface').IBarChartOptions |
+ * import('../components/line-chart/line-chart.interface').ILineChartOptions} options - chart options object
+ * @param {import('./chart-interface').IInitialState} state - chart state object controlled by useReducer or similar
+ * @return {{annotations: []}}
+ */
+declare const getAnnotation: (options: ILineChartOptions, state: IInitialState) => {
+    annotations: {} | null;
+};
+export default getAnnotation;

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

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

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

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

package/package.json

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

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

@@ -1,139 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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/components/common/helpers/get-chart-annotation.d.ts

@@ -1,27 +0,0 @@
-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

@@ -1,18 +0,0 @@
-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/components/line-chart/controls/axes-options/axes-options-interfaces.d.ts

@@ -1,52 +0,0 @@
-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 {};