@arcgis/charts-components 5.2.0-next.10 → 5.2.0-next.11

package/dist/docs/web-types.json

@@ -1 +1 @@
-{"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@arcgis/charts-components","version":"5.2.0-next.10","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"arcgis-chart","description":"The 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.\n\nSupported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.\n--\n\n### Events\n- **arcgisAxesMinMaxChange** - Event triggered once the chart axes min/max values are computed.\n- **arcgisBadDataWarningRaise** - Event triggered when an error is detected with the data set.\n- **arcgisChartNotFoundWarning** - Event triggered when the chart is not found for the given [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property.\n- **arcgisConfigChange** - Event triggered when the chart config is changed.\n- **arcgisDataFetchComplete** - Event triggered once the chart data has been fetched but not yet fully processed.\n\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n\n**Note**: Applicable to pie charts only.\n- **arcgisDataProcessComplete** - Event triggered once the chart data has been processed.\n- **arcgisDataProcessError** - Event triggered when an error occurred while fetching of processing the data for the chart.\n- **arcgisInvalidConfigWarningRaise** - Event triggered when an invalid configuration is detected.\n- **arcgisLegendItemVisibilityChange** - Event triggered once a legend item visibility has been changed.\n- **arcgisNoRenderPropChange** - Event triggered when a no-render prop is changed.\n- **arcgisRenderingComplete** - Event triggered once the chart rendering is complete.\n- **arcgisRuntimeError** - Event triggered when an error occurred that prevents the chart from being created or updated.\n- **arcgisSelectionComplete** - Event triggered when a selection is applied to the chart.\n- **arcgisSeriesColorChange** - Event triggered once the chart series color have been assigned.\n- **arcgisSeriesOrder** - Event carrying the series id as they have been sorted following the `orderOptions` instructions.\n- **arcgisUpdateComplete** - Event triggered once the chart is updated.\n\n### Methods\n- `applySelectionFromSelectionManager(): void` - Apply the selection from the selection manager to the chart.\n- `clearSelection(): Promise<void>` - Clears all selection on the chart.\n\n**Note**: Not applicable to gauge.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the chart instance and removes it from the DOM.\n- `errorAlert(errorMessage?: string): Promise<void>` - **Deprecated**: since 5.1. Won't be replaced.. Triggers an alert to display an error message.\n- `exportAsCSV(options?: CSVOptions): Promise<void>` - Export the current chart's data as a CSV file.\n\nThe `Options` object can contain the following properties:\n- `columns`: An array of column to include in the CSV file.\n- `delimiter`: The delimiter to use in the CSV file. Default is `,`.\n- `includeHeader`: Whether to include the header row in the CSV file. Default is `true`.\n- `quoteAll`: Whether to quote all values in the CSV file. Default is `false`.\n- `locale`: The locale to use when formatting the CSV file. Default is `en`.\n   - Locale supported are: \"ar\", \"ar-u-nu-latn\", \"bs\", \"bg\", \"ca\", \"cs\", \"da\", \"de\", \"el\", \"en\", \"en-US\", \"es\", \"et\", \"fi\", \"fr\", \"he\", \"hr\", \"hu\", \"id\", \"it\", \"ja\", \"ko\", \"lt\", \"lv\", \"no\", \"nl\", \"pl\", \"pt-BR\", \"pt-PT\", \"ro\", \"ru\", \"sr\", \"sl\", \"sk\", \"sv\", \"th\", \"tr\", \"uk\", \"vi\", \"zh-CN\", \"zh-HK\", \"zh-TW\"\n\n**Note**: The chart types supported by this method are:\n- Bar chart\n- Box plot\n- Combo bar line chart\n- Heat chart\n- Histogram\n- Line chart\n- Pie chart\n- `exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>` - Exports the current chart as an image. Default format is `png`.\n- Alternative formats supported are: `jpeg` and `svg`.\n- `loadModel(): Promise<void>` - Returns a promise that resolves when the chart model is fully loaded.\n- `notify(message?: string, heading?: string): Promise<void>` - Notify method allows passing external messages to the chart component.\nIt can be used to pass validation or information messages.\nIn a situation where a model update is overriding the notification modal, consider waiting for the [@arcgisUpdateComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisUpdateComplete) event.\n- `refresh(props?: {\n    updateData?: boolean;\n    resetAxesBounds?: boolean;\n}): Promise<void>` - Re-render the chart.\n- `resetZoom(): Promise<void>` - Resets the chart zoom to bring it back to full extent.\n\n**Note**: Applicable to XY charts only.\n- `switchSelection(): Promise<void>` - Switches the selection on the chart.\n\n**Note**: Not applicable to gauge.\n\n### Slots\n- **action-bar** - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.","doc-url":"https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/","attributes":[{"name":"action-mode","description":"Specifies the user action behavior for the chart.\n\n- `monoSelection`: Select a single data point or series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points or series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points or series while holding the Ctrl key (Cmd on Mac). When the key is held, each new selection is added; otherwise, the selection is replaced.\n- `none`: No action is performed on user interaction.\n- `zoom`: Zoom into a specific area of the chart.\n\n**Note**: Not applicable to gauges.","value":{"type":["\"none\"","\"monoSelection\"","\"multiSelection\"","\"multiSelectionWithCtrlKey\"","\"zoom\""]}},{"name":"allow-using-object-id-stat","description":"Whether to allow the object id to be used as a statistic other than `Count`.","default":"false","value":{"type":"boolean"}},{"name":"animation-enabled","description":"Enable animation on the chart.","default":"false","value":{"type":"boolean"}},{"name":"auto-destroy-disabled","description":"If `true`, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#destroy)  method when you are done to prevent memory leaks.","default":"false","value":{"type":"boolean"}},{"name":"auto-dispose-chart","description":"**Deprecated**: since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#autoDestroyDisabled) instead.. Auto disposes the chart when a new one is created in the same container.","default":"false","value":{"type":"boolean"}},{"name":"auto-inverse-data-label-text-color","description":"When `true`, the data label text color is automatically adjusted for readability based on its background.\nIf the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.\n\n**Note**: Applicable to heat charts only.","default":"false","value":{"type":"boolean"}},{"name":"chart-index","description":"The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.\n\nIf a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nIf the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.","value":{"type":"number"}},{"name":"configuration-enabled","description":"Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","default":"false","value":{"type":"boolean"}},{"name":"cursor-range","description":"Sets the cursor range when `actionMode` is set to `zoom`, `multiSelection` or `multiSelectionWithCtrlKey`.\n\n- `multi-axes`: Allows to draw a free rectangle.\n- `x-axis`: Allows to draw a rectangle bound to the x-axis.\n- `y-axis`: Allows to draw a rectangle bound to the y-axis.\n- `undefined`: Defaults to the preset behavior according to the chart type and action mode.\n\n**Note**: Not applicable to gauges.","value":{"type":["\"multi-axes\"","\"x-axis\"","\"y-axis\""]}},{"name":"disable-interactions","description":"**Deprecated**: since 5.1. Use [interactionsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#interactionsDisabled) instead.. Disables all interactions on the chart.","default":"false","value":{"type":"boolean"}},{"name":"disable-toggling-legend-items","description":"**Deprecated**: since 5.1. Use [togglingLegendItemsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#togglingLegendItemsDisabled) instead.. Disables the toggling of series from the legend items.\n\n**Note**: Only applicable to multi-series charts.","default":"false","value":{"type":"boolean"}},{"name":"enable-beta-features","description":"Whether to enable the beta features from the chart component.","default":"false","value":{"type":"boolean"}},{"name":"enable-configuration","description":"**Deprecated**: since 5.1. Use [configurationEnabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#configurationEnabled) instead.. Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","default":"false","value":{"type":"boolean"}},{"name":"enable-responsive-features","description":"**Deprecated**: since 5.1. Won't be replaced.. Enables the responsive features.","default":"false","value":{"type":"boolean"}},{"name":"error-policy","description":"Whether to display an error alert and hide the chart when it can't be created or updated.","default":"\"throw\"","value":{"type":["\"throw\"","\"ignore\""]}},{"name":"feature-index","description":"**Deprecated**: since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/model/gauge-model/gauge-model/#featureIndex) prop instead.. The index of the feature to render when using a feature based gauge.\n\n**Note**: Applicable to gauges only.","value":{"type":"number"}},{"name":"filter-by-extent","description":"**Deprecated**: since 5.1. Use [filterByViewExtent](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#filterByViewExtent) instead.. When `true`, all chart elements are filtered based on the view extent.","default":"false","value":{"type":"boolean"}},{"name":"filter-by-selection","description":"When `true`, all chart elements are filtered based on the selection.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers.","default":"false","value":{"type":"boolean"}},{"name":"filter-by-view-extent","description":"When `true`, all chart elements are filtered based on the view extent.","default":"false","value":{"type":"boolean"}},{"name":"hide-empty-series","description":"**Deprecated**: since 5.1. Use [showEmptySeries](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#showEmptySeries) instead.. When `true`, the empty series are completely hidden from the chart and the legend.\nFor example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"hide-license-watermark","description":"**Deprecated**: since 5.1. Use [showLicenseWatermark](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#showLicenseWatermark) instead.. Hides the license watermark.","default":"false","value":{"type":"boolean"}},{"name":"hide-loader-animation","description":"Hides the loader animation (curtain and spinner), showed by default at every update.","default":"false","value":{"type":"boolean"}},{"name":"hide-ui-messages","description":"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":"false","value":{"type":"boolean"}},{"name":"hide-zero-count-categories","description":"Whether to keep missing categories from a count aggregation as gaps in the chart's data.\n\nWhen data is retrieved from the server, the server excludes all features having a count of 0 from the response; hence resulting in missing entries on the charts.\n\nWhen this property is set to `true`, the dataset will keep these gaps instead of filling them with 0s.\n\nWhen left to `false`,  the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","default":"false","value":{"type":"boolean"}},{"name":"ignore-smooth-rendering-limit","description":"**Deprecated**: since 5.1. Won't be replaced.. When `true`, disables the default setting that uses debounce functions to handle the visibility of markers\nthat are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed\n(via chart cursor or scrollbar), to increase performance.\n\nThis property will be set when the chart is created and cannot be updated after that.\nIt's recommended that this property should only be set to `true` for small datasets.\nWhen left `undefined`, will be treated as `false`.\n\n**Note**: Applicable to line charts only.","default":"false","value":{"type":"boolean"}},{"name":"ignore-view-extent","description":"This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.\n\nBy default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any\ngeometry passed through the model (`component.model.dataFilters`) or the runtime filters (`component.runtimeDataFilters`).\n\nSetting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.","default":"false","value":{"type":"boolean"}},{"name":"interactions-disabled","description":"Disables all interactions on the chart.","default":"false","value":{"type":"boolean"}},{"name":"layer-fields-change-policy","description":"**Deprecated**: since 5.1. Won't be replaced.. Allows the chart to update automatically when the layer's `fields` property changes.","default":"\"refresh\"","value":{"type":["\"refresh\"","\"ignore\""]}},{"name":"layer-filter-change-policy","description":"**Deprecated**: since 5.1. Won't be replaced.. Whether the chart should be refreshed when the layer's filter (`definitionExpression`) changes.","default":"\"refresh\"","value":{"type":["\"refresh\"","\"ignore\""]}},{"name":"layer-item-id","description":"Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.\n\nIf `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nSupported layers include: `FeatureLayer`, `SubtypeSublayer`, `ImageryLayer`, `ImageryTileLayer` and `WCSLayer`.","value":{"type":"string"}},{"name":"layer-renderer-change-policy","description":"**Deprecated**: since 5.1. Won't be replaced.. Allows the chart to update automatically when the layer's renderer changes. Applies when the color match is enabled.\n\n**Note**: If the property is set to `ignore` the chart will still use the layer's renderer information when the data is updated.","default":"\"refresh\"","value":{"type":["\"refresh\"","\"ignore\""]}},{"name":"legend-position","description":"**Deprecated**: since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#legendPosition) prop instead.. Sets the legend's position on the chart.\n\n**Note**: Not applicable to gauges.","value":{"type":["\"left\"","\"right\"","\"top\"","\"bottom\""]}},{"name":"legend-visibility","description":"**Deprecated**: since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#legendVisibility) prop instead.. When `true`, the legend is visible on the chart.\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"null-as-valid","description":"Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:\n- The corresponding warning event will be sent\n- The \"no data\" message will be displayed (unless `hideUIMessages` is set to `true` or `showUIMessages` is set to `false`)","default":"false","value":{"type":"boolean"}},{"name":"placeholder","description":"A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.","value":{"type":"string"}},{"name":"popup-template-field-infos-enabled","description":"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":"false","value":{"type":"boolean"}},{"name":"queue-chart-creation","description":"**Deprecated**: since 5.1. Use [skipChartCreationQueue](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#skipChartCreationQueue) instead.. Builds charts sequentially instead of rendering them all at once.","default":"false","value":{"type":"boolean"}},{"name":"replace-no-value-category-with-zero","description":"**Deprecated**: since 5.0. Use [hideZeroCountCategories](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideZeroCountCategories) instead.. When `true`, the chart's `dataItems` associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","default":"false","value":{"type":"boolean"}},{"name":"return-features-extent","description":"When `true`, the features extent will be returned through the [@arcgisDataProcessComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisDataProcessComplete) and [@arcgisSelectionComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisSelectionComplete) events payload.\nApplies only to:\n- Charts using an aggregation.\n- Data source using a feature layer compatible with envelope aggregation.\n\nThe extent (IExtent) is returned through the property [featuresExtentField](https://developers.arcgis.com/javascript/latest/references/charts-components/utils/defaults/index/#featuresExtentField).\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"return-selection-indexes","description":"When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"return-selection-oi-ds","description":"When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.\nOnly considered for a data source using a feature layer.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers. It's always `false` for imagery layers. No object ids will be computed.","default":"false","value":{"type":"boolean"}},{"name":"rotated","description":"When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","default":"false","value":{"type":"boolean"}},{"name":"rotation","description":"**Deprecated**: since 5.0. Use either [rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#rotated) or the charts model's [rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#rotated) prop instead.. When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","default":"false","value":{"type":"boolean"}},{"name":"set-time-binning-info-when-not-provided","description":"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.\n\n**Note**: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar line chart, radar chart).","default":"false","value":{"type":"boolean"}},{"name":"show-empty-series","description":"Show the series on the chart even if it doesn't have data (i.e. empty)\n\nWhen `false`, the empty series are completely hidden from the chart and the legend.\nFor example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"show-license-watermark","description":"Shows the license watermark.","default":"false","value":{"type":"boolean"}},{"name":"show-ui-messages","description":"**Deprecated**: since 5.1. Use [hideUIMessages](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideUIMessages) instead.. 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":"false","value":{"type":"boolean"}},{"name":"skip-chart-creation-queue","description":"Whether to skip the chart rendering queue.\n\nWhen `true`, charts will render immediately without waiting for other charts to finish rendering.\nWhen `false` (default), charts are queued so that only one chart renders at a time.","default":"false","value":{"type":"boolean"}},{"name":"sync-charts-selection","description":"Whether to synchronize the selection between chart components from the same layer.","default":"false","value":{"type":"boolean"}},{"name":"sync-selection","description":"**Deprecated**: since 5.1. Use [syncChartsSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncChartsSelection) prop instead.. Whether to synchronize the selection between chart components from the same layer.","default":"false","value":{"type":"boolean"}},{"name":"sync-selections-between-chart-and-layer-view-policy","description":"**Deprecated**: since 5.1. Use [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) prop instead.. Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","default":"\"disabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"sync-view-selection","description":"Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","default":"false","value":{"type":"boolean"}},{"name":"sync-view-time-extent","description":"Whether the chart should be refreshed when the view's time extent changes.\n\n**Note**: Not supported for histogram.","default":"false","value":{"type":"boolean"}},{"name":"sync-view-time-zone","description":"Whether the chart's data should be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).\n\n**Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the\ncapacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the value of this property.","default":"false","value":{"type":"boolean"}},{"name":"time-zone","description":"Used to set a custom time zone for the chart.","value":{"type":"string"}},{"name":"toggling-legend-items-disabled","description":"Disables the toggling of series via the legend items.\n\n**Note**: Only applicable to multi-series charts.","default":"false","value":{"type":"boolean"}},{"name":"use-animated-charts","description":"**Deprecated**: since 5.1. Use [animationEnabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#animationEnabled) instead.. Enable animation on the chart.","default":"false","value":{"type":"boolean"}},{"name":"use-popup-template-fields-info","description":"**Deprecated**: since 5.1. Use [popupTemplateFieldInfosEnabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#popupTemplateFieldInfosEnabled) instead.. 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":"false","value":{"type":"boolean"}},{"name":"view-time-extent-change-policy","description":"**Deprecated**: since 5.1. Use [syncViewTimeExtent](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewTimeExtent) prop instead.\n\n**Note**: Not applicable for histograms.. Whether the chart should be refreshed when the view's time extent changes.","default":"\"ignore\"","value":{"type":["\"refresh\"","\"ignore\""]}}],"slots":[{"name":"action-bar","description":"Slot for adding a `charts-action-bar` component or `calcite-action-bar`."}],"events":[{"name":"arcgisAxesMinMaxChange","type":"AxesMinMaxChangePayload","description":"Event triggered once the chart axes min/max values are computed."},{"name":"arcgisBadDataWarningRaise","type":"DataWarningObject","description":"Event triggered when an error is detected with the data set."},{"name":"arcgisChartNotFoundWarning","type":"string","description":"Event triggered when the chart is not found for the given [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property."},{"name":"arcgisConfigChange","type":"{\n    newConfig: WebChart | undefined;\n    oldConfig: WebChart | undefined;\n    functionCalled: string | undefined;\n}","description":"Event triggered when the chart config is changed."},{"name":"arcgisDataFetchComplete","type":"WebChartDataTypes","description":"Event triggered once the chart data has been fetched but not yet fully processed.\n\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n\n**Note**: Applicable to pie charts only."},{"name":"arcgisDataProcessComplete","type":"DataProcessCompletePayload","description":"Event triggered once the chart data has been processed."},{"name":"arcgisDataProcessError","type":"void","description":"Event triggered when an error occurred while fetching of processing the data for the chart."},{"name":"arcgisInvalidConfigWarningRaise","type":"DataWarningObject","description":"Event triggered when an invalid configuration is detected."},{"name":"arcgisLegendItemVisibilityChange","type":"LegendItemVisibilityChangePayload","description":"Event triggered once a legend item visibility has been changed."},{"name":"arcgisNoRenderPropChange","type":"NoRenderPropChangePayload","description":"Event triggered when a no-render prop is changed."},{"name":"arcgisRenderingComplete","type":"void","description":"Event triggered once the chart rendering is complete."},{"name":"arcgisRuntimeError","type":"void","description":"Event triggered when an error occurred that prevents the chart from being created or updated."},{"name":"arcgisSelectionComplete","type":"SelectionCompletePayload","description":"Event triggered when a selection is applied to the chart."},{"name":"arcgisSeriesColorChange","type":"SeriesColorChangePayload","description":"Event triggered once the chart series color have been assigned."},{"name":"arcgisSeriesOrder","type":"string[]","description":"Event carrying the series id as they have been sorted following the `orderOptions` instructions."},{"name":"arcgisUpdateComplete","type":"ValidationStatus","description":"Event triggered once the chart is updated."}],"js":{"properties":[{"name":"actionMode","description":"Specifies the user action behavior for the chart.\n\n- `monoSelection`: Select a single data point or series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points or series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points or series while holding the Ctrl key (Cmd on Mac). When the key is held, each new selection is added; otherwise, the selection is replaced.\n- `none`: No action is performed on user interaction.\n- `zoom`: Zoom into a specific area of the chart.\n\n**Note**: Not applicable to gauges.","type":"ActionModes | undefined"},{"name":"allowUsingObjectIdStat","description":"Whether to allow the object id to be used as a statistic other than `Count`.","type":"boolean"},{"name":"animationEnabled","description":"Enable animation on the chart.","type":"boolean | undefined"},{"name":"aria","description":"The ARIA attributes for the chart. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [`label`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [`description`](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [`describedByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaDescribedByElements), and [`labelledByElements`](https://developer.mozilla.org/en-US/docs/Web/API/Element/ariaLabelledByElements).","type":"DOMContainerAria | undefined"},{"name":"autoDestroyDisabled","description":"If `true`, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#destroy)  method when you are done to prevent memory leaks.","type":"boolean"},{"name":"autoDisposeChart","description":"Auto disposes the chart when a new one is created in the same container.","type":"boolean"},{"name":"autoInverseDataLabelTextColor","description":"When `true`, the data label text color is automatically adjusted for readability based on its background.\nIf the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.\n\n**Note**: Applicable to heat charts only.","type":"boolean"},{"name":"calciteThemingCSSVariables","description":"Allows picking the Calcite CSS variables to use when applying a Calcite theme.\n\nBy default the following variables are used:\n- background: `--calcite-color-foreground-1`\n- text: `--calcite-color-text-1`\n- line: `--calcite-color-border-1`\n- secondary line: `--calcite-color-text-3`\n- spinner: `--calcite-color-brand-hover`\n\nThe charts colors are overridden by those associated to those CSS variables, but only if they have not been\ncustomized beforehand.","type":"CalciteThemeCSSVariables"},{"name":"chartIndex","description":"The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.\n\nIf a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nIf the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.","type":"number | undefined"},{"name":"chartLimits","description":"Customize the maximum number of series allowed on the chart.\n\nThe chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation\nor update of the chart, or render the elements up to the given limits.\n\n**Note**: Not applicable to gauges.","type":"ChartElementLimit | undefined"},{"name":"chartWillRender","description":"Lifecycle function executed after the data has been processed and before the chart renders.\nCan be used to alter the model from information extracted from the data.\n\n**Note**: Applicable to gauges and pie charts only.","type":"PreRenderCallback | undefined"},{"name":"configurationEnabled","description":"Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","type":"boolean"},{"name":"cursorRange","description":"Sets the cursor range when `actionMode` is set to `zoom`, `multiSelection` or `multiSelectionWithCtrlKey`.\n\n- `multi-axes`: Allows to draw a free rectangle.\n- `x-axis`: Allows to draw a rectangle bound to the x-axis.\n- `y-axis`: Allows to draw a rectangle bound to the y-axis.\n- `undefined`: Defaults to the preset behavior according to the chart type and action mode.\n\n**Note**: Not applicable to gauges.","type":"CursorRange | undefined"},{"name":"dataLabelFormatter","description":"Callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to gauges.","type":"ChartOptions[\"dataLabelFormatter\"] | undefined"},{"name":"disableInteractions","description":"Disables all interactions on the chart.","type":"boolean"},{"name":"disableTogglingLegendItems","description":"Disables the toggling of series from the legend items.\n\n**Note**: Only applicable to multi-series charts.","type":"boolean"},{"name":"enableBetaFeatures","description":"Whether to enable the beta features from the chart component.","type":"boolean"},{"name":"enableConfiguration","description":"Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","type":"boolean"},{"name":"enableResponsiveFeatures","description":"Enables the responsive features.","type":"boolean"},{"name":"errorPolicy","description":"Whether to display an error alert and hide the chart when it can't be created or updated.","type":"ErrorPolicy"},{"name":"featureIndex","description":"The index of the feature to render when using a feature based gauge.\n\n**Note**: Applicable to gauges only.","type":"number | undefined"},{"name":"filterByExtent","description":"When `true`, all chart elements are filtered based on the view extent.","type":"boolean"},{"name":"filterBySelection","description":"When `true`, all chart elements are filtered based on the selection.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers.","type":"boolean"},{"name":"filterByViewExtent","description":"When `true`, all chart elements are filtered based on the view extent.","type":"boolean"},{"name":"gaugeInnerLabelFormatter","description":"Callback function used to format the gauge inner label. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Applicable to gauges only.","type":"GaugeInnerLabelFormatCallback | undefined"},{"name":"guideTooltipFormatter","description":"Callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie charts.","type":"GuideTooltipFormatCallback | undefined"},{"name":"hideEmptySeries","description":"When `true`, the empty series are completely hidden from the chart and the legend.\nFor example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","type":"boolean | undefined"},{"name":"hideLicenseWatermark","description":"Hides the license watermark.","type":"boolean | undefined"},{"name":"hideLoaderAnimation","description":"Hides the loader animation (curtain and spinner), showed by default at every update.","type":"boolean"},{"name":"hideUIMessages","description":"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).","type":"boolean"},{"name":"hideZeroCountCategories","description":"Whether to keep missing categories from a count aggregation as gaps in the chart's data.\n\nWhen data is retrieved from the server, the server excludes all features having a count of 0 from the response; hence resulting in missing entries on the charts.\n\nWhen this property is set to `true`, the dataset will keep these gaps instead of filling them with 0s.\n\nWhen left to `false`,  the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","type":"boolean"},{"name":"ignoreSmoothRenderingLimit","description":"When `true`, disables the default setting that uses debounce functions to handle the visibility of markers\nthat are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed\n(via chart cursor or scrollbar), to increase performance.\n\nThis property will be set when the chart is created and cannot be updated after that.\nIt's recommended that this property should only be set to `true` for small datasets.\nWhen left `undefined`, will be treated as `false`.\n\n**Note**: Applicable to line charts only.","type":"boolean"},{"name":"ignoreViewExtent","description":"This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.\n\nBy default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any\ngeometry passed through the model (`component.model.dataFilters`) or the runtime filters (`component.runtimeDataFilters`).\n\nSetting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.","type":"boolean"},{"name":"interactionsDisabled","description":"Disables all interactions on the chart.","type":"boolean"},{"name":"layer","description":"Used to perform queries.\nIf the layer is a `FeatureLayerView` or if the layer and the `view` property are both provided, the queries will be executed client-side.","type":"FeatureLayerView | SupportedLayer | SupportedRasterLayer | undefined"},{"name":"layerFieldsChangePolicy","description":"Allows the chart to update automatically when the layer's `fields` property changes.","type":"LayerFieldsChangePolicy"},{"name":"layerFilterChangePolicy","description":"Whether the chart should be refreshed when the layer's filter (`definitionExpression`) changes.","type":"LayerFilterChangePolicy"},{"name":"layerItemId","description":"Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.\n\nIf `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nSupported layers include: `FeatureLayer`, `SubtypeSublayer`, `ImageryLayer`, `ImageryTileLayer` and `WCSLayer`.","type":"string | undefined"},{"name":"layerRendererChangePolicy","description":"Allows the chart to update automatically when the layer's renderer changes. Applies when the color match is enabled.\n\n**Note**: If the property is set to `ignore` the chart will still use the layer's renderer information when the data is updated.","type":"LayerRendererChangePolicy"},{"name":"legendPosition","description":"Sets the legend's position on the chart.\n\n**Note**: Not applicable to gauges.","type":"WebChartLegendPositions | undefined"},{"name":"legendValueLabelFormatter","description":"A callback function used to format the legend value labels. If the returned string contains HTML tags they will be interpreted as such.\nIf provided, the formatter will be used if at least [displayNumericValue](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChartPieChartLegend-displayNumericValue) or [displayPercentage](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChartPieChartLegend-displayPercentage) is `true`.\n\n**Note**: Applicable to pie charts only.","type":"PieChartLegendValueLabelFormatCallback | undefined"},{"name":"legendVisibility","description":"When `true`, the legend is visible on the chart.\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"loaderColors","description":"Defines the colors for the loader animation.","type":"LoaderColors | undefined"},{"name":"messageOverrides","description":"Custom message overrides for the chart's strings.","type":"Record<string, unknown> | undefined"},{"name":"model","description":"Provides an API to interact with the chart's configuration.\n\n**Note**: This property has a union type of `ChartModel | WebChart` meaning a raw chart configuration object can be passed to it instead, however it is recommended to use the `ChartModel` instance whenever possible.","type":"ChartModel | WebChart | undefined"},{"name":"nullAsValid","description":"Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:\n- The corresponding warning event will be sent\n- The \"no data\" message will be displayed (unless `hideUIMessages` is set to `true` or `showUIMessages` is set to `false`)","type":"boolean"},{"name":"placeholder","description":"A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.","type":"string | undefined"},{"name":"popupTemplateFieldInfosEnabled","description":"Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).","type":"boolean | undefined"},{"name":"queueChartCreation","description":"Builds charts sequentially instead of rendering them all at once.","type":"boolean | undefined"},{"name":"replaceNoValueCategoryWithZero","description":"When `true`, the chart's `dataItems` associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","type":"boolean | undefined"},{"name":"returnFeaturesExtent","description":"When `true`, the features extent will be returned through the [@arcgisDataProcessComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisDataProcessComplete) and [@arcgisSelectionComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisSelectionComplete) events payload.\nApplies only to:\n- Charts using an aggregation.\n- Data source using a feature layer compatible with envelope aggregation.\n\nThe extent (IExtent) is returned through the property [featuresExtentField](https://developers.arcgis.com/javascript/latest/references/charts-components/utils/defaults/index/#featuresExtentField).\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"returnSelectionIndexes","description":"When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"returnSelectionOIDs","description":"When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.\nOnly considered for a data source using a feature layer.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers. It's always `false` for imagery layers. No object ids will be computed.","type":"boolean | undefined"},{"name":"rotated","description":"When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","type":"boolean"},{"name":"rotation","description":"When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","type":"boolean"},{"name":"runtimeDataFilters","description":"Applies runtime data filters to the chart.","type":"WebChartDataFilters | undefined"},{"name":"secondaryYAxisLabelFormatter","description":"Callback function used to format the secondary y-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Appliable to bar charts, line charts, combo bar line charts with dual axes.","type":"AxisLabelFormatCallback | undefined"},{"name":"selectionData","description":"When this property is set, it will apply a selection on the chart matching the provided selection.\n\n**Note**: Not applicable to gauges.","type":"SelectionData | undefined"},{"name":"selectionManager","description":"Selection manager object used to synchronize the selections with the chart when [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) is `true`.\nIt has precedence over the layer view's [SelectionManager](/references/core/views/SelectionManager/) when both are available.","type":"SelectionManager | undefined"},{"name":"selectionTheme","description":"Used to provide a customized theme for the selected and non selected elements.\n- If no style is provided for the selected elements, a default selection is applied.\n- If no style is provided for the non selected elements, the chart's style is applied.\n\n**Note**: Not applicable to gauges.","type":"SelectionTheme | undefined"},{"name":"setTimeBinningInfoWhenNotProvided","description":"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.\n\n**Note**: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar line chart, radar chart).","type":"boolean"},{"name":"showEmptySeries","description":"Show the series on the chart even if it doesn't have data (i.e. empty)\n\nWhen `false`, the empty series are completely hidden from the chart and the legend.\nFor example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"showLicenseWatermark","description":"Shows the license watermark.","type":"boolean"},{"name":"showUIMessages","description":"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).","type":"boolean | undefined"},{"name":"skipChartCreationQueue","description":"Whether to skip the chart rendering queue.\n\nWhen `true`, charts will render immediately without waiting for other charts to finish rendering.\nWhen `false` (default), charts are queued so that only one chart renders at a time.","type":"boolean"},{"name":"syncChartsSelection","description":"Whether to synchronize the selection between chart components from the same layer.","type":"boolean"},{"name":"syncSelection","description":"Whether to synchronize the selection between chart components from the same layer.","type":"boolean"},{"name":"syncSelectionsBetweenChartAndLayerViewPolicy","description":"Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","type":"SyncSelectionsBetweenChartAndLayerViewPolicy"},{"name":"syncViewSelection","description":"Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","type":"boolean"},{"name":"syncViewTimeExtent","description":"Whether the chart should be refreshed when the view's time extent changes.\n\n**Note**: Not supported for histogram.","type":"boolean"},{"name":"syncViewTimeZone","description":"Whether the chart's data should be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).\n\n**Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the\ncapacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the value of this property.","type":"boolean"},{"name":"syncViewTimeZoneInclusionList","description":"List of chart types to include from syncing the view's [`timeZone`](/references/core/views/MapView/#timeZone) with the data. Currently heat charts are included by default.\n\n**Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the\ncapacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the content of this list.","type":"(typeof WebChartTypes.BarSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries)[]"},{"name":"timeZone","description":"Used to set a custom time zone for the chart.","type":"MapView[\"timeZone\"] | undefined"},{"name":"togglingLegendItemsDisabled","description":"Disables the toggling of series via the legend items.\n\n**Note**: Only applicable to multi-series charts.","type":"boolean | undefined"},{"name":"tooltipFormatter","description":"Callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.","type":"ChartOptions[\"tooltipFormatter\"] | undefined"},{"name":"updateSplitBySeries","description":"Whether to update the series when the data updates while the chart uses a split-by field configuration.\n\nIf `addMissingSeries` is set to `true` the missing series will be added to cover the split-by values not referenced by the model.\nThe default information from the property `updateSplitBySeries.seriesTemplate` will be applied to the new series.\n\n**Note**: Applicable only to bar chart, line chart and box plot when a split-by field is used.","type":"MissingSplitBySeriesProps | undefined"},{"name":"useAnimatedCharts","description":"Enable animation on the chart.","type":"boolean"},{"name":"usePopupTemplateFieldsInfo","description":"Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).","type":"boolean"},{"name":"view","description":"Used to access the feature layer view instance in order to perform client side queries.","type":"MapView | SceneView | undefined"},{"name":"viewTimeExtentChangePolicy","description":"Whether the chart should be refreshed when the view's time extent changes.","type":"ViewTimeExtentChangePolicy"},{"name":"xAxisLabelFormatter","description":"Callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie charts.","type":"AxisLabelFormatCallback | undefined"},{"name":"yAxisLabelFormatter","description":"Callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie charts or gauges.","type":"AxisLabelFormatCallback | undefined"}],"events":[{"name":"arcgisAxesMinMaxChange","type":"AxesMinMaxChangePayload","description":"Event triggered once the chart axes min/max values are computed."},{"name":"arcgisBadDataWarningRaise","type":"DataWarningObject","description":"Event triggered when an error is detected with the data set."},{"name":"arcgisChartNotFoundWarning","type":"string","description":"Event triggered when the chart is not found for the given [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property."},{"name":"arcgisConfigChange","type":"{\n    newConfig: WebChart | undefined;\n    oldConfig: WebChart | undefined;\n    functionCalled: string | undefined;\n}","description":"Event triggered when the chart config is changed."},{"name":"arcgisDataFetchComplete","type":"WebChartDataTypes","description":"Event triggered once the chart data has been fetched but not yet fully processed.\n\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n\n**Note**: Applicable to pie charts only."},{"name":"arcgisDataProcessComplete","type":"DataProcessCompletePayload","description":"Event triggered once the chart data has been processed."},{"name":"arcgisDataProcessError","type":"void","description":"Event triggered when an error occurred while fetching of processing the data for the chart."},{"name":"arcgisInvalidConfigWarningRaise","type":"DataWarningObject","description":"Event triggered when an invalid configuration is detected."},{"name":"arcgisLegendItemVisibilityChange","type":"LegendItemVisibilityChangePayload","description":"Event triggered once a legend item visibility has been changed."},{"name":"arcgisNoRenderPropChange","type":"NoRenderPropChangePayload","description":"Event triggered when a no-render prop is changed."},{"name":"arcgisRenderingComplete","type":"void","description":"Event triggered once the chart rendering is complete."},{"name":"arcgisRuntimeError","type":"void","description":"Event triggered when an error occurred that prevents the chart from being created or updated."},{"name":"arcgisSelectionComplete","type":"SelectionCompletePayload","description":"Event triggered when a selection is applied to the chart."},{"name":"arcgisSeriesColorChange","type":"SeriesColorChangePayload","description":"Event triggered once the chart series color have been assigned."},{"name":"arcgisSeriesOrder","type":"string[]","description":"Event carrying the series id as they have been sorted following the `orderOptions` instructions."},{"name":"arcgisUpdateComplete","type":"ValidationStatus","description":"Event triggered once the chart is updated."}]}},{"name":"arcgis-charts-action-bar","description":"The Charts Action Bar component provides context-specific actions such as rotation, zooming, and filtering, as well as general actions like exporting the chart as an image or CSV file.\nThis component is designed to be used with a chart component and is not intended for standalone use.\n--\n\n### Events\n- **arcgisActionBarToggle** - Event triggered once action bar expand is toggled.\n- **arcgisDefaultActionSelect** - Event triggered once a default action is selected.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- **custom-action-top** - A slot for adding custom `calcite-action` to the top of the default actions.\n- **custom-action-below** - A slot for adding custom `calcite-action` to the bottom of the default actions.","doc-url":"https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-charts-action-bar/","attributes":[{"name":"action-bar-selection-mode","description":"Defines which selection mode the slotted action bar should use.\n- `monoSelection`: Select a single data point/series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points/series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points/series while holding the Ctrl key (Cmd key on Mac), new selection adds to the previous one.","default":"\"multiSelectionWithCtrlKey\"","value":{"type":["\"monoSelection\"","\"multiSelection\"","\"multiSelectionWithCtrlKey\""]}},{"name":"chart-type","description":"Chart type used to determine which default actions to display.","value":{"type":["\"scatterSeries\"","\"pieSeries\"","\"gaugeSeries\"","\"lineSeries\"","\"barSeries\"","\"histogramSeries\"","\"boxPlotSeries\"","\"radarSeries\"","\"comboLineAndBarSeries\"","\"heatSeries\""]}},{"name":"clear-selection-state","description":"When `disabled`, interaction with the clear selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"clear-selection-title","description":"Custom title for the clear selection action.","value":{"type":"string"}},{"name":"clear-selection-toggle","description":"When `active`, the clear selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"edit-chart-state","description":"When `disabled`, interaction with the edit chart action is prevented and the component is displayed with lower opacity.","default":"\"disabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"edit-chart-title","description":"Custom title for the edit chart action.","value":{"type":"string"}},{"name":"edit-chart-toggle","description":"When `active`, the edit chart action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"expanded","description":"When `true`, the action bar is expanded.","default":"false","value":{"type":"boolean"}},{"name":"export-action-state","description":"When `disabled`, interaction with the export action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"export-as-csv-state","description":"When `disabled`, interaction with the download CSV is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"export-as-csv-title","description":"Custom title for the download CSV action.","value":{"type":"string"}},{"name":"export-as-image-state","description":"When `disabled`, interaction with the download image is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"export-as-image-title","description":"Custom title for the download chart action.","value":{"type":"string"}},{"name":"filter-by-extent-state","description":"When `disabled`, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"filter-by-extent-title","description":"Custom title for the filter by extent action.","value":{"type":"string"}},{"name":"filter-by-extent-toggle","description":"When `active`, the filter by extent action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"filter-by-selection-state","description":"When `disabled`, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"filter-by-selection-title","description":"Custom title for the filter by selection action.","value":{"type":"string"}},{"name":"filter-by-selection-toggle","description":"When `active`, the filter by selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"force-disable-actions","description":"When `true`, overrides the individual settings for each action to instead force disable them all.","default":"false","value":{"type":"boolean"}},{"name":"full-extent-state","description":"When `disabled`, interaction with the full extent action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"full-extent-title","description":"Custom title for the full extent action.","value":{"type":"string"}},{"name":"full-extent-toggle","description":"When `active`, the full extent action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"legend-state","description":"When `disabled`, interaction with the legend action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"legend-title","description":"Custom title for the legend action.","value":{"type":"string"}},{"name":"legend-toggle","description":"When `active`, the legend action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"rotate-chart-state","description":"When `disabled`, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"rotate-chart-title","description":"Custom title for the rotate chart action.","value":{"type":"string"}},{"name":"rotate-chart-toggle","description":"When `active`, the rotate chart action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"selection-state","description":"When `disabled`, interaction with the selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"selection-title","description":"Custom title for the selection action.","value":{"type":"string"}},{"name":"selection-toggle","description":"When `active`, the selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"switch-selection-state","description":"When `disabled`, interaction with the switch selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"switch-selection-title","description":"Custom title for the switch selection action.","value":{"type":"string"}},{"name":"switch-selection-toggle","description":"When `active`, the switch selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"zoom-state","description":"When `disabled`, interaction with the zoom action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"zoom-title","description":"Custom title for the zoom action.","value":{"type":"string"}},{"name":"zoom-toggle","description":"When `active`, the zoom action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}}],"slots":[{"name":"custom-action-top","description":"A slot for adding custom `calcite-action` to the top of the default actions."},{"name":"custom-action-below","description":"A slot for adding custom `calcite-action` to the bottom of the default actions."}],"events":[{"name":"arcgisActionBarToggle","type":"boolean","description":"Event triggered once action bar expand is toggled."},{"name":"arcgisDefaultActionSelect","type":"DefaultActionSelectPayload","description":"Event triggered once a default action is selected."}],"js":{"properties":[{"name":"actionBarSelectionMode","description":"Defines which selection mode the slotted action bar should use.\n- `monoSelection`: Select a single data point/series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points/series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points/series while holding the Ctrl key (Cmd key on Mac), new selection adds to the previous one.","type":"Extract<ActionModes, \"monoSelection\" | \"multiSelection\" | \"multiSelectionWithCtrlKey\"> | undefined"},{"name":"chartElement","description":"Chart element reference with which the action bar is associated.","type":"ArcgisChart | undefined"},{"name":"chartType","description":"Chart type used to determine which default actions to display.","type":"ChartTypes | undefined"},{"name":"clearSelectionState","description":"When `disabled`, interaction with the clear selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"clearSelectionTitle","description":"Custom title for the clear selection action.","type":"string | undefined"},{"name":"clearSelectionToggle","description":"When `active`, the clear selection action is highlighted.","type":"ActionToggle"},{"name":"csvExportExclusionList","description":"The CSV export action is disabled for certain chart types.\n\nModify this property to add or remove chart types from the list of disabled types.","type":"WebChartTypes[]"},{"name":"disableCSVExportForChartTypes","description":"The CSV export action is disabled for certain chart types.\n\nModify this property to add or remove chart types from the list of disabled types.","type":"WebChartTypes[]"},{"name":"editChartState","description":"When `disabled`, interaction with the edit chart action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"editChartTitle","description":"Custom title for the edit chart action.","type":"string | undefined"},{"name":"editChartToggle","description":"When `active`, the edit chart action is highlighted.","type":"ActionToggle"},{"name":"expanded","description":"When `true`, the action bar is expanded.","type":"boolean"},{"name":"exportActionState","description":"When `disabled`, interaction with the export action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"exportAsCSVState","description":"When `disabled`, interaction with the download CSV is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"exportAsCSVTitle","description":"Custom title for the download CSV action.","type":"string | undefined"},{"name":"exportAsImageState","description":"When `disabled`, interaction with the download image is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"exportAsImageTitle","description":"Custom title for the download chart action.","type":"string | undefined"},{"name":"filterByExtentState","description":"When `disabled`, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"filterByExtentTitle","description":"Custom title for the filter by extent action.","type":"string | undefined"},{"name":"filterByExtentToggle","description":"When `active`, the filter by extent action is highlighted.","type":"ActionToggle"},{"name":"filterBySelectionState","description":"When `disabled`, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"filterBySelectionTitle","description":"Custom title for the filter by selection action.","type":"string | undefined"},{"name":"filterBySelectionToggle","description":"When `active`, the filter by selection action is highlighted.","type":"ActionToggle"},{"name":"forceDisableActions","description":"When `true`, overrides the individual settings for each action to instead force disable them all.","type":"boolean"},{"name":"fullExtentState","description":"When `disabled`, interaction with the full extent action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"fullExtentTitle","description":"Custom title for the full extent action.","type":"string | undefined"},{"name":"fullExtentToggle","description":"When `active`, the full extent action is highlighted.","type":"ActionToggle"},{"name":"hiddenActions","description":"Holds a list of actions to hide from the action bar.\n\n**Note:** The edit chart action is hidden by default. To show it, remove its value from this array.","type":"DefaultChartActions[]"},{"name":"legendState","description":"When `disabled`, interaction with the legend action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"legendTitle","description":"Custom title for the legend action.","type":"string | undefined"},{"name":"legendToggle","description":"When `active`, the legend action is highlighted.","type":"ActionToggle"},{"name":"messageOverrides","description":"Overwrite localized strings for this component.","type":"Record<string, unknown> | undefined"},{"name":"rotateChartState","description":"When `disabled`, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"rotateChartTitle","description":"Custom title for the rotate chart action.","type":"string | undefined"},{"name":"rotateChartToggle","description":"When `active`, the rotate chart action is highlighted.","type":"ActionToggle"},{"name":"selectionState","description":"When `disabled`, interaction with the selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"selectionTitle","description":"Custom title for the selection action.","type":"string | undefined"},{"name":"selectionToggle","description":"When `active`, the selection action is highlighted.","type":"ActionToggle"},{"name":"switchSelectionState","description":"When `disabled`, interaction with the switch selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"switchSelectionTitle","description":"Custom title for the switch selection action.","type":"string | undefined"},{"name":"switchSelectionToggle","description":"When `active`, the switch selection action is highlighted.","type":"ActionToggle"},{"name":"zoomState","description":"When `disabled`, interaction with the zoom action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"zoomTitle","description":"Custom title for the zoom action.","type":"string | undefined"},{"name":"zoomToggle","description":"When `active`, the zoom action is highlighted.","type":"ActionToggle"}],"events":[{"name":"arcgisActionBarToggle","type":"boolean","description":"Event triggered once action bar expand is toggled."},{"name":"arcgisDefaultActionSelect","type":"DefaultActionSelectPayload","description":"Event triggered once a default action is selected."}]}}]},"css":{"properties":[],"pseudo-elements":[]}}}
+{"$schema":"https://raw.githubusercontent.com/JetBrains/web-types/master/schema/web-types.json","name":"@arcgis/charts-components","version":"5.2.0-next.11","description-markup":"markdown","contributions":{"html":{"elements":[{"name":"arcgis-chart","description":"The 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.\n\nSupported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.\n--\n\n### Events\n- **arcgisAxesMinMaxChange** - Event triggered once the chart axes min/max values are computed.\n- **arcgisBadDataWarningRaise** - Event triggered when an error is detected with the data set.\n- **arcgisChartNotFoundWarning** - Event triggered when the chart is not found for the given [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property.\n- **arcgisConfigChange** - Event triggered when the chart config is changed.\n- **arcgisDataFetchComplete** - Event triggered once the chart data has been fetched but not yet fully processed.\n\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n\n**Note**: Applicable to pie charts only.\n- **arcgisDataProcessComplete** - Event triggered once the chart data has been processed.\n- **arcgisDataProcessError** - Event triggered when an error occurred while fetching of processing the data for the chart.\n- **arcgisInvalidConfigWarningRaise** - Event triggered when an invalid configuration is detected.\n- **arcgisLegendItemVisibilityChange** - Event triggered once a legend item visibility has been changed.\n- **arcgisNoRenderPropChange** - Event triggered when a no-render prop is changed.\n- **arcgisRenderingComplete** - Event triggered once the chart rendering is complete.\n- **arcgisRuntimeError** - Event triggered when an error occurred that prevents the chart from being created or updated.\n- **arcgisSelectionComplete** - Event triggered when a selection is applied to the chart.\n- **arcgisSeriesColorChange** - Event triggered once the chart series color have been assigned.\n- **arcgisSeriesOrder** - Event carrying the series id as they have been sorted following the `orderOptions` instructions.\n- **arcgisUpdateComplete** - Event triggered once the chart is updated.\n\n### Methods\n- `applySelectionFromSelectionManager(): void` - Apply the selection from the selection manager to the chart.\n- `clearSelection(): Promise<void>` - Clears all selection on the chart.\n\n**Note**: Not applicable to gauge.\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n- `destroy(): Promise<void>` - Destroys the chart instance and removes it from the DOM.\n- `errorAlert(errorMessage?: string): Promise<void>` - **Deprecated**: since 5.1. Won't be replaced.. Triggers an alert to display an error message.\n- `exportAsCSV(options?: CSVOptions): Promise<void>` - Export the current chart's data as a CSV file.\n\nThe `Options` object can contain the following properties:\n- `columns`: An array of column to include in the CSV file.\n- `delimiter`: The delimiter to use in the CSV file. Default is `,`.\n- `includeHeader`: Whether to include the header row in the CSV file. Default is `true`.\n- `quoteAll`: Whether to quote all values in the CSV file. Default is `false`.\n- `locale`: The locale to use when formatting the CSV file. Default is `en`.\n   - Locale supported are: \"ar\", \"ar-u-nu-latn\", \"bs\", \"bg\", \"ca\", \"cs\", \"da\", \"de\", \"el\", \"en\", \"en-US\", \"es\", \"et\", \"fi\", \"fr\", \"he\", \"hr\", \"hu\", \"id\", \"it\", \"ja\", \"ko\", \"lt\", \"lv\", \"no\", \"nl\", \"pl\", \"pt-BR\", \"pt-PT\", \"ro\", \"ru\", \"sr\", \"sl\", \"sk\", \"sv\", \"th\", \"tr\", \"uk\", \"vi\", \"zh-CN\", \"zh-HK\", \"zh-TW\"\n\n**Note**: The chart types supported by this method are:\n- Bar chart\n- Box plot\n- Combo bar line chart\n- Heat chart\n- Histogram\n- Line chart\n- Pie chart\n- `exportAsImage(format?: DownloadableChartImagesTypes): Promise<void>` - Exports the current chart as an image. Default format is `png`.\n- Alternative formats supported are: `jpeg` and `svg`.\n- `loadModel(): Promise<void>` - Returns a promise that resolves when the chart model is fully loaded.\n- `notify(message?: string, heading?: string): Promise<void>` - Notify method allows passing external messages to the chart component.\nIt can be used to pass validation or information messages.\nIn a situation where a model update is overriding the notification modal, consider waiting for the [@arcgisUpdateComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisUpdateComplete) event.\n- `refresh(props?: {\n    updateData?: boolean;\n    resetAxesBounds?: boolean;\n}): Promise<void>` - Re-render the chart.\n- `resetZoom(): Promise<void>` - Resets the chart zoom to bring it back to full extent.\n\n**Note**: Applicable to XY charts only.\n- `switchSelection(): Promise<void>` - Switches the selection on the chart.\n\n**Note**: Not applicable to gauge.\n\n### Slots\n- **action-bar** - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.","doc-url":"https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/","attributes":[{"name":"action-mode","description":"Specifies the user action behavior for the chart.\n\n- `monoSelection`: Select a single data point or series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points or series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points or series while holding the Ctrl key (Cmd on Mac). When the key is held, each new selection is added; otherwise, the selection is replaced.\n- `none`: No action is performed on user interaction.\n- `zoom`: Zoom into a specific area of the chart.\n\n**Note**: Not applicable to gauges.","value":{"type":["\"none\"","\"monoSelection\"","\"multiSelection\"","\"multiSelectionWithCtrlKey\"","\"zoom\""]}},{"name":"allow-using-object-id-stat","description":"Whether to allow the object id to be used as a statistic other than `Count`.","default":"false","value":{"type":"boolean"}},{"name":"animation-enabled","description":"Enable animation on the chart.","default":"false","value":{"type":"boolean"}},{"name":"auto-destroy-disabled","description":"If `true`, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#destroy)  method when you are done to prevent memory leaks.","default":"false","value":{"type":"boolean"}},{"name":"auto-dispose-chart","description":"**Deprecated**: since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#autoDestroyDisabled) instead.. Auto disposes the chart when a new one is created in the same container.","default":"false","value":{"type":"boolean"}},{"name":"auto-inverse-data-label-text-color","description":"When `true`, the data label text color is automatically adjusted for readability based on its background.\nIf the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.\n\n**Note**: Applicable to heat charts only.","default":"false","value":{"type":"boolean"}},{"name":"chart-index","description":"The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.\n\nIf a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nIf the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.","value":{"type":"number"}},{"name":"configuration-enabled","description":"Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","default":"false","value":{"type":"boolean"}},{"name":"cursor-range","description":"Sets the cursor range when `actionMode` is set to `zoom`, `multiSelection` or `multiSelectionWithCtrlKey`.\n\n- `multi-axes`: Allows to draw a free rectangle.\n- `x-axis`: Allows to draw a rectangle bound to the x-axis.\n- `y-axis`: Allows to draw a rectangle bound to the y-axis.\n- `undefined`: Defaults to the preset behavior according to the chart type and action mode.\n\n**Note**: Not applicable to gauges.","value":{"type":["\"multi-axes\"","\"x-axis\"","\"y-axis\""]}},{"name":"disable-interactions","description":"**Deprecated**: since 5.1. Use [interactionsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#interactionsDisabled) instead.. Disables all interactions on the chart.","default":"false","value":{"type":"boolean"}},{"name":"disable-toggling-legend-items","description":"**Deprecated**: since 5.1. Use [togglingLegendItemsDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#togglingLegendItemsDisabled) instead.. Disables the toggling of series from the legend items.\n\n**Note**: Only applicable to multi-series charts.","default":"false","value":{"type":"boolean"}},{"name":"enable-beta-features","description":"Whether to enable the beta features from the chart component.","default":"false","value":{"type":"boolean"}},{"name":"enable-configuration","description":"**Deprecated**: since 5.1. Use [configurationEnabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#configurationEnabled) instead.. Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","default":"false","value":{"type":"boolean"}},{"name":"enable-responsive-features","description":"**Deprecated**: since 5.1. Won't be replaced.. Enables the responsive features.","default":"false","value":{"type":"boolean"}},{"name":"error-policy","description":"Whether to display an error alert and hide the chart when it can't be created or updated.","default":"\"throw\"","value":{"type":["\"throw\"","\"ignore\""]}},{"name":"feature-index","description":"**Deprecated**: since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/model/gauge-model/gauge-model/#featureIndex) prop instead.. The index of the feature to render when using a feature based gauge.\n\n**Note**: Applicable to gauges only.","value":{"type":"number"}},{"name":"filter-by-extent","description":"**Deprecated**: since 5.1. Use [filterByViewExtent](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#filterByViewExtent) instead.. When `true`, all chart elements are filtered based on the view extent.","default":"false","value":{"type":"boolean"}},{"name":"filter-by-selection","description":"When `true`, all chart elements are filtered based on the selection.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers.","default":"false","value":{"type":"boolean"}},{"name":"filter-by-view-extent","description":"When `true`, all chart elements are filtered based on the view extent.","default":"false","value":{"type":"boolean"}},{"name":"hide-empty-series","description":"**Deprecated**: since 5.1. Use [showEmptySeries](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#showEmptySeries) instead.. When `true`, the empty series are completely hidden from the chart and the legend.\nFor example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"hide-license-watermark","description":"**Deprecated**: since 5.1. Use [showLicenseWatermark](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#showLicenseWatermark) instead.. Hides the license watermark.","default":"false","value":{"type":"boolean"}},{"name":"hide-loader-animation","description":"Hides the loader animation (curtain and spinner), showed by default at every update.","default":"false","value":{"type":"boolean"}},{"name":"hide-ui-messages","description":"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":"false","value":{"type":"boolean"}},{"name":"hide-zero-count-categories","description":"Whether to keep missing categories from a count aggregation as gaps in the chart's data.\n\nWhen data is retrieved from the server, the server excludes all features having a count of 0 from the response; hence resulting in missing entries on the charts.\n\nWhen this property is set to `true`, the dataset will keep these gaps instead of filling them with 0s.\n\nWhen left to `false`,  the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","default":"false","value":{"type":"boolean"}},{"name":"ignore-smooth-rendering-limit","description":"**Deprecated**: since 5.1. Won't be replaced.. When `true`, disables the default setting that uses debounce functions to handle the visibility of markers\nthat are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed\n(via chart cursor or scrollbar), to increase performance.\n\nThis property will be set when the chart is created and cannot be updated after that.\nIt's recommended that this property should only be set to `true` for small datasets.\nWhen left `undefined`, will be treated as `false`.\n\n**Note**: Applicable to line charts only.","default":"false","value":{"type":"boolean"}},{"name":"ignore-view-extent","description":"This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.\n\nBy default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any\ngeometry passed through the model (`component.model.dataFilters`) or the runtime filters (`component.runtimeDataFilters`).\n\nSetting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.","default":"false","value":{"type":"boolean"}},{"name":"interactions-disabled","description":"Disables all interactions on the chart.","default":"false","value":{"type":"boolean"}},{"name":"layer-fields-change-policy","description":"**Deprecated**: since 5.1. Won't be replaced.. Allows the chart to update automatically when the layer's `fields` property changes.","default":"\"refresh\"","value":{"type":["\"refresh\"","\"ignore\""]}},{"name":"layer-filter-change-policy","description":"**Deprecated**: since 5.1. Won't be replaced.. Whether the chart should be refreshed when the layer's filter (`definitionExpression`) changes.","default":"\"refresh\"","value":{"type":["\"refresh\"","\"ignore\""]}},{"name":"layer-item-id","description":"Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.\n\nIf `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nSupported layers include: `FeatureLayer`, `SubtypeSublayer`, `ImageryLayer`, `ImageryTileLayer` and `WCSLayer`.","value":{"type":"string"}},{"name":"layer-renderer-change-policy","description":"**Deprecated**: since 5.1. Won't be replaced.. Allows the chart to update automatically when the layer's renderer changes. Applies when the color match is enabled.\n\n**Note**: If the property is set to `ignore` the chart will still use the layer's renderer information when the data is updated.","default":"\"refresh\"","value":{"type":["\"refresh\"","\"ignore\""]}},{"name":"legend-position","description":"**Deprecated**: since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#legendPosition) prop instead.. Sets the legend's position on the chart.\n\n**Note**: Not applicable to gauges.","value":{"type":["\"left\"","\"right\"","\"top\"","\"bottom\""]}},{"name":"legend-visibility","description":"**Deprecated**: since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#legendVisibility) prop instead.. When `true`, the legend is visible on the chart.\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"null-as-valid","description":"Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:\n- The corresponding warning event will be sent\n- The \"no data\" message will be displayed (unless `hideUIMessages` is set to `true` or `showUIMessages` is set to `false`)","default":"false","value":{"type":"boolean"}},{"name":"placeholder","description":"A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.","value":{"type":"string"}},{"name":"popup-template-field-infos-enabled","description":"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":"false","value":{"type":"boolean"}},{"name":"queue-chart-creation","description":"**Deprecated**: since 5.1. Use [skipChartCreationQueue](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#skipChartCreationQueue) instead.. Builds charts sequentially instead of rendering them all at once.","default":"false","value":{"type":"boolean"}},{"name":"replace-no-value-category-with-zero","description":"**Deprecated**: since 5.0. Use [hideZeroCountCategories](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideZeroCountCategories) instead.. When `true`, the chart's `dataItems` associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","default":"false","value":{"type":"boolean"}},{"name":"return-features-extent","description":"When `true`, the features extent will be returned through the [@arcgisDataProcessComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisDataProcessComplete) and [@arcgisSelectionComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisSelectionComplete) events payload.\nApplies only to:\n- Charts using an aggregation.\n- Data source using a feature layer compatible with envelope aggregation.\n\nThe extent (IExtent) is returned through the property [featuresExtentField](https://developers.arcgis.com/javascript/latest/references/charts-components/utils/defaults/index/#featuresExtentField).\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"return-selection-indexes","description":"When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"return-selection-oi-ds","description":"When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.\nOnly considered for a data source using a feature layer.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers. It's always `false` for imagery layers. No object ids will be computed.","default":"false","value":{"type":"boolean"}},{"name":"rotated","description":"When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","default":"false","value":{"type":"boolean"}},{"name":"rotation","description":"**Deprecated**: since 5.0. Use either [rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#rotated) or the charts model's [rotated](https://developers.arcgis.com/javascript/latest/references/charts-components/model/bar-chart-model/bar-chart-model/#rotated) prop instead.. When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","default":"false","value":{"type":"boolean"}},{"name":"set-time-binning-info-when-not-provided","description":"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.\n\n**Note**: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar line chart, radar chart).","default":"false","value":{"type":"boolean"}},{"name":"show-empty-series","description":"Show the series on the chart even if it doesn't have data (i.e. empty)\n\nWhen `false`, the empty series are completely hidden from the chart and the legend.\nFor example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","default":"false","value":{"type":"boolean"}},{"name":"show-license-watermark","description":"Shows the license watermark.","default":"false","value":{"type":"boolean"}},{"name":"show-ui-messages","description":"**Deprecated**: since 5.1. Use [hideUIMessages](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#hideUIMessages) instead.. 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":"false","value":{"type":"boolean"}},{"name":"skip-chart-creation-queue","description":"Whether to skip the chart rendering queue.\n\nWhen `true`, charts will render immediately without waiting for other charts to finish rendering.\nWhen `false` (default), charts are queued so that only one chart renders at a time.","default":"false","value":{"type":"boolean"}},{"name":"sync-charts-selection","description":"Whether to synchronize the selection between chart components from the same layer.","default":"false","value":{"type":"boolean"}},{"name":"sync-selection","description":"**Deprecated**: since 5.1. Use [syncChartsSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncChartsSelection) prop instead.. Whether to synchronize the selection between chart components from the same layer.","default":"false","value":{"type":"boolean"}},{"name":"sync-selections-between-chart-and-layer-view-policy","description":"**Deprecated**: since 5.1. Use [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) prop instead.. Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","default":"\"disabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"sync-view-selection","description":"Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","default":"false","value":{"type":"boolean"}},{"name":"sync-view-time-extent","description":"Whether the chart should be refreshed when the view's time extent changes.\n\n**Note**: Not supported for histogram.","default":"false","value":{"type":"boolean"}},{"name":"sync-view-time-zone","description":"Whether the chart's data should be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).\n\n**Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the\ncapacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the value of this property.","default":"false","value":{"type":"boolean"}},{"name":"time-zone","description":"Used to set a custom time zone for the chart.","value":{"type":"string"}},{"name":"toggling-legend-items-disabled","description":"Disables the toggling of series via the legend items.\n\n**Note**: Only applicable to multi-series charts.","default":"false","value":{"type":"boolean"}},{"name":"use-animated-charts","description":"**Deprecated**: since 5.1. Use [animationEnabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#animationEnabled) instead.. Enable animation on the chart.","default":"false","value":{"type":"boolean"}},{"name":"use-popup-template-fields-info","description":"**Deprecated**: since 5.1. Use [popupTemplateFieldInfosEnabled](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#popupTemplateFieldInfosEnabled) instead.. 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":"false","value":{"type":"boolean"}},{"name":"view-time-extent-change-policy","description":"**Deprecated**: since 5.1. Use [syncViewTimeExtent](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewTimeExtent) prop instead.\n\n**Note**: Not applicable for histograms.. Whether the chart should be refreshed when the view's time extent changes.","default":"\"ignore\"","value":{"type":["\"refresh\"","\"ignore\""]}}],"slots":[{"name":"action-bar","description":"Slot for adding a `charts-action-bar` component or `calcite-action-bar`."}],"events":[{"name":"arcgisAxesMinMaxChange","type":"AxesMinMaxChangePayload","description":"Event triggered once the chart axes min/max values are computed."},{"name":"arcgisBadDataWarningRaise","type":"DataWarningObject","description":"Event triggered when an error is detected with the data set."},{"name":"arcgisChartNotFoundWarning","type":"string","description":"Event triggered when the chart is not found for the given [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property."},{"name":"arcgisConfigChange","type":"{\n    newConfig: WebChart | undefined;\n    oldConfig: WebChart | undefined;\n    functionCalled: string | undefined;\n}","description":"Event triggered when the chart config is changed."},{"name":"arcgisDataFetchComplete","type":"WebChartDataTypes","description":"Event triggered once the chart data has been fetched but not yet fully processed.\n\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n\n**Note**: Applicable to pie charts only."},{"name":"arcgisDataProcessComplete","type":"DataProcessCompletePayload","description":"Event triggered once the chart data has been processed."},{"name":"arcgisDataProcessError","type":"void","description":"Event triggered when an error occurred while fetching of processing the data for the chart."},{"name":"arcgisInvalidConfigWarningRaise","type":"DataWarningObject","description":"Event triggered when an invalid configuration is detected."},{"name":"arcgisLegendItemVisibilityChange","type":"LegendItemVisibilityChangePayload","description":"Event triggered once a legend item visibility has been changed."},{"name":"arcgisNoRenderPropChange","type":"NoRenderPropChangePayload","description":"Event triggered when a no-render prop is changed."},{"name":"arcgisRenderingComplete","type":"void","description":"Event triggered once the chart rendering is complete."},{"name":"arcgisRuntimeError","type":"void","description":"Event triggered when an error occurred that prevents the chart from being created or updated."},{"name":"arcgisSelectionComplete","type":"SelectionCompletePayload","description":"Event triggered when a selection is applied to the chart."},{"name":"arcgisSeriesColorChange","type":"SeriesColorChangePayload","description":"Event triggered once the chart series color have been assigned."},{"name":"arcgisSeriesOrder","type":"string[]","description":"Event carrying the series id as they have been sorted following the `orderOptions` instructions."},{"name":"arcgisUpdateComplete","type":"ValidationStatus","description":"Event triggered once the chart is updated."}],"js":{"properties":[{"name":"actionMode","description":"Specifies the user action behavior for the chart.\n\n- `monoSelection`: Select a single data point or series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points or series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points or series while holding the Ctrl key (Cmd on Mac). When the key is held, each new selection is added; otherwise, the selection is replaced.\n- `none`: No action is performed on user interaction.\n- `zoom`: Zoom into a specific area of the chart.\n\n**Note**: Not applicable to gauges.","type":"ActionModes | undefined"},{"name":"allowUsingObjectIdStat","description":"Whether to allow the object id to be used as a statistic other than `Count`.","type":"boolean"},{"name":"animationEnabled","description":"Enable animation on the chart.","type":"boolean | undefined"},{"name":"aria","description":"The ARIA attributes for the chart. Provides accessibility information to assistive technologies such as screen readers. Supports the following properties: [\\`label\\`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-label), [\\`description\\`](https://developer.mozilla.org/docs/Web/Accessibility/ARIA/Reference/Attributes/aria-description), [\\`describedByElements\\`](https://developer.mozilla.org/docs/Web/API/Element/ariaDescribedByElements), and [\\`labelledByElements\\`](https://developer.mozilla.org/docs/Web/API/Element/ariaLabelledByElements).","type":"DOMContainerAria | undefined"},{"name":"autoDestroyDisabled","description":"If `true`, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#destroy)  method when you are done to prevent memory leaks.","type":"boolean"},{"name":"autoDisposeChart","description":"Auto disposes the chart when a new one is created in the same container.","type":"boolean"},{"name":"autoInverseDataLabelTextColor","description":"When `true`, the data label text color is automatically adjusted for readability based on its background.\nIf the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.\n\n**Note**: Applicable to heat charts only.","type":"boolean"},{"name":"calciteThemingCSSVariables","description":"Allows picking the Calcite CSS variables to use when applying a Calcite theme.\n\nBy default the following variables are used:\n- background: `--calcite-color-foreground-1`\n- text: `--calcite-color-text-1`\n- line: `--calcite-color-border-1`\n- secondary line: `--calcite-color-text-3`\n- spinner: `--calcite-color-brand-hover`\n\nThe charts colors are overridden by those associated to those CSS variables, but only if they have not been\ncustomized beforehand.","type":"CalciteThemeCSSVariables"},{"name":"chartIndex","description":"The index of the chart to be rendered from the layer. Must be used in conjunction with the `layerItemId` or `layer` property.\n\nIf a `layer` or `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nIf the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.","type":"number | undefined"},{"name":"chartLimits","description":"Customize the maximum number of series allowed on the chart.\n\nThe chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation\nor update of the chart, or render the elements up to the given limits.\n\n**Note**: Not applicable to gauges.","type":"ChartElementLimit | undefined"},{"name":"chartWillRender","description":"Lifecycle function executed after the data has been processed and before the chart renders.\nCan be used to alter the model from information extracted from the data.\n\n**Note**: Applicable to gauges and pie charts only.","type":"PreRenderCallback | undefined"},{"name":"configurationEnabled","description":"Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","type":"boolean"},{"name":"cursorRange","description":"Sets the cursor range when `actionMode` is set to `zoom`, `multiSelection` or `multiSelectionWithCtrlKey`.\n\n- `multi-axes`: Allows to draw a free rectangle.\n- `x-axis`: Allows to draw a rectangle bound to the x-axis.\n- `y-axis`: Allows to draw a rectangle bound to the y-axis.\n- `undefined`: Defaults to the preset behavior according to the chart type and action mode.\n\n**Note**: Not applicable to gauges.","type":"CursorRange | undefined"},{"name":"dataLabelFormatter","description":"Callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to gauges.","type":"ChartOptions[\"dataLabelFormatter\"] | undefined"},{"name":"disableInteractions","description":"Disables all interactions on the chart.","type":"boolean"},{"name":"disableTogglingLegendItems","description":"Disables the toggling of series from the legend items.\n\n**Note**: Only applicable to multi-series charts.","type":"boolean"},{"name":"enableBetaFeatures","description":"Whether to enable the beta features from the chart component.","type":"boolean"},{"name":"enableConfiguration","description":"Whether to use features uniquely designed for a chart currently being configured by a user via the UI.\nWhen true, the slotted charts action bar will expose an Edit chart action, surfaces relevant error states,\nand can show a helpful in-container placeholder about the chart’s purpose.","type":"boolean"},{"name":"enableResponsiveFeatures","description":"Enables the responsive features.","type":"boolean"},{"name":"errorPolicy","description":"Whether to display an error alert and hide the chart when it can't be created or updated.","type":"ErrorPolicy"},{"name":"featureIndex","description":"The index of the feature to render when using a feature based gauge.\n\n**Note**: Applicable to gauges only.","type":"number | undefined"},{"name":"filterByExtent","description":"When `true`, all chart elements are filtered based on the view extent.","type":"boolean"},{"name":"filterBySelection","description":"When `true`, all chart elements are filtered based on the selection.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers.","type":"boolean"},{"name":"filterByViewExtent","description":"When `true`, all chart elements are filtered based on the view extent.","type":"boolean"},{"name":"gaugeInnerLabelFormatter","description":"Callback function used to format the gauge inner label. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Applicable to gauges only.","type":"GaugeInnerLabelFormatCallback | undefined"},{"name":"guideTooltipFormatter","description":"Callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie charts.","type":"GuideTooltipFormatCallback | undefined"},{"name":"hideEmptySeries","description":"When `true`, the empty series are completely hidden from the chart and the legend.\nFor example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","type":"boolean | undefined"},{"name":"hideLicenseWatermark","description":"Hides the license watermark.","type":"boolean | undefined"},{"name":"hideLoaderAnimation","description":"Hides the loader animation (curtain and spinner), showed by default at every update.","type":"boolean"},{"name":"hideUIMessages","description":"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).","type":"boolean"},{"name":"hideZeroCountCategories","description":"Whether to keep missing categories from a count aggregation as gaps in the chart's data.\n\nWhen data is retrieved from the server, the server excludes all features having a count of 0 from the response; hence resulting in missing entries on the charts.\n\nWhen this property is set to `true`, the dataset will keep these gaps instead of filling them with 0s.\n\nWhen left to `false`,  the chart's dataItems associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","type":"boolean"},{"name":"ignoreSmoothRenderingLimit","description":"When `true`, disables the default setting that uses debounce functions to handle the visibility of markers\nthat are outside of the plotting area when the min/max bound changes and/or when a zoom action is performed\n(via chart cursor or scrollbar), to increase performance.\n\nThis property will be set when the chart is created and cannot be updated after that.\nIt's recommended that this property should only be set to `true` for small datasets.\nWhen left `undefined`, will be treated as `false`.\n\n**Note**: Applicable to line charts only.","type":"boolean"},{"name":"ignoreViewExtent","description":"This property will be effective when the component's `view` is provided or when the `layer` is set to a FeatureLayerView.\n\nBy default the queries made by the chart will consider the view's extent as the unique geometry filter applicable. This implies ignoring any\ngeometry passed through the model (`component.model.dataFilters`) or the runtime filters (`component.runtimeDataFilters`).\n\nSetting this property to `false` signals the queries to ignore the view's extent, whether an additional geometry filter is provided or not.","type":"boolean"},{"name":"interactionsDisabled","description":"Disables all interactions on the chart.","type":"boolean"},{"name":"layer","description":"Used to perform queries.\nIf the layer is a `FeatureLayerView` or if the layer and the `view` property are both provided, the queries will be executed client-side.","type":"FeatureLayerView | SupportedLayer | SupportedRasterLayer | undefined"},{"name":"layerFieldsChangePolicy","description":"Allows the chart to update automatically when the layer's `fields` property changes.","type":"LayerFieldsChangePolicy"},{"name":"layerFilterChangePolicy","description":"Whether the chart should be refreshed when the layer's filter (`definitionExpression`) changes.","type":"LayerFilterChangePolicy"},{"name":"layerItemId","description":"Layer item ID associated with the chart to be rendered. Can be used in conjunction with the `chartIndex` property.\n\nIf `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.\n\nSupported layers include: `FeatureLayer`, `SubtypeSublayer`, `ImageryLayer`, `ImageryTileLayer` and `WCSLayer`.","type":"string | undefined"},{"name":"layerRendererChangePolicy","description":"Allows the chart to update automatically when the layer's renderer changes. Applies when the color match is enabled.\n\n**Note**: If the property is set to `ignore` the chart will still use the layer's renderer information when the data is updated.","type":"LayerRendererChangePolicy"},{"name":"legendPosition","description":"Sets the legend's position on the chart.\n\n**Note**: Not applicable to gauges.","type":"WebChartLegendPositions | undefined"},{"name":"legendValueLabelFormatter","description":"A callback function used to format the legend value labels. If the returned string contains HTML tags they will be interpreted as such.\nIf provided, the formatter will be used if at least [displayNumericValue](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChartPieChartLegend-displayNumericValue) or [displayPercentage](https://developers.arcgis.com/javascript/latest/references/charts-components/spec/web-chart/#WebChartPieChartLegend-displayPercentage) is `true`.\n\n**Note**: Applicable to pie charts only.","type":"PieChartLegendValueLabelFormatCallback | undefined"},{"name":"legendVisibility","description":"When `true`, the legend is visible on the chart.\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"loaderColors","description":"Defines the colors for the loader animation.","type":"LoaderColors | undefined"},{"name":"messageOverrides","description":"Custom message overrides for the chart's strings.","type":"Record<string, unknown> | undefined"},{"name":"model","description":"Provides an API to interact with the chart's configuration.\n\n**Note**: This property has a union type of `ChartModel | WebChart` meaning a raw chart configuration object can be passed to it instead, however it is recommended to use the `ChartModel` instance whenever possible.","type":"ChartModel | WebChart | undefined"},{"name":"nullAsValid","description":"Whether to consider a `null` statistic as valid. If set to `false` and the data has only null values, the chart's dataset will be considered empty:\n- The corresponding warning event will be sent\n- The \"no data\" message will be displayed (unless `hideUIMessages` is set to `true` or `showUIMessages` is set to `false`)","type":"boolean"},{"name":"placeholder","description":"A placeholder string to provides a brief hint to the user indicating needed information for creating a chart.","type":"string | undefined"},{"name":"popupTemplateFieldInfosEnabled","description":"Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).","type":"boolean | undefined"},{"name":"queueChartCreation","description":"Builds charts sequentially instead of rendering them all at once.","type":"boolean | undefined"},{"name":"replaceNoValueCategoryWithZero","description":"When `true`, the chart's `dataItems` associated with empty (no value) categories (from only a `Count` aggregation)\nwill be populated with 0s.","type":"boolean | undefined"},{"name":"returnFeaturesExtent","description":"When `true`, the features extent will be returned through the [@arcgisDataProcessComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisDataProcessComplete) and [@arcgisSelectionComplete](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#event-arcgisSelectionComplete) events payload.\nApplies only to:\n- Charts using an aggregation.\n- Data source using a feature layer compatible with envelope aggregation.\n\nThe extent (IExtent) is returned through the property [featuresExtentField](https://developers.arcgis.com/javascript/latest/references/charts-components/utils/defaults/index/#featuresExtentField).\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"returnSelectionIndexes","description":"When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"returnSelectionOIDs","description":"When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.\nOnly considered for a data source using a feature layer.\n\n**Note**: Not applicable to gauges or charts configured with imagery layers. It's always `false` for imagery layers. No object ids will be computed.","type":"boolean | undefined"},{"name":"rotated","description":"When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","type":"boolean"},{"name":"rotation","description":"When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.\n\n**Note**: Applicable to bar chart, line chart, combo bar line chart and box plot.","type":"boolean"},{"name":"runtimeDataFilters","description":"Applies runtime data filters to the chart.","type":"WebChartDataFilters | undefined"},{"name":"secondaryYAxisLabelFormatter","description":"Callback function used to format the secondary y-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Appliable to bar charts, line charts, combo bar line charts with dual axes.","type":"AxisLabelFormatCallback | undefined"},{"name":"selectionData","description":"When this property is set, it will apply a selection on the chart matching the provided selection.\n\n**Note**: Not applicable to gauges.","type":"SelectionData | undefined"},{"name":"selectionManager","description":"Selection manager object used to synchronize the selections with the chart when [syncViewSelection](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#syncViewSelection) is `true`.\nIt has precedence over the layer view's [SelectionManager](/references/core/views/SelectionManager/) when both are available.","type":"SelectionManager | undefined"},{"name":"selectionTheme","description":"Used to provide a customized theme for the selected and non selected elements.\n- If no style is provided for the selected elements, a default selection is applied.\n- If no style is provided for the non selected elements, the chart's style is applied.\n\n**Note**: Not applicable to gauges.","type":"SelectionTheme | undefined"},{"name":"setTimeBinningInfoWhenNotProvided","description":"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.\n\n**Note**: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar line chart, radar chart).","type":"boolean"},{"name":"showEmptySeries","description":"Show the series on the chart even if it doesn't have data (i.e. empty)\n\nWhen `false`, the empty series are completely hidden from the chart and the legend.\nFor example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by view extent).\n\n**Note**: Not applicable to gauges.","type":"boolean"},{"name":"showLicenseWatermark","description":"Shows the license watermark.","type":"boolean"},{"name":"showUIMessages","description":"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).","type":"boolean | undefined"},{"name":"skipChartCreationQueue","description":"Whether to skip the chart rendering queue.\n\nWhen `true`, charts will render immediately without waiting for other charts to finish rendering.\nWhen `false` (default), charts are queued so that only one chart renders at a time.","type":"boolean"},{"name":"syncChartsSelection","description":"Whether to synchronize the selection between chart components from the same layer.","type":"boolean"},{"name":"syncSelection","description":"Whether to synchronize the selection between chart components from the same layer.","type":"boolean"},{"name":"syncSelectionsBetweenChartAndLayerViewPolicy","description":"Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","type":"SyncSelectionsBetweenChartAndLayerViewPolicy"},{"name":"syncViewSelection","description":"Determines whether the chart's selection should be synchronized with either the chart's [selectionManager](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#selectionManager) or the layer view's.","type":"boolean"},{"name":"syncViewTimeExtent","description":"Whether the chart should be refreshed when the view's time extent changes.\n\n**Note**: Not supported for histogram.","type":"boolean"},{"name":"syncViewTimeZone","description":"Whether the chart's data should be in sync with the view's [timeZone](/references/core/views/MapView/#timeZone).\n\n**Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the\ncapacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the value of this property.","type":"boolean"},{"name":"syncViewTimeZoneInclusionList","description":"List of chart types to include from syncing the view's [`timeZone`](/references/core/views/MapView/#timeZone) with the data. Currently heat charts are included by default.\n\n**Note**: This applies only to charts supporting temporal data. Additionally if the data is binned, it applies only if the layer has the\ncapacity to handle the `/queryBins` operation. For any other case the chart will ignore the view's time zone regardless of the content of this list.","type":"(typeof WebChartTypes.BarSeries | typeof WebChartTypes.ComboLineAndBarSeries | typeof WebChartTypes.HeatSeries | typeof WebChartTypes.LineSeries | typeof WebChartTypes.RadarSeries)[]"},{"name":"timeZone","description":"Used to set a custom time zone for the chart.","type":"MapView[\"timeZone\"] | undefined"},{"name":"togglingLegendItemsDisabled","description":"Disables the toggling of series via the legend items.\n\n**Note**: Only applicable to multi-series charts.","type":"boolean | undefined"},{"name":"tooltipFormatter","description":"Callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.","type":"ChartOptions[\"tooltipFormatter\"] | undefined"},{"name":"updateSplitBySeries","description":"Whether to update the series when the data updates while the chart uses a split-by field configuration.\n\nIf `addMissingSeries` is set to `true` the missing series will be added to cover the split-by values not referenced by the model.\nThe default information from the property `updateSplitBySeries.seriesTemplate` will be applied to the new series.\n\n**Note**: Applicable only to bar chart, line chart and box plot when a split-by field is used.","type":"MissingSplitBySeriesProps | undefined"},{"name":"useAnimatedCharts","description":"Enable animation on the chart.","type":"boolean"},{"name":"usePopupTemplateFieldsInfo","description":"Allows the use of the fields alias from the `layer.popupTemplate` when rendering the field names on the chart (e.g. tooltips, axes, legend).","type":"boolean"},{"name":"view","description":"Used to access the feature layer view instance in order to perform client side queries.","type":"MapView | SceneView | undefined"},{"name":"viewTimeExtentChangePolicy","description":"Whether the chart should be refreshed when the view's time extent changes.","type":"ViewTimeExtentChangePolicy"},{"name":"xAxisLabelFormatter","description":"Callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie charts.","type":"AxisLabelFormatCallback | undefined"},{"name":"yAxisLabelFormatter","description":"Callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.\n\n**Note**: Not applicable to pie charts or gauges.","type":"AxisLabelFormatCallback | undefined"}],"events":[{"name":"arcgisAxesMinMaxChange","type":"AxesMinMaxChangePayload","description":"Event triggered once the chart axes min/max values are computed."},{"name":"arcgisBadDataWarningRaise","type":"DataWarningObject","description":"Event triggered when an error is detected with the data set."},{"name":"arcgisChartNotFoundWarning","type":"string","description":"Event triggered when the chart is not found for the given [chartIndex](https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-chart/#chartIndex) property."},{"name":"arcgisConfigChange","type":"{\n    newConfig: WebChart | undefined;\n    oldConfig: WebChart | undefined;\n    functionCalled: string | undefined;\n}","description":"Event triggered when the chart config is changed."},{"name":"arcgisDataFetchComplete","type":"WebChartDataTypes","description":"Event triggered once the chart data has been fetched but not yet fully processed.\n\nFor instance it can be useful to see all the slices before they get grouped into an 'other' slice during the post-processing step.\n\n**Note**: Applicable to pie charts only."},{"name":"arcgisDataProcessComplete","type":"DataProcessCompletePayload","description":"Event triggered once the chart data has been processed."},{"name":"arcgisDataProcessError","type":"void","description":"Event triggered when an error occurred while fetching of processing the data for the chart."},{"name":"arcgisInvalidConfigWarningRaise","type":"DataWarningObject","description":"Event triggered when an invalid configuration is detected."},{"name":"arcgisLegendItemVisibilityChange","type":"LegendItemVisibilityChangePayload","description":"Event triggered once a legend item visibility has been changed."},{"name":"arcgisNoRenderPropChange","type":"NoRenderPropChangePayload","description":"Event triggered when a no-render prop is changed."},{"name":"arcgisRenderingComplete","type":"void","description":"Event triggered once the chart rendering is complete."},{"name":"arcgisRuntimeError","type":"void","description":"Event triggered when an error occurred that prevents the chart from being created or updated."},{"name":"arcgisSelectionComplete","type":"SelectionCompletePayload","description":"Event triggered when a selection is applied to the chart."},{"name":"arcgisSeriesColorChange","type":"SeriesColorChangePayload","description":"Event triggered once the chart series color have been assigned."},{"name":"arcgisSeriesOrder","type":"string[]","description":"Event carrying the series id as they have been sorted following the `orderOptions` instructions."},{"name":"arcgisUpdateComplete","type":"ValidationStatus","description":"Event triggered once the chart is updated."}]}},{"name":"arcgis-charts-action-bar","description":"The Charts Action Bar component provides context-specific actions such as rotation, zooming, and filtering, as well as general actions like exporting the chart as an image or CSV file.\nThis component is designed to be used with a chart component and is not intended for standalone use.\n--\n\n### Events\n- **arcgisActionBarToggle** - Event triggered once action bar expand is toggled.\n- **arcgisDefaultActionSelect** - Event triggered once a default action is selected.\n\n### Methods\n- `componentOnReady(): Promise<this>` - Creates a promise that resolves once the component is fully loaded.\n\n### Slots\n- **custom-action-top** - A slot for adding custom `calcite-action` to the top of the default actions.\n- **custom-action-below** - A slot for adding custom `calcite-action` to the bottom of the default actions.","doc-url":"https://developers.arcgis.com/javascript/latest/references/charts-components/components/arcgis-charts-action-bar/","attributes":[{"name":"action-bar-selection-mode","description":"Defines which selection mode the slotted action bar should use.\n- `monoSelection`: Select a single data point/series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points/series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points/series while holding the Ctrl key (Cmd key on Mac), new selection adds to the previous one.","default":"\"multiSelectionWithCtrlKey\"","value":{"type":["\"monoSelection\"","\"multiSelection\"","\"multiSelectionWithCtrlKey\""]}},{"name":"chart-type","description":"Chart type used to determine which default actions to display.","value":{"type":["\"scatterSeries\"","\"pieSeries\"","\"gaugeSeries\"","\"lineSeries\"","\"barSeries\"","\"histogramSeries\"","\"boxPlotSeries\"","\"radarSeries\"","\"comboLineAndBarSeries\"","\"heatSeries\""]}},{"name":"clear-selection-state","description":"When `disabled`, interaction with the clear selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"clear-selection-title","description":"Custom title for the clear selection action.","value":{"type":"string"}},{"name":"clear-selection-toggle","description":"When `active`, the clear selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"edit-chart-state","description":"When `disabled`, interaction with the edit chart action is prevented and the component is displayed with lower opacity.","default":"\"disabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"edit-chart-title","description":"Custom title for the edit chart action.","value":{"type":"string"}},{"name":"edit-chart-toggle","description":"When `active`, the edit chart action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"expanded","description":"When `true`, the action bar is expanded.","default":"false","value":{"type":"boolean"}},{"name":"export-action-state","description":"When `disabled`, interaction with the export action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"export-as-csv-state","description":"When `disabled`, interaction with the download CSV is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"export-as-csv-title","description":"Custom title for the download CSV action.","value":{"type":"string"}},{"name":"export-as-image-state","description":"When `disabled`, interaction with the download image is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"export-as-image-title","description":"Custom title for the download chart action.","value":{"type":"string"}},{"name":"filter-by-extent-state","description":"When `disabled`, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"filter-by-extent-title","description":"Custom title for the filter by extent action.","value":{"type":"string"}},{"name":"filter-by-extent-toggle","description":"When `active`, the filter by extent action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"filter-by-selection-state","description":"When `disabled`, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"filter-by-selection-title","description":"Custom title for the filter by selection action.","value":{"type":"string"}},{"name":"filter-by-selection-toggle","description":"When `active`, the filter by selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"force-disable-actions","description":"When `true`, overrides the individual settings for each action to instead force disable them all.","default":"false","value":{"type":"boolean"}},{"name":"full-extent-state","description":"When `disabled`, interaction with the full extent action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"full-extent-title","description":"Custom title for the full extent action.","value":{"type":"string"}},{"name":"full-extent-toggle","description":"When `active`, the full extent action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"legend-state","description":"When `disabled`, interaction with the legend action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"legend-title","description":"Custom title for the legend action.","value":{"type":"string"}},{"name":"legend-toggle","description":"When `active`, the legend action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"rotate-chart-state","description":"When `disabled`, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"rotate-chart-title","description":"Custom title for the rotate chart action.","value":{"type":"string"}},{"name":"rotate-chart-toggle","description":"When `active`, the rotate chart action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"selection-state","description":"When `disabled`, interaction with the selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"selection-title","description":"Custom title for the selection action.","value":{"type":"string"}},{"name":"selection-toggle","description":"When `active`, the selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"switch-selection-state","description":"When `disabled`, interaction with the switch selection action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"switch-selection-title","description":"Custom title for the switch selection action.","value":{"type":"string"}},{"name":"switch-selection-toggle","description":"When `active`, the switch selection action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}},{"name":"zoom-state","description":"When `disabled`, interaction with the zoom action is prevented and the component is displayed with lower opacity.","default":"\"enabled\"","value":{"type":["\"disabled\"","\"enabled\""]}},{"name":"zoom-title","description":"Custom title for the zoom action.","value":{"type":"string"}},{"name":"zoom-toggle","description":"When `active`, the zoom action is highlighted.","default":"\"inactive\"","value":{"type":["\"active\"","\"inactive\""]}}],"slots":[{"name":"custom-action-top","description":"A slot for adding custom `calcite-action` to the top of the default actions."},{"name":"custom-action-below","description":"A slot for adding custom `calcite-action` to the bottom of the default actions."}],"events":[{"name":"arcgisActionBarToggle","type":"boolean","description":"Event triggered once action bar expand is toggled."},{"name":"arcgisDefaultActionSelect","type":"DefaultActionSelectPayload","description":"Event triggered once a default action is selected."}],"js":{"properties":[{"name":"actionBarSelectionMode","description":"Defines which selection mode the slotted action bar should use.\n- `monoSelection`: Select a single data point/series, new selection replaces the previous one.\n- `multiSelection`: Select multiple data points/series, new selection adds to the previous one.\n- `multiSelectionWithCtrlKey`: Select multiple data points/series while holding the Ctrl key (Cmd key on Mac), new selection adds to the previous one.","type":"Extract<ActionModes, \"monoSelection\" | \"multiSelection\" | \"multiSelectionWithCtrlKey\"> | undefined"},{"name":"chartElement","description":"Chart element reference with which the action bar is associated.","type":"ArcgisChart | undefined"},{"name":"chartType","description":"Chart type used to determine which default actions to display.","type":"ChartTypes | undefined"},{"name":"clearSelectionState","description":"When `disabled`, interaction with the clear selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"clearSelectionTitle","description":"Custom title for the clear selection action.","type":"string | undefined"},{"name":"clearSelectionToggle","description":"When `active`, the clear selection action is highlighted.","type":"ActionToggle"},{"name":"csvExportExclusionList","description":"The CSV export action is disabled for certain chart types.\n\nModify this property to add or remove chart types from the list of disabled types.","type":"WebChartTypes[]"},{"name":"disableCSVExportForChartTypes","description":"The CSV export action is disabled for certain chart types.\n\nModify this property to add or remove chart types from the list of disabled types.","type":"WebChartTypes[]"},{"name":"editChartState","description":"When `disabled`, interaction with the edit chart action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"editChartTitle","description":"Custom title for the edit chart action.","type":"string | undefined"},{"name":"editChartToggle","description":"When `active`, the edit chart action is highlighted.","type":"ActionToggle"},{"name":"expanded","description":"When `true`, the action bar is expanded.","type":"boolean"},{"name":"exportActionState","description":"When `disabled`, interaction with the export action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"exportAsCSVState","description":"When `disabled`, interaction with the download CSV is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"exportAsCSVTitle","description":"Custom title for the download CSV action.","type":"string | undefined"},{"name":"exportAsImageState","description":"When `disabled`, interaction with the download image is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"exportAsImageTitle","description":"Custom title for the download chart action.","type":"string | undefined"},{"name":"filterByExtentState","description":"When `disabled`, interaction with the filter by extent action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"filterByExtentTitle","description":"Custom title for the filter by extent action.","type":"string | undefined"},{"name":"filterByExtentToggle","description":"When `active`, the filter by extent action is highlighted.","type":"ActionToggle"},{"name":"filterBySelectionState","description":"When `disabled`, interaction with the filter by selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"filterBySelectionTitle","description":"Custom title for the filter by selection action.","type":"string | undefined"},{"name":"filterBySelectionToggle","description":"When `active`, the filter by selection action is highlighted.","type":"ActionToggle"},{"name":"forceDisableActions","description":"When `true`, overrides the individual settings for each action to instead force disable them all.","type":"boolean"},{"name":"fullExtentState","description":"When `disabled`, interaction with the full extent action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"fullExtentTitle","description":"Custom title for the full extent action.","type":"string | undefined"},{"name":"fullExtentToggle","description":"When `active`, the full extent action is highlighted.","type":"ActionToggle"},{"name":"hiddenActions","description":"Holds a list of actions to hide from the action bar.\n\n**Note:** The edit chart action is hidden by default. To show it, remove its value from this array.","type":"DefaultChartActions[]"},{"name":"legendState","description":"When `disabled`, interaction with the legend action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"legendTitle","description":"Custom title for the legend action.","type":"string | undefined"},{"name":"legendToggle","description":"When `active`, the legend action is highlighted.","type":"ActionToggle"},{"name":"messageOverrides","description":"Overwrite localized strings for this component.","type":"Record<string, unknown> | undefined"},{"name":"rotateChartState","description":"When `disabled`, interaction with the rotate chart action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"rotateChartTitle","description":"Custom title for the rotate chart action.","type":"string | undefined"},{"name":"rotateChartToggle","description":"When `active`, the rotate chart action is highlighted.","type":"ActionToggle"},{"name":"selectionState","description":"When `disabled`, interaction with the selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"selectionTitle","description":"Custom title for the selection action.","type":"string | undefined"},{"name":"selectionToggle","description":"When `active`, the selection action is highlighted.","type":"ActionToggle"},{"name":"switchSelectionState","description":"When `disabled`, interaction with the switch selection action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"switchSelectionTitle","description":"Custom title for the switch selection action.","type":"string | undefined"},{"name":"switchSelectionToggle","description":"When `active`, the switch selection action is highlighted.","type":"ActionToggle"},{"name":"zoomState","description":"When `disabled`, interaction with the zoom action is prevented and the component is displayed with lower opacity.","type":"ActionState"},{"name":"zoomTitle","description":"Custom title for the zoom action.","type":"string | undefined"},{"name":"zoomToggle","description":"When `active`, the zoom action is highlighted.","type":"ActionToggle"}],"events":[{"name":"arcgisActionBarToggle","type":"boolean","description":"Event triggered once action bar expand is toggled."},{"name":"arcgisDefaultActionSelect","type":"DefaultActionSelectPayload","description":"Event triggered once a default action is selected."}]}}]},"css":{"properties":[],"pseudo-elements":[]}}}

package/dist/json-schema/index.d.ts

@@ -528,6 +528,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         ILocation: {
@@ -575,6 +576,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         Position: {
@@ -735,6 +737,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IPolygonWithCurves: {
@@ -762,6 +765,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         ElipticArc: {
@@ -4045,6 +4049,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IWCSLayer: {
@@ -4122,6 +4127,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IExclusionArea: {
@@ -4658,6 +4664,7 @@
                 };
             };
             required: string[];
+            description: string;
             title: string;
         };
         IGeoRssLayer: {
@@ -8734,11 +8741,11 @@
             description: string;
             title: string;
         };
-        "Omit<(structure-1066060463-59783-61526-1066060463-59708-61527-1066060463-55813-61529-1066060463-0-64582|undefined)937098756,(\"data\"|\"orderByFields\")>": {
+        "Omit<(structure-1066060463-59771-61514-1066060463-59696-61515-1066060463-55801-61517-1066060463-0-64570|undefined)937098756,(\"data\"|\"orderByFields\")>": {
             $ref: string;
             title: string;
         };
-        "Pick<(structure-1066060463-59783-61526-1066060463-59708-61527-1066060463-55813-61529-1066060463-0-64582|undefined)937098756,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
+        "Pick<(structure-1066060463-59771-61514-1066060463-59696-61515-1066060463-55801-61517-1066060463-0-64570|undefined)937098756,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
             type: string;
             properties: {
                 series: {

package/dist/model/interfaces/common.d.ts

@@ -163,11 +163,9 @@ export const ModelTypes: {
 
 export type ModelTypes = (typeof ModelTypes)[keyof typeof ModelTypes];
 
-/** @internal */
 export type ModelTypeToSeriesType<T extends ModelTypes> = T extends typeof ModelTypes.BarChart ? WebChartBarChartSeries : T extends typeof ModelTypes.LineChart ? WebChartLineChartSeries : T extends typeof ModelTypes.ComboBarLineChart ? WebChartBarChartSeries | WebChartLineChartSeries : T extends typeof ModelTypes.BoxPlot ? WebChartBoxPlotSeries | WebChartLineChartSeries : T extends typeof ModelTypes.PieChart ? WebChartPieChartSeries : T extends typeof ModelTypes.Scatterplot ? WebChartScatterplotSeries : T extends typeof ModelTypes.Histogram ? WebChartHistogramSeries : T extends typeof ModelTypes.Gauge ? WebChartGaugeSeries : T extends typeof ModelTypes.RadarChart ? WebChartRadarChartSeries : T extends typeof ModelTypes.HeatChart ? WebChartHeatChartSeries : SupportedChartSeries;
 
 /** @internal */
 export type SeriesTypeToChartType<T extends SupportedChartSeries> = T extends WebChartBarChartSeries ? typeof WebChartTypes.BarSeries : T extends WebChartLineChartSeries ? typeof WebChartTypes.LineSeries : T extends WebChartBoxPlotSeries ? typeof WebChartTypes.BoxPlotSeries : T extends WebChartPieChartSeries ? typeof WebChartTypes.PieSeries : T extends WebChartScatterplotSeries ? typeof WebChartTypes.ScatterSeries : T extends WebChartHistogramSeries ? typeof WebChartTypes.HistogramSeries : T extends WebChartGaugeSeries ? typeof WebChartTypes.GaugeSeries : T extends WebChartRadarChartSeries ? typeof WebChartTypes.RadarSeries : T extends WebChartHeatChartSeries ? typeof WebChartTypes.HeatSeries : never;
 
-/** @internal */
 export type ModelOfType<T> = T extends typeof ModelTypes.BarChart ? BarChartModel : T extends typeof ModelTypes.BoxPlot ? BoxPlotModel : T extends typeof ModelTypes.LineChart ? LineChartModel : T extends typeof ModelTypes.ComboBarLineChart ? ComboBarLineChartModel : T extends typeof ModelTypes.PieChart ? PieChartModel : T extends typeof ModelTypes.Scatterplot ? ScatterplotModel : T extends typeof ModelTypes.Histogram ? HistogramModel : T extends typeof ModelTypes.Gauge ? GaugeModel : T extends typeof ModelTypes.RadarChart ? RadarChartModel : T extends typeof ModelTypes.HeatChart ? HeatChartModel : never;

package/dist/spec/rest-js-types.d.ts

@@ -71,7 +71,16 @@ export interface IGeometry {
   spatialReference?: ISpatialReference;
 }
 
-/** @internal */
+/**
+ * A simple point geometry, with spatial reference defined.
+ *
+ * `IPoint` can also be imported from the following packages:
+ *
+ * ```js
+ * import { IPoint } from "@esri/arcgis-rest-routing";
+ * import { IPoint } from "@esri/arcgis-rest-geocoding";
+ * ```
+ */
 export interface IPoint extends IHasZM, IGeometry {
   x: number;
   y: number;
@@ -90,7 +99,7 @@ export interface ILocation {
   z?: number;
 }
 
-/** @internal */
+/** Polyline geometry. */
 export interface IPolyline extends IHasZM, IGeometry {
   paths: Position[][];
 }
@@ -103,12 +112,12 @@ export interface IPolylineWithCurves extends IHasZM, IGeometry {
   curvePaths: (JsonCurve | Position)[][];
 }
 
-/** @internal */
+/** Polygon geometry. */
 export interface IPolygon extends IHasZM, IGeometry {
   rings: Position[][];
 }
 
-/** @internal */
+/** Polygon geometry with curves. */
 export interface IPolygonWithCurves extends IHasZM, IGeometry {
   curveRings: (JsonCurve | Position)[][];
 }
@@ -1367,7 +1376,6 @@ export interface IBingLayer extends ILayer {
   portalUrl?: string;
 }
 
-/** @internal */
 export interface IImageServiceLayer extends ILayer, ISupportsTime {
   /** An array of bandIds that are visible, can specify bands to export or rearrange band order(from image service). */
   bandIds?: number[];
@@ -1748,7 +1756,7 @@ export interface IOpenStreetMapLayer extends ILayer {
   type?: "OpenStreetMap";
 }
 
-/** @internal */
+/** Tiled image service layer definition. */
 export interface ITiledImageServiceLayer extends ILayer {
   /** Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
   isReference?: boolean;
@@ -1758,7 +1766,7 @@ export interface ITiledImageServiceLayer extends ILayer {
   refreshInterval?: number;
 }
 
-/** @internal */
+/** Web Coverage Service (WCS) layer definition. */
 export interface IWCSLayer extends ILayer {
   /** Applicable if used as a baseMapLayer. A boolean value indicating whether or not the baseMapLayer draws on top (true) of other layers, including operationalLayers , or below (false). */
   isReference?: boolean;
@@ -1935,7 +1943,13 @@ export interface ICsvLayer extends ILayer {
   type?: "CSV";
 }
 
-/** @internal */
+/**
+ * Feature layers can be created by referencing a layer from either a map service or a feature service or by specifying a feature collection object.
+ * Use a map service if you just want to retrieve geometries and attributes from the server and symbolize them yourself. Use a feature service if
+ * you want to take advantage of symbols from the service's source map document. Also, use a feature service if you plan on doing editing with the
+ * feature layer. Feature layers honor any feature templates configured in the source map document. Feature collection objects are used to create
+ * a feature layer based on the supplied definition.
+ */
 export interface IFeatureLayer extends ILayer, ISupportsTime {
   /** A comma-separated string listing which editing operations are allowed on an editable feature service. */
   capabilities?: string;