@arcgis/charts-components 5.0.0-next.4 → 5.0.0-next.41

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

@@ -4,25 +4,24 @@ import { default as SceneView } from '@arcgis/core/views/SceneView';
 import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLayerView';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { PropertyValues } from 'lit';
-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 { SupportedLayer, WebChart, WebChartDataFilters, WebChartDataTypes, WebChartLegendPositions } from '../../spec';
 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, 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/)
  *
@@ -32,7 +31,6 @@ import { MissingSplitBySeriesProps, DownloadableChartImagesTypes } from '../../u
 export declare class ArcgisChart extends LitElement {
     /**
      * 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}
@@ -592,12 +590,11 @@ export declare class ArcgisChart extends LitElement {
      */
     updateSplitBySeries?: MissingSplitBySeriesProps;
     /**
-     * Returns a promise that resolves when the chart model is fully loaded.
+     * Custom message overrides for the chart's strings.
      *
-     * @returns
-     * @category Public
+     * @public
      */
-    loadModel(): Promise<void>;
+    messageOverrides?: typeof this._messages._overrides & typeof this.commonStrings._overrides;
     /**
      * Clears all selection on the chart.
      *
@@ -644,6 +641,13 @@ export declare class ArcgisChart extends LitElement {
      * @default DownloadableChartImagesTypes.PNG
      */
     exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>;
+    /**
+     * Returns a promise that resolves when the chart model is fully loaded.
+     *
+     * @returns
+     * @category Public
+     */
+    loadModel(): Promise<void>;
     /**
      * Notify method allows passing external messages to the chart component.
      * It can be used to pass validation or information messages.
@@ -660,14 +664,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
@@ -716,7 +718,8 @@ export declare class ArcgisChart extends LitElement {
     }>;
     /**
      * Event triggered once the chart data has been fetched but not yet fully processed.
-     * For instance it can be useful for a pie chart to see all the slices before they get grouped into an 'other' slice during the post-processing step.
+     * Only supported for pie chart at the moment.
+     * For instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.
      *
      * @type {EventEmitter<WebChartDataTypes>}
      * @event
@@ -783,6 +786,8 @@ export declare class ArcgisChart extends LitElement {
      * @event
      */
     readonly arcgisUpdateComplete: TargetedEvent<this, ValidationStatus>;
+    private _messages;
+    private commonStrings;
     readonly _setterTypes: {
         disableInteractions?: boolean | undefined;
     };