@carbon/charts 1.9.0-rc.5 → 1.10.1

package/dist/model/model.d.ts

@@ -1,110 +1,110 @@
-import { ColorClassNameTypes } from '../interfaces/enums';
-import type { ChartTabularData } from '../interfaces/model';
-export type StackKeysParams = {
-    bins?: any;
-    groups?: any;
-    percentage?: any;
-    divergent?: any;
-};
-/** 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(): import("d3").SeriesPoint<{
-        [key: string]: number;
-    }>[][];
-    getGroupedData(groups?: any): {
-        name: string;
-        data: any;
-    }[];
-    getStackKeys({ bins, groups }?: StackKeysParams): any;
-    getDataValuesGroupedByKeys({ bins, groups }: StackKeysParams): any;
-    getStackedData({ percentage, groups, divergent }: StackKeysParams): 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 | number;
-        originalClassName?: string;
-        value?: number;
-    }): 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): ChartTabularData;
-    getTabularDataArray(): ChartTabularData;
-    exportToCSV(): void;
-    protected getTabularData(data: any): any[];
-    protected sanitize(data: any): any;
-    protected updateAllDataGroups(): void;
-    protected generateDataGroups(data: any): {
-        name: unknown;
-        status: number;
-    }[];
-    protected setCustomColorScale(): void;
-    protected setColorClassNames(): void;
-}
+import { ColorClassNameTypes } from '../interfaces/enums';
+import { ChartTabularData } from '../interfaces/model';
+export type StackKeysParams = {
+    bins?: any;
+    groups?: any;
+    percentage?: any;
+    divergent?: any;
+};
+/** 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(): import("d3").SeriesPoint<{
+        [key: string]: number;
+    }>[][];
+    getGroupedData(groups?: any): {
+        name: string;
+        data: any;
+    }[];
+    getStackKeys({ bins, groups }?: StackKeysParams): any;
+    getDataValuesGroupedByKeys({ bins, groups }: StackKeysParams): any;
+    getStackedData({ percentage, groups, divergent }: StackKeysParams): 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 | number;
+        originalClassName?: string;
+        value?: number;
+    }): 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): ChartTabularData;
+    getTabularDataArray(): ChartTabularData;
+    exportToCSV(): void;
+    protected getTabularData(data: any): any[];
+    protected sanitize(data: any): any;
+    protected updateAllDataGroups(): void;
+    protected generateDataGroups(data: any): {
+        name: unknown;
+        status: number;
+    }[];
+    protected setCustomColorScale(): void;
+    protected setColorClassNames(): void;
+}

package/dist/model/pie.d.ts

@@ -1,9 +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[];
-}
+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/dist/model/radar.d.ts

@@ -1,7 +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[][];
-}
+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/dist/model/tree.d.ts

@@ -1,14 +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;
-}
+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/dist/model/treemap.d.ts

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

package/dist/model/wordcloud.d.ts

@@ -1,7 +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[];
-}
+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/dist/services/angle-utils.d.ts

@@ -1,15 +1,15 @@
-import { TextAnchor, DominantBaseline } from '../interfaces/enums';
-export interface Point {
-    x: number;
-    y: number;
-}
-export type Angle = number;
-export interface LabelAlignment {
-    textAnchor: TextAnchor;
-    dominantBaseline: DominantBaseline;
-}
-export declare function radialLabelPlacement(angleRadians: Angle): LabelAlignment;
-export declare function radToDeg(rad: Angle): Angle;
-export declare function degToRad(deg: Angle): Angle;
-export declare function polarToCartesianCoords(a: Angle, r: number, t?: Point): Point;
-export declare function distanceBetweenPointOnCircAndVerticalDiameter(a: Angle, r: number): number;
+import { TextAnchor, DominantBaseline } from '../interfaces/enums';
+export interface Point {
+    x: number;
+    y: number;
+}
+export type Angle = number;
+export interface LabelAlignment {
+    textAnchor: TextAnchor;
+    dominantBaseline: DominantBaseline;
+}
+export declare function radialLabelPlacement(angleRadians: Angle): LabelAlignment;
+export declare function radToDeg(rad: Angle): Angle;
+export declare function degToRad(deg: Angle): Angle;
+export declare function polarToCartesianCoords(a: Angle, r: number, t?: Point): Point;
+export declare function distanceBetweenPointOnCircAndVerticalDiameter(a: Angle, r: number): number;

package/dist/services/canvas-zoom.d.ts

@@ -1,11 +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;
-}
+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/dist/services/color-scale-utils.d.ts

@@ -1,2 +1,2 @@
-export declare function getDomain(data: any): number[];
-export declare function getColorScale(displayData: any, colorOptions: any): import("d3-scale").ScaleQuantize<number, never>;
+export declare function getDomain(data: any): number[];
+export declare function getColorScale(displayData: any, colorOptions: any): import("d3-scale").ScaleQuantize<number, never>;

package/dist/services/curves.d.ts

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

package/dist/services/essentials/dom-utils.d.ts

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

package/dist/services/essentials/events.d.ts

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

package/dist/services/essentials/files.d.ts

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

package/dist/services/essentials/gradient-utils.d.ts

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

package/dist/services/essentials/index.d.ts

@@ -1,5 +1,5 @@
-export { type Dimensions, DOMUtils, type getSVGElementSizeOptions } from './dom-utils';
-export { Events } from './events';
-export { Files } from './files';
-export { GradientUtils } from './gradient-utils';
-export { type setupTransitionConfigs, Transitions } from './transitions';
+export { Dimensions, DOMUtils, getSVGElementSizeOptions } from './dom-utils';
+export { Events } from './events';
+export { Files } from './files';
+export { GradientUtils } from './gradient-utils';
+export { setupTransitionConfigs, Transitions } from './transitions';

package/dist/services/essentials/transitions.d.ts

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

package/dist/services/index.d.ts

@@ -1,9 +1,9 @@
-export { getColorScale, getDomain } from './color-scale-utils';
-export { type Dimensions, DOMUtils, Events, Files, type getSVGElementSizeOptions, GradientUtils, type setupTransitionConfigs, Transitions } from './essentials';
-export { type Angle, degToRad, distanceBetweenPointOnCircAndVerticalDiameter, type LabelAlignment, type Point, polarToCartesianCoords, radialLabelPlacement, radToDeg } from './angle-utils';
-export { CanvasZoom } from './canvas-zoom';
-export { Curves } from './curves';
-export { CartesianScales, type ScaleFunction } from './scales-cartesian';
-export { Service } from './service';
-export { computeTimeIntervalName, formatDateTillMilliSeconds, formatTick, getTimeformats, isTickPrimary, TIME_INTERVALS } from './time-series';
-export { Zoom } from './zoom';
+export { getColorScale, getDomain } from './color-scale-utils';
+export { Dimensions, DOMUtils, Events, Files, getSVGElementSizeOptions, GradientUtils, setupTransitionConfigs, Transitions } from './essentials';
+export { Angle, degToRad, distanceBetweenPointOnCircAndVerticalDiameter, LabelAlignment, Point, polarToCartesianCoords, radialLabelPlacement, radToDeg } from './angle-utils';
+export { CanvasZoom } from './canvas-zoom';
+export { Curves } from './curves';
+export { CartesianScales, ScaleFunction } from './scales-cartesian';
+export { Service } from './service';
+export { computeTimeIntervalName, formatDateTillMilliSeconds, formatTick, getTimeformats, isTickPrimary, TIME_INTERVALS } from './time-series';
+export { Zoom } from './zoom';