@arcgis/charts-components 4.33.0-next.134 → 4.33.0-next.135

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

@@ -6,6 +6,7 @@ import { default as FeatureLayerView } from '@arcgis/core/views/layers/FeatureLa
 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 { 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';
@@ -533,25 +534,6 @@ export declare class ArcgisChart extends LitElement {
      * @default undefined
      */
     updateSplitBySeries?: MissingSplitBySeriesProps;
-    /**
-     * Export the current chart to an image
-     *
-     * @param props.format image format to export the chart to. Supports 'png' | 'jpg'
-     * @param props.quality quality of the image should be 0 - 1. If outside of the range, it will default to 1
-     * @param props.maxWidth max width in px
-     * @param props.minWidth min width in px
-     * @param props.maxHeight max height in px
-     * @param props.minHeight min height in px
-     * @returns
-     */
-    exportImage(props: {
-        format: "jpg" | "png";
-        quality?: number;
-        maxWidth?: number;
-        minWidth?: number;
-        maxHeight?: number;
-        minHeight?: number;
-    }): Promise<File>;
     /**
      * Clears all selection on the chart.
      *
@@ -574,6 +556,20 @@ export declare class ArcgisChart extends LitElement {
      * @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.
+     *
+     * 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`.
+     * @category Public
+     */
+    exportAsCSV(options?: CSVOptions): Promise<void>;
     /**
      * Notify method allows passing external messages to the chart component.
      * It can be used to pass validation or information messages.