@arcgis/charts-components 5.1.0-next.8 → 5.1.0-next.80

package/dist/interfaces.d.ts

@@ -1,13 +1,18 @@
 import type FeatureLayer from "@arcgis/core/layers/FeatureLayer.js";
 import type SubtypeSublayer from "@arcgis/core/layers/support/SubtypeSublayer.js";
+import type ImageryLayer from "@arcgis/core/layers/ImageryLayer.js";
+import type ImageryTileLayer from "@arcgis/core/layers/ImageryTileLayer.js";
 import type { EventEmitter } from "@arcgis/lumina";
 import type { SupportedLocale } from "@arcgis/toolkit/intl";
 import type { WebChartTemporalBinningUnits } from "./spec/chart-object-literals.js";
 import type { List as List } from "@esri/calcite-components/components/calcite-list";
 
-/** Supported layer type for ArcGIS charts. */
+/** Supported layer types for feature charts. */
 export type SupportedLayer = FeatureLayer | SubtypeSublayer;
 
+/** Supported layer types for imagery charts. */
+export type SupportedRasterLayer = ImageryLayer | ImageryTileLayer;
+
 export interface IntervalPopoverProps {
   size: number;
   unit: WebChartTemporalBinningUnits;
@@ -163,7 +168,7 @@ export const ButtonDirections: {
 export type ButtonDirections = (typeof ButtonDirections)[keyof typeof ButtonDirections];
 
 /**
- * Options for CSV export.
+ * Options for exporting chart data to CSV.
  *
  * @template T - The type of the data being exported.
  */
@@ -180,10 +185,11 @@ export interface CSVOptions {
   /** Whether to quote all fields. */
   quoteAll?: boolean;
   /**
-   * Locale used for formatting numbers in the CSV.
-   * This affects how numbers are formatted, such as decimal and thousands separators.
+   * Locale used for formatting numbers in the CSV. This affects how numbers are formatted, such as decimal and thousands separators.
    * If not provided, the default locale will be used.
-   * "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"
+   *
+   * Supported locales include:
+   * `"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"`
    */
   locale?: SupportedLocale;
 }

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

@@ -54,6 +54,7 @@
             };
             minItems: number;
             maxItems: number;
+            description: string;
             title: string;
         };
         WebChartTextSymbol: {
@@ -116,6 +117,7 @@
                 };
                 text: {
                     type: string;
+                    description: string;
                 };
             };
             required: string[];
@@ -170,6 +172,7 @@
                 };
                 text: {
                     type: string;
+                    description: string;
                 };
             };
             required: string[];
@@ -320,7 +323,7 @@
                 maxHeight: {
                     type: string[];
                     description: string;
-                    default: any;
+                    default: null;
                 };
                 roundMarkers: {
                     type: string;
@@ -406,7 +409,7 @@
                 maxHeight: {
                     type: string[];
                     description: string;
-                    default: any;
+                    default: null;
                 };
                 roundMarkers: {
                     type: string;
@@ -647,8 +650,6 @@
                 characterLimit: {
                     type: string[];
                     description: string;
-                    minimum: number;
-                    multipleOf: number;
                 };
             };
             required: string[];
@@ -3267,7 +3268,9 @@
                     description: string;
                 };
                 iLayer: {
-                    $ref: string;
+                    anyOf: {
+                        $ref: string;
+                    }[];
                     description: string;
                 };
                 dataFilters: {
@@ -3289,7 +3292,7 @@
                 background: {
                     $ref: string;
                     description: string;
-                    default: number[];
+                    default: string;
                 };
                 cursorCrosshair: {
                     $ref: string;
@@ -4351,6 +4354,192 @@
             };
             title: string;
         };
+        IImageServiceLayer: {
+            type: string;
+            properties: {
+                timeAnimation: {
+                    type: string;
+                    description: string;
+                };
+                id: {
+                    description: string;
+                };
+                name: {
+                    type: string;
+                    description: string;
+                };
+                itemId: {
+                    type: string;
+                    description: string;
+                };
+                layerType: {
+                    type: string;
+                    const: string;
+                    description: string;
+                };
+                maxScale: {
+                    type: string;
+                    description: string;
+                };
+                minScale: {
+                    type: string;
+                    description: string;
+                };
+                opacity: {
+                    type: string;
+                    description: string;
+                };
+                showLegend: {
+                    type: string;
+                    description: string;
+                };
+                title: {
+                    type: string;
+                    description: string;
+                };
+                type: {
+                    type: string;
+                    description: string;
+                    deprecated: boolean;
+                };
+                visibility: {
+                    type: string;
+                    description: string;
+                };
+                url: {
+                    type: string;
+                    description: string;
+                };
+                bandIds: {
+                    type: string;
+                    items: {
+                        type: string;
+                    };
+                    description: string;
+                };
+                compressionQuality: {
+                    description: string;
+                };
+                definitionEditor: {
+                    description: string;
+                };
+                disablePopup: {
+                    type: string;
+                    description: string;
+                };
+                format: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                interpolation: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                isReference: {
+                    type: string;
+                    description: string;
+                };
+                layerDefinition: {
+                    $ref: string;
+                    description: string;
+                };
+                mosaicRule: {
+                    description: string;
+                };
+                noData: {
+                    description: string;
+                };
+                noDataInterpretation: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                pixelType: {
+                    type: string;
+                    enum: string[];
+                    description: string;
+                };
+                popupInfo: {
+                    $ref: string;
+                    description: string;
+                };
+                refreshInterval: {
+                    type: string;
+                    description: string;
+                };
+                renderingRule: {
+                    description: string;
+                };
+            };
+            required: string[];
+            title: string;
+        };
+        ITiledImageServiceLayer: {
+            type: string;
+            properties: {
+                id: {
+                    description: string;
+                };
+                name: {
+                    type: string;
+                    description: string;
+                };
+                itemId: {
+                    type: string;
+                    description: string;
+                };
+                layerType: {
+                    type: string;
+                    const: string;
+                    description: string;
+                };
+                maxScale: {
+                    type: string;
+                    description: string;
+                };
+                minScale: {
+                    type: string;
+                    description: string;
+                };
+                opacity: {
+                    type: string;
+                    description: string;
+                };
+                showLegend: {
+                    type: string;
+                    description: string;
+                };
+                title: {
+                    type: string;
+                    description: string;
+                };
+                type: {
+                    type: string;
+                    description: string;
+                    deprecated: boolean;
+                };
+                visibility: {
+                    type: string;
+                    description: string;
+                };
+                url: {
+                    type: string;
+                    description: string;
+                };
+                isReference: {
+                    type: string;
+                    description: string;
+                };
+                refreshInterval: {
+                    type: string;
+                    description: string;
+                };
+            };
+            required: string[];
+            title: string;
+        };
         WebChartLabelBehavior: {
             type: string;
             enum: string[];
@@ -4490,7 +4679,9 @@
                     description: string;
                 };
                 iLayer: {
-                    $ref: string;
+                    anyOf: {
+                        $ref: string;
+                    }[];
                     description: string;
                 };
                 dataFilters: {
@@ -4512,7 +4703,7 @@
                 background: {
                     $ref: string;
                     description: string;
-                    default: number[];
+                    default: string;
                 };
                 cursorCrosshair: {
                     $ref: string;
@@ -4640,7 +4831,9 @@
                     description: string;
                 };
                 iLayer: {
-                    $ref: string;
+                    anyOf: {
+                        $ref: string;
+                    }[];
                     description: string;
                 };
                 dataFilters: {
@@ -4662,7 +4855,7 @@
                 background: {
                     $ref: string;
                     description: string;
-                    default: number[];
+                    default: string;
                 };
                 cursorCrosshair: {
                     $ref: string;
@@ -4779,7 +4972,9 @@
                     description: string;
                 };
                 iLayer: {
-                    $ref: string;
+                    anyOf: {
+                        $ref: string;
+                    }[];
                     description: string;
                 };
                 dataFilters: {
@@ -4801,7 +4996,7 @@
                 background: {
                     $ref: string;
                     description: string;
-                    default: number[];
+                    default: string;
                 };
                 cursorCrosshair: {
                     $ref: string;
@@ -4920,7 +5115,9 @@
                     description: string;
                 };
                 iLayer: {
-                    $ref: string;
+                    anyOf: {
+                        $ref: string;
+                    }[];
                     description: string;
                 };
                 dataFilters: {
@@ -4942,7 +5139,7 @@
                 background: {
                     $ref: string;
                     description: string;
-                    default: number[];
+                    default: string;
                 };
                 cursorCrosshair: {
                     $ref: string;
@@ -5032,11 +5229,11 @@
             description: string;
             title: string;
         };
-        "Omit<(structure-1066060463-56690-58343-1066060463-56618-58344-1066060463-52638-58346-1066060463-0-61364|undefined)1405062998,(\"data\"|\"orderByFields\")>": {
+        "Omit<(structure-1066060463-57317-59060-1066060463-57242-59061-1066060463-53359-59063-1066060463-0-62116|undefined)937098756,(\"data\"|\"orderByFields\")>": {
             $ref: string;
             title: string;
         };
-        "Pick<(structure-1066060463-56690-58343-1066060463-56618-58344-1066060463-52638-58346-1066060463-0-61364|undefined)1405062998,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
+        "Pick<(structure-1066060463-57317-59060-1066060463-57242-59061-1066060463-53359-59063-1066060463-0-62116|undefined)937098756,Exclude<(\"series\"|\"data\"|\"orderByFields\"),(\"data\"|\"orderByFields\")>>": {
             type: string;
             properties: {
                 series: {
@@ -5058,15 +5255,19 @@
             properties: {
                 r: {
                     type: string;
+                    description: string;
                 };
                 g: {
                     type: string;
+                    description: string;
                 };
                 b: {
                     type: string;
+                    description: string;
                 };
                 a: {
                     type: string;
+                    description: string;
                     default: number;
                 };
             };
@@ -5529,9 +5730,11 @@
                 };
                 geometryType: {
                     $ref: string;
+                    description: string;
                 };
                 spatialReference: {
                     $ref: string;
+                    description: string;
                 };
                 fields: {
                     type: string;
@@ -6550,6 +6753,7 @@
                 };
                 text: {
                     type: string;
+                    description: string;
                 };
             };
             required: string[];
@@ -6708,11 +6912,6 @@
                 };
             };
             required: string[];
-            examples: {
-                background: {
-                    color: number[];
-                };
-            }[];
             title: string;
         };
         IBookmark: {
@@ -6752,13 +6951,6 @@
                     description: string;
                 };
             };
-            examples: {
-                mapRangeInfo: {
-                    activeRangeName: string;
-                    currentRangeExtent: number[];
-                    fullRangeExtent: number[];
-                };
-            }[];
             title: string;
         };
         IMapLocation: {
@@ -6799,12 +6991,6 @@
                     description: string;
                 };
             };
-            examples: {
-                visibleLayer: {
-                    featureVisibility: number[][];
-                    id: string;
-                };
-            }[];
             title: string;
         };
         IVisiblePopup: {
@@ -7302,127 +7488,6 @@
             required: string[];
             title: string;
         };
-        IImageServiceLayer: {
-            type: string;
-            properties: {
-                timeAnimation: {
-                    type: string;
-                    description: string;
-                };
-                id: {
-                    description: string;
-                };
-                name: {
-                    type: string;
-                    description: string;
-                };
-                itemId: {
-                    type: string;
-                    description: string;
-                };
-                layerType: {
-                    type: string;
-                    const: string;
-                    description: string;
-                };
-                maxScale: {
-                    type: string;
-                    description: string;
-                };
-                minScale: {
-                    type: string;
-                    description: string;
-                };
-                opacity: {
-                    type: string;
-                    description: string;
-                };
-                showLegend: {
-                    type: string;
-                    description: string;
-                };
-                title: {
-                    type: string;
-                    description: string;
-                };
-                type: {
-                    type: string;
-                    description: string;
-                    deprecated: boolean;
-                };
-                visibility: {
-                    type: string;
-                    description: string;
-                };
-                url: {
-                    type: string;
-                    description: string;
-                };
-                bandIds: {
-                    type: string;
-                    items: {
-                        type: string;
-                    };
-                    description: string;
-                };
-                compressionQuality: {
-                    description: string;
-                };
-                definitionEditor: {
-                    description: string;
-                };
-                disablePopup: {
-                    type: string;
-                    description: string;
-                };
-                format: {
-                    type: string;
-                    enum: string[];
-                    description: string;
-                };
-                interpolation: {
-                    type: string;
-                    enum: string[];
-                    description: string;
-                };
-                isReference: {
-                    type: string;
-                    description: string;
-                };
-                layerDefinition: {
-                    description: string;
-                };
-                mosaicRule: {
-                    description: string;
-                };
-                noData: {
-                    description: string;
-                };
-                noDataInterpretation: {
-                    type: string;
-                    enum: string[];
-                    description: string;
-                };
-                pixelType: {
-                    type: string;
-                    enum: string[];
-                    description: string;
-                };
-                popupInfo: {
-                    $ref: string;
-                    description: string;
-                };
-                refreshInterval: {
-                    type: string;
-                    description: string;
-                };
-                renderingRule: {
-                    description: string;
-                };
-            };
-            required: string[];
-            title: string;
-        };
         IImageVectorLayer: {
             type: string;
             properties: {
@@ -7803,70 +7868,6 @@
             required: string[];
             title: string;
         };
-        ITiledImageServiceLayer: {
-            type: string;
-            properties: {
-                id: {
-                    description: string;
-                };
-                name: {
-                    type: string;
-                    description: string;
-                };
-                itemId: {
-                    type: string;
-                    description: string;
-                };
-                layerType: {
-                    type: string;
-                    const: string;
-                    description: string;
-                };
-                maxScale: {
-                    type: string;
-                    description: string;
-                };
-                minScale: {
-                    type: string;
-                    description: string;
-                };
-                opacity: {
-                    type: string;
-                    description: string;
-                };
-                showLegend: {
-                    type: string;
-                    description: string;
-                };
-                title: {
-                    type: string;
-                    description: string;
-                };
-                type: {
-                    type: string;
-                    description: string;
-                    deprecated: boolean;
-                };
-                visibility: {
-                    type: string;
-                    description: string;
-                };
-                url: {
-                    type: string;
-                    description: string;
-                };
-                isReference: {
-                    type: string;
-                    description: string;
-                };
-                refreshInterval: {
-                    type: string;
-                    description: string;
-                };
-            };
-            required: string[];
-            title: string;
-        };
         IExclusionArea: {
             type: string;
             properties: {