@carbon/charts 1.8.0 → 1.9.0-next.0

package/build/src/interfaces/events.d.ts

@@ -1,239 +0,0 @@
-/**
- * enum of all events related to the chart on the DOM
- */
-export declare enum Chart {
-    RENDER_FINISHED = "render-finished",
-    RESIZE = "chart-resize",
-    MOUSEOVER = "chart-mouseover",
-    MOUSEOUT = "chart-mouseout"
-}
-/**
- * enum of all events related to the overlay modal
- */
-export declare enum Modal {
-    SHOW = "show-modal",
-    HIDE = "hide-modal"
-}
-/**
- * enum of all events related to the chart model
- */
-export declare enum Model {
-    UPDATE = "model-update"
-}
-/**
- * enum of all toolbar events
- */
-export declare enum Toolbar {
-    SHOW_OVERFLOW_MENU = "show-toolbar-overflow-menu",
-    HIDE_OVERFLOW_MENU = "hide-toolbar-overflow-menu",
-    BUTTON_CLICK = "toolbar-button-click"
-}
-/**
- * enum of all events related to the zoom-bar
- */
-export declare enum ZoomBar {
-    UPDATE = "zoom-bar-update",
-    SELECTION_START = "zoom-bar-selection-start",
-    SELECTION_IN_PROGRESS = "zoom-bar-selection-in-progress",
-    SELECTION_END = "zoom-bar-selection-end"
-}
-/**
- * enum of all events related to the zoom domain
- */
-export declare enum ZoomDomain {
-    CHANGE = "zoom-domain-change"
-}
-/** enum of all events related to canvas zoom *
- *
- */
-export declare enum CanvasZoom {
-    CANVAS_ZOOM_IN = "canvas-zoom-in",
-    CANVAS_ZOOM_OUT = "canvas-zoom-out"
-}
-/**
- * enum of all axis-related events
- */
-export declare enum Axis {
-    LABEL_MOUSEOVER = "axis-label-mouseover",
-    LABEL_MOUSEMOVE = "axis-label-mousemove",
-    LABEL_CLICK = "axis-label-click",
-    LABEL_MOUSEOUT = "axis-label-mouseout",
-    LABEL_FOCUS = "axis-label-focus",
-    LABEL_BLUR = "axis-label-blur",
-    RENDER_COMPLETE = "axis-render-complete"
-}
-/**
- * enum of all area graph events
- */
-export declare enum Area {
-    POINT_MOUSEOVER = "scatter-mouseover",
-    POINT_MOUSEMOVE = "scatter-mousemove",
-    POINT_CLICK = "scatter-click",
-    POINT_MOUSEOUT = "scatter-mouseout"
-}
-/**
- * enum of all wordcloud graph events
- */
-export declare enum WordCloud {
-    WORD_MOUSEOVER = "wordcloud-word-mouseover",
-    WORD_MOUSEMOVE = "wordcloud-word-mousemove",
-    WORD_CLICK = "wordcloud-word-click",
-    WORD_MOUSEOUT = "wordcloud-word-mouseout"
-}
-/**
- * enum of all pie graph events
- */
-export declare enum Pie {
-    SLICE_MOUSEOVER = "pie-slice-mouseover",
-    SLICE_MOUSEMOVE = "pie-slice-mousemove",
-    SLICE_CLICK = "pie-slice-click",
-    SLICE_MOUSEOUT = "pie-slice-mouseout"
-}
-/**
- * enum of all gauge graph events
- */
-export declare enum Gauge {
-    ARC_MOUSEOVER = "gauge-arc-mouseover",
-    ARC_MOUSEMOVE = "gauge-arc-mousemove",
-    ARC_CLICK = "gauge-arc-click",
-    ARC_MOUSEOUT = "gauge-arc-mouseout"
-}
-/**
- * enum of all bar graph events
- */
-export declare enum Bar {
-    BAR_MOUSEOVER = "bar-mouseover",
-    BAR_MOUSEMOVE = "bar-mousemove",
-    BAR_CLICK = "bar-click",
-    BAR_MOUSEOUT = "bar-mouseout"
-}
-/**
- * enum of all boxplot graph events
- */
-export declare enum Boxplot {
-    BOX_MOUSEOVER = "box-mouseover",
-    BOX_MOUSEMOVE = "box-mousemove",
-    BOX_CLICK = "box-click",
-    BOX_MOUSEOUT = "box-mouseout",
-    OUTLIER_MOUSEOVER = "outlier-mouseover",
-    OUTLIER_MOUSEMOVE = "outlier-mousemove",
-    OUTLIER_CLICK = "outlier-click",
-    OUTLIER_MOUSEOUT = "outlier-mouseout"
-}
-/**
- * enum of all scatter graph events
- */
-export declare enum Scatter {
-    SCATTER_MOUSEOVER = "scatter-mouseover",
-    SCATTER_MOUSEMOVE = "scatter-mousemove",
-    SCATTER_CLICK = "scatter-click",
-    SCATTER_MOUSEOUT = "scatter-mouseout"
-}
-/**
- * enum of all line graph events
- */
-export declare enum Line {
-    POINT_MOUSEOVER = "scatter-mouseover",
-    POINT_MOUSEMOVE = "scatter-mousemove",
-    POINT_CLICK = "scatter-click",
-    POINT_MOUSEOUT = "scatter-mouseout"
-}
-/**
- * enum of all radar graph events
- */
-export declare enum Radar {
-    X_AXIS_MOUSEOVER = "radar-x-axis-mouseover",
-    X_AXIS_MOUSEMOVE = "radar-x-axis-mousemove",
-    X_AXIS_CLICK = "radar-x-axis-click",
-    X_AXIS_MOUSEOUT = "radar-x-axis-mouseout"
-}
-/**
- * enum of all tree graph events
- */
-export declare enum Tree {
-    NODE_MOUSEOVER = "tree-node-mouseover",
-    NODE_CLICK = "tree-node-click",
-    NODE_MOUSEOUT = "tree-node-mouseout"
-}
-/**
- * enum of all treemap graph events
- */
-export declare enum Treemap {
-    LEAF_MOUSEOVER = "leaf-mouseover",
-    LEAF_MOUSEMOVE = "leaf-mousemove",
-    LEAF_CLICK = "leaf-click",
-    LEAF_MOUSEOUT = "leaf-mouseout"
-}
-/**
- * enum of all tooltip events
- */
-export declare enum Tooltip {
-    SHOW = "show-tooltip",
-    MOVE = "move-tooltip",
-    HIDE = "hide-tooltip"
-}
-/**
- * enum of all threshold events
- */
-export declare enum Threshold {
-    SHOW = "show-threshold",
-    HIDE = "hide-threshold"
-}
-/**
- * enum of all legend related events
- */
-export declare enum Legend {
-    ITEM_HOVER = "legend-item-onhover",
-    ITEM_CLICK = "legend-item-onclick",
-    ITEM_MOUSEOUT = "legend-item-onmouseout",
-    ITEMS_UPDATE = "legend-items-update"
-}
-/**
- * enum of all circlepack related events
- */
-export declare enum CirclePack {
-    CIRCLE_MOUSEOVER = "circle-leaf-mouseover",
-    CIRCLE_CLICK = "circle-leaf-click",
-    CIRCLE_MOUSEOUT = "circle-leaf-mouseout",
-    CIRCLE_MOUSEMOVE = "circle-leaf-mousemove"
-}
-/**
- * enum of all alluvial related events
- */
-export declare enum Alluvial {
-    NODE_MOUSEOVER = "alluvial-node-mouseover",
-    NODE_CLICK = "alluvial-node-click",
-    NODE_MOUSEOUT = "alluvial-node-mouseout",
-    NODE_MOUSEMOVE = "alluvial-node-mousemove",
-    LINE_MOUSEOVER = "alluvial-line-mouseover",
-    LINE_CLICK = "alluvial-line-click",
-    LINE_MOUSEOUT = "alluvial-line-mouseout",
-    LINE_MOUSEMOVE = "alluvial-line-mousemove"
-}
-/**
- * enum of all meter related events
- */
-export declare enum Meter {
-    METER_MOUSEOVER = "meter-mouseover",
-    METER_CLICK = "meter-click",
-    METER_MOUSEOUT = "meter-mouseout",
-    METER_MOUSEMOVE = "meter-mousemove"
-}
-/**
- * enum of all heatmap related events
- */
-export declare enum Heatmap {
-    HEATMAP_MOUSEOVER = "heatmap-mouseover",
-    HEATMAP_CLICK = "heatmap-click",
-    HEATMAP_MOUSEOUT = "heatmap-mouseout",
-    HEATMAP_MOUSEMOVE = "hetmap-mousemove"
-}
-/**
- * enum of all choropleth related events
- */
-export declare enum Choropleth {
-    CHOROPLETH_MOUSEOVER = "choropleth-mouseover",
-    CHOROPLETH_CLICK = "choropleth-click",
-    CHOROPLETH_MOUSEOUT = "choropleth-mouseout",
-    CHOROPLETH_MOUSEMOVE = "choropleth-mousemove"
-}

package/build/src/interfaces/index.d.ts

@@ -1,7 +0,0 @@
-export * from './a11y';
-export * from './axis-scales';
-export * from './charts';
-export * from './components';
-export * from './enums';
-export * from './layout';
-export * from './model';

package/build/src/interfaces/layout.d.ts

@@ -1,15 +0,0 @@
-import { LayoutAlignItems, LayoutDirection, RenderTypes } from './enums';
-export interface LayoutConfigs {
-    /**
-     * Direction/orientation of the layout
-     */
-    direction?: LayoutDirection;
-    /**
-     * Whether to render through SVG or HTML
-     */
-    renderType?: RenderTypes;
-    /**
-     * how the layout will align its children
-     */
-    alignItems?: LayoutAlignItems;
-}

package/build/src/interfaces/model.d.ts

@@ -1,35 +0,0 @@
-import { AxisChartOptions } from './charts';
-export declare type ChartTabularData = Record<string, any>[];
-/**
- * Configuration passed to the chart.
- *
- * Includes options and data
- */
-export interface ChartConfig<T extends AxisChartOptions> {
-    options: T;
-    data: ChartTabularData;
-}
-export interface DataSet {
-    /**
-     * Label for the dataset
-     */
-    label: string;
-    /**
-     * Array of hex background colors
-     */
-    fillColors: string[];
-    /**
-     * Array of data values
-     */
-    data: any[];
-}
-export interface ChartData {
-    /**
-     * Labels for the x (horizontal) axis. Should match the number of items in each dataset data array
-     */
-    labels: string[];
-    /**
-     * Array of datasets to display in the chart
-     */
-    datasets: DataSet[];
-}

package/build/src/interfaces/truncation.d.ts

@@ -1,17 +0,0 @@
-export interface TruncationOptions {
-    /**
-     * truncation configuration
-     */
-    /**
-     * truncation type
-     */
-    type?: string;
-    /**
-     * truncation threshold
-     */
-    threshold?: Number;
-    /**
-     * how many characters to be shown
-     */
-    numCharacter?: Number;
-}

package/build/src/model/alluvial.d.ts

@@ -1,8 +0,0 @@
-import { ChartModelCartesian } from './cartesian-charts';
-/**
- * Alluvial chart model layer
- */
-export declare class AlluvialChartModel extends ChartModelCartesian {
-    constructor(services: any);
-    getTabularDataArray(): any[];
-}

package/build/src/model/binned-charts.d.ts

@@ -1,7 +0,0 @@
-import { ChartModelCartesian } from './cartesian-charts';
-/**
- * this is intended for binned type of charts
- * */
-export declare class ChartModelBinned extends ChartModelCartesian {
-    getTabularDataArray(): any[];
-}

package/build/src/model/boxplot.d.ts

@@ -1,14 +0,0 @@
-import { ChartModelCartesian } from './cartesian-charts';
-/** The charting model layer which includes mainly the chart data and options,
- * as well as some misc. information to be shared among components */
-export declare class BoxplotChartModel extends ChartModelCartesian {
-    constructor(services: any);
-    getBoxQuartiles(d: any): {
-        q_25: number;
-        q_50: number;
-        q_75: number;
-    };
-    getBoxplotData(): any[];
-    getTabularDataArray(): any[][];
-    protected setColorClassNames(): void;
-}

package/build/src/model/bullet.d.ts

@@ -1,14 +0,0 @@
-import { ChartModelCartesian } from './cartesian-charts';
-/**
- * Bullet chart model layer
- */
-export declare class BulletChartModel extends ChartModelCartesian {
-    constructor(services: any);
-    /**
-     * Determines the index of the performance area titles to use
-     * @param datum
-     * @returns number
-     */
-    getMatchingRangeIndexForDatapoint(datum: any): any;
-    getTabularDataArray(): any[];
-}

package/build/src/model/cartesian-charts.d.ts

@@ -1,24 +0,0 @@
-import { ChartModel } from './model';
-import { AxisFlavor } from '../interfaces';
-/**
- * This supports adding X and Y Cartesian[2D] zoom data to a ChartModel
- * */
-export declare class ChartModelCartesian extends ChartModel {
-    protected axisFlavor: AxisFlavor;
-    constructor(services: any);
-    protected assignRangeAndDomains(): {
-        primaryDomain: any;
-        primaryRange: any;
-        secondaryDomain: any;
-        secondaryRange: any;
-    };
-    getTabularDataArray(): any[];
-    setData(newData: any): any;
-    /**
-     * @param zoomBarData any special zoom bar data to use instead of the model data
-     */
-    setZoomBarData(newZoomBarData?: any): void;
-    getZoomBarData(): any;
-    protected sanitizeDateValues(data: any): any;
-    protected sanitize(data: any): any;
-}

package/build/src/model/choropleth.d.ts

@@ -1,29 +0,0 @@
-import { ChartModel } from './model';
-/**
- * Base thematic maps chart model layer
- */
-export declare class ChoroplethModel extends ChartModel {
-    private _colorScale;
-    private _matrix;
-    constructor(services: any);
-    /**
-     * @override
-     * @param value
-     * @returns string
-     */
-    getFillColor(value: number): any;
-    /**
-     * Helper function that will generate a dictionary
-     */
-    getCombinedData(): {};
-    /**
-     * Generate tabular data from display data
-     * @returns Array<Object>
-     */
-    getTabularDataArray(): any[];
-    getColorClassName(configs: {
-        value?: number;
-        originalClassName?: string;
-    }): string;
-    protected setColorClassNames(): void;
-}

package/build/src/model/circle-pack.d.ts

@@ -1,36 +0,0 @@
-import { ChartModel } from './model';
-import { LegendItemType } from '../interfaces/enums';
-/** The charting model layer which includes mainly the chart data and options,
- * as well as some misc. information to be shared among components */
-export declare class CirclePackChartModel extends ChartModel {
-    parentNode: boolean;
-    constructor(services: any);
-    setData(newData: any): void;
-    setOptions(newOptions: any): void;
-    getZoomOptions(options?: any): {
-        legend?: undefined;
-    } | {
-        legend: {
-            additionalItems: {
-                type: LegendItemType;
-                name: string;
-            }[];
-        };
-    };
-    setZoom(options?: any): void;
-    updateHierarchyLevel(depth: number): void;
-    getHierarchyLevel(): any;
-    hasParentNode(): boolean;
-    setDataGroups(): void;
-    protected setChildrenDataGroup(node: any, name: any): any;
-    getTabularDataArray(): string[][];
-    /**
-     * Recursively determine the relationship between all the nested elements in the child
-     * @param children: Object
-     * @param parent: String
-     * @param result: Array<Object>
-     * @param totalSum: number
-     * @returns: number
-     */
-    private getChildrenDatums;
-}

package/build/src/model/gauge.d.ts

@@ -1,9 +0,0 @@
-import { ChartModel } from './model';
-/**
- * The gauge chart model layer
- */
-export declare class GaugeChartModel extends ChartModel {
-    constructor(services: any);
-    getDataGroups(): any;
-    getTabularDataArray(): any[];
-}

package/build/src/model/heatmap.d.ts

@@ -1,52 +0,0 @@
-import { AxisFlavor } from '../interfaces';
-import { ChartModelCartesian } from './cartesian-charts';
-/** The gauge chart model layer */
-export declare class HeatmapModel extends ChartModelCartesian {
-    protected axisFlavor: AxisFlavor;
-    private _colorScale;
-    private _domains;
-    private _ranges;
-    private _matrix;
-    constructor(services: any);
-    /**
-     * @override
-     * @param value
-     * @returns string
-     */
-    getFillColor(value: number): any;
-    /**
-     * Generate a list of all unique domains
-     * @returns String[]
-     */
-    getUniqueDomain(): string[];
-    /**
-     * Generates a list of all unique ranges
-     * @returns String[]
-     */
-    getUniqueRanges(): string[];
-    /**
-     * Generates a matrix (If doesn't exist) and returns it
-     * @returns Object
-     */
-    getMatrix(): {};
-    /**
-     *
-     * @param newData The new raw data to be set
-     */
-    setData(newData: any): any;
-    /**
-     * Converts Object matrix into a single array
-     * @returns Object[]
-     */
-    getMatrixAsArray(): Object[];
-    /**
-     * Generate tabular data from display data
-     * @returns Array<Object>
-     */
-    getTabularDataArray(): any[];
-    getColorClassName(configs: {
-        value?: number;
-        originalClassName?: string;
-    }): string;
-    protected setColorClassNames(): void;
-}

package/build/src/model/meter.d.ts

@@ -1,19 +0,0 @@
-import { ChartModel } from './model';
-/** The meter chart model layer which extends some of the data setting options.
- * Meter only uses 1 dataset
- *  */
-export declare class MeterChartModel extends ChartModel {
-    constructor(services: any);
-    getMaximumDomain(data: any): any;
-    /**
-     * Use a provided color for the bar or default to carbon color if no status provided.
-     * Defaults to carbon color otherwise.
-     * @param group dataset group label
-     */
-    getFillColor(group: string): any;
-    /**
-     * Get the associated status for the data by checking the ranges
-     */
-    getStatus(): any;
-    getTabularDataArray(): any[];
-}

package/build/src/model/model.d.ts

@@ -1,107 +0,0 @@
-import { ColorClassNameTypes } from '../interfaces';
-/** The charting model layer which includes mainly the chart data and options,
- * as well as some misc. information to be shared among components */
-export declare class ChartModel {
-    protected services: any;
-    protected state: any;
-    /**
-     * A list of all the data groups that have existed within the lifetime of the chart
-     * @type string[]
-     */
-    protected allDataGroups: string[];
-    protected colorScale: any;
-    protected colorClassNames: any;
-    constructor(services: any);
-    getAllDataFromDomain(groups?: any): any;
-    /**
-     * Charts that have group configs passed into them, only want to retrieve the display data relevant to that chart
-     * @param groups the included datasets for the particular chart
-     */
-    getDisplayData(groups?: any): any;
-    getData(): any;
-    isDataEmpty(): boolean;
-    /**
-     *
-     * @param newData The new raw data to be set
-     */
-    setData(newData: any): any;
-    getDataGroups(groups?: any): any;
-    getActiveDataGroups(groups?: any): any;
-    getDataGroupNames(groups?: any): any;
-    getActiveDataGroupNames(groups?: any): any;
-    private aggregateBinDataByGroup;
-    getBinConfigurations(): {
-        bins: import("d3-array").Bin<number, number>[];
-        binsDomain: any[];
-    };
-    getBinnedStackedData(): any[][];
-    getGroupedData(groups?: any): {
-        name: string;
-        data: any;
-    }[];
-    getStackKeys({ bins, groups }?: {
-        bins?: any;
-        groups?: any;
-    }): any;
-    getDataValuesGroupedByKeys({ bins, groups }: {
-        bins?: any;
-        groups?: any;
-    }): any;
-    getStackedData({ percentage, groups, divergent }: {
-        percentage?: boolean;
-        groups?: any;
-        divergent?: boolean;
-    }): any[][];
-    /**
-     * @return {Object} The chart's options
-     */
-    getOptions(): any;
-    set(newState: any, configs?: any): void;
-    get(property?: string): any;
-    /**
-     *
-     * @param newOptions New options to be set
-     */
-    setOptions(newOptions: any): void;
-    /**
-     *
-     * Updates miscellanous information within the model
-     * such as the color scales, or the legend data labels
-     */
-    update(animate?: boolean): void;
-    toggleDataLabel(changedLabel: string): void;
-    /**
-     * Should the data point be filled?
-     * @param group
-     * @param key
-     * @param value
-     * @param defaultFilled the default for this chart
-     */
-    getIsFilled(group: any, key?: any, data?: any, defaultFilled?: boolean): any;
-    getFillColor(group: any, key?: any, data?: any): any;
-    getStrokeColor(group: any, key?: any, data?: any): any;
-    isUserProvidedColorScaleValid(): any;
-    getColorClassName(configs: {
-        classNameTypes: ColorClassNameTypes[];
-        dataGroupName?: string;
-        originalClassName?: string;
-    }): string;
-    /**
-     * For charts that might hold an associated status for their dataset
-     */
-    getStatus(): any;
-    getAllDataGroupsNames(): string[];
-    /**
-     * Converts data provided in the older format to tabular
-     *
-     */
-    protected transformToTabularData(data: any): any[];
-    getTabularDataArray(): any[];
-    exportToCSV(): void;
-    protected getTabularData(data: any): any[];
-    protected sanitize(data: any): any;
-    protected updateAllDataGroups(): void;
-    protected generateDataGroups(data: any): any;
-    protected setCustomColorScale(): void;
-    protected setColorClassNames(): void;
-}

package/build/src/model/pie.d.ts

@@ -1,9 +0,0 @@
-import { ChartModel } from './model';
-/** The charting model layer which includes mainly the chart data and options,
- * as well as some misc. information to be shared among components */
-export declare class PieChartModel extends ChartModel {
-    constructor(services: any);
-    getTabularData(data: any): any[];
-    getTabularDataArray(): any[];
-    sanitize(data: any): any[];
-}

package/build/src/model/radar.d.ts

@@ -1,7 +0,0 @@
-import { ChartModelCartesian } from './cartesian-charts';
-/** The charting model layer which includes mainly the chart data and options,
- * as well as some misc. information to be shared among components */
-export declare class RadarChartModel extends ChartModelCartesian {
-    constructor(services: any);
-    getTabularDataArray(): any[][];
-}

package/build/src/model/tree.d.ts

@@ -1,14 +0,0 @@
-import { ChartModel } from './model';
-/**
- * The tree chart model layer
- */
-export declare class TreeChartModel extends ChartModel {
-    constructor(services: any);
-    getTabularDataArray(): string[][];
-    /**
-     * Determine the child parent relationship in nested data
-     * @param datum: Object
-     * @param result: Array<Object>
-     */
-    private getChildrenDatums;
-}