@arcgis/charts-components 5.0.0-next.126 → 5.0.0-next.128

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

@@ -53,10 +53,21 @@ export declare class ArcgisChart extends LitElement {
      */
     enableConfiguration: boolean;
     /**
-     * Whether to disable the auto-theming of the chart based on the Calcite themes. Currently only the dark theme is supported.
-     * By default the chart component will apply the Calcite theme if detected on its container or on a parent element.
+     * Whether to disable automatic chart theming based on Calcite theme detection.
+     *
+     * **Note**: Currently, only the `calcite-mode-dark` theme is supported. When this theme
+     * is applied, all chart colors are automatically adjusted for dark mode and
+     * any custom chart colors will be overridden. This includes series, axes, grid and other elements.
+     *
+     * When `true`, the chart component will not apply any Calcite-based theming,
+     * even if a supported Calcite theme is detected.
+     *
+     * When `false` (default), the chart component will automatically apply the
+     * supported Calcite theme if it is detected on the chart container or any
+     * parent element.
      *
      * @default false
+     * @since 5.0
      */
     disableAutoTheming: boolean;
     /**
@@ -248,10 +259,10 @@ export declare class ArcgisChart extends LitElement {
     /**
      * When `true`, the features extent will be returned through the `arcgisDataProcessComplete` and `arcgisSelectionComplete` events payload.
      * Applies only to:
-     * - Charts using an aggregation
-     * - Data source using a feature layer compatible with envelope aggregation
+     * - Charts using an aggregation.
+     * - Data source using a feature layer compatible with envelope aggregation.
      *
-     * The extent (IExtent) is returned through a property called `arcgis_charts_features_extent`.
+     * The extent (`IExtent`) is returned through a property called `arcgis_charts_features_extent`.
      *
      * **Note**: Not applicable to gauge.
      *
@@ -281,13 +292,13 @@ export declare class ArcgisChart extends LitElement {
     get disableInteractions(): boolean;
     set disableInteractions(value: boolean | undefined);
     /**
-     * Builds the charts one by one rather than all at the same time.
+     * Builds charts sequentially instead of rendering them all at once
      *
      * @default false
      */
     queueChartCreation?: boolean;
     /**
-     * Enables the animations on the chart.
+     * Enable animation on the chart.
      *
      * @default false
      */
@@ -366,7 +377,6 @@ export declare class ArcgisChart extends LitElement {
      */
     guideTooltipFormatter?: GuideTooltipFormatCallback;
     /**
-     * Indicates whether to show the ArcGIS charts notify panel. False by default
      * A callback function used to format the x-axis labels. If the returned string contains HTML tags they will be interpreted as such.
      *
      * **Note**: Not applicable to pie chart.
@@ -416,7 +426,7 @@ export declare class ArcgisChart extends LitElement {
     /** Applies runtime data filters to the chart. */
     runtimeDataFilters?: WebChartDataFilters;
     /**
-     * Allows the use of the fields alias from the layer.popupTemplate when rendering the field names on the chart (e.g. tooltips, axes, legend).
+     * 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
      */
@@ -437,6 +447,7 @@ export declare class ArcgisChart extends LitElement {
     viewTimeExtentChangePolicy: ViewTimeExtentChangePolicy;
     /**
      * 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.
@@ -478,10 +489,10 @@ export declare class ArcgisChart extends LitElement {
      * **Note**: Applicable only to bar chart, line chart and box plot when a split-by field is used.
      */
     updateSplitBySeries?: MissingSplitBySeriesProps;
-    /** Custom message overrides for the chart's strings.\ */
+    /** Custom message overrides for the chart's strings. */
     messageOverrides?: typeof this._messages._overrides & typeof this.commonStrings._overrides;
     /**
-     * If `true`, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.
+     * When `true`, the chart will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the chart to a different place on the page, or temporarily hide it.
      *
      * @default false
      */
@@ -508,6 +519,7 @@ export declare class ArcgisChart extends LitElement {
      * - `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
      * - Box plot
@@ -520,7 +532,8 @@ export declare class ArcgisChart extends LitElement {
      */
     exportAsCSV(options?: CSVOptions): Promise<void>;
     /**
-     * Exports the current chart as an image. The default format is PNG, with SVG and JPEG available as alternatives.
+     * Exports the current chart as an image. Default format is `png`.
+     * - Alternative formats supported are: `jpeg` and `svg`.
      *
      * @param format
      */
@@ -586,12 +599,7 @@ export declare class ArcgisChart extends LitElement {
     readonly arcgisDataProcessComplete: TargetedEvent<this, DataProcessCompletePayload>;
     /** Event triggered when an error occurred while fetching of processing the data for the chart. */
     readonly arcgisDataProcessError: TargetedEvent<this, void>;
-    /**
-     * Event triggered when an invalid configuration is detected.
-     *
-     * @type {EventEmitter<DataWarningObject>}
-     * @event
-     */
+    /** Event triggered when an invalid configuration is detected. */
     readonly arcgisInvalidConfigWarningRaise: TargetedEvent<this, DataWarningObject>;
     /** Event triggered once a legend item visibility has been changed. */
     readonly arcgisLegendItemVisibilityChange: TargetedEvent<this, LegendItemVisibilityChangePayload>;