@carbon/charts 1.16.4 → 1.16.6

package/dist/interfaces/layout.d.ts

@@ -1,21 +1,46 @@
 import { LayoutAlignItems, LayoutDirection, RenderTypes } from './enums';
+/**
+ * Configuration for layout settings.
+ */
 export interface LayoutConfigs {
     /**
-     * Direction/orientation of the layout
+     * Direction/orientation of the layout.
+     * @type {LayoutDirection | string}
      */
     direction?: LayoutDirection | string;
     /**
-     * Whether to render through SVG or HTML
+     * Whether to render through SVG or HTML.
+     * @type {RenderTypes | string}
      */
     renderType?: RenderTypes | string;
     /**
-     * how the layout will align its children
+     * How the layout will align its children.
+     * @type {LayoutAlignItems | string}
      */
     alignItems?: LayoutAlignItems | string;
 }
+/**
+ * Interface representing coordinates in a 2D space.
+ */
 export interface Coordinates {
+    /**
+     * The x-coordinate.
+     * @type {number}
+     */
     x: number;
+    /**
+     * The y-coordinate.
+     * @type {number}
+     */
     y: number;
+    /**
+     * The optional initial x-coordinate.
+     * @type {number}
+     */
     x0?: number;
+    /**
+     * The optional initial y-coordinate.
+     * @type {number}
+     */
     y0?: number;
 }

package/dist/interfaces/services.d.ts

@@ -7,14 +7,53 @@ import { Events } from '../services/essentials/events';
 import { Files } from '../services/essentials/files';
 import { GradientUtils } from '../services/essentials/gradient-utils';
 import { Zoom } from '../services/zoom';
+/**
+ * Represents a collection of service instances used within the chart.
+ */
 export interface Services {
+    /**
+     * Optional canvas zoom service.
+     * @type {CanvasZoom}
+     */
     canvasZoom?: CanvasZoom;
+    /**
+     * Optional Cartesian scales service.
+     * @type {CartesianScales}
+     */
     cartesianScales?: CartesianScales;
+    /**
+     * Optional curves service.
+     * @type {Curves}
+     */
     curves?: Curves;
+    /**
+     * Optional DOM utilities service.
+     * @type {DOMUtils}
+     */
     domUtils?: DOMUtils;
+    /**
+     * Optional events service.
+     * @type {Events}
+     */
     events?: Events;
+    /**
+     * Optional files service.
+     * @type {Files}
+     */
     files?: Files;
+    /**
+     * Optional gradient utilities service.
+     * @type {GradientUtils}
+     */
     gradientUtils?: GradientUtils;
+    /**
+     * Optional transitions service.
+     * @type {Transitions}
+     */
     transitions?: Transitions;
+    /**
+     * Optional zoom service.
+     * @type {Zoom}
+     */
     zoom?: Zoom;
 }

package/dist/model/cartesian-charts.d.ts

@@ -15,7 +15,13 @@ export declare class ChartModelCartesian extends ChartModel {
     getTabularDataArray(): any[];
     setData(newData: any): any;
     /**
-     * @param zoomBarData any special zoom bar data to use instead of the model data
+     * Sets the zoom bar data for the current instance.
+     *
+     * This method sanitizes the provided zoom bar data or uses the display data if no explicit
+     * zoom data is provided. It normalizes the zoom bar data by aggregating values based on unique
+     * dates and updates the instance's state with the normalized data.
+     *
+     * @param {any} [newZoomBarData] - The new zoom bar data to be set. If not provided, the display data will be used.
      */
     setZoomBarData(newZoomBarData?: any): void;
     getZoomBarData(): any;

package/dist/model/circle-pack.d.ts

@@ -26,11 +26,12 @@ export declare class CirclePackChartModel extends ChartModel {
     getTabularDataArray(): any[];
     /**
      * Recursively determine the relationship between all the nested elements in the child
-     * @param children: Object
-     * @param parent: String
-     * @param result: Array<Object>
-     * @param totalSum: number
-     * @returns: number
+     * @private
+     * @param {any} children - The children nodes to process.
+     * @param {any} parent - The parent node associated with the children.
+     * @param {string[][]} [result=[]] - An array to accumulate the resulting data.
+     * @param {number} [totalSum=0] - The running total sum of values processed.
+     * @returns {number} Sum.
      */
     private getChildrenDatums;
 }

package/dist/model/heatmap.d.ts

@@ -35,8 +35,14 @@ export declare class HeatmapModel extends ChartModelCartesian {
      */
     getMatrix(): any;
     /**
+     * Sets the data for the current instance.
      *
-     * @param newData The new raw data to be set
+     * This method sanitizes the provided data, generates data groups,
+     * and updates the instance's state with the sanitized data and data groups.
+     * It also resets the `_domains`, `_ranges`, and `_matrix` attributes to their empty states.
+     *
+     * @param {any} newData - The new data to be set. This data will be cloned and sanitized.
+     * @returns {any} - The sanitized version of the provided data.
      */
     setData(newData: any): any;
     /**

package/dist/model/index.mjs

@@ -1,4 +1,4 @@
-import { A as l, B as o, a as r, C as d, b as t, c as C, d as M, e as s, G as h, H as i, M as p, P as u, R as B, T as c, f as m, W as n } from "../wordcloud-KxSjz0Gg.mjs";
+import { A as l, B as o, a as r, C as d, b as t, c as C, d as M, e as s, G as h, H as i, M as p, P as u, R as B, T as c, f as m, W as n } from "../wordcloud-BsEQRUwL.mjs";
 export {
   l as AlluvialChartModel,
   o as BoxplotChartModel,

package/dist/model/model.d.ts

@@ -32,8 +32,13 @@ export declare class ChartModel {
     getData(): any;
     isDataEmpty(): boolean;
     /**
+     * Sets the data for the current instance.
      *
-     * @param newData The new raw data to be set
+     * This method sanitizes the provided data, generates data groups,
+     * and updates the instance's state with the sanitized data and data groups.
+     *
+     * @param {any} newData - The new data to be set. This data will be cloned and sanitized.
+     * @returns {any} - The sanitized version of the provided data.
      */
     setData(newData: any): any;
     getDataGroups(groups?: any): any;
@@ -56,14 +61,21 @@ export declare class ChartModel {
     getDataValuesGroupedByKeys({ bins, groups }: StackKeysParams): any;
     getStackedData({ percentage, groups, divergent }: StackKeysParams): any[][];
     /**
-     * @return {Object} The chart's options
+     * Retrieves the current options from the instance's state.
+     *
+     * @returns {any} - The current options stored in the instance's state.
      */
     getOptions(): any;
     set(newState: any, configs?: any): void;
     get(property?: string): any;
     /**
+     * Updates the current options for the instance.
+     *
+     * This method retrieves the existing options, updates the legend additional items,
+     * and merges the new options with the existing ones. The instance's state is then updated
+     * with the merged options.
      *
-     * @param newOptions New options to be set
+     * @param {any} newOptions - The new options to be set. These options will be merged with the existing options.
      */
     setOptions(newOptions: any): void;
     /**

package/dist/model/tree.d.ts

@@ -4,11 +4,18 @@ import { ChartModel } from './model';
  */
 export declare class TreeChartModel extends ChartModel {
     constructor(services: any);
+    /**
+     * Retrieves and formats tabular data from the display data.
+     *
+     * @returns {any[]} An object containing the headers and cells of the tabular data.
+     */
     getTabularDataArray(): any[];
     /**
      * Determine the child parent relationship in nested data
-     * @param datum: Object
-     * @param result: Array<Object>
+     * @private
+     * @param {any} datum - The datum node to process.
+     * @param {any[]} [result=[]] - An array to accumulate the resulting data.
+     * @returns {any[]} The accumulated result array.
      */
     private getChildrenDatums;
 }

package/dist/services/index.mjs

@@ -1,6 +1,6 @@
-import { T as e, c as r, f as i, b as o, g as t, a as l, d as m, i as n } from "../color-scale-utils-C93P4hee.mjs";
-import { D as c, G as d, S as C, d as f, a as g, p, b as D, r as S } from "../angle-utils-D8sXyiIj.mjs";
-import { C as b, b as E, a as x, E as I, F as M, T as P, Z } from "../zoom-B7KfNcH9.mjs";
+import { T as e, c as r, f as i, b as o, g as t, a as l, d as m, i as n } from "../color-scale-utils-BaTmNvWt.mjs";
+import { D as c, G as d, S as C, d as f, a as g, p, b as D, r as S } from "../angle-utils-BCx3SRS2.mjs";
+import { C as b, b as E, a as x, E as I, F as M, T as P, Z } from "../zoom-E2POxw6n.mjs";
 export {
   b as CanvasZoom,
   E as CartesianScales,