@arcgis/charts-components 4.33.0-next.110 → 4.33.0-next.112

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

@@ -11,8 +11,12 @@ import { ActionModes, ChartElementLimit, CursorRange, DataWarningObject, LoaderC
 import { AxesMinMaxChangePayload, DataProcessCompletePayload, LegendItemVisibilityChangePayload, NoRenderPropChangePayload, SelectionCompletePayload, SeriesColorChangePayload } from '../../utils/components/event-payloads';
 import { MissingSplitBySeriesProps, WebChartComponentVersion } 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.
- * @slot action-bar - A slot for adding charts-action-bar component or calcite-action-bar.
+/**
+ * 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.
+ *
+ * [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.
  */
 export declare class ArcGISChart extends LitElement {
     /**
@@ -20,6 +24,7 @@ export declare class ArcGISChart extends LitElement {
      *
      * @type {WebChartComponentVersion}
      * @category Public
+     * @default "stable"
      */
     componentVersion: WebChartComponentVersion;
     /**
@@ -36,6 +41,7 @@ export declare class ArcGISChart extends LitElement {
      *
      * @type {boolean}
      * @category Public
+     * @default false
      */
     enableConfiguration: boolean;
     /**
@@ -43,9 +49,9 @@ export declare class ArcGISChart extends LitElement {
      *
      * @type {boolean}
      * @category Public
+     * @default false
      */
     syncSelection: boolean;
-    get rotation(): boolean | undefined;
     /**
      * Applicable to bar chart, line chart, combo bar-line and box plot.
      * When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.
@@ -54,6 +60,7 @@ export declare class ArcGISChart extends LitElement {
      * @category Public
      * @default undefined
      */
+    get rotation(): boolean | undefined;
     set rotation(value: boolean | undefined);
     /**
      * Not applicable to gauge.
@@ -79,34 +86,31 @@ export declare class ArcGISChart extends LitElement {
      * @default undefined
      */
     cursorRange?: CursorRange;
-    get legendPosition(): WebChartLegendPositions | undefined;
     /**
      * Used to set the legend's position on the chart.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {WebChartLegendPositions | undefined}
      * @category Public
      * @default undefined
      */
+    get legendPosition(): WebChartLegendPositions | undefined;
     set legendPosition(value: WebChartLegendPositions | undefined);
-    get legendVisibility(): boolean | undefined;
     /**
      * When `true`, the legend is visible on the chart.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
      */
+    get legendVisibility(): boolean | undefined;
     set legendVisibility(value: boolean | undefined);
     /**
      * 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).
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
@@ -129,8 +133,7 @@ export declare class ArcGISChart extends LitElement {
      * It's recommended that this property should only be set to true for small datasets.
      * When left `undefined`, will be treated as `false`.
      *
-     * @remarks
-     * Applicable to line chart only.
+     * @remarks Applicable to line chart only.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
@@ -140,8 +143,7 @@ export declare class ArcGISChart extends LitElement {
      * Lifecycle function executed after the data has been processed and before the chart renders.
      * Can be used to alter the config from information extracted from the data for instance.
      *
-     * @remarks
-     * Applicable to gauge and pie chart only.
+     * @remarks Applicable to gauge and pie chart only.
      * @type {PreRenderCallback | undefined}
      * @category Public
      * @default undefined
@@ -152,8 +154,7 @@ export declare class ArcGISChart extends LitElement {
      * interpreted as such.
      * If provided, the formatter will be used if at least `WebChartPieChartLegend.displayNumericValue` or `WebChartPieChartLegend.displayPercentage` is true.
      *
-     * @remarks
-     * Applicable to pie chart only.
+     * @remarks Applicable to pie chart only.
      * @type {PieChartLegendValueLabelFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -167,7 +168,6 @@ export declare class ArcGISChart extends LitElement {
      * @default undefined
      */
     timeZone?: MapView["timeZone"];
-    get view(): MapView | SceneView | undefined;
     /**
      * Used to access the LayerView instance in order to perform client-side queries.
      *
@@ -175,6 +175,7 @@ export declare class ArcGISChart extends LitElement {
      * @category Public
      * @default undefined
      */
+    get view(): MapView | SceneView | undefined;
     set view(value: MapView | SceneView | undefined);
     /**
      * Used to perform queries.
@@ -188,8 +189,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * When this property is set, it will apply a selection on the chart matching the provided selection.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {SelectionData | undefined}
      * @category Public
      * @default undefined
@@ -199,8 +199,7 @@ export declare class ArcGISChart extends LitElement {
      * When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.
      * Only considered for a data source using a feature layer.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
@@ -209,8 +208,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
@@ -223,8 +221,7 @@ export declare class ArcGISChart extends LitElement {
      * - data source using a feature layer compatible with envelope aggregation
      * The extent (IExtent) is returned through a property called `arcgis_charts_features_extent`.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
@@ -233,14 +230,12 @@ export declare class ArcGISChart extends LitElement {
     /**
      * When `true`, all chart elements are filtered based on selection.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
      */
     filterBySelection?: boolean;
-    get filterByExtent(): boolean | undefined;
     /**
      * When `true`, all chart elements are filtered based on view extent.
      *
@@ -248,8 +243,8 @@ export declare class ArcGISChart extends LitElement {
      * @category Public
      * @default undefined
      */
+    get filterByExtent(): boolean | undefined;
     set filterByExtent(value: boolean | undefined);
-    get disableInteractions(): boolean;
     /**
      * Disables all interactions on the chart.
      *
@@ -257,6 +252,7 @@ export declare class ArcGISChart extends LitElement {
      * @category Public
      * @default false
      */
+    get disableInteractions(): boolean;
     set disableInteractions(value: boolean | undefined);
     /**
      * Builds the charts one by one rather than all at the same time.
@@ -298,17 +294,16 @@ export declare class ArcGISChart extends LitElement {
      * @default undefined
      */
     autoDisposeChart?: boolean;
-    get featureIndex(): number | undefined;
     /**
      * The index of the feature to be rendered.
      * Only used when the gauge is a feature-based gauge.
      *
-     * @remarks
-     * Applicable to gauge only.
+     * @remarks Applicable to gauge only.
      * @type {number | undefined}
      * @category Public
      * @default undefined
      */
+    get featureIndex(): number | undefined;
     set featureIndex(value: number | undefined);
     /**
      * A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.
@@ -323,8 +318,7 @@ export declare class ArcGISChart extends LitElement {
      * If no style is provided for the selected elements, a default selection is applied.
      * If no style is provided for the non selected elements, the chart's style is applied.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {SelectionTheme | undefined}
      * @category Public
      * @default undefined
@@ -333,8 +327,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.
      *
-     * @remarks
-     * Only applicable to charts using the temporal binning feature (bar and line chart).
+     * @remarks Only applicable to charts using the temporal binning feature (bar and line chart).
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
@@ -345,8 +338,7 @@ export declare class ArcGISChart extends LitElement {
      * The chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation
      * or update of the chart, or render the elements up to the given limits.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {ChartElementLimit | undefined}
      * @category Public
      * @default undefined
@@ -355,8 +347,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * A callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {BarAndLineTooltipFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -365,8 +356,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * A callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @type {BarAndLineDataLabelFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -375,8 +365,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * A callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.
      *
-     * @remarks
-     * Not applicable to pie chart.
+     * @remarks Not applicable to pie chart.
      * @type {GuideTooltipFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -386,8 +375,7 @@ export declare class ArcGISChart extends LitElement {
      * Indicates whether to show the ArcGIS charts notify panel. False by default
      * A callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      *
-     * @remarks
-     * Not applicable to pie chart.
+     * @remarks Not applicable to pie chart.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -396,8 +384,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * A callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      *
-     * @remarks
-     * Not applicable to pie chart nor gauge.
+     * @remarks Not applicable to pie chart nor gauge.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -407,8 +394,7 @@ export declare class ArcGISChart extends LitElement {
      * A callback function used to format the secondary y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      * The property will be effective only if 3 axes are defined (dual axis chart).
      *
-     * @remarks
-     * Not applicable to pie chart nor gauge.
+     * @remarks Not applicable to pie chart nor gauge.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -418,8 +404,7 @@ export declare class ArcGISChart extends LitElement {
      * A callback function used to format the gauge inner label. If the returned string contains HTML tags they will be
      * interpreted as such.
      *
-     * @remarks
-     * Applicable to gauge only.
+     * @remarks Applicable to gauge only.
      * @type {GaugeInnerLabelFormatCallback | undefined}
      * @category Public
      * @default undefined
@@ -443,8 +428,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * Disables the toggling of series via the legend items.
      *
-     * @remarks
-     * Only applicable to multi-series charts.
+     * @remarks Only applicable to multi-series charts.
      * @type {boolean | undefined}
      * @category Public
      * @default undefined
@@ -493,6 +477,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * Whether the chart should be refreshed when the view's time extent changes.
      * This is not currently supported on histogram. Setting the property to "refresh" won't have any effect on that chart.
+     *
      * @type {ViewTimeExtentChangePolicy}
      * @category Public
      * @default "ignore"
@@ -502,8 +487,7 @@ export declare class ArcGISChart extends LitElement {
      * Allows the chart to update automatically when the layer's renderer changes.
      * Applies when the color match feature is enabled.
      *
-     * @remarks
-     * Even though that property is set to Ignore the chart will use the layer's renderer information when the data is updated.
+     * @remarks Even though that property is set to Ignore the chart will use the layer's renderer information when the data is updated.
      * @type {LayerRendererChangePolicy}
      * @category Public
      * @default "refresh"
@@ -520,6 +504,7 @@ export declare class ArcGISChart extends LitElement {
     layerFieldsChangePolicy: LayerFieldsChangePolicy;
     /**
      * Determines whether the selections from the chart should be synchronized with the layer view and vice versa.
+     *
      * @type {SyncSelectionsBetweenChartAndLayerViewPolicy}
      * @category Public
      * @default "disabled
@@ -542,8 +527,7 @@ export declare class ArcGISChart extends LitElement {
      * by the config.
      * The default information from the property `updateSplitBySeries.seriesTemplate` will be applied to the new series.
      *
-     * @remarks
-     * Only applicable to bar chart, line chart and box plot, when they use a split-by field.
+     * @remarks Only applicable to bar chart, line chart and box plot, when they use a split-by field.
      * @type {MissingSplitBySeriesProps | undefined}
      * @category Public
      * @default undefined
@@ -552,12 +536,12 @@ export declare class ArcGISChart extends LitElement {
     /**
      * Export the current chart to an image
      *
-     * @param {"png" | "jpg"} [props.format] image format to export the chart to. Supports 'png' | 'jpg'
-     * @param {number | undefined} [props.quality] quality of the image should be 0 - 1. If outside of the range, it will default to 1
-     * @param {number | undefined} [props.maxWidth] max width in px
-     * @param {number | undefined} [props.minWidth] min width in px
-     * @param {number | undefined} [props.maxHeight] max height in px
-     * @param {number | undefined} [props.minHeight] min height in px
+     * @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: {
@@ -571,8 +555,7 @@ export declare class ArcGISChart extends LitElement {
     /**
      * Clears all selection on the chart.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @category Public
      */
     clearSelection(): Promise<void>;
@@ -580,7 +563,7 @@ export declare class ArcGISChart extends LitElement {
      * Triggers an alert to display an error message.
      *
      * @category Public
-     * @param {string | undefined} [errorMessage]
+     * @param errorMessage
      */
     errorAlert(errorMessage?: string): Promise<void>;
     /**
@@ -590,17 +573,17 @@ export declare class ArcGISChart extends LitElement {
      * consider waiting for the `arcgisUpdateComplete` event.
      *
      * @category Public
-     * @param {string | undefined} [message] The message to display in the notification panel.
-     * @param {string | undefined} [heading] The heading to display in the notification panel.
-     * @param {NotifyOptions | undefined} [options] The options to apply to the notification panel.
+     * @param message The message to display in the notification panel.
+     * @param heading The heading to display in the notification panel.
+     * @param options The options to apply to the notification panel.
      */
     notify(message?: string, heading?: string, options?: NotifyOptions): Promise<void>;
     /**
      * Re-render the chart.
      *
-     * @param {boolean} [props.updateData] Indicates whether to fetch new data. Default: true.
-     * @param {boolean} [props.updateExtent] Indicates whether the view's extent is to update. Default: false.
-     * @param {boolean} [props.resetAxesBounds] Option to reset the axes bounds along with the refresh. Default: false;
+     * @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?: {
@@ -611,16 +594,14 @@ export declare class ArcGISChart extends LitElement {
     /**
      * Resets the chart zoom to bring it back to full extent
      *
-     * @remarks
-     * Applicable to XY charts only.
+     * @remarks Applicable to XY charts only.
      * @category Public
      */
     resetZoom(): Promise<void>;
     /**
      * Switches the selection on the chart.
      *
-     * @remarks
-     * Not applicable to gauge.
+     * @remarks Not applicable to gauge.
      * @category Public
      */
     switchSelection(): Promise<void>;
@@ -685,6 +666,7 @@ export declare class ArcGISChart extends LitElement {
     readonly arcgisNoRenderPropChange: TargetedEvent<this, NoRenderPropChangePayload>;
     /**
      * Event triggered when an error occurred that prevents the chart from being created or updated
+     *
      * @type {EventEmitter}
      * @event
      */