@carbon/charts 0.41.1 → 0.41.5

package/build/demo/data/scatter.d.ts

@@ -103,3 +103,34 @@ export declare const scatterSkeletonOptions: {
         loading: boolean;
     };
 };
+export declare const scatterDualAxesData: ({
+    group: string;
+    date: string;
+    orderCount: number;
+    productCount?: undefined;
+} | {
+    group: string;
+    date: string;
+    productCount: number;
+    orderCount?: undefined;
+})[];
+export declare const scatterDualAxesOptions: {
+    title: string;
+    axes: {
+        bottom: {
+            mapsTo: string;
+            scaleType: string;
+        };
+        left: {
+            title: string;
+            mapsTo: string;
+            scaleType: string;
+        };
+        right: {
+            title: string;
+            mapsTo: string;
+            scaleType: string;
+            correspondingDatasets: string[];
+        };
+    };
+};

package/build/src/charts/bar-stacked.d.ts

@@ -1,6 +1,6 @@
 import { AxisChart } from "../axis-chart";
-import { ChartConfig, ScatterChartOptions } from "../interfaces/index";
+import { ChartConfig, BarChartOptions } from "../interfaces/index";
 export declare class StackedBarChart extends AxisChart {
-    constructor(holder: Element, chartConfigs: ChartConfig<ScatterChartOptions>);
+    constructor(holder: Element, chartConfigs: ChartConfig<BarChartOptions>);
     getComponents(): any[];
 }

package/build/src/charts/combo.d.ts

@@ -0,0 +1,7 @@
+import { AxisChart } from "../axis-chart";
+import { ChartConfig, ComboChartOptions } from "../interfaces/index";
+export declare class ComboChart extends AxisChart {
+    constructor(holder: Element, chartConfigs: ChartConfig<ComboChartOptions>);
+    getGraphComponents(): any;
+    getComponents(): any[];
+}

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

@@ -11,4 +11,5 @@ export * from "./donut";
 export * from "./meter";
 export * from "./radar";
 export * from "./gauge";
+export * from "./combo";
 export * from "./treemap";

package/build/src/components/axes/{ruler-stacked-bar.d.ts → ruler-stacked.d.ts}

@@ -1,5 +1,5 @@
 import { Ruler } from "./ruler";
-export declare class StackedBarRuler extends Ruler {
+export declare class StackedRuler extends Ruler {
     formatTooltipData(tooltipData: any): any;
     hideRuler(): void;
 }

package/build/src/components/axes/zoom-bar.d.ts

@@ -1,7 +1,6 @@
 import { Component } from "../component";
 import { ChartModelCartesian } from "../../model-cartesian-charts";
 export declare class ZoomBar extends Component {
-    protected model: ChartModelCartesian;
     type: string;
     MIN_SELECTION_DIFF: number;
     brushSelector: string;
@@ -10,6 +9,7 @@ export declare class ZoomBar extends Component {
     brush: import("d3-brush").BrushBehavior<unknown>;
     xScale: any;
     yScale: any;
+    protected model: ChartModelCartesian;
     init(): void;
     render(animate?: boolean): void;
     addBrushEventListener(zoomDomain: any, axesLeftMargin: any, width: any): void;

package/build/src/components/component.d.ts

@@ -1,6 +1,7 @@
 import { ChartModel } from "../model";
 export declare class Component {
     type: string;
+    id: string;
     protected parent: any;
     protected configs: any;
     protected model: ChartModel;
@@ -16,4 +17,10 @@ export declare class Component {
     getContainerSVG(configs?: {
         withinChartClip: boolean;
     }): any;
+    /**
+     * graphs used in combo charts share a model with global options but can receive their own local options.
+     * this function retrieves the global options and merges it with any options passed into this
+     * component's config.options object.
+     */
+    getOptions(): any;
 }

package/build/src/components/graphs/scatter.d.ts

@@ -11,7 +11,6 @@ export declare class Scatter extends Component {
     handleChartHolderOnMouseOut: (event: CustomEvent<any>) => void;
     handleLegendOnHover: (event: CustomEvent<any>) => void;
     handleLegendMouseOut: (event: CustomEvent<any>) => void;
-    getTooltipData(hoveredX: any, hoveredY: any): any;
     addEventListeners(): void;
     destroy(): void;
 }

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

@@ -20,6 +20,7 @@ export * from "./graphs/donut";
 export * from "./graphs/skeleton";
 export * from "./graphs/skeleton-lines";
 export * from "./graphs/treemap";
+export * from "./graphs/radar";
 export * from "./layout/spacer";
 export * from "./layout/layout";
 export * from "./axes/two-dimensional-axes";
@@ -28,7 +29,7 @@ export * from "./axes/grid-brush";
 export * from "./axes/chart-clip";
 export * from "./axes/grid";
 export * from "./axes/ruler";
-export * from "./axes/ruler-stacked-bar";
+export * from "./axes/ruler-stacked";
 export * from "./axes/toolbar";
 export * from "./axes/zero-line";
 export * from "./axes/zoom-bar";

package/build/src/configuration.d.ts

@@ -1,4 +1,4 @@
-import { BaseChartOptions, AxisChartOptions, ScatterChartOptions, LineChartOptions, BarChartOptions, StackedBarChartOptions, AreaChartOptions, PieChartOptions, GaugeChartOptions, DonutChartOptions, BubbleChartOptions, RadarChartOptions, TreemapChartOptions, GridOptions, RulerOptions, TimeScaleOptions, TooltipOptions, MeterChartOptions } from "./interfaces";
+import { BaseChartOptions, AxisChartOptions, ScatterChartOptions, LineChartOptions, BarChartOptions, StackedBarChartOptions, AreaChartOptions, PieChartOptions, GaugeChartOptions, DonutChartOptions, BubbleChartOptions, RadarChartOptions, ComboChartOptions, TreemapChartOptions, GridOptions, RulerOptions, TimeScaleOptions, TooltipOptions, MeterChartOptions } from "./interfaces";
 /**
  * Grid options
  */
@@ -28,6 +28,7 @@ export declare const options: {
     meterChart: MeterChartOptions;
     radarChart: RadarChartOptions;
     gaugeChart: GaugeChartOptions;
+    comboChart: ComboChartOptions;
     treemapChart: TreemapChartOptions;
 };
 export * from "./configuration-non-customizable";

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

@@ -1,4 +1,4 @@
-import { GaugeTypes, Statuses, ArrowDirections, Alignments } from "./enums";
+import { GaugeTypes, Statuses, ArrowDirections, Alignments, ChartTypes } from "./enums";
 import { LegendOptions, TooltipOptions, GridOptions, AxesOptions, ZoomBarsOptions } from "./index";
 import { BarOptions, StackedBarOptions } from "./components";
 import { TimeScaleOptions } from "./axis-scales";
@@ -271,7 +271,16 @@ export interface RadarChartOptions extends BaseChartOptions {
     };
 }
 /**
- * options specific to treemap charts
+ * options specific to combo bar charts
  */
+export interface ComboChartOptions extends AxisChartOptions {
+    comboChartTypes?: {
+        [ChartTypes.LINE]?: [];
+        [ChartTypes.STACKED_BAR]?: [];
+        [ChartTypes.GROUPED_BAR]?: [];
+        [ChartTypes.SIMPLE_BAR]?: [];
+        [ChartTypes.SCATTER]?: [];
+    };
+}
 export interface TreemapChartOptions extends BaseChartOptions {
 }

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

@@ -161,6 +161,18 @@ export declare enum TickRotations {
     AUTO = "auto",
     NEVER = "never"
 }
+/**
+ * enum of chartTypes that work with combo chart
+ */
+export declare enum ChartTypes {
+    SCATTER = "scatter",
+    LINE = "line",
+    SIMPLE_BAR = "simple-bar",
+    STACKED_BAR = "stacked-bar",
+    GROUPED_BAR = "grouped-bar",
+    AREA = "area",
+    STACKED_AREA = "stacked-area"
+}
 /**
  * enum of supported toolbar control types
  */

package/build/src/model.d.ts

@@ -17,8 +17,14 @@ export declare class ChartModel {
     protected colorScale: any;
     protected colorClassNames: any;
     constructor(services: any);
-    getAllDataFromDomain(): any;
-    getDisplayData(): 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;
+    setStackedGroups(groups: any): void;
+    getStackedGroups(): any;
     getData(): any;
     isDataEmpty(): boolean;
     /**
@@ -26,17 +32,18 @@ export declare class ChartModel {
      * @param newData The new raw data to be set
      */
     setData(newData: any): any;
-    getDataGroups(): any;
-    getActiveDataGroups(): any;
-    getDataGroupNames(): any;
-    getActiveDataGroupNames(): any;
-    getGroupedData(): {
+    getDataGroups(groups?: any): any;
+    getActiveDataGroups(groups?: any): any;
+    getDataGroupNames(groups?: any): any;
+    getActiveDataGroupNames(groups?: any): any;
+    getGroupedData(groups?: any): {
         name: string;
         data: any;
     }[];
-    getDataValuesGroupedByKeys(): any;
-    getStackedData({ percentage }?: {
-        percentage: boolean;
+    getDataValuesGroupedByKeys(groups?: any): any;
+    getStackedData({ percentage, groups }: {
+        percentage?: boolean;
+        groups?: any;
     }): any[][];
     /**
      * @return {Object} The chart's options

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

@@ -15,15 +15,25 @@ export declare class CartesianScales extends Service {
     };
     protected domainAxisPosition: AxisPositions;
     protected rangeAxisPosition: AxisPositions;
+    protected secondaryDomainAxisPosition: AxisPositions;
+    protected secondaryRangeAxisPosition: AxisPositions;
+    protected dualAxes: Boolean;
     protected orientation: CartesianOrientations;
-    getDomainAxisPosition(): AxisPositions;
-    getRangeAxisPosition(): AxisPositions;
+    getDomainAxisPosition({ datum }?: {
+        datum?: any;
+    }): AxisPositions;
+    getRangeAxisPosition({ datum, groups }?: {
+        datum?: any;
+        groups?: any;
+    }): AxisPositions;
     getAxisOptions(position: AxisPositions): any;
     getDomainAxisOptions(): any;
     getRangeAxisOptions(): any;
     update(animate?: boolean): void;
     findDomainAndRangeAxes(): void;
     determineOrientation(): void;
+    isDualAxes(): Boolean;
+    determineAxisDuality(): void;
     getOrientation(): CartesianOrientations;
     getScaleByPosition(axisPosition: AxisPositions): any;
     getScaleTypeByPosition(axisPosition: AxisPositions): any;
@@ -41,14 +51,22 @@ export declare class CartesianScales extends Service {
     getRangeValue(d: any, i: any): any;
     getMainXScaleType(): any;
     getMainYScaleType(): any;
-    getDomainIdentifier(): any;
-    getRangeIdentifier(): any;
+    getDomainIdentifier(datum?: any): any;
+    getRangeIdentifier(datum?: any): any;
     extendsDomain(axisPosition: AxisPositions, domain: any): number[] | Date[];
-    protected findMainVerticalAxisPosition(): AxisPositions.LEFT | AxisPositions.RIGHT;
-    protected findMainHorizontalAxisPosition(): AxisPositions.TOP | AxisPositions.BOTTOM;
-    protected findDomainAndRangeAxesPositions(mainVerticalAxisPosition: AxisPositions, mainHorizontalAxisPosition: AxisPositions): {
-        domainAxisPosition: any;
-        rangeAxisPosition: any;
+    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;

package/build/src/tools.d.ts

@@ -6,6 +6,8 @@ export declare namespace Tools {
     export const merge: any;
     export const removeArrayDuplicates: any;
     export const clamp: any;
+    export const flatten: any;
+    export const camelCase: any;
     export const isEmpty: any;
     export const isEqual: any;
     export const flatMapDeep: any;

package/build/stories/tutorials/api.d.ts

@@ -0,0 +1,4 @@
+export declare const apiTutorial: {
+    name: string;
+    content: string;
+};

package/build/stories/tutorials/color-palette.d.ts

@@ -1 +1,4 @@
-export declare const colorPaletteTutorial: string;
+export declare const colorPaletteTutorial: {
+    name: string;
+    content: string;
+};

package/build/stories/tutorials/event-listeners.d.ts

@@ -1 +1,4 @@
-export declare const eventListenersTutorial: string;
+export declare const eventListenersTutorial: {
+    name: string;
+    content: string;
+};

package/build/stories/tutorials/getting-started/angular.d.ts

@@ -1 +1,5 @@
-export declare const angularTutorial: string;
+export declare const angularTutorial: {
+    name: string;
+    type: string;
+    content: string;
+};

package/build/stories/tutorials/getting-started/react.d.ts

@@ -1 +1,5 @@
-export declare const reactTutorial: string;
+export declare const reactTutorial: {
+    name: string;
+    type: string;
+    content: string;
+};

package/build/stories/tutorials/getting-started/vanilla.d.ts

@@ -1 +1,5 @@
-export declare const vanillaTutorial: string;
+export declare const vanillaTutorial: {
+    name: string;
+    type: string;
+    content: string;
+};

package/build/stories/tutorials/getting-started/vue.d.ts

@@ -1 +1,5 @@
-export declare const vueTutorial: string;
+export declare const vueTutorial: {
+    name: string;
+    type: string;
+    content: string;
+};

package/build/stories/tutorials/index.d.ts

@@ -2,6 +2,8 @@ export * from "./getting-started/angular";
 export * from "./getting-started/react";
 export * from "./getting-started/vue";
 export * from "./getting-started/vanilla";
+export * from "./api";
 export * from "./tabular-data-format";
+export * from "./themes";
 export * from "./event-listeners";
 export * from "./color-palette";

package/build/stories/tutorials/tabular-data-format.d.ts

@@ -1 +1,4 @@
-export declare const tabularTutorial: string;
+export declare const tabularTutorial: {
+    name: string;
+    content: string;
+};

package/build/stories/tutorials/themes.d.ts

@@ -0,0 +1,4 @@
+export declare const themesTutorial: {
+    name: string;
+    content: string;
+};

package/build/stories/utils.d.ts

@@ -1,13 +1,5 @@
 export declare const addControls: (container: any, chart: any) => void;
-export declare const addRadioButtonEventListeners: {
-    (container: any): void;
-    displayName: string;
-    __docgenInfo: {
-        "description": string;
-        "displayName": string;
-        "props": {};
-    };
-};
+export declare const addRadioButtonEventListeners: (container: any, chart: any) => void;
 /**
  * Generates random data going backwards from now once a minute
  * @param {number} quantity number of data points to create