@arcgis/charts-components 4.34.0-next.5 → 4.34.0-next.50

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

@@ -13,11 +13,20 @@ import { AxesMinMaxChangePayload, DataProcessCompletePayload, LegendItemVisibili
 import { MissingSplitBySeriesProps, WebChartComponentVersion, 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 {
     /**
@@ -562,6 +571,14 @@ export declare class ArcgisChart extends LitElement {
      * @param
      * options The options to use when exporting the data.
      *
+     * NOTE: This method won't work for scatter plot 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 `,`.