@carbon/charts 0.59.0-beta.0 → 1.0.3

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

@@ -0,0 +1,57 @@
+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);
+    /**
+     * Get min and maximum value of the display data
+     * @returns Array consisting of smallest and largest values in  data
+     */
+    getValueDomain(): number[];
+    /**
+     * @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

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

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

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

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

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

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

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

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

@@ -0,0 +1,7 @@
+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 WordCloudModel extends ChartModel {
+    constructor(services: any);
+    getTabularDataArray(): any[];
+}

package/build/src/services/angle-utils.d.ts

@@ -0,0 +1,205 @@
+import { TextAnchor, DominantBaseline } from '../interfaces/enums';
+export interface Point {
+    x: number;
+    y: number;
+}
+export declare type Angle = number;
+interface LabelAlignment {
+    textAnchor: TextAnchor;
+    dominantBaseline: DominantBaseline;
+}
+export declare function radialLabelPlacement(angleRadians: Angle): LabelAlignment;
+export declare namespace radialLabelPlacement {
+    var displayName: string;
+    var __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {
+            "toString": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toFixed": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toExponential": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toPrecision": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "valueOf": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toLocaleString": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+        };
+    };
+}
+export declare function radToDeg(rad: Angle): Angle;
+export declare namespace radToDeg {
+    var displayName: string;
+    var __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {
+            "toString": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toFixed": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toExponential": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toPrecision": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "valueOf": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toLocaleString": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+        };
+    };
+}
+export declare function degToRad(deg: Angle): Angle;
+export declare namespace degToRad {
+    var displayName: string;
+    var __docgenInfo: {
+        "description": string;
+        "displayName": string;
+        "props": {
+            "toString": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toFixed": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toExponential": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toPrecision": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "valueOf": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+            "toLocaleString": {
+                "defaultValue": any;
+                "description": string;
+                "name": string;
+                "required": boolean;
+                "type": {
+                    "name": string;
+                };
+            };
+        };
+    };
+}
+export declare function polarToCartesianCoords(a: Angle, r: number, t?: Point): Point;
+export declare function distanceBetweenPointOnCircAndVerticalDiameter(a: Angle, r: number): number;
+export {};

package/build/src/services/canvas-zoom.d.ts

@@ -0,0 +1,11 @@
+import { Service } from './service';
+export declare class CanvasZoom extends Service {
+    protected model: any;
+    /**
+     * focal:  object to zoom into
+     * canvasElements: all the elements to translate and zoom on the chart area
+     * zoomSettings: object containing duration, easing and zoomlevel for the zoom behaviours
+     *  */
+    zoomIn(focal: any, canvasElements: any, zoomSettings?: any): void;
+    zoomOut(canvasElements: any, zoomSettings?: any): void;
+}

package/build/src/services/curves.d.ts

@@ -0,0 +1,25 @@
+import { CurveBundleFactory, CurveCardinalFactory, CurveCatmullRomFactory } from 'd3-shape';
+import { Service } from './service';
+export declare class Curves extends Service {
+    curveTypes: {
+        curveLinear: import("d3-shape").CurveFactory;
+        curveLinearClosed: import("d3-shape").CurveFactory;
+        curveBasis: import("d3-shape").CurveFactory;
+        curveBasisClosed: import("d3-shape").CurveFactory;
+        curveBasisOpen: import("d3-shape").CurveFactory;
+        curveBundle: CurveBundleFactory;
+        curveCardinal: CurveCardinalFactory;
+        curveCardinalClosed: CurveCardinalFactory;
+        curveCardinalOpen: CurveCardinalFactory;
+        curveCatmullRom: CurveCatmullRomFactory;
+        curveCatmullRomClosed: CurveCatmullRomFactory;
+        curveCatmullRomOpen: CurveCatmullRomFactory;
+        curveMonotoneX: import("d3-shape").CurveFactory;
+        curveMonotoneY: import("d3-shape").CurveFactory;
+        curveNatural: import("d3-shape").CurveFactory;
+        curveStep: import("d3-shape").CurveFactory;
+        curveStepAfter: import("d3-shape").CurveFactory;
+        curveStepBefore: import("d3-shape").CurveFactory;
+    };
+    getD3Curve(): any;
+}

package/build/src/services/essentials/dom-utils.d.ts

@@ -0,0 +1,38 @@
+import { Service } from '../service';
+import { Selection } from 'd3-selection';
+interface getSVGElementSizeOptions {
+    useAttrs?: boolean;
+    useClientDimensions?: boolean;
+    useBBox?: boolean;
+    useBoundingRect?: boolean;
+}
+export declare class DOMUtils extends Service {
+    private chartID;
+    constructor(model: any, services: any);
+    static getHTMLElementSize(element: HTMLElement): {
+        width: number;
+        height: number;
+    };
+    static getSVGElementSize(svgSelector: Selection<any, any, any, any>, options?: getSVGElementSizeOptions): any;
+    static appendOrSelect(parent: any, query: any): any;
+    protected mainContainer: HTMLElement;
+    protected width: string;
+    protected height: string;
+    init(): void;
+    getChartID(): string;
+    generateElementIDString(originalID: any): string;
+    addMainContainer(): void;
+    update(): void;
+    styleHolderElement(): void;
+    getHolder(): any;
+    exportToJPG(): void;
+    exportToPNG(): void;
+    toggleFullscreen(): void;
+    handleFullscreenChange(): void;
+    verifyCSSStylesBeingApplied(): void;
+    setSVGMaxHeight(): void;
+    getMainContainer(): HTMLElement;
+    addHolderListeners(): void;
+    addResizeListener(): void;
+}
+export {};

package/build/src/services/essentials/events.d.ts

@@ -0,0 +1,8 @@
+import { Service } from '../service';
+export declare class Events extends Service {
+    documentFragment: DocumentFragment;
+    init(): void;
+    addEventListener(type: string, listener: Function): void;
+    removeEventListener(type: string, listener: Function): void;
+    dispatchEvent(eventType: string, eventDetail?: object): void;
+}

package/build/src/services/essentials/files.d.ts

@@ -0,0 +1,6 @@
+import { Service } from '../service';
+export declare class Files extends Service {
+    constructor(model: any, services: any);
+    downloadCSV(content: any, filename: any): void;
+    downloadImage(uri: any, name: any): void;
+}

package/build/src/services/essentials/gradient-utils.d.ts

@@ -0,0 +1,6 @@
+import { Service } from '../service';
+export declare class GradientUtils extends Service {
+    static appendOrUpdateLinearGradient(configs: any): void;
+    static getOffsetRatio(domain: any): string;
+    static getStops(domain: any, color: any): object[];
+}

package/build/src/services/essentials/transitions.d.ts

@@ -0,0 +1,13 @@
+import { Service } from '../service';
+interface setupTransitionConfigs {
+    transition?: any;
+    name?: string;
+    animate?: boolean;
+}
+export declare class Transitions extends Service {
+    pendingTransitions: {};
+    init(): void;
+    setupTransition({ transition: t, name, animate }: setupTransitionConfigs): any;
+    getPendingTransitions(): {};
+}
+export {};

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

@@ -0,0 +1,9 @@
+export * from './essentials/dom-utils';
+export * from './essentials/events';
+export * from './essentials/files';
+export * from './essentials/transitions';
+export * from './essentials/gradient-utils';
+export * from './scales-cartesian';
+export * from './curves';
+export * from './zoom';
+export * from './canvas-zoom';

package/build/src/services/scales-cartesian.d.ts

@@ -0,0 +1,86 @@
+import { Service } from './service';
+import { AxisPositions, CartesianOrientations, ScaleTypes, ThresholdOptions } from '../interfaces';
+export declare class CartesianScales extends Service {
+    protected scaleTypes: {
+        top: any;
+        right: any;
+        bottom: any;
+        left: any;
+    };
+    protected scales: {
+        top: any;
+        right: any;
+        bottom: any;
+        left: any;
+    };
+    protected domainAxisPosition: AxisPositions;
+    protected rangeAxisPosition: AxisPositions;
+    protected secondaryDomainAxisPosition: AxisPositions;
+    protected secondaryRangeAxisPosition: AxisPositions;
+    protected dualAxes: Boolean;
+    protected orientation: CartesianOrientations;
+    getDomainAxisPosition({ datum }?: {
+        datum?: any;
+    }): AxisPositions;
+    getRangeAxisPosition({ datum, groups }?: {
+        datum?: any;
+        groups?: any;
+    }): AxisPositions;
+    getAxisOptions(position: AxisPositions): any;
+    getDomainAxisOptions(): any;
+    getRangeAxisOptions(): any;
+    getScaleLabel(position: AxisPositions): any;
+    getDomainLabel(): any;
+    getRangeLabel(): any;
+    update(animate?: boolean): void;
+    findDomainAndRangeAxes(): void;
+    determineOrientation(): void;
+    isDualAxes(): Boolean;
+    determineAxisDuality(): void;
+    getCustomDomainValuesByposition(axisPosition: AxisPositions): any;
+    getOrientation(): CartesianOrientations;
+    getScaleByPosition(axisPosition: AxisPositions): any;
+    getScaleTypeByPosition(axisPosition: AxisPositions): any;
+    getDomainAxisScaleType(): any;
+    getRangeAxisScaleType(): any;
+    getDomainScale(): any;
+    getRangeScale(): any;
+    getMainXAxisPosition(): AxisPositions;
+    getMainYAxisPosition(): AxisPositions;
+    getMainXScale(): any;
+    getMainYScale(): any;
+    getValueFromScale(scale: any, scaleType: ScaleTypes, axisPosition: AxisPositions, datum: any, index?: number): any;
+    getBoundedScaledValues(datum: any, index?: number): any[];
+    getValueThroughAxisPosition(axisPosition: AxisPositions, datum: any, index?: number): any;
+    getDomainValue(d: any, i: any): any;
+    getRangeValue(d: any, i: any): any;
+    getMainXScaleType(): any;
+    getMainYScaleType(): any;
+    getDomainIdentifier(datum?: any): any;
+    getRangeIdentifier(datum?: any): any;
+    extendsDomain(axisPosition: AxisPositions, domain: any): number[] | Date[];
+    protected findVerticalAxesPositions(): {
+        primary: AxisPositions;
+        secondary: AxisPositions;
+    };
+    protected findHorizontalAxesPositions(): {
+        primary: AxisPositions;
+        secondary: AxisPositions;
+    };
+    protected findDomainAndRangeAxesPositions(verticalAxesPositions: any, horizontalAxesPositions: any): {
+        primaryDomainAxisPosition: any;
+        secondaryDomainAxisPosition: any;
+        primaryRangeAxisPosition: any;
+        secondaryRangeAxisPosition: any;
+    };
+    protected getScaleDomain(axisPosition: AxisPositions): any;
+    protected createScale(axisPosition: AxisPositions): any;
+    protected getHighestDomainThreshold(): null | {
+        threshold: ThresholdOptions;
+        scaleValue: number;
+    };
+    protected getHighestRangeThreshold(): null | {
+        threshold: ThresholdOptions;
+        scaleValue: number;
+    };
+}

package/build/src/services/service.d.ts

@@ -0,0 +1,10 @@
+import { ChartModel } from '../model/model';
+export declare class Service {
+    protected model: ChartModel;
+    protected services: any;
+    constructor(model: ChartModel, services: any);
+    init(): void;
+    update(): void;
+    setModel(newObj: any): void;
+    setServices(newObj: any): void;
+}