@carbon/charts 0.41.103 → 0.44.0

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

@@ -1,4 +1,4 @@
-import { PieChartModel } from '../model-pie';
+import { PieChartModel } from '../model/pie';
 import { Chart } from '../chart';
 import { ChartConfig, PieChartOptions } from '../interfaces/index';
 export declare class PieChart extends Chart {

package/build/src/components/axes/axis.d.ts

@@ -1,6 +1,6 @@
 import { Component } from '../component';
 import { ScaleTypes } from '../../interfaces';
-import { ChartModel } from '../../model';
+import { ChartModel } from '../../model/model';
 import { RenderTypes } from '../../interfaces/enums';
 export declare class Axis extends Component {
     type: string;

package/build/src/components/axes/chart-clip.d.ts

@@ -1,5 +1,5 @@
 import { Component } from '../component';
-import { ChartModel } from '../../model';
+import { ChartModel } from '../../model/model';
 import { RenderTypes } from '../../interfaces';
 export declare class ChartClip extends Component {
     type: string;

package/build/src/components/axes/ruler-binned.d.ts

@@ -0,0 +1,7 @@
+import { Ruler } from './ruler';
+import { RenderTypes } from '../../interfaces';
+export declare class BinnedRuler extends Ruler {
+    type: string;
+    renderType: RenderTypes;
+    showRuler(event: any, [x, y]: [number, number]): void;
+}

package/build/src/components/axes/ruler.d.ts

@@ -1,7 +1,7 @@
 import { Component } from '../component';
 import { RenderTypes } from '../../interfaces';
 import { Selection } from 'd3-selection';
-declare type GenericSvgSelection = Selection<SVGElement, any, SVGElement, any>;
+export declare type GenericSvgSelection = Selection<SVGElement, any, SVGElement, any>;
 export declare class Ruler extends Component {
     type: string;
     renderType: RenderTypes;
@@ -17,7 +17,7 @@ export declare class Ruler extends Component {
     render(): void;
     removeBackdropEventListeners(): void;
     formatTooltipData(tooltipData: any): any;
-    showRuler([x, y]: [number, number]): any;
+    showRuler(event: any, [x, y]: [number, number]): any;
     hideRuler(): void;
     /**
      * Adds the listener on the X grid to trigger multiple point tooltips along the x axis.
@@ -25,4 +25,3 @@ export declare class Ruler extends Component {
     addBackdropEventListeners(): void;
     drawBackdrop(): void;
 }
-export {};

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

@@ -1,5 +1,5 @@
 import { Component } from '../component';
-import { ChartModelCartesian } from '../../model-cartesian-charts';
+import { ChartModelCartesian } from '../../model/cartesian-charts';
 import { RenderTypes } from '../../interfaces';
 export declare class ZoomBar extends Component {
     type: string;

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

@@ -1,4 +1,4 @@
-import { ChartModel } from '../model';
+import { ChartModel } from '../model/model';
 import { RenderTypes } from '../interfaces';
 export declare class Component {
     type: string;

package/build/src/components/essentials/modal.d.ts

@@ -1,5 +1,5 @@
 import { Component } from '../component';
-import { ChartModel } from '../../model';
+import { ChartModel } from '../../model/model';
 export declare class Modal extends Component {
     type: string;
     isEventListenerAdded: boolean;
@@ -9,12 +9,6 @@ export declare class Modal extends Component {
     handleHideModal: () => void;
     addEventListeners(): void;
     removeEventListeners(): void;
-    assignRangeAndDomains(): {
-        primaryDomain: any;
-        primaryRange: any;
-        secondaryDomain: any;
-        secondaryRange: any;
-    };
     getModalHTML(): string;
     render(): void;
     destroy(): void;

package/build/src/components/essentials/threshold.d.ts

@@ -1,5 +1,5 @@
 import { Component } from '../component';
-import { ChartModel } from '../../model';
+import { ChartModel } from '../../model/model';
 import { RenderTypes } from '../../interfaces';
 import Position from '@carbon/utils-position';
 export declare class Threshold extends Component {

package/build/src/components/essentials/tooltip-histogram.d.ts

@@ -0,0 +1,26 @@
+import { AxisChartsTooltip } from './tooltip-axis';
+export declare class TooltipHistogram extends AxisChartsTooltip {
+    init(): void;
+    /**
+     * Get the position of the tooltip relative to the active hovered bar. Tooltip should appear above
+     * positive valued data and below negative value data.
+     * @param hoveredElement
+     */
+    getTooltipPosition(hoveredElement: any, data?: any): {
+        placement: string;
+        position: {
+            left: number;
+            top: number;
+        };
+    };
+    /**
+     * Returns the html for the bar single point tooltip
+     * @param data associated values for the hovered bar
+     */
+    getTooltipHTML(e: any): string;
+    /**
+     * Multip tooltips for bar charts include totals for each stack
+     * @param data
+     */
+    getMultilineTooltipHTML(data: any): string;
+}

package/build/src/components/essentials/tooltip.d.ts

@@ -1,5 +1,5 @@
 import { Component } from '../component';
-import { ChartModel } from '../../model';
+import { ChartModel } from '../../model/model';
 import { RenderTypes } from '../../interfaces';
 import Position from '@carbon/utils-position';
 export declare class Tooltip extends Component {

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

@@ -0,0 +1,12 @@
+import { RenderTypes } from '../../interfaces';
+import { Component } from '../component';
+export declare class Histogram extends Component {
+    type: string;
+    renderType: RenderTypes;
+    init(): void;
+    render(animate: boolean): void;
+    handleLegendOnHover: (event: CustomEvent<any>) => void;
+    handleLegendMouseOut: (event: CustomEvent<any>) => void;
+    addEventListeners(): void;
+    destroy(): void;
+}

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

@@ -6,6 +6,7 @@ export * from './essentials/title';
 export * from './essentials/title-meter';
 export * from './essentials/tooltip';
 export * from './essentials/tooltip-axis';
+export * from "./essentials/tooltip-histogram";
 export * from './essentials/canvas-chart-clip';
 export * from './graphs/area';
 export * from './graphs/area-stacked';
@@ -15,6 +16,7 @@ export * from './graphs/bar-stacked';
 export * from './graphs/boxplot';
 export * from './graphs/bubble';
 export * from './graphs/bullet';
+export * from './graphs/histogram';
 export * from './graphs/line';
 export * from './graphs/lollipop';
 export * from './graphs/scatter';
@@ -36,6 +38,7 @@ export * from './axes/grid-brush';
 export * from './axes/chart-clip';
 export * from './axes/grid';
 export * from './axes/ruler';
+export * from './axes/ruler-binned';
 export * from './axes/ruler-stacked';
 export * from './axes/toolbar';
 export * from './axes/zero-line';

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

@@ -1,6 +1,6 @@
 import { Component } from '../component';
 import { LayoutComponentChild, LayoutConfigs } from '../../interfaces/index';
-import { ChartModel } from '../../model';
+import { ChartModel } from '../../model/model';
 export declare class LayoutComponent extends Component {
     static instanceID: number;
     type: string;

package/build/src/configuration-non-customizable.d.ts

@@ -66,6 +66,9 @@ export declare const boxplot: {
         thicker: number;
     };
 };
+export declare const histogram: {
+    defaultBins: number;
+};
 export declare const legend: {
     items: {
         status: {

package/build/src/configuration.d.ts

@@ -1,4 +1,4 @@
-import { BaseChartOptions, AxisChartOptions, ScatterChartOptions, LollipopChartOptions, LineChartOptions, BarChartOptions, StackedBarChartOptions, BoxplotChartOptions, AreaChartOptions, PieChartOptions, GaugeChartOptions, DonutChartOptions, BubbleChartOptions, BulletChartOptions, RadarChartOptions, ComboChartOptions, TreemapChartOptions, CirclePackChartOptions, WorldCloudChartOptions, GridOptions, RulerOptions, TimeScaleOptions, TooltipOptions, MeterChartOptions } from './interfaces';
+import { BaseChartOptions, AxisChartOptions, ScatterChartOptions, LollipopChartOptions, LineChartOptions, BarChartOptions, StackedBarChartOptions, BoxplotChartOptions, AreaChartOptions, PieChartOptions, GaugeChartOptions, DonutChartOptions, BubbleChartOptions, BulletChartOptions, HistogramChartOptions, RadarChartOptions, ComboChartOptions, TreemapChartOptions, CirclePackChartOptions, WorldCloudChartOptions, GridOptions, RulerOptions, TimeScaleOptions, TooltipOptions, MeterChartOptions } from './interfaces';
 /**
  * Grid options
  */
@@ -21,6 +21,7 @@ export declare const options: {
     boxplotChart: BoxplotChartOptions;
     bubbleChart: BubbleChartOptions;
     bulletChart: BulletChartOptions;
+    histogramChart: HistogramChartOptions;
     lineChart: LineChartOptions;
     areaChart: AreaChartOptions;
     stackedAreaChart: AreaChartOptions;

package/build/src/interfaces/axis-scales.d.ts

@@ -3,22 +3,11 @@ import { ThresholdOptions } from './components';
 import { TruncationOptions } from './truncation';
 import { AxisDomain } from 'd3-axis';
 import { Locale } from 'date-fns';
-/**
- * options to configure a scale. not all options are used by all scales
- */
-export interface AxisOptions {
+export interface BasedAxisOptions {
     /**
      * type of the scale used on axis
      */
     scaleType?: ScaleTypes;
-    /**
-     * option for stacked axis
-     */
-    stacked?: boolean;
-    /**
-     * option for percentage axis scale
-     */
-    percentage?: boolean;
     /**
      * Whether the Axis should use the specified domain
      * instead of it being dynamically generated based on data extents.
@@ -103,6 +92,53 @@ export interface AxisOptions {
      * is axis visible or not
      */
     visible?: boolean;
+    /**
+     * Bins to display (Histogram)
+     * bins: 20
+     * bins: [0, 20, 40, 60]
+     * bins: [new Date(...), new Date(...), ...]
+     */
+    bins?: number | any[];
+    /**
+     * limit the visible axis domain to only the binned area
+     */
+    limitDomainToBins?: boolean;
+    /**
+     * should be set to `true` on the domain
+     * axis that's being broken into bins
+     */
+    binned?: boolean;
+}
+/**
+ * options to configure a scale. not all options are used by all scales
+ */
+export interface AxisOptions extends BasedAxisOptions {
+    /**
+     * option for stacked axis
+     */
+    stacked?: boolean;
+    /**
+     * option for percentage axis scale
+     */
+    percentage?: boolean;
+}
+export interface BinnedAxisOptions {
+    /**
+     * should be set to `true` on the domain
+     * axis that's being broken into bins
+     */
+    binned?: boolean;
+    /**
+     * Bins to display (Histogram)
+     * bins: 20
+     * bins: [0, 20, 40, 60]
+     * bins: [new Date(...), new Date(...), ...]
+     */
+    bins?: number | any[];
+    /**
+     * limit the visible axis domain to only the binned area
+     */
+    limitDomainToBins?: boolean;
 }
 /**
  * customize time series scales
@@ -146,9 +182,9 @@ export interface TimeIntervalFormats {
 /**
  * customize the axes components
  */
-export interface AxesOptions {
-    left?: AxisOptions;
-    bottom?: AxisOptions;
-    right?: AxisOptions;
-    top?: AxisOptions;
+export interface AxesOptions<AxesOptionType> {
+    left?: AxesOptionType;
+    bottom?: AxesOptionType;
+    right?: AxesOptionType;
+    top?: AxesOptionType;
 }

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

@@ -1,7 +1,7 @@
 import { GaugeTypes, Statuses, ArrowDirections, Alignments, ChartTypes } from './enums';
 import { LegendOptions, TooltipOptions, GridOptions, AxesOptions, ZoomBarsOptions } from './index';
 import { BarOptions, StackedBarOptions, ToolbarOptions } from './components';
-import { TimeScaleOptions } from './axis-scales';
+import { AxisOptions, BinnedAxisOptions, TimeScaleOptions } from './axis-scales';
 /**
  * Base chart options common to any chart
  */
@@ -107,7 +107,19 @@ export interface BaseChartOptions {
  * Options common to any chart with an axis
  */
 export interface AxisChartOptions extends BaseChartOptions {
-    axes?: AxesOptions;
+    axes?: AxesOptions<AxisOptions>;
+    grid?: GridOptions;
+    timeScale?: TimeScaleOptions;
+    /**
+     * zoombar configuration
+     */
+    zoomBar?: ZoomBarsOptions;
+}
+/**
+ * Options common to binned charts with an axis
+ */
+export interface BinnedAxisChartOptions extends AxisChartOptions {
+    axes?: AxesOptions<BinnedAxisOptions>;
     grid?: GridOptions;
     timeScale?: TimeScaleOptions;
     /**
@@ -196,6 +208,17 @@ export interface BulletChartOptions extends AxisChartOptions {
         performanceAreaTitles?: string[];
     };
 }
+/**
+ * options specific to histogram charts
+ */
+export interface HistogramChartOptions extends AxisChartOptions {
+    /**
+     * options related to bins
+     */
+    bins?: {
+        rangeLabel?: string;
+    };
+}
 /**
  * options specific to line charts
  */

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

@@ -0,0 +1,7 @@
+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 → model/boxplot.d.ts}

@@ -1,4 +1,4 @@
-import { ChartModelCartesian } from './model-cartesian-charts';
+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 {

package/build/src/{model-cartesian-charts.d.ts → model/cartesian-charts.d.ts}

@@ -4,6 +4,8 @@ import { ChartModel } from './model';
  * */
 export declare class ChartModelCartesian extends ChartModel {
     constructor(services: any);
+    private assignRangeAndDomains;
+    getTabularDataArray(): any[];
     exportToCSV(): void;
     setData(newData: any): any;
     /**

package/build/src/{model-circle-pack.d.ts → model/circle-pack.d.ts}

@@ -1,5 +1,5 @@
 import { ChartModel } from './model';
-import { LegendItemType } from './interfaces/enums';
+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 {

package/build/src/{model.d.ts → model/model.d.ts}

@@ -1,4 +1,4 @@
-import { ColorClassNameTypes } from './interfaces';
+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 {
@@ -29,14 +29,28 @@ export declare class ChartModel {
     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;
     }[];
-    getDataValuesGroupedByKeys(groups?: any): any;
-    getStackedData({ percentage, groups }: {
+    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

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

@@ -1,4 +1,4 @@
-import { ChartModel } from '../model';
+import { ChartModel } from '../model/model';
 export declare class Service {
     protected model: ChartModel;
     protected services: any;

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

@@ -1,5 +1,5 @@
 import { Service } from './service';
-import { ChartModelCartesian } from '../model-cartesian-charts';
+import { ChartModelCartesian } from '../model/cartesian-charts';
 export declare class Zoom extends Service {
     protected model: ChartModelCartesian;
     isZoomBarEnabled(): boolean;

package/build/src/tools.d.ts

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