@arcgis/charts-components 5.0.0-next.58 → 5.0.0-next.59

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

@@ -25,42 +25,42 @@ import { MissingSplitBySeriesProps, DownloadableChartImagesTypes } from '../../u
  *
  * [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`.
+ * @since 4.32
  */
 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}
      * @default undefined
+     * @type {ChartModel | WebChart | undefined}
      */
     model?: ChartModel | WebChart;
     /**
      * Whether to use features uniquely designed for a chart currently being configured by a user via the UI.
      *
+     * @default false
      * @type {boolean}
      * @category Public
-     * @default false
      */
     enableConfiguration: boolean;
     /**
      * Whether to synchronize the selection between chart components from the same layer.
      *
+     * @default false
      * @type {boolean}
      * @category Public
-     * @default false
      */
     syncSelection: boolean;
     /**
      * 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.
      *
-     * @type {boolean | undefined}
-     * @category Public
      * @deprecated since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead.
      * @default undefined
+     * @type {boolean | undefined}
+     * @category Public
      */
     get rotation(): boolean | undefined;
     set rotation(value: boolean | undefined);
@@ -68,9 +68,9 @@ export declare class ArcgisChart extends LitElement {
      * Not applicable to gauge.
      * Defines the cursor behavior on the chart (zoom, selection...).
      *
+     * @default undefined
      * @type {ActionModes | undefined}
      * @category Public
-     * @default undefined
      */
     actionMode?: ActionModes;
     /**
@@ -80,42 +80,42 @@ export declare class ArcgisChart extends LitElement {
      * - CursorRange.YAxis: allows to draw a rectangle bound to the y-axis
      * - undefined: defaults to a preset behavior according to the chart type and action mode
      *
+     * @default undefined
      * @remarks
      * Not applicable to gauge.
      * Applies only when the action mode is set to zoom or multi-selection.
      * @type {CursorRange | undefined}
      * @category Public
-     * @default undefined
      */
     cursorRange?: CursorRange;
     /**
      * Used to set the legend's position on the chart.
      *
+     * @deprecated since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {WebChartLegendPositions | undefined}
      * @category Public
-     * @deprecated since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.
-     * @default undefined
      */
     get legendPosition(): WebChartLegendPositions | undefined;
     set legendPosition(value: WebChartLegendPositions | undefined);
     /**
      * When `true`, the legend is visible on the chart.
      *
+     * @deprecated since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
-     * @deprecated since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.
-     * @default undefined
      */
     get legendVisibility(): boolean | undefined;
     set legendVisibility(value: boolean | undefined);
     /**
      * Whether to allow the object id to be used as a statistic other than COUNT.
      *
+     * @default false
      * @type {boolean}
      * @category Public
-     * @default false
      */
     allowUsingObjectIdStat: boolean;
     /**
@@ -124,28 +124,28 @@ export declare class ArcgisChart extends LitElement {
      * - the corresponding warning event will be sent
      * - the "no data" message will be displayed (unless `showUIMesssages` is set to `false`)
      *
+     * @default false
      * @type {boolean}
      * @category Public
-     * @default false
      */
     nullAsValid: boolean;
     /**
      * 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).
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     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).
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     hideEmptySeries?: boolean;
     /**
@@ -153,19 +153,19 @@ export declare class ArcgisChart extends LitElement {
      * For example if the data label is dark, and it's on top of a dark color series area, the text color will eventually
      * be set to either the chart's background color or white.
      *
+     * @default undefined
      * @remarks This feature is currently only available for bar chart.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     autoInverseDataLabelTextColor?: boolean;
     /**
      * When `true`, the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)
      * will be populated with 0s, via the `completeDataForEmptyCategoriesWithZeros` method.
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     replaceNoValueCategoryWithZero?: boolean;
     /**
@@ -176,20 +176,20 @@ 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`.
      *
+     * @default undefined
      * @remarks Applicable to line chart only.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     ignoreSmoothRenderingLimit?: boolean;
     /**
      * 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.
      *
+     * @default undefined
      * @remarks Applicable to gauge and pie chart only.
      * @type {PreRenderCallback | undefined}
      * @category Public
-     * @default undefined
      */
     chartWillRender?: PreRenderCallback;
     /**
@@ -197,26 +197,26 @@ 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.
      *
+     * @default undefined
      * @remarks Applicable to pie chart only.
      * @type {PieChartLegendValueLabelFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     legendValueLabelFormatter?: PieChartLegendValueLabelFormatCallback;
     /**
      * Used to set a custom time zone for the chart.
      *
+     * @default undefined
      * @type {MapView["timeZone"] | undefined}
      * @category Public
-     * @default undefined
      */
     timeZone?: MapView["timeZone"];
     /**
      * Used to access the LayerView instance in order to perform client-side queries.
      *
+     * @default undefined
      * @type {MapView | SceneView | undefined}
      * @category Public
-     * @default undefined
      */
     get view(): MapView | SceneView | undefined;
     set view(value: MapView | SceneView | undefined);
@@ -224,9 +224,9 @@ export declare class ArcgisChart extends LitElement {
      * Used to perform queries.
      * If the layer is a FeatureLayerView or if the layer and the `view` property are both provided, the queries will be executed client-side.
      *
+     * @default undefined
      * @type {SupportedLayer | FeatureLayerView | undefined}
      * @category Public
-     * @default undefined
      */
     layer?: FeatureLayerView | SupportedLayer;
     /**
@@ -234,10 +234,10 @@ export declare class ArcgisChart extends LitElement {
      *
      * If `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
      *
+     * @default undefined
      * @example <arcgis-chart layer-item-id="05e015c5f0314db9a487a9b46cb37eca" chart-index="2"></arcgis-chart>
      * @type {string | undefined}
      * @category Public
-     * @default undefined
      */
     layerItemId?: string;
     /**
@@ -247,38 +247,38 @@ export declare class ArcgisChart extends LitElement {
      *
      * If the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.
      *
+     * @default undefined
      * @example <arcgis-chart layer-item-id="05e015c5f0314db9a487a9b46cb37eca" chart-index="2"></arcgis-chart>
      * @type {number | undefined}
      * @category Public
-     * @default undefined
      */
     chartIndex?: number;
     /**
      * When this property is set, it will apply a selection on the chart matching the provided selection.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {SelectionData | undefined}
      * @category Public
-     * @default undefined
      */
     selectionData?: SelectionData;
     /**
      * 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.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     returnSelectionOIDs?: boolean;
     /**
      * When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     returnSelectionIndexes?: boolean;
     /**
@@ -288,98 +288,98 @@ 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`.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     returnFeaturesExtent?: boolean;
     /**
      * When `true`, all chart elements are filtered based on selection.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     filterBySelection?: boolean;
     /**
      * When `true`, all chart elements are filtered based on view extent.
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     get filterByExtent(): boolean | undefined;
     set filterByExtent(value: boolean | undefined);
     /**
      * Disables all interactions on the chart.
      *
+     * @default false
      * @type {boolean | undefined}
      * @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.
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     queueChartCreation?: boolean;
     /**
      * Enables the animations on the chart.
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     useAnimatedCharts?: boolean;
     /**
      * Hides the license watermark.
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     hideLicenseWatermark?: boolean;
     /**
      * Enables the responsive features.
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     enableResponsiveFeatures?: boolean;
     /**
      * Auto-disposes the chart when a new one is created in the same container.
      *
-     * @type {boolean | undefined}
-     * @category Public
      * @deprecated since 5.0. Use `autoDestroyDisabled` instead. Will be removed in 6.0.
      * @default undefined
+     * @type {boolean | undefined}
+     * @category Public
      */
     autoDisposeChart?: boolean;
     /**
      * The index of the feature to be rendered.
      * Only used when the gauge is a feature-based gauge.
      *
+     * @deprecated since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.
+     * @default undefined
      * @remarks Applicable to gauge only.
      * @type {number | undefined}
      * @category Public
-     * @deprecated since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.
-     * @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.
      *
+     * @default undefined
      * @type {string | undefined}
      * @category Public
-     * @default undefined
      */
     placeholder?: string;
     /**
@@ -387,19 +387,19 @@ 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.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {SelectionTheme | undefined}
      * @category Public
-     * @default undefined
      */
     selectionTheme?: SelectionTheme;
     /**
      * 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.
      *
+     * @default undefined
      * @remarks Only applicable to charts using the temporal binning feature (bar and line chart).
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     setTimeBinningInfoWhenNotProvided?: boolean;
     /**
@@ -407,168 +407,168 @@ 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.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {ChartElementLimit | undefined}
      * @category Public
-     * @default undefined
      */
     chartLimits?: ChartElementLimit;
     /**
      * A callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {BarAndLineTooltipFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     tooltipFormatter?: ChartOptions["tooltipFormatter"];
     /**
      * A callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * @default undefined
      * @remarks Not applicable to gauge.
      * @type {BarAndLineDataLabelFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     dataLabelFormatter?: ChartOptions["dataLabelFormatter"];
     /**
      * A callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * @default undefined
      * @remarks Not applicable to pie chart.
      * @type {GuideTooltipFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     guideTooltipFormatter?: GuideTooltipFormatCallback;
     /**
      * 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.
      *
+     * @default undefined
      * @remarks Not applicable to pie chart.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     xAxisLabelFormatter?: AxisLabelFormatCallback;
     /**
      * A callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * @default undefined
      * @remarks Not applicable to pie chart nor gauge.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     yAxisLabelFormatter?: AxisLabelFormatCallback;
     /**
      * 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).
      *
+     * @default undefined
      * @remarks Not applicable to pie chart nor gauge.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     secondaryYAxisLabelFormatter?: AxisLabelFormatCallback;
     /**
      * A callback function used to format the gauge inner label. If the returned string contains HTML tags they will be
      * interpreted as such.
      *
+     * @default undefined
      * @remarks Applicable to gauge only.
      * @type {GaugeInnerLabelFormatCallback | undefined}
      * @category Public
-     * @default undefined
      */
     gaugeInnerLabelFormatter?: GaugeInnerLabelFormatCallback;
     /**
      * Whether to display an error alert and hide the chart when it can't be created or updated.
      *
-     * @type {ErrorPolicy}
      * @default "throw"
+     * @type {ErrorPolicy}
      */
     errorPolicy: ErrorPolicy;
     /**
      * Disables the toggling of series via the legend items.
      *
+     * @default undefined
      * @remarks Only applicable to multi-series charts.
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     disableTogglingLegendItems?: boolean;
     /**
      * Hides the loader animation (curtain and spinner), showed by default at every update.
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     hideLoaderAnimation?: boolean;
     /**
      * Defines the colors for the loader animation.
      *
+     * @default undefined
      * @type { LoaderColors  | undefined}
      * @category Public
-     * @default undefined
      */
     loaderColors?: LoaderColors;
     /**
      * Applies runtime data filters to the chart's.
      *
+     * @default undefined
      * @type {WebChartDataFilters | undefined}
      * @category Public
-     * @default undefined
      */
     runtimeDataFilters?: WebChartDataFilters;
     /**
      * Allows the use of the fields alias from the layer.popupTemplate when rendering the field names on the chart (e.g. tooltips, axes, legend).
      *
+     * @default undefined
      * @type {boolean | undefined}
      * @category Public
-     * @default undefined
      */
     usePopupTemplateFieldsInfo?: boolean;
     /**
      * Whether the chart should be refreshed when the layer's filter (`definitionExpression`) changes.
      *
+     * @default "refresh"
      * @type {LayerFilterChangePolicy}
      * @category Public
-     * @default "refresh"
      */
     layerFilterChangePolicy: LayerFilterChangePolicy;
     /**
      * 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.
      *
+     * @default "ignore"
      * @type {ViewTimeExtentChangePolicy}
      * @category Public
-     * @default "ignore"
      */
     viewTimeExtentChangePolicy: ViewTimeExtentChangePolicy;
     /**
      * Allows the chart to update automatically when the layer's renderer changes.
      * Applies when the color match feature is enabled.
      *
+     * @default "refresh"
      * @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"
      */
     layerRendererChangePolicy: LayerRendererChangePolicy;
     /**
      * Allows the chart to update automatically when the layer's fields change.
      * Applies when the field list (`fields`) in the feature layer is updated.
      *
+     * @default "refresh"
      * @type {LayerFieldsChangePolicy}
      * @category Public
-     * @default "refresh"
      */
     layerFieldsChangePolicy: LayerFieldsChangePolicy;
     /**
      * Determines whether the selections from the chart should be synchronized with the layer view and vice versa.
      *
+     * @default "disabled
      * @type {SyncSelectionsBetweenChartAndLayerViewPolicy}
      * @category Public
-     * @default "disabled
      */
     syncSelectionsBetweenChartAndLayerViewPolicy: SyncSelectionsBetweenChartAndLayerViewPolicy;
     /**
@@ -577,9 +577,9 @@ export declare class ArcgisChart extends LitElement {
      * geometry passed through the config (component.config.dataFilters) or the runtime filters (component.runtimeDataFilters).
      * Setting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.
      *
+     * @default false
      * @type {boolean | undefined}
      * @category Public
-     * @default false
      */
     ignoreViewExtent?: boolean;
     /**
@@ -588,10 +588,10 @@ export declare class ArcgisChart extends LitElement {
      * by the config.
      * The default information from the property `updateSplitBySeries.seriesTemplate` will be applied to the new series.
      *
+     * @default undefined
      * @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
      */
     updateSplitBySeries?: MissingSplitBySeriesProps;
     /**
@@ -616,6 +616,7 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Triggers an alert to display an error message.
      *
+     * @param errorMessage
      * @category Public
      * @param errorMessage
      */
@@ -623,8 +624,8 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Export the current chart's data as a CSV file.
      *
-     * @param
-     * options The options to use when exporting the data.
+     * @param options
+     * @param options The options to use when exporting the data.
      *
      * NOTE: This method won't work for scatterplot series. The support charts for this method are:
      * - Bar chart
@@ -647,9 +648,10 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Export the current chart as an image.
      *
+     * @default DownloadableChartImagesTypes.PNG
+     * @param format
      * @param format The format of the image to download.
      * @category Public
-     * @default DownloadableChartImagesTypes.PNG
      */
     exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>;
     /**
@@ -665,6 +667,9 @@ export declare class ArcgisChart extends LitElement {
      * In a situation where a config update is overriding your notification modal,
      * consider waiting for the `arcgisUpdateComplete` event.
      *
+     * @param message
+     * @param heading
+     * @param options
      * @category Public
      * @param message The message to display in the notification panel.
      * @param heading The heading to display in the notification panel.
@@ -674,6 +679,7 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Re-render the chart.
      *
+     * @param props
      * @param props.updateData Indicates whether to fetch new data. Default: true.
      * @param props.resetAxesBounds Option to reset the axes bounds along with the refresh. Default: false;
      * @category Public