@carbon/charts 0.30.21 → 0.30.25

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

@@ -0,0 +1,17 @@
+import { Component } from "../component";
+import { ChartModel } from "../../model";
+import Position from "@carbon/utils-position";
+export declare class Threshold extends Component {
+    type: string;
+    threshold: any;
+    thresholdClass: string;
+    thresholdIdentifierClass: string;
+    label: any;
+    positionService: Position;
+    constructor(model: ChartModel, services: any, configs: any);
+    render(animate?: boolean): void;
+    getFormattedValue(): any;
+    appendThresholdLabel(): void;
+    setThresholdLabelPosition(): void;
+    addEventListeners(): void;
+}

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

@@ -1,4 +1,4 @@
 import { Component } from "../component";
 export declare class Bar extends Component {
-    protected getBarWidth(): number;
+    protected getBarWidth(allDataLabels?: string[]): number;
 }

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

@@ -4,6 +4,7 @@ export declare class Scatter extends Component {
     type: string;
     init(): void;
     render(animate: boolean): void;
+    isDatapointThresholdAnomaly(datum: any, index: number): boolean;
     styleCircles(selection: Selection<any, any, any, any>, animate: boolean): void;
     handleLegendOnHover: (event: CustomEvent<any>) => void;
     handleLegendMouseOut: (event: CustomEvent<any>) => void;

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

@@ -0,0 +1,22 @@
+import { Component } from "../component";
+export declare class Skeleton extends Component {
+    type: string;
+    xScale: any;
+    yScale: any;
+    backdrop: any;
+    render(): void;
+    renderSkeleton(showShimmerEffect: boolean): void;
+    renderGridSkeleton(showShimmerEffect: boolean): void;
+    renderVertOrHorizSkeleton(showShimmerEffect: boolean): void;
+    renderPieSkeleton(showShimmerEffect: boolean): void;
+    renderDonutSkeleton(showShimmerEffect: boolean): void;
+    setScales(): void;
+    drawBackdrop(showShimmerEffect: boolean): void;
+    drawXGrid(showShimmerEffect: boolean): void;
+    drawYGrid(showShimmerEffect: boolean): void;
+    drawRing(outerRadius: number, innerRadius: number, shimmer?: boolean): void;
+    computeOuterRadius(): any;
+    computeInnerRadius(): number;
+    setShimmerEffect(gradientId: string): void;
+    removeSkeleton(): void;
+}

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

@@ -1,5 +1,6 @@
 export * from "./component";
 export * from "./essentials/legend";
+export * from "./essentials/threshold";
 export * from "./essentials/title";
 export * from "./essentials/tooltip";
 export * from "./essentials/tooltip-bar";
@@ -14,6 +15,7 @@ export * from "./graphs/line";
 export * from "./graphs/scatter";
 export * from "./graphs/pie";
 export * from "./graphs/donut";
+export * from "./graphs/skeleton";
 export * from "./layout/spacer";
 export * from "./layout/layout";
 export * from "./axes/two-dimensional-axes";

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

@@ -1,6 +1,7 @@
 import { ScaleTypes } from "./enums";
 import { AxisDomain } from "d3";
 import { Locale } from "date-fns";
+import { ThresholdOptions } from "./components";
 /**
  * options to configure a scale. not all options are used by all scales
  */
@@ -18,10 +19,10 @@ export interface AxisOptions {
      */
     domain?: AxisDomain[];
     /**
-    * Whether the Axis should be forced to include 0 as a starting point
-    * (or ending point, in case of all negative axis).
-    * Default: true
-    */
+     * Whether the Axis should be forced to include 0 as a starting point
+     * (or ending point, in case of all negative axis).
+     * Default: true
+     */
     includeZero?: boolean;
     /**
      * identifies what key within the data the axis values would map to
@@ -31,6 +32,16 @@ export interface AxisOptions {
      * optional title for the scales
      */
     title?: string;
+    /**
+     * thresholds
+     * Example:
+     * [
+     *		{value: 10000},
+     *		{value: 40020, valueFormatter: (x) => x},
+     *		{value: 55000, label: "Custom label", fillColor: "#03a9f4"},
+     * ]
+     */
+    thresholds?: ThresholdOptions[];
     /**
      * tick configuration
      */
@@ -88,14 +99,14 @@ export interface TickFormats {
 }
 export interface TimeIntervalFormats {
     "15seconds"?: TickFormats;
-    "minute"?: TickFormats;
+    minute?: TickFormats;
     "30minutes"?: TickFormats;
-    "hourly"?: TickFormats;
-    "daily"?: TickFormats;
-    "weekly"?: TickFormats;
-    "monthly"?: TickFormats;
-    "quarterly"?: TickFormats;
-    "yearly"?: TickFormats;
+    hourly?: TickFormats;
+    daily?: TickFormats;
+    weekly?: TickFormats;
+    monthly?: TickFormats;
+    quarterly?: TickFormats;
+    yearly?: TickFormats;
 }
 /**
  * customize the axes components

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

@@ -57,6 +57,10 @@ export interface BaseChartOptions {
          * identifier for data groups
          */
         groupMapsTo?: string;
+        /**
+         * used to simulate data loading
+         */
+        loading?: Boolean;
     };
     /**
      * options related to color scales
@@ -171,6 +175,7 @@ export interface PieChartOptions extends BaseChartOptions {
 export interface DonutChartOptions extends PieChartOptions {
     donut?: {
         center?: {
+            label?: string;
             numberFontSize?: Function;
             titleFontSize?: Function;
             titleYPosition?: Function;

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

@@ -86,6 +86,27 @@ export interface TooltipOptions {
         width?: number;
     };
 }
+/**
+ * Threshold options
+ */
+export interface ThresholdOptions {
+    /**
+     * threshold value
+     */
+    value: number | Date;
+    /**
+     * a function to format the threshold values
+     */
+    valueFormatter?: Function;
+    /**
+     * hex threshold line color
+     */
+    fillColor: string;
+    /**
+     * threshold label
+     */
+    label: string;
+}
 /**
  * extends tooltip options to provide support for multiple gridline tooltips
  */

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

@@ -93,6 +93,15 @@ export declare enum CalloutDirections {
     LEFT = "left",
     RIGHT = "right"
 }
+/**
+ * enum of all possible skeleton/empty state types
+ */
+export declare enum Skeletons {
+    GRID = "grid",
+    VERT_OR_HORIZ = "vertOrHoriz",
+    PIE = "pie",
+    DONUT = "donut"
+}
 /**
  * enum of all possible attributes used to aling text horizontally
  */

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

@@ -72,6 +72,13 @@ export declare enum Tooltip {
     SHOW = "show-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
  */

package/build/src/model.d.ts

@@ -17,6 +17,7 @@ export declare class ChartModel {
     constructor(services: any);
     getDisplayData(): any;
     getData(): any;
+    isDataEmpty(): boolean;
     /**
      *
      * @param newData The new raw data to be set

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

@@ -1,5 +1,5 @@
 import { Service } from "./service";
-import { AxisPositions, CartesianOrientations } from "../interfaces";
+import { AxisPositions, CartesianOrientations, ThresholdOptions } from "../interfaces";
 export declare class CartesianScales extends Service {
     protected scaleTypes: {
         top: any;
@@ -46,4 +46,12 @@ export declare class CartesianScales extends Service {
     };
     protected getScaleDomain(axisPosition: AxisPositions): any;
     protected createScale(axisPosition: AxisPositions): any;
+    getHighestDomainThreshold(): null | {
+        threshold: ThresholdOptions;
+        scaleValue: number;
+    };
+    getHighestRangeThreshold(): null | {
+        threshold: ThresholdOptions;
+        scaleValue: number;
+    };
 }

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

@@ -0,0 +1 @@
+export declare const eventListenersTutorial: string;

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

@@ -1,5 +1,6 @@
-export * from "./tabular-data-format";
 export * from "./getting-started/angular";
 export * from "./getting-started/react";
 export * from "./getting-started/vue";
 export * from "./getting-started/vanilla";
+export * from "./tabular-data-format";
+export * from "./event-listeners";