@arcgis/charts-components 5.0.0-next.61 → 5.0.0-next.63

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

@@ -13,24 +13,23 @@ import { AxesMinMaxChangePayload, DataProcessCompletePayload, LegendItemVisibili
 import { MissingSplitBySeriesProps, DownloadableChartImagesTypes } from '../../utils/components/interfaces';
 
 /**
- * The ArcGIS 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.
+ * 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.
  *
  * Supported chart types include bar charts, box plots, line charts, combo bar-line charts, gauges, heat charts, histograms, pie charts, scatterplots, and radar charts.
  *
- * See also:
- * - [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
- * - [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)
- * - [Tutorial: Create a heat chart](https://developers.arcgis.com/javascript/latest/tutorials/create-a-heat-chart/)
- * - [Tutorial: Modify a chart](https://developers.arcgis.com/javascript/latest/tutorials/modify-a-chart/)
- *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/)
  *
  * @slot [action-bar] - Slot for adding a `charts-action-bar` component or `calcite-action-bar`.
+ * @see [Introduction to charts](https://developers.arcgis.com/javascript/latest/charts-components-intro/)
+ * @see [Tutorial: Display a chart](https://developers.arcgis.com/javascript/latest/tutorials/display-and-create-charts-components/)
+ * @see [Tutorial: Create a heat chart](https://developers.arcgis.com/javascript/latest/tutorials/create-a-heat-chart/)
+ * @see [Tutorial: Modify a chart](https://developers.arcgis.com/javascript/latest/tutorials/modify-a-chart/)
  * @since 4.32
  */
 export declare class ArcgisChart extends LitElement {
     /**
-     * Instance of an ArcGIS Chart Model. Provides an API to interact with the chart's configuration.
+     * Provides an API to interact with the chart's configuration.
+     *
      * **Note:** This property has a union type of `ChartModel | WebChart` meaning a raw chart config object can be passed to it instead, however it is recommended to use a `ChartModel` instance whenever possible.
      *
      * @default undefined
@@ -54,9 +53,10 @@ export declare class ArcgisChart extends LitElement {
      */
     syncSelection: boolean;
     /**
-     * Applicable to bar chart, line chart, combo bar-line and box plot.
      * When `true`, the chart is rotated 90 degrees so that the x-axis becomes vertical and the y-axis becomes horizontal.
      *
+     * **Note**: Applicable to bar chart, line chart, combo bar and line chart and box plot.
+     *
      * @deprecated since 5.0. Use charts model's [rotatedState](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#rotatedstate) prop instead.
      * @default undefined
      * @type {boolean | undefined}
@@ -65,35 +65,43 @@ export declare class ArcgisChart extends LitElement {
     get rotation(): boolean | undefined;
     set rotation(value: boolean | undefined);
     /**
-     * Not applicable to gauge.
-     * Defines the cursor behavior on the chart (zoom, selection...).
+     * Specifies the user action behavior for the chart.
      *
-     * @default undefined
+     * - `monoSelection`: Select a single data point or series, new selection replaces the previous one.
+     * - `multiSelection`: Select multiple data points or series, new selection adds to the previous one.
+     * - `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.
+     * - `none`: No action is performed on user interaction.
+     * - `zoom`: Zoom into a specific area of the chart.
+     *
+     * **Note**: Not applicable to gauge.
+     *
+     * @default multiSelectionWithCtrlKey
      * @type {ActionModes | undefined}
      * @category Public
      */
     actionMode?: ActionModes;
     /**
-     * Sets the cursor range:
-     * - CursorRange.MultiAxes: allows to draw a free rectangle
-     * - CursorRange.XAxis: allows to draw a rectangle bound to the x-axis
-     * - CursorRange.YAxis: allows to draw a rectangle bound to the y-axis
-     * - undefined: defaults to a preset behavior according to the chart type and action mode
+     * Sets the cursor range when `actionMode` is set to `zoom`, `multiSelection` or `multiSelectionWithCtrlKey`.
+     *
+     * - `multi-axes`: Allows to draw a free rectangle.
+     * - `x-axis`: Allows to draw a rectangle bound to the x-axis.
+     * - `y-axis`: Allows to draw a rectangle bound to the y-axis.
+     * - `undefined`: Defaults to the preset behavior according to the chart type and action mode.
+     *
+     * **Note**: Not applicable to gauge.
      *
      * @default undefined
-     * @remarks
-     * Not applicable to gauge.
-     * Applies only when the action mode is set to zoom or multi-selection.
      * @type {CursorRange | undefined}
      * @category Public
      */
     cursorRange?: CursorRange;
     /**
-     * Used to set the legend's position on the chart.
+     * Sets the legend's position on the chart.
+     *
+     * **Note**: Not applicable to gauge.
      *
      * @deprecated since 5.0. Use charts model's [legendPosition](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendPosition) prop instead.
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {WebChartLegendPositions | undefined}
      * @category Public
      */
@@ -102,16 +110,17 @@ export declare class ArcgisChart extends LitElement {
     /**
      * When `true`, the legend is visible on the chart.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @deprecated since 5.0. Use charts model's [legendVisibility](https://developers.arcgis.com/javascript/latest/charts-model/bar-chart-model/#legendVisibility) prop instead.
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      */
     get legendVisibility(): boolean | undefined;
     set legendVisibility(value: boolean | undefined);
     /**
-     * Whether to allow the object id to be used as a statistic other than COUNT.
+     * Whether to allow the object id to be used as a statistic other than `COUNT`.
      *
      * @default false
      * @type {boolean}
@@ -119,8 +128,7 @@ export declare class ArcgisChart extends LitElement {
      */
     allowUsingObjectIdStat: boolean;
     /**
-     * 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:
+     * 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:
      * - the corresponding warning event will be sent
      * - the "no data" message will be displayed (unless `showUIMesssages` is set to `false`)
      *
@@ -130,8 +138,7 @@ export declare class ArcgisChart extends LitElement {
      */
     nullAsValid: boolean;
     /**
-     * Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an
-     * axis when the data contains values <= 0).
+     * Whether to display or hide all UI messages (e.g. no data warnings, or when the logarithmic scale can't be applied to an axis when the data contains values <= 0).
      *
      * @default undefined
      * @type {boolean | undefined}
@@ -140,21 +147,22 @@ export declare class ArcgisChart extends LitElement {
     showUIMessages?: boolean;
     /**
      * When `true`, the empty series are completely hidden from the chart and the legend.
-     * For example a series can be empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).
+     * For example, a series may become empty after applying a data filter, filter by attribute or geometry (as when using the filter by extent).
+     *
+     * **Note**: Not applicable to gauge.
      *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      */
     hideEmptySeries?: boolean;
     /**
-     * When `true`, the data label text color is automatically inverted based on the data label background color.
-     * For example if the data label is dark, and it's on top of a dark color series area, the text color will eventually
-     * be set to either the chart's background color or white.
+     * When `true`, the data label text color is automatically adjusted for readability based on its background.
+     * If the label is dark and appears over a dark series area, the text color is switched to either the chart background color or white.
+     *
+     * **Note**: Only applicable to bar chart.
      *
      * @default undefined
-     * @remarks This feature is currently only available for bar chart.
      * @type {boolean | undefined}
      * @category Public
      */
@@ -176,8 +184,9 @@ export declare class ArcgisChart extends LitElement {
      * It's recommended that this property should only be set to true for small datasets.
      * When left `undefined`, will be treated as `false`.
      *
+     * **Note**: Applicable to line chart only.
+     *
      * @default undefined
-     * @remarks Applicable to line chart only.
      * @type {boolean | undefined}
      * @category Public
      */
@@ -186,19 +195,20 @@ export declare class ArcgisChart extends LitElement {
      * Lifecycle function executed after the data has been processed and before the chart renders.
      * Can be used to alter the config from information extracted from the data for instance.
      *
+     * **Note**: Applicable to gauge and pie chart only.
+     *
      * @default undefined
-     * @remarks Applicable to gauge and pie chart only.
      * @type {PreRenderCallback | undefined}
      * @category Public
      */
     chartWillRender?: PreRenderCallback;
     /**
-     * A callback function used to format the legend value labels. If the returned string contains HTML tags they will be
-     * interpreted as such.
+     * A callback function used to format the legend value labels. If the returned string contains HTML tags they will be interpreted as such.
      * If provided, the formatter will be used if at least `WebChartPieChartLegend.displayNumericValue` or `WebChartPieChartLegend.displayPercentage` is true.
      *
+     * **Note**: Applicable to pie chart only.
+     *
      * @default undefined
-     * @remarks Applicable to pie chart only.
      * @type {PieChartLegendValueLabelFormatCallback | undefined}
      * @category Public
      */
@@ -212,7 +222,7 @@ export declare class ArcgisChart extends LitElement {
      */
     timeZone?: MapView["timeZone"];
     /**
-     * Used to access the LayerView instance in order to perform client-side queries.
+     * Used to access the feature layer view instance in order to perform client side queries.
      *
      * @default undefined
      * @type {MapView | SceneView | undefined}
@@ -235,7 +245,10 @@ export declare class ArcgisChart extends LitElement {
      * If `layerItemId` is set without `chartIndex`, the first chart in the layer will be rendered.
      *
      * @default undefined
-     * @example <arcgis-chart layer-item-id="05e015c5f0314db9a487a9b46cb37eca" chart-index="2"></arcgis-chart>
+     * @example
+     * ```html
+     * <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2"></arcgis-chart>
+     * ```
      * @type {string | undefined}
      * @category Public
      */
@@ -248,7 +261,10 @@ export declare class ArcgisChart extends LitElement {
      * If the `chartIndex` is out of bounds, the first chart in the layer will be rendered and a warning event will be emitted.
      *
      * @default undefined
-     * @example <arcgis-chart layer-item-id="05e015c5f0314db9a487a9b46cb37eca" chart-index="2"></arcgis-chart>
+     * @example
+     * ```html
+     * <arcgis-chart layer-item-id="8871626e970a4f3e9d6113ec63a92f2f" chart-index="2"></arcgis-chart>
+     * ```
      * @type {number | undefined}
      * @category Public
      */
@@ -256,8 +272,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * When this property is set, it will apply a selection on the chart matching the provided selection.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {SelectionData | undefined}
      * @category Public
      */
@@ -266,8 +283,9 @@ export declare class ArcgisChart extends LitElement {
      * When `true`, the object ids will be computed whenever a selection is made on or passed to the chart.
      * Only considered for a data source using a feature layer.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      */
@@ -275,8 +293,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * When `true`, the selection indexes will be computed whenever a selection is made on or passed to the chart.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      */
@@ -288,23 +307,25 @@ export declare class ArcgisChart extends LitElement {
      * - data source using a feature layer compatible with envelope aggregation
      * The extent (IExtent) is returned through a property called `arcgis_charts_features_extent`.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      */
     returnFeaturesExtent?: boolean;
     /**
-     * When `true`, all chart elements are filtered based on selection.
+     * When `true`, all chart elements are filtered based on the selection.
+     *
+     * **Note**: Not applicable to gauge.
      *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {boolean | undefined}
      * @category Public
      */
     filterBySelection?: boolean;
     /**
-     * When `true`, all chart elements are filtered based on view extent.
+     * When `true`, all chart elements are filtered based on the view extent.
      *
      * @default undefined
      * @type {boolean | undefined}
@@ -354,21 +375,21 @@ export declare class ArcgisChart extends LitElement {
      */
     enableResponsiveFeatures?: boolean;
     /**
-     * Auto-disposes the chart when a new one is created in the same container.
+     * Auto disposes the chart when a new one is created in the same container.
      *
-     * @deprecated since 5.0. Use `autoDestroyDisabled` instead. Will be removed in 6.0.
+     * @deprecated since 5.0. Use [autoDestroyDisabled](https://developers.arcgis.com/javascript/latest/references/charts-components/arcgis-chart/#autoDestroyDisabled)instead.
      * @default undefined
      * @type {boolean | undefined}
      * @category Public
      */
     autoDisposeChart?: boolean;
     /**
-     * The index of the feature to be rendered.
-     * Only used when the gauge is a feature-based gauge.
+     * The index of the feature to render when using a feature based gauge.
+     *
+     * **Note**: Only applicable to gauge.
      *
      * @deprecated since 5.0. Use charts model's [featureIndex](https://developers.arcgis.com/javascript/latest/charts-model/gauge-model/#featureindex) prop instead.
      * @default undefined
-     * @remarks Applicable to gauge only.
      * @type {number | undefined}
      * @category Public
      */
@@ -387,8 +408,9 @@ export declare class ArcgisChart extends LitElement {
      * If no style is provided for the selected elements, a default selection is applied.
      * If no style is provided for the non selected elements, the chart's style is applied.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {SelectionTheme | undefined}
      * @category Public
      */
@@ -396,8 +418,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * When `true`, the series properties `unit` and `size` become optional and will be automatically set to values that fit the data set. Used when creating or updating a chart compatible with time binning.
      *
+     * **Note**: Only applicable to charts using the temporal binning feature (bar chart, line chart, combo bar and line chart, radar chart).
+     *
      * @default undefined
-     * @remarks Only applicable to charts using the temporal binning feature (bar and line chart).
      * @type {boolean | undefined}
      * @category Public
      */
@@ -407,8 +430,9 @@ export declare class ArcgisChart extends LitElement {
      * The chart's behavior once that limit is reached can be adjusted through the `behaviorAfterLimit` nested property, to either reject the creation
      * or update of the chart, or render the elements up to the given limits.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {ChartElementLimit | undefined}
      * @category Public
      */
@@ -416,8 +440,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * A callback function used to format the tooltips. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {BarAndLineTooltipFormatCallback | undefined}
      * @category Public
      */
@@ -425,8 +450,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * A callback function used to format the data labels. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * **Note**: Not applicable to gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to gauge.
      * @type {BarAndLineDataLabelFormatCallback | undefined}
      * @category Public
      */
@@ -434,8 +460,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * A callback function used to format the axes guides tooltip. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * **Note**: Not applicable to pie chart.
+     *
      * @default undefined
-     * @remarks Not applicable to pie chart.
      * @type {GuideTooltipFormatCallback | undefined}
      * @category Public
      */
@@ -444,8 +471,9 @@ export declare class ArcgisChart extends LitElement {
      * Indicates whether to show the ArcGIS charts notify panel. False by default
      * A callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * **Note**: Not applicable to pie chart.
+     *
      * @default undefined
-     * @remarks Not applicable to pie chart.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
      */
@@ -453,8 +481,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * A callback function used to format the y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      *
+     * **Note**: Not applicable to pie chart or gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to pie chart nor gauge.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
      */
@@ -463,18 +492,19 @@ export declare class ArcgisChart extends LitElement {
      * A callback function used to format the secondary y-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      * The property will be effective only if 3 axes are defined (dual axis chart).
      *
+     * **Note**: Not applicable to pie chart or gauge.
+     *
      * @default undefined
-     * @remarks Not applicable to pie chart nor gauge.
      * @type {AxisLabelFormatCallback | undefined}
      * @category Public
      */
     secondaryYAxisLabelFormatter?: AxisLabelFormatCallback;
     /**
-     * A callback function used to format the gauge inner label. If the returned string contains HTML tags they will be
-     * interpreted as such.
+     * A callback function used to format the gauge inner label. If the returned string contains HTML tags they will be interpreted as such.
+     *
+     * **Note**: Applicable to gauge only.
      *
      * @default undefined
-     * @remarks Applicable to gauge only.
      * @type {GaugeInnerLabelFormatCallback | undefined}
      * @category Public
      */
@@ -489,8 +519,9 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Disables the toggling of series via the legend items.
      *
+     * **Note**: Only applicable to multi-series charts.
+     *
      * @default undefined
-     * @remarks Only applicable to multi-series charts.
      * @type {boolean | undefined}
      * @category Public
      */
@@ -512,7 +543,7 @@ export declare class ArcgisChart extends LitElement {
      */
     loaderColors?: LoaderColors;
     /**
-     * Applies runtime data filters to the chart's.
+     * Applies runtime data filters to the chart.
      *
      * @default undefined
      * @type {WebChartDataFilters | undefined}
@@ -537,7 +568,8 @@ export declare class ArcgisChart extends LitElement {
     layerFilterChangePolicy: LayerFilterChangePolicy;
     /**
      * Whether the chart should be refreshed when the view's time extent changes.
-     * This is not currently supported on histogram. Setting the property to "refresh" won't have any effect on that chart.
+     *
+     * **Note**: Not supported for histogram.
      *
      * @default "ignore"
      * @type {ViewTimeExtentChangePolicy}
@@ -548,8 +580,9 @@ export declare class ArcgisChart extends LitElement {
      * Allows the chart to update automatically when the layer's renderer changes.
      * Applies when the color match feature is enabled.
      *
+     * **Note**: If the property is set to `ignore` the chart will use the layer's renderer information when the data is updated.
+     *
      * @default "refresh"
-     * @remarks Even though that property is set to Ignore the chart will use the layer's renderer information when the data is updated.
      * @type {LayerRendererChangePolicy}
      * @category Public
      */
@@ -584,12 +617,12 @@ export declare class ArcgisChart extends LitElement {
     ignoreViewExtent?: boolean;
     /**
      * Whether to update the series when the data updates while the chart uses a split-by field configuration.
-     * If `addMissingSeries` is set to `true` the missing series will be added to cover the split-by values not referenced
-     * by the config.
+     * If `addMissingSeries` is set to `true` the missing series will be added to cover the split-by values not referenced by the config.
      * The default information from the property `updateSplitBySeries.seriesTemplate` will be applied to the new series.
      *
+     * **Note**: Applicable only to bar chart, line chart and box plot when a split-by field is used.
+     *
      * @default undefined
-     * @remarks Only applicable to bar chart, line chart and box plot, when they use a split-by field.
      * @type {MissingSplitBySeriesProps | undefined}
      * @category Public
      */
@@ -609,7 +642,8 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Clears all selection on the chart.
      *
-     * @remarks Not applicable to gauge.
+     * **Note**: Not applicable to gauge.
+     *
      * @category Public
      */
     clearSelection(): Promise<void>;
@@ -624,29 +658,29 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Export the current chart's data as a CSV file.
      *
-     * @param options
-     * @param options The options to use when exporting the data.
-     *
-     * NOTE: This method won't work for scatterplot series. The support charts for this method are:
+     * The `Options` object can contain the following properties:
+     * - `columns`: An array of column to include in the CSV file.
+     * - `delimiter`: The delimiter to use in the CSV file. Default is `,`.
+     * - `includeHeader`: Whether to include the header row in the CSV file. Default is `true`.
+     * - `quoteAll`: Whether to quote all values in the CSV file. Default is `false`.
+     * - `locale`: The locale to use when formatting the CSV file. Default is `en`.
+     *    * * 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"
+     *
+     * **Note**: The chart types supported by this method are:
      * - Bar chart
-     * - Line chart
-     * - Combo bar-line chart
      * - Box plot
+     * - Combo bar and line chart
      * - Histogram
+     * - Line chart
      * - Pie chart
      *
-     * The `Options` object can contain the following properties:
-     * - `columns` - An array of column to include in the CSV file.
-     * - `delimiter` - The delimiter to use in the CSV file. Default is `,`.
-     * - `includeHeader` - Whether to include the header row in the CSV file. Default is `true`.
-     * - `quoteAll` - Whether to quote all values in the CSV file. Default is `false`.
-     * - `locale` - The locale to use when formatting the CSV file. Default is `en`.
-     * * * 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"
+     * @param options
+     * @param options The options to use when exporting the data.
      * @category Public
      */
     exportAsCSV(options?: CSVOptions): Promise<void>;
     /**
-     * Export the current chart as an image.
+     * Exports the current chart as an image. The default format is PNG, with SVG and JPEG available as alternatives.
      *
      * @default DownloadableChartImagesTypes.PNG
      * @param format
@@ -664,8 +698,7 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Notify method allows passing external messages to the chart component.
      * It can be used to pass validation or information messages.
-     * In a situation where a config update is overriding your notification modal,
-     * consider waiting for the `arcgisUpdateComplete` event.
+     * In a situation where a config update is overriding your notification modal, consider waiting for the `arcgisUpdateComplete` event.
      *
      * @param message
      * @param heading
@@ -691,14 +724,16 @@ export declare class ArcgisChart extends LitElement {
     /**
      * Resets the chart zoom to bring it back to full extent
      *
-     * @remarks Applicable to XY charts only.
+     * **Note**: Applicable to XY charts only.
+     *
      * @category Public
      */
     resetZoom(): Promise<void>;
     /**
      * Switches the selection on the chart.
      *
-     * @remarks Not applicable to gauge.
+     * **Note**: Not applicable to gauge.
+     *
      * @category Public
      */
     switchSelection(): Promise<void>;