@react-magma/charts 13.0.0 → 13.0.1

package/dist/components/CarbonChart/CarbonChartLollipop.stories.d.ts

@@ -0,0 +1,55 @@
+import { CarbonChartProps, CarbonChartType } from '.';
+declare const _default: import("@storybook/csf").ComponentAnnotations<import("@storybook/react/types-6-0").ReactFramework, import("@storybook/react/types-6-0").Args>;
+export default _default;
+export declare const LollipopDiscrete: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            key: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    title: string;
+                    scaleType: string;
+                    mapsTo: string;
+                };
+                left: {
+                    mapsTo: string;
+                };
+            };
+            height: string;
+        };
+    };
+};
+export declare const LollipopHorizontalPresentation: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            key: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            axes: {
+                left: {
+                    title: string;
+                    scaleType: string;
+                    mapsTo: string;
+                };
+                bottom: {
+                    mapsTo: string;
+                };
+            };
+            height: string;
+        };
+    };
+};

package/dist/components/CarbonChart/CarbonChartMeter.stories.d.ts

@@ -0,0 +1,127 @@
+import { CarbonChartProps, CarbonChartType } from '.';
+declare const _default: import("@storybook/csf").ComponentAnnotations<import("@storybook/react/types-6-0").ReactFramework, import("@storybook/react/types-6-0").Args>;
+export default _default;
+export declare const MeterChartWithStatuses: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            meter: {
+                peak: number;
+                status: {
+                    ranges: {
+                        range: number[];
+                        status: string;
+                    }[];
+                };
+            };
+            height: string;
+        };
+    };
+};
+export declare const MeterChartNoStatus: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            meter: {
+                peak: number;
+            };
+            height: string;
+        };
+    };
+};
+export declare const ProportionalMeterChart: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            height: string;
+            meter: {
+                proportional: {
+                    total: number;
+                    unit: string;
+                };
+            };
+            color: {
+                pairing: {
+                    option: number;
+                };
+            };
+        };
+    };
+};
+export declare const ProportionalMeterChartPeakAndStatuses: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            height: string;
+            meter: {
+                peak: number;
+                proportional: {
+                    total: number;
+                    unit: string;
+                };
+                status: {
+                    ranges: {
+                        range: number[];
+                        status: string;
+                    }[];
+                };
+            };
+            color: {
+                pairing: {
+                    option: number;
+                };
+            };
+        };
+    };
+};
+export declare const ProportionalMeterChartTruncated: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            height: string;
+            meter: {
+                proportional: {
+                    total: number;
+                    unit: string;
+                    totalFormatter: (e: any) => string;
+                    breakdownFormatter: (e: any) => string;
+                };
+            };
+        };
+    };
+};

package/dist/components/CarbonChart/CarbonChartPie.stories.d.ts

@@ -0,0 +1,101 @@
+import { CarbonChartProps, CarbonChartType } from '.';
+declare const _default: import("@storybook/csf").ComponentAnnotations<import("@storybook/react/types-6-0").ReactFramework, import("@storybook/react/types-6-0").Args>;
+export default _default;
+export declare const Pie: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            resizable: boolean;
+            height: string;
+            legend: {
+                truncation: {
+                    type: string;
+                };
+            };
+        };
+    };
+};
+export declare const PieCentered: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            resizable: boolean;
+            pie: {
+                alignment: string;
+            };
+            height: string;
+            legend: {
+                truncation: {
+                    type: string;
+                };
+            };
+        };
+    };
+};
+export declare const PieValueMapsToCount: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            count: number;
+        }[];
+        options: {
+            title: string;
+            resizable: boolean;
+            pie: {
+                valueMapsTo: string;
+            };
+            height: string;
+            legend: {
+                truncation: {
+                    type: string;
+                };
+            };
+        };
+    };
+};
+export declare const PieEmptyState: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: never[];
+        options: {
+            title: string;
+            resizable: boolean;
+            height: string;
+        };
+    };
+};
+export declare const PieSkeleton: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: never[];
+        options: {
+            title: string;
+            resizable: boolean;
+            data: {
+                loading: boolean;
+            };
+            height: string;
+        };
+    };
+};

package/dist/components/CarbonChart/CarbonChartRadar.stories.d.ts

@@ -0,0 +1,98 @@
+import { CarbonChartProps, CarbonChartType } from '.';
+declare const _default: import("@storybook/csf").ComponentAnnotations<import("@storybook/react/types-6-0").ReactFramework, import("@storybook/react/types-6-0").Args>;
+export default _default;
+export declare const Radar: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            product: string;
+            feature: string;
+            score: number;
+        }[];
+        options: {
+            title: string;
+            radar: {
+                axes: {
+                    angle: string;
+                    value: string;
+                };
+            };
+            data: {
+                groupMapsTo: string;
+            };
+            height: string;
+        };
+    };
+};
+export declare const RadarCentered: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            product: string;
+            feature: string;
+            score: number;
+        }[];
+        options: {
+            title: string;
+            radar: {
+                axes: {
+                    angle: string;
+                    value: string;
+                };
+                alignment: string;
+            };
+            data: {
+                groupMapsTo: string;
+            };
+            legend: {
+                alignment: string;
+            };
+            height: string;
+        };
+    };
+};
+export declare const RadarMissingDatapoints: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            key: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            height: string;
+        };
+    };
+};
+export declare const RadarDense: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            month: string;
+            activity: string;
+            hoursAvg: number;
+        }[];
+        options: {
+            title: string;
+            radar: {
+                axes: {
+                    angle: string;
+                    value: string;
+                };
+            };
+            data: {
+                groupMapsTo: string;
+            };
+            height: string;
+        };
+    };
+};

package/dist/components/CarbonChart/CarbonChartScatter.stories.d.ts

@@ -0,0 +1,173 @@
+import { CarbonChartProps, CarbonChartType } from '.';
+declare const _default: import("@storybook/csf").ComponentAnnotations<import("@storybook/react/types-6-0").ReactFramework, import("@storybook/react/types-6-0").Args>;
+export default _default;
+export declare const ScatterLinearXAndY: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            employees: number;
+            sales: number;
+        }[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    title: string;
+                    mapsTo: string;
+                    scaleType: string;
+                };
+                left: {
+                    title: string;
+                    mapsTo: string;
+                    scaleType: string;
+                };
+            };
+            height: string;
+        };
+    };
+};
+export declare const ScatterTimeSeries: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: ({
+            group: string;
+            date: string;
+            value: number;
+        } | {
+            group: string;
+            date: string;
+            value: null;
+        })[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    title: string;
+                    scaleType: string;
+                    mapsTo: string;
+                };
+                left: {
+                    mapsTo: string;
+                };
+            };
+            height: string;
+        };
+    };
+};
+export declare const ScatterDiscrete: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            key: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    title: string;
+                    scaleType: string;
+                    mapsTo: string;
+                };
+                left: {
+                    mapsTo: string;
+                };
+            };
+            height: string;
+        };
+    };
+};
+export declare const ScatterDualAxes: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: ({
+            group: string;
+            date: string;
+            orderCount: number;
+            productCount?: undefined;
+        } | {
+            group: string;
+            date: string;
+            productCount: number;
+            orderCount?: undefined;
+        })[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    mapsTo: string;
+                    scaleType: string;
+                };
+                left: {
+                    title: string;
+                    mapsTo: string;
+                    scaleType: string;
+                };
+                right: {
+                    title: string;
+                    mapsTo: string;
+                    scaleType: string;
+                    correspondingDatasets: string[];
+                };
+            };
+            height: string;
+        };
+    };
+};
+export declare const ScatterEmptyState: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: never[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    title: string;
+                    scaleType: string;
+                    mapsTo: string;
+                };
+                left: {
+                    mapsTo: string;
+                };
+            };
+            height: string;
+        };
+    };
+};
+export declare const ScatterSkeleton: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: never[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    title: string;
+                    scaleType: string;
+                    mapsTo: string;
+                };
+                left: {
+                    mapsTo: string;
+                };
+            };
+            data: {
+                loading: boolean;
+            };
+            height: string;
+        };
+    };
+};

package/dist/components/CarbonChart/CarbonChartSparkline.stories.d.ts

@@ -0,0 +1,51 @@
+import { CarbonChartProps, CarbonChartType } from '.';
+declare const _default: import("@storybook/csf").ComponentAnnotations<import("@storybook/react/types-6-0").ReactFramework, import("@storybook/react/types-6-0").Args>;
+export default _default;
+export declare const AreaSparkline: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: {
+            group: string;
+            date: string;
+            value: number;
+        }[];
+        options: {
+            title: string;
+            height: string;
+            grid: {
+                x: {
+                    enabled: boolean;
+                };
+                y: {
+                    enabled: boolean;
+                };
+            };
+            axes: {
+                bottom: {
+                    visible: boolean;
+                    title: string;
+                    mapsTo: string;
+                    scaleType: string;
+                };
+                left: {
+                    visible: boolean;
+                    mapsTo: string;
+                    scaleType: string;
+                };
+            };
+            color: {
+                gradient: {
+                    enabled: boolean;
+                };
+            };
+            points: {
+                enabled: boolean;
+            };
+            legend: {
+                enabled: boolean;
+            };
+        };
+    };
+};

package/dist/components/CarbonChart/CarbonChartStep.stories.d.ts

@@ -0,0 +1,38 @@
+import { CarbonChartProps, CarbonChartType } from '.';
+declare const _default: import("@storybook/csf").ComponentAnnotations<import("@storybook/react/types-6-0").ReactFramework, import("@storybook/react/types-6-0").Args>;
+export default _default;
+export declare const StepTimeSeries: {
+    render: import("@storybook/csf").AnnotatedStoryFn<import("@storybook/react/types-6-0").ReactFramework, CarbonChartProps>;
+    args: {
+        isInverse: boolean;
+        type: CarbonChartType;
+        dataSet: ({
+            group: string;
+            date: string;
+            value: number;
+            surplus: number;
+        } | {
+            group: string;
+            date: string;
+            value: null;
+            surplus: number;
+        })[];
+        options: {
+            title: string;
+            axes: {
+                bottom: {
+                    title: string;
+                    mapsTo: string;
+                    scaleType: string;
+                };
+                left: {
+                    mapsTo: string;
+                    title: string;
+                    scaleType: string;
+                };
+            };
+            curve: string;
+            height: string;
+        };
+    };
+};

package/dist/components/LineChart/Chart.d.ts

@@ -0,0 +1,27 @@
+import * as React from 'react';
+import { LineChartProps } from './LineChart';
+interface BaseChartProps {
+    /**
+     * Description of what the line chart data represents placed above the chart
+     */
+    description?: string;
+    /**
+     * @internal
+     */
+    testId?: string;
+    /**
+     * Title of the line chart
+     */
+    title: string;
+    /**
+     * Type of chart - for now just 'line' is accepted
+     */
+    type: string;
+}
+export interface ChartProps<T extends any> extends BaseChartProps, Omit<React.HTMLAttributes<HTMLDivElement>, 'title'>, LineChartProps<T> {
+}
+declare function BaseChart<T>(props: ChartProps<T>, ref: React.Ref<HTMLDivElement>): React.JSX.Element;
+export declare const Chart: <T>(props: ChartProps<T> & {
+    ref?: React.MutableRefObject<HTMLDivElement> | undefined;
+}) => ReturnType<typeof BaseChart>;
+export {};

package/dist/components/LineChart/ChartDataTable.d.ts

@@ -0,0 +1,17 @@
+import * as React from 'react';
+import { VictoryAxisProps } from 'victory';
+export declare function toCamelCase(str: string): string;
+export interface DataTableProps {
+    data?: any[];
+    xData: {
+        keyValue?: string | number | symbol;
+        label?: VictoryAxisProps['label'];
+        tickFormat?: Partial<VictoryAxisProps['tickFormat']>;
+        tickValues?: VictoryAxisProps['tickValues'];
+    };
+    yData: {
+        keyValue?: string | number | symbol;
+        tickFormat?: Partial<VictoryAxisProps['tickFormat']>;
+    };
+}
+export declare const ChartDataTable: (props: DataTableProps) => React.JSX.Element;

package/dist/components/LineChart/CustomAxisComponent.d.ts

@@ -0,0 +1,3 @@
+import * as React from 'react';
+import { LineSegmentProps } from 'victory';
+export declare const CustomAxisComponent: React.FunctionComponent<LineSegmentProps>;