@arcgis/charts-components 5.1.0-next.8 → 5.1.0-next.80

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

@@ -1,34 +1,36 @@
 /// <reference path="../../index.d.ts" />
-import type MapView from "@arcgis/core/views/MapView";
-import type SceneView from "@arcgis/core/views/SceneView";
-import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView";
-import type { DOMContainerAria } from "@arcgis/core/views/DOMContainer";
+import type MapView from "@arcgis/core/views/MapView.js";
+import type SceneView from "@arcgis/core/views/SceneView.js";
+import type FeatureLayerView from "@arcgis/core/views/layers/FeatureLayerView.js";
+import type SelectionManager from "@arcgis/core/views/SelectionManager.js";
+import type { DOMContainerAria } from "@arcgis/core/views/DOMContainer.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
 import type { AxisLabelFormatCallback, ChartOptions, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, PieChartLegendValueLabelFormatCallback, PreRenderCallback } from "../../chart-rendering/common/interfaces.js";
-import type { CSVOptions, SupportedLayer } from "../../interfaces.js";
-import type { AxesMinMaxChangePayload, DataProcessCompletePayload, LegendItemVisibilityChangePayload, NoRenderPropChangePayload, SelectionCompletePayload, SeriesColorChangePayload } from "../../utils/components/event-payloads.js";
-import type { MissingSplitBySeriesProps, DownloadableChartImagesTypes } from "../../utils/components/interfaces.js";
+import type { CSVOptions, SupportedLayer, SupportedRasterLayer } from "../../interfaces.js";
 import type { ChartModel } from "../../model/chart-model/chart-model.js";
 import type { WebChartLegendPositions } from "../../spec/chart-object-literals.js";
-import type { WebChart, WebChartDataFilters } from "../../spec/web-chart.js";
 import type { WebChartDataTypes } from "../../spec/data-source.js";
-import type { LoaderColors, SelectionData, SelectionTheme } from "../../utils/misc/interfaces.js";
-import type { ErrorPolicy, LayerFieldsChangePolicy, LayerFilterChangePolicy, LayerRendererChangePolicy, SyncSelectionsBetweenChartAndLayerViewPolicy, ViewTimeExtentChangePolicy } from "../../utils/types/index.js";
+import type { WebChart, WebChartDataFilters } from "../../spec/web-chart.js";
+import type { DataWarningObject, ValidationStatus } from "../../utils/chart-config/validator/interfaces.js";
+import type { AxesMinMaxChangePayload, DataProcessCompletePayload, LegendItemVisibilityChangePayload, NoRenderPropChangePayload, SelectionCompletePayload, SeriesColorChangePayload } from "../../utils/components/event-payloads.js";
+import type { MissingSplitBySeriesProps, DownloadableChartImagesTypes } from "../../utils/components/interfaces.js";
 import type { ActionModes, CursorRange } from "../../utils/cursor/interfaces.js";
 import type { ChartElementLimit } from "../../utils/defaults/interfaces.js";
-import type { DataWarningObject, ValidationStatus } from "../../utils/chart-config/validator/interfaces.js";
+import type { LoaderColors, SelectionData, SelectionTheme } from "../../utils/misc/interfaces.js";
+import type { ErrorPolicy, LayerFieldsChangePolicy, LayerFilterChangePolicy, LayerRendererChangePolicy, SyncSelectionsBetweenChartAndLayerViewPolicy, ViewTimeExtentChangePolicy } from "../../utils/types/index.js";
 import type { T9nMeta } from "@arcgis/lumina/controllers";
 
 /**
- * The Chart component renders a chart based on the provided model. Get started by reading the [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) page.
+ * The Chart component renders a chart based on the provided model. Get started by reading the [introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/) page.
  *
  * Supported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.
  *
  * @slot [action-bar] - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.
  * @see [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
- * @see [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)
- * @see [Tutorial: Create a heat chart](https://developers.arcgis.com/javascript/latest/tutorials/create-a-heat-chart/)
- * @see [Tutorial: Modify a chart](https://developers.arcgis.com/javascript/latest/tutorials/modify-a-chart/)
+ * @see
+ * [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-a-chart/)
+ *
+ * **Note**: When the chart is getting rendered while its container is not yet fully sized, a console error about the chart's attribute height may appear. This is a known issue and should not affect the functionality of the chart.
  * @since 4.32
  */
 export abstract class ArcgisChart extends LitElement {
@@ -62,6 +64,7 @@ export abstract class ArcgisChart extends LitElement {
    * When `true`, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.
    *
    * @default false
+   * @since 5.0
    */
   accessor autoDestroyDisabled: boolean;
   /**
@@ -183,6 +186,9 @@ export abstract class ArcgisChart extends LitElement {
               histogramCreateMsg: string;
               scatterplotCreateMsg: string;
               calendarHeatChartCreateMsg: string;
+              comboBarLineChartCreateMsg: string;
+              radarChartCreateMsg: string;
+              gaugeCreateMsg: string;
           };
           notifications: {
               invalidConfig: string;
@@ -438,6 +444,9 @@ export abstract class ArcgisChart extends LitElement {
               histogramCreateMsg: string;
               scatterplotCreateMsg: string;
               calendarHeatChartCreateMsg: string;
+              comboBarLineChartCreateMsg: string;
+              radarChartCreateMsg: string;
+              gaugeCreateMsg: string;
           };
           notifications: {
               invalidConfig: string;
@@ -640,24 +649,6 @@ export abstract class ArcgisChart extends LitElement {
    * **Note**: Not applicable to gauge.
    */
   accessor dataLabelFormatter: ChartOptions["dataLabelFormatter"] | undefined;
-  /**
-   * Whether to disable automatic chart theming based on Calcite theme detection.
-   *
-   * **Note**: Currently, only the `calcite-mode-dark` theme is supported. When this theme
-   * is applied, all chart colors are automatically adjusted for dark mode and
-   * any custom chart colors will be overridden. This includes series, axes, grid and other elements.
-   *
-   * When `true`, the chart component will not apply any Calcite-based theming,
-   * even if a supported Calcite theme is detected.
-   *
-   * When `false` (default), the chart component will automatically apply the
-   * supported Calcite theme if it is detected on the chart container or any
-   * parent element.
-   *
-   * @default false
-   * @since 5.0
-   */
-  accessor disableAutoTheming: boolean;
   /**
    * Disables all interactions on the chart.
    *
@@ -673,6 +664,25 @@ export abstract class ArcgisChart extends LitElement {
    * @default false
    */
   accessor disableTogglingLegendItems: boolean | undefined;
+  /**
+   * Whether to enable automatic chart theming based on Calcite theme detection.
+   *
+   * **Note**: Currently, only the `calcite-mode-dark` theme is supported. When this theme
+   * is applied, all chart colors are automatically adjusted for dark mode and
+   * any custom chart colors will be overridden. This includes series, axes, grid and other elements.
+   *
+   * When `true`, the chart component will automatically apply the
+   * supported Calcite theme if it is detected on the chart container or any
+   * parent element.
+   *
+   * When `false` (default), the chart component will not apply any Calcite-based theming,
+   * even if a supported Calcite theme is detected.
+   *
+   * @default false
+   * @since 5.0
+   * @internal
+   */
+  accessor enableAutoTheming: boolean;
   /**
    * Whether to enable the beta features from the chart component.
    *
@@ -689,6 +699,7 @@ export abstract class ArcgisChart extends LitElement {
   /**
    * Enables the responsive features.
    *
+   * @deprecated since 5.1. Won't be replaced.
    * @default false
    */
   accessor enableResponsiveFeatures: boolean | undefined;
@@ -703,7 +714,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * **Note**: Only applicable to gauge.
    *
-   * @deprecated since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.
+   * @deprecated since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/model/gauge-model/gauge-model/#featureIndex) prop instead.
    */
   accessor featureIndex: number | undefined;
   /**
@@ -716,6 +727,7 @@ export abstract class ArcgisChart extends LitElement {
    * When `true`, all chart elements are filtered based on the selection.
    *
    * **Note**: Not applicable to gauge.
+   *           Not applicable to imagery layer charts.
    *
    * @default false
    */
@@ -744,6 +756,7 @@ export abstract class ArcgisChart extends LitElement {
   /**
    * Hides the license watermark.
    *
+   * @deprecated since 5.1. Won't be replaced.
    * @default false
    */
   accessor hideLicenseWatermark: boolean | undefined;
@@ -782,7 +795,7 @@ export abstract class ArcgisChart extends LitElement {
    * Used to perform queries.
    * If the layer is a `FeatureLayerView` or if the layer and the `view` property are both provided, the queries will be executed client-side.
    */
-  accessor layer: FeatureLayerView | SupportedLayer | undefined;
+  accessor layer: FeatureLayerView | SupportedLayer | SupportedRasterLayer | undefined;
   /**
    * Allows the chart to update automatically when the layer's fields change.
    *
@@ -823,7 +836,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * **Note**: Not applicable to gauge.
    *
-   * @deprecated since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.
+   * @deprecated since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#legendPosition) prop instead.
    */
   accessor legendPosition: WebChartLegendPositions | undefined;
   /**
@@ -838,7 +851,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * **Note**: Not applicable to gauge.
    *
-   * @deprecated since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.
+   * @deprecated since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#legendVisibility) prop instead.
    * @default false
    */
   accessor legendVisibility: boolean | undefined;
@@ -916,6 +929,9 @@ export abstract class ArcgisChart extends LitElement {
               histogramCreateMsg?: string | undefined;
               scatterplotCreateMsg?: string | undefined;
               calendarHeatChartCreateMsg?: string | undefined;
+              comboBarLineChartCreateMsg?: string | undefined;
+              radarChartCreateMsg?: string | undefined;
+              gaugeCreateMsg?: string | undefined;
           } | undefined;
           notifications?: {
               invalidConfig?: string | undefined;
@@ -1110,7 +1126,7 @@ export abstract class ArcgisChart extends LitElement {
   /**
    * Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:
    * - The corresponding warning event will be sent
-   * - The "no data" message will be displayed (unless `showUIMesssages` is set to `false`)
+   * - The "no data" message will be displayed (unless `showUIMessages` is set to `false`)
    *
    * @default false
    */
@@ -1120,6 +1136,7 @@ export abstract class ArcgisChart extends LitElement {
   /**
    * Builds charts sequentially instead of rendering them all at once
    *
+   * @deprecated since 5.1. Won't be replaced.
    * @default false
    */
   accessor queueChartCreation: boolean | undefined;
@@ -1156,6 +1173,7 @@ export abstract class ArcgisChart extends LitElement {
    * Only considered for a data source using a feature layer.
    *
    * **Note**: Not applicable to gauge.
+   *           Not applicable to imagery layer charts. It's always `false` for imagery layers. No object ids will be computed.
    *
    * @default false
    */
@@ -1165,7 +1183,7 @@ export abstract class ArcgisChart extends LitElement {
    *
    * **Note**: Applicable to bar chart, line chart, combo bar and line chart and box plot.
    *
-   * @deprecated since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead.
+   * @deprecated since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#rotatedState) prop instead.
    * @default false
    */
   accessor rotation: boolean | undefined;
@@ -1184,6 +1202,13 @@ export abstract class ArcgisChart extends LitElement {
    * **Note**: Not applicable to gauge.
    */
   accessor selectionData: SelectionData | undefined;
+  /**
+   * Selection manager object used to synchronize the selections with the chart when `syncViewSelection` is `true`.
+   * It has precedence over the layer view's [SelectionManager](https://developers.arcgis.com/javascript/latest/references/core/views/SelectionManager/) when both are available.
+   *
+   * @since 5.1
+   */
+  accessor selectionManager: SelectionManager | undefined;
   /**
    * Used to provide a customized theme for the selected and non selected elements.
    * - If no style is provided for the selected elements, a default selection is applied.
@@ -1213,11 +1238,19 @@ export abstract class ArcgisChart extends LitElement {
    */
   accessor syncSelection: boolean;
   /**
-   * Determines whether the selections from the chart should be synchronized with the layer view and vice versa.
+   * Determines whether the chart's selection should be synchronized with either the chart's `selectionManager` or the layer view's.
    *
+   * @deprecated since 5.1. Use [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) instead.
    * @default "disabled"
    */
   accessor syncSelectionsBetweenChartAndLayerViewPolicy: SyncSelectionsBetweenChartAndLayerViewPolicy;
+  /**
+   * Determines whether the chart's selection should be synchronized with either the chart's `selectionManager` or the layer view's.
+   *
+   * @default false
+   * @since 5.1
+   */
+  accessor syncViewSelection: boolean;
   /** Used to set a custom time zone for the chart. */
   accessor timeZone: MapView["timeZone"] | undefined;
   /**
@@ -1269,6 +1302,12 @@ export abstract class ArcgisChart extends LitElement {
    * **Note**: Not applicable to pie chart or gauge.
    */
   accessor yAxisLabelFormatter: AxisLabelFormatCallback | undefined;
+  /**
+   * Apply the selection from the selection manager to the chart.
+   *
+   * @internal
+   */
+  applySelectionFromSelectionManager(): void;
   /**
    * Clears all selection on the chart.
    *
@@ -1276,11 +1315,11 @@ export abstract class ArcgisChart extends LitElement {
    */
   clearSelection(): Promise<void>;
   /**
-   * Triggers an alert to display an error message.
+   * Destroys the chart instance and removes it from the DOM.
    *
-   * @param errorMessage
+   * @since 5.1
    */
-  errorAlert(errorMessage?: string): Promise<void>;
+  destroy(): Promise<void>;
   /**
    * Export the current chart's data as a CSV file.
    *
@@ -1317,8 +1356,8 @@ export abstract class ArcgisChart extends LitElement {
    * It can be used to pass validation or information messages.
    * In a situation where a config update is overriding your notification modal, consider waiting for the `arcgisUpdateComplete` event.
    *
-   * @param message - The message to display in the notification panel.
-   * @param heading - The heading to display in the notification panel.
+   * @param message - The message to display in the chart's info modal.
+   * @param heading - The heading to display in the chart's info modal.
    */
   notify(message?: string, heading?: string): Promise<void>;
   /**