@arcgis/core 5.0.0-next.65 → 5.0.0-next.67

package/applications/Components/baUtils.d.ts

@@ -2,42 +2,42 @@ import type { EventedMixin } from "../../core/Evented.js";
 import type { ResourceHandle } from "../../core/Handles.js";
 
 /**
- * @deprecated
  * @param color
+ * @experimental
  * @internal
  */
 export function toRGB(color: any): any;
 
 /**
- * @deprecated
  * @param color
+ * @experimental
  * @internal
  */
 export function toHSV(color: any): any;
 
 /**
- * @deprecated
  * @param target
  * @param eventName
  * @param callback
+ * @experimental
  * @internal
  */
 export function once(target: EventedMixin | EventTarget, eventName: string, callback: (event: any) => void): ResourceHandle;
 
 /**
- * @deprecated
  * @param target
  * @param eventName
  * @param callback
+ * @experimental
  * @internal
  */
 export function on(target: EventedMixin | EventTarget, eventName: string | string[], callback: (event: any) => void): ResourceHandle;
 
 /**
- * @deprecated
  * @param target
  * @param type
  * @param listener
+ * @experimental
  * @internal
  */
 export function pausable(target: EventedMixin | EventTarget, type: string | string[], listener: (event: any) => void): ResourceHandle & {
@@ -46,24 +46,24 @@ export function pausable(target: EventedMixin | EventTarget, type: string | stri
 };
 
 /**
- * @deprecated
  * @param name
+ * @experimental
  * @internal
  */
 export function has(name: string): any;
 
 /**
- * @deprecated
  * @param value
  * @param options
+ * @experimental
  * @internal
  */
 export function format(value: number, options?: Record<string, unknown>): string | null;
 
 /**
- * @deprecated
  * @param expression
  * @param options
+ * @experimental
  * @internal
  */
 export function parse(expression: string, options?: Record<string, unknown>): number;

package/applications/Components/basemapUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Basemap utils for Components.
  *
+ * @experimental
  * @internal
  */
 import type Basemap from "../../Basemap.js";
@@ -9,6 +10,7 @@ import type Basemap from "../../Basemap.js";
  * Get the thumbnail url of an arcgis basemap.
  *
  * @param basemap
+ * @experimental
  * @internal
  */
 export function getBasemapThumbnailUrl(basemap: Basemap | null | undefined): string | null | undefined;

package/applications/Components/drawUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Draw utils for Components.
  *
+ * @experimental
  * @internal
  */
 import type Extent from "../../geometry/Extent.js";
@@ -9,7 +10,10 @@ import type Point from "../../geometry/Point.js";
 import type Polygon from "../../geometry/Polygon.js";
 import type Polyline from "../../geometry/Polyline.js";
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export type MoveGeometries = Extent | Multipoint | Point | Polygon | Polyline;
 
 /**
@@ -21,6 +25,7 @@ export type MoveGeometries = Extent | Multipoint | Point | Polygon | Polyline;
  * @param dx
  * @param dy
  * @param dz
+ * @experimental
  * @internal
  */
 export function move(geometry: MoveGeometries, dx: number, dy: number, dz?: number): MoveGeometries;

package/applications/Components/featureUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Feature utils for Components.
  *
+ * @experimental
  * @internal
  */
 import type WebScene from "../../WebScene.js";
@@ -19,6 +20,7 @@ import type { RequestOptions } from "../../request/types.js";
  * @param layer - The layer to find relationships for.
  * @param relationship - The relationship info to use for finding related layers.
  * @returns The related layer, if found.
+ * @experimental
  * @internal
  */
 export function findRelatedLayer(map: MapClass | WebScene, layer: any, relationship: Relationship): any | null | undefined;
@@ -28,6 +30,7 @@ export function findRelatedLayer(map: MapClass | WebScene, layer: any, relations
  *
  * @param layer - A layer to check.
  * @returns True if the layer is relatable and feature-supported.
+ * @experimental
  * @internal
  */
 export function isRelatableFeatureSupportedLayer(layer: unknown): boolean;
@@ -37,6 +40,7 @@ export function isRelatableFeatureSupportedLayer(layer: unknown): boolean;
  *
  * @param layer - A layer to check.
  * @returns True if the layer is relatable.
+ * @experimental
  * @internal
  */
 export function isRelatableLayer(layer: unknown): boolean;
@@ -46,6 +50,7 @@ export function isRelatableLayer(layer: unknown): boolean;
  *
  * @param layer - A layer to check.
  * @returns True if the layer is feature-supported.
+ * @experimental
  * @internal
  */
 export function isFeatureSupportedLayer(layer: unknown): boolean;
@@ -56,6 +61,7 @@ export function isFeatureSupportedLayer(layer: unknown): boolean;
  * @param map - Map that contains a [UtilityNetwork](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html).
  * @param layer - The layer being validated as a UtilityLayer.
  * @returns Returns a [UtilityNetwork](https://developers.arcgis.com/javascript/latest/api-reference/esri-networks-UtilityNetwork.html).
+ * @experimental
  * @internal
  */
 export function findUtilityNetwork(map: MapClass, layer: any): UtilityNetwork | null | undefined;
@@ -67,6 +73,7 @@ export function findUtilityNetwork(map: MapClass, layer: any): UtilityNetwork |
  * @param query - -The query being used.
  * @param options - -The request options.
  * @returns Returns a FeatureSet.
+ * @experimental
  * @internal
  */
 export function queryAllJSON(layer: FeatureLayer | SubtypeGroupLayer, query: Query, options?: RequestOptions): Promise<any>;
@@ -78,6 +85,7 @@ export function queryAllJSON(layer: FeatureLayer | SubtypeGroupLayer, query: Que
  * @param key - The key to look up.
  * @param createValue - Factory function that creates the value if the key does not exist.
  * @returns The existing value in the map, or a newly created value.
+ * @experimental
  * @internal
  */
 export function getOrCreateMapValue(map: any, key: any, createValue: () => any): any;
@@ -86,6 +94,7 @@ export function getOrCreateMapValue(map: any, key: any, createValue: () => any):
  * Used to generate a new reactive map that implements the Map interface.
  *
  * @returns A Map instance with reactivity features applied.
+ * @experimental
  * @internal
  */
 export function createReactiveMap<Key, Value>(): Map<Key, Value>;

package/applications/Components/fontUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Font utils for Components.
  *
+ * @experimental
  * @internal
  */
 import type Font from "../../symbols/Font.js";
@@ -11,6 +12,7 @@ import type { FontProperties } from "../../symbols/Font.js";
  * font family, style, and weight.
  *
  * @param font
+ * @experimental
  * @internal
  */
 export function loadFont(font: Pick<Font, "family"> & FontProperties): Promise<FontFace>;

package/applications/Components/formatUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * format utils for Components. Used by the Coordinate Conversion component
  *
+ * @experimental
  * @internal
  */
 import type Format from "../../widgets/CoordinateConversion/support/Format.js";
@@ -9,6 +10,7 @@ import type Format from "../../widgets/CoordinateConversion/support/Format.js";
  * Given a format, return whether it has the properties needed for display
  *
  * @param format
+ * @experimental
  * @internal
  */
 export function hasDisplayProperties(format: Format): boolean;

package/applications/Components/getDefaultUnits.d.ts

@@ -1,6 +1,7 @@
 /**
  * Extract default units from map of view.
  *
+ * @experimental
  * @internal
  */
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
@@ -10,6 +11,7 @@ import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
  * of a webmap/webscene used in a a view.
  *
  * @param view
+ * @experimental
  * @internal
  */
 export function getDefaultUnitForView(view: MapViewOrSceneView): "imperial" | "metric";

package/applications/Components/imageryUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Imagery utility functions for Web Components.
  *
+ * @experimental
  * @internal
  */
 import type Extent from "../../geometry/Extent.js";
@@ -22,25 +23,52 @@ import type { AbortOptions } from "../../core/promiseUtils.js";
  * @param parameters - An object with the following properties.
  * @param options - An object with the following properties.
  * @returns Resolves to an object containing the pixels as point features.
+ * @experimental
  * @internal
  */
 export function fetchPixelFeatureSet(layer: ImageryLayer | ImageryTileLayer | WCSLayer, parameters: PixelFeatureSetParameters, options?: AbortOptions): Promise<object>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface ImagePixelBlockParameters {
-  /** When true, auto resample the image (reading pyramid) to reduce the amount of reading and result features. */
+  /**
+   * When true, auto resample the image (reading pyramid) to reduce the amount of reading and result features.
+   *
+   * @experimental
+   */
   autoResample?: boolean | null;
-  /** The geometry. */
+  /**
+   * The geometry.
+   *
+   * @experimental
+   */
   geometry: Extent | Polygon | Polyline;
-  /** Auto resample (reading pyramid) is performed based on the provided maximum pixel count. */
+  /**
+   * Auto resample (reading pyramid) is performed based on the provided maximum pixel count.
+   *
+   * @experimental
+   */
   maxPixelCount?: number | null;
-  /** The request pixel size. Default to source pixel size of the layer. */
+  /**
+   * The request pixel size. Default to source pixel size of the layer.
+   *
+   * @experimental
+   */
   pixelSize?: Point | null;
 }
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface PixelFeatureSetParameters extends ImagePixelBlockParameters {
-  /** Sample pixels by skipping provided number of rows and cols. */
+  /**
+   * Sample pixels by skipping provided number of rows and cols.
+   *
+   * @experimental
+   */
   skipFactor?: number | null;
 }
 
@@ -51,13 +79,21 @@ export interface PixelFeatureSetParameters extends ImagePixelBlockParameters {
  * @param parameters - An object with the following properties.
  * @param options - An object with the following properties.
  * @returns Resolves to an array of objects, each element contain the intersected pixel center location and value.
+ * @experimental
  * @internal
  */
 export function readIntersectingPixels(layer: ImageryTileLayer | ImageryLayer | WCSLayer, parameters: ReadIntersectingPixelsParameters, options?: AbortOptions): Promise<object[]>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface ReadIntersectingPixelsParameters {
-  /** The geometry. */
+  /**
+   * The geometry.
+   *
+   * @experimental
+   */
   geometry: Polygon | Extent | Polyline;
 }
 
@@ -68,13 +104,21 @@ export interface ReadIntersectingPixelsParameters {
  * @param parameters - An object with the following properties.
  * @param options - An object with the following properties.
  * @returns Resolves to a raster attribute table object.
+ * @experimental
  * @internal
  */
 export function computeRasterAttributeTable(layer: ImageryTileLayer | ImageryLayer | WCSLayer, parameters: ComputeRasterAttributeTableParameters, options?: AbortOptions): Promise<FeatureSet | null | undefined>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface ComputeRasterAttributeTableParameters {
-  /** The geometry. */
+  /**
+   * The geometry.
+   *
+   * @experimental
+   */
   geometry: Extent | Polygon | Polyline;
 }
 
@@ -87,15 +131,27 @@ export interface ComputeRasterAttributeTableParameters {
  * @param parameters - An object with the following properties.
  * @param options - An object with the following properties.
  * @returns Returns async generator, each part resolves to an object containing the extent and feature set that represent pixel centers.
+ * @experimental
  * @internal
  */
 export function createPixelFeatureSetCursor(layer: ImageryTileLayer | ImageryLayer | WCSLayer, parameters?: PixelFeatureSetCursorParameters, options?: AbortOptions): AsyncGenerator<any>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface PixelFeatureSetCursorParameters {
-  /** The geometry, default to layer's full extent. */
+  /**
+   * The geometry, default to layer's full extent.
+   *
+   * @experimental
+   */
   geometry?: Extent | Polygon | Polyline | null;
-  /** Sample pixels by skipping provided number of rows and cols. */
+  /**
+   * Sample pixels by skipping provided number of rows and cols.
+   *
+   * @experimental
+   */
   skipFactor?: number | null;
 }
 
@@ -106,13 +162,21 @@ export interface PixelFeatureSetCursorParameters {
  * @param parameters - An object with the following properties.
  * @param options - An object with the following properties.
  * @returns Resolves to an array, each element represent the box statistics of that band, including min, max, avg, median, quantile1 and quantile3.
+ * @experimental
  * @internal
  */
 export function computeBoxStatistics(layer: ImageryTileLayer | ImageryLayer | WCSLayer, parameters: ComputeBoxStatisticsParameters, options?: AbortOptions): Promise<object[] | null | undefined>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface ComputeBoxStatisticsParameters {
-  /** The geometry. */
+  /**
+   * The geometry.
+   *
+   * @experimental
+   */
   geometry: Polygon | Extent | Polyline | Multipoint;
 }
 
@@ -128,27 +192,63 @@ export interface ComputeBoxStatisticsParameters {
  * ---------|------|-------------
  * histograms[] | [RasterHistogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterHistogram) | Result containing raster histograms.
  * bandStatistics[] | [RasterBandStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-types.html#RasterBandStatistics) | Raster band statistics.
+ * @experimental
  * @internal
  */
 export function computeStatisticsHistograms(layer: ImageryTileLayer | ImageryLayer | WCSLayer, parameters: PixelStatisticsParameters, options?: AbortOptions): Promise<object>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface PixelStatisticsParameters {
-  /** The list of band ids. */
+  /**
+   * The list of band ids.
+   *
+   * @experimental
+   */
   bandIds?: number[];
-  /** The geometry. */
+  /**
+   * The geometry.
+   *
+   * @experimental
+   */
   geometry: Polygon | Extent | Polyline;
-  /** The size of the histogram. Default is up to 256. */
+  /**
+   * The size of the histogram. Default is up to 256.
+   *
+   * @experimental
+   */
   histogramSize?: number;
-  /** Lambda for box-cox transform type. Default is 0. */
+  /**
+   * Lambda for box-cox transform type. Default is 0.
+   *
+   * @experimental
+   */
   lambda?: number;
-  /** The request pixel size. Default to source pixel size of the layer. */
+  /**
+   * The request pixel size. Default to source pixel size of the layer.
+   *
+   * @experimental
+   */
   pixelSize?: Point | null;
-  /** Shift for box-cox transform type. Default is 0. */
+  /**
+   * Shift for box-cox transform type. Default is 0.
+   *
+   * @experimental
+   */
   shift?: number;
-  /** The transform type for pixel values. Default is not transformed. */
+  /**
+   * The transform type for pixel values. Default is not transformed.
+   *
+   * @experimental
+   */
   transformType?: "log" | "sqrt" | "inverse" | "box-cox";
-  /** Field name from raster attribute table. */
+  /**
+   * Field name from raster attribute table.
+   *
+   * @experimental
+   */
   valueAttributeFieldName?: string;
 }
 
@@ -159,12 +259,20 @@ export interface PixelStatisticsParameters {
  * @param parameters - An object with the following properties.
  * @param options - An object with the following properties.
  * @returns Resolves to an array of numbers, each element represented the average for the band.
+ * @experimental
  * @internal
  */
 export function identifyAveragePixelValue(layer: ImageryTileLayer | ImageryLayer | WCSLayer, parameters: IdentityAveragePixelValueParameters, options?: AbortOptions): Promise<number[] | null | undefined>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface IdentityAveragePixelValueParameters {
-  /** The geometry. */
+  /**
+   * The geometry.
+   *
+   * @experimental
+   */
   geometry: Polygon | Extent | Polyline | Multipoint | Point;
 }

package/applications/Components/layerOriginUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Layer origin utils for Components.
  *
+ * @experimental
  * @internal
  */
 import type Layer from "../../layers/Layer.js";
@@ -9,6 +10,7 @@ import type Layer from "../../layers/Layer.js";
  * Indicates whether origin info can be returned for the given layer and its properties.
  *
  * @param layer
+ * @experimental
  * @internal
  */
 export function isSupportedLayer(layer: Layer): boolean;
@@ -23,6 +25,7 @@ export function isSupportedLayer(layer: Layer): boolean;
  *
  * @param layer
  * @param origin
+ * @experimental
  * @internal
  */
 export function clearOverrides(layer: Layer, origin: "portal-item" | "web-map" | "web-scene"): void;
@@ -38,6 +41,7 @@ export function clearOverrides(layer: Layer, origin: "portal-item" | "web-map" |
  *
  * @param layer
  * @param origin
+ * @experimental
  * @internal
  */
 export function disconnectFromSource(layer: Layer, origin: "portal-item" | "web-map" | "web-scene"): void;
@@ -64,6 +68,7 @@ export function disconnectFromSource(layer: Layer, origin: "portal-item" | "web-
  *
  * @param layer
  * @param origin
+ * @experimental
  * @internal
  */
 export function getLayerOriginInfo(layer: Layer, origin: "portal-item" | "web-map" | "web-scene"): object | null | undefined;

package/applications/Components/layersEffectsJsonUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Layers Effects json utils for Components.
  *
+ * @experimental
  * @internal
  */
 
@@ -10,6 +11,7 @@
  * Throws an error if the effect property is invalid.
  *
  * @param input
+ * @experimental
  * @internal
  */
 export function toJSON(input: any | string): any;

package/applications/Components/previewSymbol2D.d.ts

@@ -1,6 +1,7 @@
 /**
  * Background theme utils for Components.
  *
+ * @experimental
  * @internal
  */
 import type { Symbol2DUnion } from "../../symbols/types.js";
@@ -11,6 +12,7 @@ import type { Symbol2DUnion } from "../../symbols/types.js";
  *
  * @param symbol
  * @param threshold
+ * @experimental
  * @internal
  */
 export function getContrastingBackgroundTheme(symbol: Symbol2DUnion, threshold?: number): "light" | "dark" | null | undefined;

package/applications/Components/reactiveUtils.d.ts

@@ -2,71 +2,75 @@
  * Utilities related to reactivity that we're not quite ready to expose in the public API but which are useful for
  * internal component development.
  *
+ * @experimental
  * @internal
  */
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export interface Signal<T> {
   value: T;
   /**
-   * @deprecated
    * @param mutateFn
+   * @experimental
    */
   mutate(mutateFn: (value: T) => void): void;
 }
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export interface ReactiveObservable {
+  /** @experimental */
   notify(): void;
 }
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export interface ReactiveTrackingTarget {
+  /** @experimental */
   clear(): void;
+  /** @experimental */
   destroy(): void;
 }
 
 /**
- * @deprecated
  * @param initialValue
  * @param equalityFunction
+ * @experimental
  * @internal
  */
 export function signal<T>(initialValue: T, equalityFunction?: (a: T, b: T) => boolean): Signal<T>;
 
 /**
- * @deprecated
+ * @experimental
  * @internal
  */
 export function createObservable(): ReactiveObservable;
 
 /**
- * @deprecated
  * @param notify
+ * @experimental
  * @internal
  */
 export function createTrackingTarget(notify: () => void): ReactiveTrackingTarget;
 
 /**
- * @deprecated
  * @param observable
+ * @experimental
  * @internal
  */
 export function trackAccess(observable: ReactiveObservable): void;
 
 /**
- * @deprecated
  * @param target
  * @param callback
+ * @experimental
  * @internal
  */
 export function runTracked<T>(target: ReactiveTrackingTarget, callback: () => T): T | null;

package/applications/Components/sanitizerUtils.d.ts

@@ -1,12 +1,14 @@
 /**
  * Sanitiziing utils for Components.
  *
+ * @experimental
  * @internal
  */
 
 /**
  * The rendering sanitizer for use in Components.
  *
+ * @experimental
  * @internal
  */
 export const renderingSanitizer: any;