@arcgis/charts-components 4.34.0-next.12 → 4.34.0-next.121

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

@@ -1,33 +1,34 @@
-/// <reference types="../../index.d.ts" />
-import { SupportedLayer, WebChart, WebChartDataFilters, WebChartDataTypes, WebChartLegendPositions } from '@arcgis/charts-spec';
+/// <reference path="../../index.d.ts" />
+import { SupportedLayer, WebChart, WebChartDataFilters, WebChartDataTypes, WebChartLegendPositions } from '../../spec';
 import { default as MapView } from '@arcgis/core/views/MapView';
 import { default as SceneView } from '@arcgis/core/views/SceneView';
-import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
+import { FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { PropertyValues } from 'lit';
-import { AxisLabelFormatCallback, ChartOptions, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, MessageOptions, NotifyOptions, PieChartLegendValueLabelFormatCallback, PreRenderCallback } from '../../chart-rendering/common/interfaces';
+import { AxisLabelFormatCallback, ChartOptions, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, NotifyOptions, PieChartLegendValueLabelFormatCallback, PreRenderCallback } from '../../chart-rendering/common/interfaces';
 import { CSVOptions } from '../../interfaces';
 import { ChartModel } from '../../model';
 import { ActionModes, ChartElementLimit, CursorRange, DataWarningObject, LoaderColors, SelectionData, SelectionTheme, ValidationStatus, ErrorPolicy, LayerFieldsChangePolicy, LayerFilterChangePolicy, LayerRendererChangePolicy, SyncSelectionsBetweenChartAndLayerViewPolicy, ViewTimeExtentChangePolicy } from '../../utils';
 import { AxesMinMaxChangePayload, DataProcessCompletePayload, LegendItemVisibilityChangePayload, NoRenderPropChangePayload, SelectionCompletePayload, SeriesColorChangePayload } from '../../utils/components/event-payloads';
-import { MissingSplitBySeriesProps, WebChartComponentVersion, DownloadableChartImagesTypes } from '../../utils/components/interfaces';
+import { MissingSplitBySeriesProps, DownloadableChartImagesTypes } from '../../utils/components/interfaces';
 
 /**
- * Chart component renders various chart types based on the provided model, including bar charts, line charts, pie charts, box plots, combo bar-line charts, gauges, scatterplots, and histograms.
+ * The ArcGIS Chart component renders various chart types based on the provided model.
+ *
+ * Supported chart types include bar charts, line charts, pie charts, box plots, combo bar-line charts, gauges, scatterplots, histograms and radar charts.
+ *
+ * The Chart component can be rendered using an [existing model](https://developers.arcgis.com/javascript/latest/charts-components-intro/#use-an-existing-model-from-a-webmap-or-feature-layer) from a web map or feature layer,
+ * or by [creating a new model](https://developers.arcgis.com/javascript/latest/charts-components-intro/#create-a-new-model).
+ *
+ * See also:
+ * - [Introduction to Charts components](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
+ * - [Tutorial: Display and create charts components](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/)
  *
- * @slot [action-bar] - A slot for adding charts-action-bar component or calcite-action-bar.
+ * @slot [action-bar] - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.
  */
 export declare class ArcgisChart extends LitElement {
-    /**
-     * Whether to use the stable version of the component or the beta version.
-     *
-     * @type {WebChartComponentVersion}
-     * @category Public
-     * @default "stable"
-     */
-    componentVersion: WebChartComponentVersion;
     /**
      * Instance of an ArcGIS Chart Model. Provides an API to interact with the chart's configuration.
      *
@@ -36,7 +37,7 @@ export declare class ArcgisChart extends LitElement {
      * @type {ChartModel | WebChart | undefined}
      * @default undefined
      */
-    model: ChartModel | WebChart | undefined;
+    model?: ChartModel | WebChart;
     /**
      * Whether to use features uniquely designed for a chart currently being configured by a user via the UI.
      *
@@ -107,6 +108,34 @@ export declare class ArcgisChart extends LitElement {
      */
     get legendVisibility(): boolean | undefined;
     set legendVisibility(value: boolean | undefined);
+    /**
+     * Whether to allow the object id to be used as a statistic other than COUNT.
+     *
+     * @type {boolean}
+     * @category Public
+     * @default false
+     */
+    allowUsingObjectIdStat: boolean;
+    /**
+     * 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`)
+     *
+     * @type {boolean}
+     * @category Public
+     * @default false
+     */
+    nullAsValid: boolean;
+    /**
+     * Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an
+     * axis when the data contains values <= 0).
+     *
+     * @type {boolean | undefined}
+     * @category Public
+     * @default undefined
+     */
+    showUIMessages?: boolean;
     /**
      * When `true`, the empty series are completely hidden from the chart and the legend.
      * For example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).
@@ -117,6 +146,17 @@ export declare class ArcgisChart extends LitElement {
      * @default undefined
      */
     hideEmptySeries?: boolean;
+    /**
+     * When `true`, the data label text color is automatically inverted based on the data label background color.
+     * For example if the data label is dark, and it's on top of a dark color series area, the text color will eventually
+     * be set to either the chart's background color or white.
+     *
+     * @remarks This feature is currently only available for bar chart.
+     * @type {boolean | undefined}
+     * @category Public
+     * @default undefined
+     */
+    autoInverseDataLabelTextColor?: boolean;
     /**
      * When `true`, the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)
      * will be populated with 0s, via the `completeDataForEmptyCategoriesWithZeros` method.
@@ -187,6 +227,30 @@ export declare class ArcgisChart extends LitElement {
      * @default undefined
      */
     layer?: FeatureLayerView | SupportedLayer;
+    /**
+     * Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.
+     *
+     * If `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
+     *
+     * @example <arcgis-chart layer-item-id="05e015c5f0314db9a487a9b46cb37eca" chart-index="2"></arcgis-chart>
+     * @type {string | undefined}
+     * @category Public
+     * @default undefined
+     */
+    layerItemId?: string;
+    /**
+     * The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.
+     *
+     * If a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
+     *
+     * If the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.
+     *
+     * @example <arcgis-chart layer-item-id="05e015c5f0314db9a487a9b46cb37eca" chart-index="2"></arcgis-chart>
+     * @type {number | undefined}
+     * @category Public
+     * @default undefined
+     */
+    chartIndex?: number;
     /**
      * When this property is set, it will apply a selection on the chart matching the provided selection.
      *
@@ -411,14 +475,6 @@ export declare class ArcgisChart extends LitElement {
      * @default undefined
      */
     gaugeInnerLabelFormatter?: GaugeInnerLabelFormatCallback;
-    /**
-     * Used to set the options available to handle specific messages displayed by the chart.
-     *
-     * @type {MessageOptions | undefined}
-     * @category Public
-     * @default undefined
-     */
-    messageOptions?: MessageOptions;
     /**
      * Whether to display an error alert and hide the chart when it can't be created or updated.
      *
@@ -534,6 +590,13 @@ export declare class ArcgisChart extends LitElement {
      * @default undefined
      */
     updateSplitBySeries?: MissingSplitBySeriesProps;
+    /**
+     * Returns a promise that resolves when the chart model is fully loaded.
+     *
+     * @returns
+     * @category Public
+     */
+    loadModel(): Promise<void>;
     /**
      * Clears all selection on the chart.
      *
@@ -548,28 +611,38 @@ export declare class ArcgisChart extends LitElement {
      * @param errorMessage
      */
     errorAlert(errorMessage?: string): Promise<void>;
-    /**
-     * Export the current chart as an image.
-     *
-     * @param format The format of the image to download.
-     * @category Public
-     * @default DownloadableChartImagesTypes.PNG
-     */
-    exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>;
     /**
      * Export the current chart's data as a CSV file.
      *
      * @param
      * options The options to use when exporting the data.
      *
+     * NOTE: This method won't work for scatterplot series. The support charts for this method are:
+     * - Bar chart
+     * - Line chart
+     * - Combo bar-line chart
+     * - Box plot
+     * - Histogram
+     * - Pie chart
+     *
      * The `Options` object can contain the following properties:
      * - `columns` - An array of column to include in the CSV file.
      * - `delimiter` - The delimiter to use in the CSV file. Default is `,`.
      * - `includeHeader` - Whether to include the header row in the CSV file. Default is `true`.
      * - `quoteAll` - Whether to quote all values in the CSV file. Default is `false`.
+     * - `locale` - The locale to use when formatting the CSV file. Default is `en`.
+     * * * Locale supported are: "ar", "ar-u-nu-latn", "bs", "bg", "ca", "cs", "da", "de", "el", "en", "en-US", "es", "et", "fi", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "no", "nl", "pl", "pt-BR", "pt-PT", "ro", "ru", "sr", "sl", "sk", "sv", "th", "tr", "uk", "vi", "zh-CN", "zh-HK", "zh-TW"
      * @category Public
      */
     exportAsCSV(options?: CSVOptions): Promise<void>;
+    /**
+     * Export the current chart as an image.
+     *
+     * @param format The format of the image to download.
+     * @category Public
+     * @default DownloadableChartImagesTypes.PNG
+     */
+    exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>;
     /**
      * Notify method allows passing external messages to the chart component.
      * It can be used to pass validation or information messages.
@@ -623,6 +696,13 @@ export declare class ArcgisChart extends LitElement {
      * @event
      */
     readonly arcgisBadDataWarningRaise: TargetedEvent<this, DataWarningObject>;
+    /**
+     * Event triggered when the chart is not found for the given `chartIndex` property.
+     *
+     * @type {EventEmitter<string>}
+     * @event
+     */
+    readonly arcgisChartNotFoundWarning: TargetedEvent<this, string>;
     /**
      * Event triggered when the chart config is changed
      *