@arcgis/charts-components 5.0.0-next.13 → 5.0.0-next.131

package/dist/components/arcgis-chart/index.d.ts

@@ -1,2 +1,4 @@
 import "@esri/calcite-components/components/calcite-alert";
+import "@esri/calcite-components/components/calcite-loader";
+import "../arcgis-charts-info-modal/index.js";
 export * from "./customElement.js";

package/dist/components/arcgis-chart/index.js

@@ -1,2 +1,4 @@
 import "@esri/calcite-components/components/calcite-alert";
+import "@esri/calcite-components/components/calcite-loader";
+import "../arcgis-charts-info-modal/index.js";
 export * from "./customElement.js";

package/dist/components/arcgis-charts-action-bar/customElement.d.ts

@@ -1,355 +1,216 @@
 /// <reference path="../../index.d.ts" />
-import { ChartTypes, ActionModes, ActionState, ActionToggle, DefaultChartActions } from '../../utils';
 import { DefaultActionSelectPayload } from '../../utils/components/event-payloads';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
-import { WebChartTypes } from '../../spec';
 import { ArcgisChart } from '../arcgis-chart/customElement.js';
+import { ChartTypes } from '../../utils/misc/index';
+import { ActionState, ActionToggle, DefaultChartActions } from '../../utils/types/index';
+import { ActionModes } from '../../utils/cursor/interfaces';
+import { WebChartTypes } from '../../spec/chart-object-literals';
 
 /**
- * The ArcGIS charts action bar component enhances chart functionality by offering context-specific actions such as rotation, zooming, and filtering.
- * It also supports general actions like exporting the chart as an image or CSV.
+ * The Charts Action Bar component provides context-specific actions such as rotation, zooming, and filtering, as well as general actions like exporting the chart as an image or CSV file.
  * This component is designed to be used with a chart component and is not intended for standalone use.
  *
- * See also:
- * - [Tutorial: Charts components with Map components using charts action bar](https://developers.arcgis.com/javascript/latest/tutorials/charts-components-with-map-components/)
- *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-charts-action-bar/)
  *
- * @since 4.29
  * @slot [custom-action-top] - A slot for adding custom `calcite-action` to the top of the default actions.
  * @slot [custom-action-below] - A slot for adding custom `calcite-action` to the bottom of the default actions.
+ * @see [Tutorial: Chart and map interactions](https://developers.arcgis.com/javascript/latest/tutorials/chart-and-map-interactions/)
+ * @since 4.29
  */
 export declare class ArcgisChartsActionBar extends LitElement {
-    /** Overwrite localized strings for this component */
+    /** Overwrite localized strings for this component. */
     messageOverrides?: typeof this._messages._overrides;
-    /**
-     * Chart type used to determine which default actions to display.
-     *
-     * @category Public
-     * @type {SupportedCharts | undefined}
-     * @default undefined
-     */
+    /** Chart type used to determine which default actions to display. */
     chartType?: ChartTypes;
-    /**
-     * Chart element reference with which the action bar is associated.
-     *
-     * @category Public
-     * @type {HTMLArcgisChartElement}
-     * @default undefined
-     */
+    /** Chart element reference with which the action bar is associated. */
     chartElement?: HTMLArcgisChartElement;
     /**
      * When `true`, overrides the individual settings for each action to instead force disable them all.
      *
-     * @category Public
-     * @type {boolean}
      * @default false
      */
     forceDisableActions: boolean;
     /**
-     * When active, the edit chart action is highlighted.
+     * When `active`, the edit chart action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     editChartToggle: ActionToggle;
     /**
-     * When disabled, interaction with the edit chart action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the edit chart action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "disabled"
      */
     editChartState: ActionState;
-    /**
-     * Custom title for the edit chart action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the edit chart action. */
     editChartTitle?: string;
     /**
-     * When active, the legend action is highlighted.
+     * When `active`, the legend action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     legendToggle: ActionToggle;
     /**
-     * When disabled, interaction with the legend action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the legend action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     legendState: ActionState;
-    /**
-     * Custom title for the legend action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the legend action. */
     legendTitle?: string;
     /**
-     * When active, the rotate chart action is highlighted.
+     * When `active`, the rotate chart action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     rotateChartToggle: ActionToggle;
     /**
-     * When disabled, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     rotateChartState: ActionState;
-    /**
-     * Custom title for the rotate chart action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the rotate chart action. */
     rotateChartTitle?: string;
     /**
-     * When active, the filter by selection action is highlighted.
+     * When `active`, the filter by selection action is highlighted.
      *
-     * @category
-     * Public
-     * type {ActionToggle}
      * @default "inactive"
      */
     filterBySelectionToggle: ActionToggle;
     /**
-     * When disabled, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     filterBySelectionState: ActionState;
-    /**
-     * Custom title for the filter by selection action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the filter by selection action. */
     filterBySelectionTitle?: string;
     /**
-     * When active, the filter by extent action is highlighted.
+     * When `active`, the filter by extent action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     filterByExtentToggle: ActionToggle;
     /**
-     * When disabled, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     filterByExtentState: ActionState;
-    /**
-     * Custom title for the filter by extent action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the filter by extent action. */
     filterByExtentTitle?: string;
     /**
-     * Action bar selection mode. Defines which selection mode the slotted action bar should use.
+     * Defines which selection mode the slotted action bar should use.
+     * - `monoSelection`: Select a single data point/series, new selection replaces the previous one.
+     * - `multiSelection`: Select multiple data points/series, new selection adds to the previous one.
+     * - `multiSelectionWithCtrlKey`: Select multiple data points/series while holding the Ctrl key (Cmd key on Mac), new selection adds to the previous one.
      *
-     * @category Public
-     * @type {Extract<ActionModes, "monoSelection" | "multiSelection" | "multiSelectionWithCtrlKey">}
      * @default "multiSelectionWithCtrlKey"
      */
     actionBarSelectionMode?: Extract<ActionModes, "monoSelection" | "multiSelection" | "multiSelectionWithCtrlKey">;
     /**
-     * When active, the selection action is highlighted.
+     * When `active`, the selection action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     selectionToggle: ActionToggle;
     /**
-     * When disabled, interaction with the selection action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the selection action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     selectionState: ActionState;
-    /**
-     * Custom title for the selection action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the selection action. */
     selectionTitle?: string;
     /**
-     * When active, the zoom action is highlighted.
+     * When `active`, the zoom action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     zoomToggle: ActionToggle;
     /**
-     * When disabled, interaction with the zoom action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the zoom action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     zoomState: ActionState;
-    /**
-     * Custom title for the zoom action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the zoom action. */
     zoomTitle?: string;
     /**
-     * When active, the full extent action is highlighted.
+     * When `active`, the full extent action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     fullExtentToggle: ActionToggle;
     /**
-     * When disabled, interaction with the full extent action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the full extent action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     fullExtentState: ActionState;
-    /**
-     * Custom title for the full extent action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the full extent action. */
     fullExtentTitle?: string;
     /**
-     * When active, the clear selection action is highlighted.
+     * When `active`, the clear selection action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     clearSelectionToggle: ActionToggle;
     /**
-     * When disabled, interaction with the clear selection action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the clear selection action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     clearSelectionState: ActionState;
-    /**
-     * Custom title for the clear selection action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the clear selection action. */
     clearSelectionTitle?: string;
     /**
-     * When active, the switch selection action is highlighted.
+     * When `active`, the switch selection action is highlighted.
      *
-     * @category Public
-     * @type {ActionToggle}
      * @default "inactive"
      */
     switchSelectionToggle: ActionToggle;
     /**
-     * When disabled, interaction with the switch selection action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the switch selection action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     switchSelectionState: ActionState;
-    /**
-     * Custom title for the switch selection action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the switch selection action. */
     switchSelectionTitle?: string;
     /**
-     * When disabled, interaction with the download image is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the download image is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     exportAsImageState: ActionState;
-    /**
-     * Custom title for the download chart action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the download chart action. */
     exportAsImageTitle?: string;
     /**
-     * When disabled, interaction with the download CSV is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the download CSV is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     exportAsCSVState: ActionState;
-    /**
-     * Custom title for the download CSV action.
-     *
-     * @category Public
-     * @type {string | undefined}
-     * @default undefined
-     */
+    /** Custom title for the download CSV action. */
     exportAsCSVTitle?: string;
     /**
      * The CSV export action is disabled for certain chart types.
      *
      * Modify this property to add or remove chart types from the list of disabled types.
-     *
-     * @category Public
-     * @type {WebChartTypes[]}
-     * @default [WebChartTypes.ScatterSeries, WebChartTypes.BoxPlotSeries]
      */
     disableCSVExportForChartTypes: WebChartTypes[];
     /**
-     * When disabled, interaction with the export action is prevented and the component is displayed with lower opacity.
+     * When `disabled`, interaction with the export action is prevented and the component is displayed with lower opacity.
      *
-     * @category Public
-     * @type {ActionState}
      * @default "enabled"
      */
     exportActionState: ActionState;
     /**
      * When `true`, the action bar is expanded.
      *
-     * @category Public
-     * @type {boolean}
      * @default false
      */
     expanded: boolean;
@@ -357,25 +218,15 @@ export declare class ArcgisChartsActionBar extends LitElement {
      * Holds a list of actions to hide from the action bar.
      *
      * **Note:** The edit chart action is hidden by default. To show it, remove its value from this array.
-     *
-     * @category Public
-     * @type {DefaultChartActions[]}
-     * @default ["editChart"]
      */
     hiddenActions: DefaultChartActions[];
-    /**
-     * Event triggered once action bar expand is toggled
-     *
-     * @type {EventEmitter<boolean>}
-     * @event
-     */
+    /** Event triggered once action bar expand is toggled. */
     readonly arcgisActionBarToggle: TargetedEvent<this, boolean>;
-    /**
-     * Event triggered once a default action is selected
-     *
-     * @type {EventEmitter<DefaultActionSelectPayload>}
-     * @event
-     */
+    /** Event triggered once a default action is selected. */
     readonly arcgisDefaultActionSelect: TargetedEvent<this, DefaultActionSelectPayload>;
     private _messages;
+    "@eventTypes": {
+        "arcgisActionBarToggle": ArcgisChartsActionBar["arcgisActionBarToggle"]["detail"];
+        "arcgisDefaultActionSelect": ArcgisChartsActionBar["arcgisDefaultActionSelect"]["detail"];
+    };
 }