@arcgis/charts-components 4.34.0-next.98 → 4.34.0

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

@@ -1,45 +1,36 @@
 /// <reference path="../../index.d.ts" />
-import { SupportedLayer, WebChart, WebChartDataFilters, WebChartDataTypes, WebChartLegendPositions } from '@arcgis/charts-spec';
 import { default as MapView } from '@arcgis/core/views/MapView';
 import { default as SceneView } from '@arcgis/core/views/SceneView';
-import { FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
+import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { PropertyValues } from 'lit';
-import { AxisLabelFormatCallback, ChartOptions, DisplaySettings, QuerySettings, GaugeInnerLabelFormatCallback, GuideTooltipFormatCallback, NotifyOptions, PieChartLegendValueLabelFormatCallback, PreRenderCallback } from '../../chart-rendering/common/interfaces';
+import { SupportedLayer, WebChart, WebChartDataFilters, WebChartDataTypes, WebChartLegendPositions } from '../../spec';
+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';
 
 /**
- * The ArcGIS Chart component renders various chart types based on the provided model.
+ * The ArcGIS 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, 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).
+ * Supported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.
  *
  * 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/)
+ * - [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
+ * - [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)
+ * - [Tutorial: Create a heat chart](https://developers.arcgis.com/javascript/latest/tutorials/create-a-heat-chart/)
+ * - [Tutorial: Modify a chart](https://developers.arcgis.com/javascript/latest/tutorials/modify-a-chart/)
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/)
  *
+ * @since 4.32
  * @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.
-     *
      * **Note:** This property has a union type of `ChartModel | WebChart` meaning a raw chart config object can be passed to it instead, however it is recommended to use a `ChartModel` instance whenever possible.
      *
      * @type {ChartModel | WebChart | undefined}
@@ -117,29 +108,33 @@ export declare class ArcgisChart extends LitElement {
     get legendVisibility(): boolean | undefined;
     set legendVisibility(value: boolean | undefined);
     /**
-     * Used to set the options available to handle messages displayed on the chart.
+     * Whether to allow the object id to be used as a statistic other than COUNT.
      *
-     * @type {DisplaySettings | undefined}
+     * @type {boolean}
      * @category Public
-     * @default undefined
+     * @default false
      */
-    displaySettings?: DisplaySettings;
+    allowUsingObjectIdStat: boolean;
     /**
-     * Used to set the options available to query data for the chart.
+     * 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 {QuerySettings | undefined}
+     * @type {boolean}
      * @category Public
-     * @default undefined
+     * @default false
      */
-    querySettings?: QuerySettings;
+    nullAsValid: boolean;
     /**
-     * Whether to allow the object id to be used as a statistic other than COUNT.
+     * 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
      */
-    allowUsingObjectIdStat?: boolean;
+    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).
@@ -594,6 +589,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.
      *
@@ -656,14 +658,12 @@ export declare class ArcgisChart extends LitElement {
      * Re-render the chart.
      *
      * @param props.updateData Indicates whether to fetch new data. Default: true.
-     * @param props.updateExtent Indicates whether the view's extent is to update. Default: false.
      * @param props.resetAxesBounds Option to reset the axes bounds along with the refresh. Default: false;
      * @category Public
      */
     refresh(props?: {
         updateData?: boolean;
         resetAxesBounds?: boolean;
-        updateExtent?: boolean;
     }): Promise<void>;
     /**
      * Resets the chart zoom to bring it back to full extent