@arcgis/core 5.1.0-next.20 → 5.1.0-next.21

package/applications/Components/OrientedImageryViewer/galleryUtils.d.ts

@@ -1,7 +1,7 @@
 /**
  * OrientedImageryViewer gallery utils for Components.
  *
- * @experimental
+ * @internal
  * @internal
  */
 import type OrientedImageryLayer from "../../../layers/OrientedImageryLayer.js";
@@ -9,35 +9,53 @@ import type PixelBlock from "../../../layers/support/PixelBlock.js";
 import type { AbortOptions } from "../../../core/promiseUtils.js";
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface ImageSource {
   /**
    * The dataset format.
    * e.g., "TIFF" | "MRF" | "JPG"
+   *
+   * @internal
    */
   datasetFormat: string;
-  /** The url of the image source. */
+  /**
+   * The url of the image source.
+   *
+   * @internal
+   */
   url: string;
 }
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface GetImageSourceFromAttachmentProperties {
-  /** The oriented imagery layer. */
+  /**
+   * The oriented imagery layer.
+   *
+   * @internal
+   */
   layer: OrientedImageryLayer;
-  /** The object id of the feature. */
+  /**
+   * The object id of the feature.
+   *
+   * @internal
+   */
   objectId: number;
-  /** The abort options. */
+  /**
+   * The abort options.
+   *
+   * @internal
+   */
   options?: AbortOptions;
 }
 
 /**
  * @param properties - The properties to get the image source from attachment.
- * @experimental
+ * @internal
  * @internal
  */
 export function getImageSourceFromAttachment(properties: GetImageSourceFromAttachmentProperties): Promise<ImageSource>;
@@ -45,27 +63,39 @@ export function getImageSourceFromAttachment(properties: GetImageSourceFromAttac
 /**
  * @param urlOrImageSource - The image source or url to get the thumbnail pixel block from.
  * @param options - The abort options.
- * @experimental
+ * @internal
  * @internal
  */
 export function getThumbnailAsPixelBlock(urlOrImageSource: ImageSource | string, options?: AbortOptions): Promise<PixelBlock | null | undefined>;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface LoadImageFromAttachmentProperties {
-  /** The oriented imagery layer. */
+  /**
+   * The oriented imagery layer.
+   *
+   * @internal
+   */
   layer?: OrientedImageryLayer | null;
-  /** The object id of the feature. */
+  /**
+   * The object id of the feature.
+   *
+   * @internal
+   */
   objectId: number;
-  /** The abort options. */
+  /**
+   * The abort options.
+   *
+   * @internal
+   */
   options?: AbortOptions;
 }
 
 /**
  * @param properties - The properties to load the image for attachment.
- * @experimental
+ * @internal
  * @internal
  */
 export function loadImageForAttachment(properties: LoadImageFromAttachmentProperties): Promise<PixelBlock | HTMLImageElement | null | undefined>;
@@ -74,7 +104,7 @@ export function loadImageForAttachment(properties: LoadImageFromAttachmentProper
  * @param pixelBlockOrImageElement - The pixel block or HTML image element.
  * @param canvas - The canvas to render the image on.
  * @param rotation - The rotation angle in degrees.
- * @experimental
+ * @internal
  * @internal
  */
 export function renderImageWithRotation(pixelBlockOrImageElement: HTMLImageElement | PixelBlock, canvas: HTMLCanvasElement, rotation?: number): void;

package/applications/Components/QuantityFormatter.d.ts

@@ -3,7 +3,7 @@ import type { Area, Length, RotationType, Volume } from "../../core/quantity.js"
 import type { AngleUnit } from "../../core/units.js";
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface QuantityFormatterProperties {}
@@ -11,7 +11,7 @@ export interface QuantityFormatterProperties {}
 /**
  * The format to use for the quantity.
  *
- * @experimental
+ * @internal
  * @internal
  */
 export type FormattingStyle = "singular" | "plural" | "abbr";
@@ -20,11 +20,11 @@ export type FormattingStyle = "singular" | "plural" | "abbr";
  * Class which has methods to format quantities like lengths and areas. To be used in components until we have a public
  * API for unit conversion and formatting.
  *
- * @experimental
+ * @internal
  * @internal
  */
 export default class QuantityFormatter extends Accessor {
-  /** @experimental */
+  /** @internal */
   constructor(properties?: QuantityFormatterProperties);
   /**
    * Formats an angle quantity to degrees. Absolute angles are always formatted in the domain [0, 360).
@@ -35,7 +35,7 @@ export default class QuantityFormatter extends Accessor {
    * @param preferredType - The preferred type of the resulting formatted angle.
    * @param precision - Precision to be used when formatting values.
    * @returns The formatted angle.
-   * @experimental
+   * @internal
    */
   formatAngleDegrees(angle: number, unit: AngleUnit, rotationType: RotationType, preferredType: RotationType, precision?: number | null | undefined): string;
   /**
@@ -45,7 +45,7 @@ export default class QuantityFormatter extends Accessor {
    * @param precision - The number of decimal places to include in the formatted string.
    * @param format - The format to use for the quantity.
    * @returns The formatted quantity.
-   * @experimental
+   * @internal
    */
   formatArea(quantity: Area, precision?: number, format?: FormattingStyle): string;
   /**
@@ -55,7 +55,7 @@ export default class QuantityFormatter extends Accessor {
    * @param precision - The number of decimal places to include in the formatted string.
    * @param format - The format to use for the quantity.
    * @returns The formatted quantity.
-   * @experimental
+   * @internal
    */
   formatDecimal(quantity: Length | Area, precision?: number, format?: FormattingStyle): string;
   /**
@@ -65,7 +65,7 @@ export default class QuantityFormatter extends Accessor {
    * @param precision - The number of decimal places to include in the formatted string.
    * @param format - The format to use for the quantity.
    * @returns The formatted length quantity.
-   * @experimental
+   * @internal
    */
   formatLength(quantity: Length, precision?: number, format?: FormattingStyle): string;
   /**
@@ -75,7 +75,7 @@ export default class QuantityFormatter extends Accessor {
    * @param precision - The number of decimal places to include in the formatted string.
    * @param format - The format to use for the quantity.
    * @returns The formatted quantity.
-   * @experimental
+   * @internal
    */
   formatVerticalLength(quantity: Length, precision?: number, format?: FormattingStyle): string;
   /**
@@ -85,14 +85,14 @@ export default class QuantityFormatter extends Accessor {
    * @param precision - The number of decimal places to include in the formatted string.
    * @param format - The format to use for the quantity.
    * @returns The formatted quantity.
-   * @experimental
+   * @internal
    */
   formatVolume(quantity: Volume, precision?: number, format?: FormattingStyle): string;
   /**
    * Returns a promise that resolves when the messages are loaded.
    *
    * @returns A promise that resolves when the messages are loaded.
-   * @experimental
+   * @internal
    */
   when(): Promise<void>;
 }

package/applications/Components/SelectionOperation.d.ts

@@ -1,62 +1,62 @@
 /**
  * Utilities for creating a SelectionOperation class instance.
  *
- * @experimental
+ * @internal
  * @internal
  */
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export type SelectionOperationType = "add" | "remove" | "replace";
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface OperationOptions {
   /**
    * The tool to create ("point", "polygon", "circle", or "rectangle"). Defaults to "rectangle" if not specified.
    *
-   * @experimental
+   * @internal
    */
   createTool?: "point" | "polygon" | "circle" | "rectangle";
   /**
    * The operation mode ("click", "freehand", or "hybrid").
    *
-   * @experimental
+   * @internal
    */
   mode?: "click" | "freehand" | "hybrid";
   /**
    * An optional, unique name used to distinguish an operation.
    *
-   * @experimental
+   * @internal
    */
   name?: "rectangle" | "lasso" | "point" | string;
   /**
    * Whether the final selection should update the current selection manager.
    *
-   * @experimental
+   * @internal
    */
   persistSelection?: boolean;
   /**
    * Whether the selected graphics should include geometries. Defaults to true if not specified.
    *
-   * @experimental
+   * @internal
    */
   returnGeometry?: boolean;
   /**
    * Whether to select on complete. Defaults to true if not specified.
    *
-   * @experimental
+   * @internal
    */
   selectOnComplete?: boolean;
   /**
    * The type of selection operation ("add", "remove" or "replace"). Defaults to "add" if not specified.
    *
-   * @experimental
+   * @internal
    */
   type?: SelectionOperationType;
 }
@@ -68,7 +68,7 @@ export interface OperationOptions {
  * @param sources - An array of source layers.
  * @param options - Additional tool- and selection-related options for the SelectionOperation.
  * @returns The created SelectionOperation instance.
- * @experimental
+ * @internal
  * @internal
  */
 export function createSelectionOperation(view: MapViewOrSceneView, sources: any[] | null | undefined, options?: OperationOptions): any;

package/applications/Components/SketchTooltipControls.d.ts

@@ -1,47 +1,47 @@
 /**
  * Utilities for creating a SketchTooltipControls class instance.
  *
- * @experimental
+ * @internal
  * @internal
  */
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface VisibleElements {
   /**
    * Whether the direction mode picker is visible.
    *
-   * @experimental
+   * @internal
    */
   directionModePicker?: boolean;
   /**
    * Whether the header is visible.
    *
-   * @experimental
+   * @internal
    */
   header?: boolean;
   /**
    * Whether the labels toggle is visible.
    *
-   * @experimental
+   * @internal
    */
   labelsToggle?: boolean;
   /**
    * Whether the tooltips toggle is visible.
    *
-   * @experimental
+   * @internal
    */
   tooltipsToggle?: boolean;
 }
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface SketchTooltipControlsInterface {
-  /** @experimental */
+  /** @internal */
   destroy(): void;
 }
 
@@ -52,7 +52,7 @@ export interface SketchTooltipControlsInterface {
  * @param sketchOptions - Determines which sketch options to show, such as labels or tooltips.
  * @param viewType - Type of view; determines whether SegmentLabels toggle will be shown (only for 3D)
  * @returns The created SketchTooltipControls instance.
- * @experimental
+ * @internal
  * @internal
  */
 export function createSketchTooltipControls(visibleElements: VisibleElements, sketchOptions: any, viewType?: "2d" | "3d" | null | undefined): SketchTooltipControlsInterface;

package/applications/Components/actionUtils.d.ts

@@ -2,6 +2,7 @@
  * Action utils for Components.
  *
  * @internal
+ * @internal
  */
 import type Graphic from "../../Graphic.js";
 import type MapView from "../../views/MapView.js";
@@ -13,7 +14,7 @@ import type SceneView from "../../views/SceneView.js";
  * @param graphic - The graphic feature to check.
  * @param view - The view associated with the popup.
  * @returns True if the screen size is suitable for zoom actions, otherwise false.
- * @experimental
+ * @internal
  * @internal
  */
 export function isZoomScreenSize(graphic: Graphic | null | undefined, view: MapView | SceneView | null | undefined): Promise<boolean>;

package/applications/Components/analysisUtils.d.ts

@@ -2,6 +2,7 @@
  * Analysis utility functions for Web Components.
  *
  * @internal
+ * @internal
  */
 import type ElevationProfileAnalysisView2D from "../../views/2d/analysis/ElevationProfileAnalysisView2D.js";
 import type AreaMeasurementAnalysisView3D from "../../views/3d/analysis/AreaMeasurementAnalysisView3D.js";
@@ -18,7 +19,7 @@ import type { AnalysisViewUnion } from "../../views/analysis/types.js";
  * @param analysisView - The analysis view whose `interactive` property is to be forced to `true`.
  * @returns A handle which, when removed, will restore the analysis view to its
  * original interactive state.
- * @experimental
+ * @internal
  * @internal
  */
 export function forceInteractive(analysisView: AnalysisViewUnion): ResourceHandle;
@@ -28,7 +29,7 @@ export function forceInteractive(analysisView: AnalysisViewUnion): ResourceHandl
  *
  * @param length - The length to check.
  * @returns `true` if the specified length is geodesic, `false` otherwise.
- * @experimental
+ * @internal
  * @internal
  */
 export function isAboveGeodesicDistanceThreshold(length: Length): boolean;
@@ -38,7 +39,7 @@ export function isAboveGeodesicDistanceThreshold(length: Length): boolean;
  *
  * @param analysisView - The analysis view to check.
  * @returns `true` if the analysis view contains a valid result, `false` otherwise.
- * @experimental
+ * @internal
  * @internal
  */
 export function hasValidAreaResult(analysisView: AreaMeasurementAnalysisView3D): boolean;
@@ -47,7 +48,7 @@ export function hasValidAreaResult(analysisView: AreaMeasurementAnalysisView3D):
  * Sets the elevation profile to a test configuration which removes timeouts, throtting, etc to make tests faster.
  *
  * @returns A watch handle.
- * @experimental
+ * @internal
  * @internal
  */
 export function setElevationProfileTestConfig(): ResourceHandle;
@@ -55,81 +56,81 @@ export function setElevationProfileTestConfig(): ResourceHandle;
 /**
  * An elevation profile chart.
  *
- * @experimental
+ * @internal
  * @internal
  */
 export interface InternalElevationProfileChart {
   /**
    * The ElevationProfileAnalysisView2D or ElevationProfileAnalysisView3D associated with the chart.
    *
-   * @experimental
+   * @internal
    */
   analysisView?: ElevationProfileAnalysisView2D | ElevationProfileAnalysisView3D | null;
   /**
    * Indicates whether the chart should be shown.
    *
-   * @experimental
+   * @internal
    */
   chartVisible: boolean;
   /**
    * The messages used in the chart.
    *
-   * @experimental
+   * @internal
    */
   messages?: object | null;
   /**
    * Indicates whether the loading spinner should be shown.
    *
-   * @experimental
+   * @internal
    */
   spinnerVisible: boolean;
   /**
    * Indicates whether uniform scaling is enabled for the chart axes.
    *
-   * @experimental
+   * @internal
    */
   uniformScaling: boolean;
   /**
    * The MapView or SceneView associated with the chart.
    *
-   * @experimental
+   * @internal
    */
   view?: MapViewOrSceneView | null;
   /**
    * Destroys the chart and releases resources.
    *
-   * @experimental
+   * @internal
    */
   destroy: () => void;
   /**
    * Zooms out the chart to show the full range of data.
    *
-   * @experimental
+   * @internal
    */
   zoomOut: () => void;
   /**
    * Testing utilities (only available when the `esri-tests` build flag is set to `true`).
    *
-   * @experimental
+   * @internal
    */
   test?: InternalElevationProfileChartTest;
 }
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface InternalElevationProfileChartTest {
   /**
    * Shows the chart tooltip at the specified coordinates.
    *
-   * @experimental
+   * @internal
    */
   forceShowTooltipAt: (x: number, y: number) => Promise<void>;
   /**
    * Returns a promise that resolves when the chart is fully ready.
    *
-   * @experimental
+   * @internal
    */
   whenReady: () => Promise<void>;
 }
@@ -140,56 +141,56 @@ export interface InternalElevationProfileChartTest {
  *
  * @param parameters
  * @returns The created chart instance.
- * @experimental
+ * @internal
  * @internal
  */
 export function createChart(parameters: InternalCreateChartParameters): Promise<InternalElevationProfileChart>;
 
 /**
- * @experimental
+ * @internal
  * @internal
  */
 export interface InternalCreateChartParameters extends AbortOptions {
   /**
    * The container element in which to render the chart.
    *
-   * @experimental
+   * @internal
    */
   container: HTMLElement;
   /**
    * The analysis view to associate with the chart.
    *
-   * @experimental
+   * @internal
    */
   analysisView?: ElevationProfileAnalysisView2D | ElevationProfileAnalysisView3D | null;
   /**
    * Messages to display in the chart.
    *
-   * @experimental
+   * @internal
    */
   messages?: object | null;
   /**
    * Called when the cursor position changes on the chart.
    *
-   * @experimental
+   * @internal
    */
   onCursorPositionChange?: null | ((x: number | null | undefined, y: number | null | undefined) => void);
   /**
    * Called when the chart's range changes.
    *
-   * @experimental
+   * @internal
    */
   onRangeChange?: null | ((zoomFactorX: number, zoomFactorY: number) => void);
   /**
    * Whether to use uniform scaling for the chart axes.
    *
-   * @experimental
+   * @internal
    */
   uniformScaling?: boolean | null;
   /**
    * The MapView or SceneView instance associated with the chart.
    *
-   * @experimental
+   * @internal
    */
   view?: MapViewOrSceneView | null;
 }