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

package/applications/KnowledgeStudio/reshape.d.ts

@@ -1,6 +1,7 @@
 /**
  * A utility method for getting a Reshape instance with support for connected reshaping.
  *
+ * @experimental
  * @internal
  */
 import type Graphic from "../../Graphic.js";
@@ -16,17 +17,40 @@ import type MapView from "../../views/MapView.js";
 import type LinkChartView from "../../views/LinkChartView.js";
 import type { ResourceHandle } from "../../core/Handles.js";
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface ReshapeInterface {
-  /** An array of `ConnectedReshapeProviderFactory` objects that provide connected reshape functionality for the reshape operation. */
+  /**
+   * An array of `ConnectedReshapeProviderFactory` objects that provide connected reshape functionality for the reshape operation.
+   *
+   * @experimental
+   */
   connectedReshapeProviders?: ConnectedReshapeProviderFactory[] | null;
-  /** Destroys the reshape instance. */
+  /**
+   * Destroys the reshape instance.
+   *
+   * @experimental
+   */
   destroy: () => void;
-  /** The graphic being reshaped. */
+  /**
+   * The graphic being reshaped.
+   *
+   * @experimental
+   */
   graphic: Graphic;
-  /** A GraphicsLayer to be used for temporary graphics during the reshape operation. */
+  /**
+   * A GraphicsLayer to be used for temporary graphics during the reshape operation.
+   *
+   * @experimental
+   */
   layer: GraphicsLayer;
-  /** The MapView in which the reshape operation is taking place. */
+  /**
+   * The MapView in which the reshape operation is taking place.
+   *
+   * @experimental
+   */
   view: MapView;
 }
 
@@ -34,11 +58,15 @@ export interface ReshapeInterface {
  * Returns a reshape operation.
  *
  * @param properties - The constructor properties.
+ * @experimental
  * @internal
  */
 export function getReshape(properties: ConstructProperties): Promise<ReshapeInterface>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export type ConstructProperties = Pick<ReshapeInterface, "connectedReshapeProviders" | "graphic" | "layer" | "view">;
 
 /**
@@ -48,15 +76,21 @@ export type ConstructProperties = Pick<ReshapeInterface, "connectedReshapeProvid
  * @param targetEntityType - The type of the entity to be moved.
  * @param targetView - The LinkChartView in which the node movement reshape operation will take place.
  * @param options - Optional parameters.
+ * @experimental
  * @internal
  */
 export function studioStartNodeMovement(targetEntityId: string, targetEntityType: string, targetView: LinkChartView, options?: {
     useSnappingGrid?: boolean;
 }): Promise<StudioNodeMovementReturnType>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface StudioNodeMovementReturnType {
+  /** @experimental */
   cancelNodeMovement: () => void;
+  /** @experimental */
   commitNodeMovement: () => Promise<Point>;
 }
 
@@ -65,62 +99,119 @@ export interface StudioNodeMovementReturnType {
  *
  * @param targetView - The LinkChartView in which the node movement reshape operation is taking place.
  * @param movementStopCallback - The callback function to be called when the node movement stops.
+ * @experimental
  * @internal
  */
 export function onNodeMovementStop(targetView: LinkChartView, movementStopCallback: MovementStopCallback): ResourceHandle;
 
 /**
  * @param event - The event object containing information about the node movement.
+ * @experimental
  * @internal
  */
 export type MovementStopCallback = (event: MovementStopCallbackEvent) => void;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface MovementStopCallbackEvent {
-  /** The change in the x-coordinate of the node's position. */
+  /**
+   * The change in the x-coordinate of the node's position.
+   *
+   * @experimental
+   */
   dx: number;
-  /** The change in the y-coordinate of the node's position. */
+  /**
+   * The change in the y-coordinate of the node's position.
+   *
+   * @experimental
+   */
   dy: number;
-  /** The graphic representing the node being moved. */
+  /**
+   * The graphic representing the node being moved.
+   *
+   * @experimental
+   */
   mover: Graphic;
 }
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export type ConnectedReshapeSupportedLayer = GeoJSONLayer | FeatureLayer | OrientedImageryLayer | SceneLayer | SubtypeSublayer | GraphicsLayer | KnowledgeGraphSublayer;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface ReshapeFeature {
-  /** The graphic being reshaped. */
+  /**
+   * The graphic being reshaped.
+   *
+   * @experimental
+   */
   graphic: Graphic;
-  /** The layer to which the graphic belongs. */
+  /**
+   * The layer to which the graphic belongs.
+   *
+   * @experimental
+   */
   layer: ConnectedReshapeSupportedLayer;
 }
 
 /**
  * Represents a feature that has been modified by a ConnectedReshapeProvider due to being connected (or otherwise spatially related to) the feature(s) or vertex(es) being reshaped.
  *
+ * @experimental
  * @internal
  */
 export interface ModifiedFeature {
-  /** The current version of the feature, with a geometry that reflects whatever translation/transformation has been made as a result of the reshape operation */
+  /**
+   * The current version of the feature, with a geometry that reflects whatever translation/transformation has been made as a result of the reshape operation
+   *
+   * @experimental
+   */
   graphic: Graphic;
-  /** The layer to which the feature belongs */
+  /**
+   * The layer to which the feature belongs
+   *
+   * @experimental
+   */
   layer: ConnectedReshapeSupportedLayer;
-  /** The original version of the feature, before the start of the reshape operation */
+  /**
+   * The original version of the feature, before the start of the reshape operation
+   *
+   * @experimental
+   */
   originalGraphic: Graphic;
-  /** Some unique identifier of the feature. E.g., the feature's object ID. */
+  /**
+   * Some unique identifier of the feature. E.g., the feature's object ID.
+   *
+   * @experimental
+   */
   uniqueId: string | number;
 }
 
 /**
  * An object that provides "connected reshaping" functionality for a feature or vertex being reshaped. This object is given information about each incremental position change throughout the reshape operation. The object is responsible for identifying and loading features that are connected to the primary feature, and providing, for each incremental change, the current positions of those connected features.
  *
+ * @experimental
  * @internal
  */
 export interface ConnectedReshapeProvider {
-  /** Called each time the position of the given feature or vertex changes during the reshape operation. This function should return an array of [ModifiedFeature](https://developers.arcgis.com/javascript/latest/api-reference/esri-applications-KnowledgeStudio-reshape.html#ModifiedFeature) objects representing the current positions of the connected features given the change so far to the position of the feature or vertex being reshaped. Parameters represent the incremental change in position of the feature (or vertex) since the last time `translate` was called. Values are in the units of the spatial reference. */
+  /**
+   * Called each time the position of the given feature or vertex changes during the reshape operation. This function should return an array of [ModifiedFeature](https://developers.arcgis.com/javascript/latest/api-reference/esri-applications-KnowledgeStudio-reshape.html#ModifiedFeature) objects representing the current positions of the connected features given the change so far to the position of the feature or vertex being reshaped. Parameters represent the incremental change in position of the feature (or vertex) since the last time `translate` was called. Values are in the units of the spatial reference.
+   *
+   * @experimental
+   */
   translate: TranslateMethod;
-  /** Not used at this time. Hard-code this to `false` for now. */
+  /**
+   * Not used at this time. Hard-code this to `false` for now.
+   *
+   * @experimental
+   */
   updating: boolean;
 }
 
@@ -131,29 +222,53 @@ export interface ConnectedReshapeProvider {
  * @param deltaY - The change in the y-coordinate of the feature or vertex being reshaped, in the units of the spatial reference.
  * @param deltaZ - The change in the z-coordinate of the feature or vertex being reshaped, in the units of the spatial reference. This may be `nil` if the feature does not have a z-coordinate.
  * @returns An array of modified features representing the current positions of the connected features given the change so far to the position of the feature or vertex being reshaped.
+ * @experimental
  * @internal
  */
 export type TranslateMethod = (deltaX: number, deltaY: number, deltaZ: number | null | undefined) => ModifiedFeature[];
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface VertexInfo {
-  /** The index of the ring or path in the feature's geometry that contains the vertex. */
+  /**
+   * The index of the ring or path in the feature's geometry that contains the vertex.
+   *
+   * @experimental
+   */
   pathIndex: number;
-  /** The index of the vertex in the ring or path. */
+  /**
+   * The index of the vertex in the ring or path.
+   *
+   * @experimental
+   */
   vertexIndex: number;
 }
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface ConnectedReshapeProviderFactory {
-  /** Called at the start a reshape operation involving one or more whole features. Should return a `ConnectedReshapeProvider` that will provide information about features connected to this feature(s) during the reshape operation. */
+  /**
+   * Called at the start a reshape operation involving one or more whole features. Should return a `ConnectedReshapeProvider` that will provide information about features connected to this feature(s) during the reshape operation.
+   *
+   * @experimental
+   */
   getFeatureReshapeProvider: GetFeatureReshapeProvider;
-  /** Called at the start of a reshape operation involving one or more vertices of a feature. Should return a `ConnectedReshapeProvider` that will provide information about features connected to this vertex(es) during the reshape operation. */
+  /**
+   * Called at the start of a reshape operation involving one or more vertices of a feature. Should return a `ConnectedReshapeProvider` that will provide information about features connected to this vertex(es) during the reshape operation.
+   *
+   * @experimental
+   */
   getVertexReshapeProvider: GetVertexReshapeProvider;
 }
 
 /**
  * @param features - The features being reshaped.
  * @returns The connected reshape provider for the features.
+ * @experimental
  * @internal
  */
 export type GetFeatureReshapeProvider = (features: ReshapeFeature[]) => ConnectedReshapeProvider | null | undefined;
@@ -162,6 +277,7 @@ export type GetFeatureReshapeProvider = (features: ReshapeFeature[]) => Connecte
  * @param feature - The feature being reshaped.
  * @param vertices - The vertices of the feature being reshaped.
  * @returns The connected reshape provider for the feature.
+ * @experimental
  * @internal
  */
 export type GetVertexReshapeProvider = (feature: ReshapeFeature, vertices: VertexInfo[]) => ConnectedReshapeProvider | null | undefined;

package/applications/KnowledgeStudio/resourceSerializationUtils.d.ts

@@ -1,5 +1,5 @@
 /**
- * @beta
+ * @experimental
  * @since 4.32
  * @internal
  */
@@ -7,15 +7,21 @@ import type KnowledgeGraph from "../../rest/knowledgeGraph/KnowledgeGraph.js";
 import type { AbortOptions } from "../../core/promiseUtils.js";
 import type { InclusionListDefinition } from "../../layers/knowledgeGraph/KnowledgeGraphLayerDataManager.js";
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface SerializedResourceURLs {
+  /** @experimental */
   entitiesUrl?: string | null;
+  /** @experimental */
   relationshipsUrl?: string | null;
 }
 
 /**
  * @param serializedResourceURLs
  * @param options
+ * @experimental
  * @internal
  */
 export function fetchAndConvertSerializedLinkChart(serializedResourceURLs: SerializedResourceURLs, options?: AbortOptions): Promise<InclusionListDefinition>;
@@ -24,13 +30,19 @@ export function fetchAndConvertSerializedLinkChart(serializedResourceURLs: Seria
  * @param idCollectionsUrl
  * @param generateAllSublayers
  * @param options
+ * @experimental
  * @internal
  */
 export function fetchAndConvertSerializedKnowledgeIdMap(idCollectionsUrl: string, generateAllSublayers?: boolean, options?: AbortOptions): Promise<InclusionListDefinition>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface SerializedFeatureCollections {
+  /** @experimental */
   entitiesFC: Uint8Array<ArrayBuffer>;
+  /** @experimental */
   relationshipsFC: Uint8Array<ArrayBuffer>;
 }
 
@@ -38,6 +50,7 @@ export interface SerializedFeatureCollections {
  * @param inclusionDefinition
  * @param kg
  * @param endpointMap
+ * @experimental
  * @internal
  */
 export function serializeInclusionDefinitionToAllPbf(inclusionDefinition: InclusionListDefinition, kg: KnowledgeGraph, endpointMap: Map<string, [
@@ -47,6 +60,7 @@ export function serializeInclusionDefinitionToAllPbf(inclusionDefinition: Inclus
 
 /**
  * @param inclusionDefinition
+ * @experimental
  * @internal
  */
 export function serializeInclusionDefinitionToIdCollectionsMapPbf(inclusionDefinition: InclusionListDefinition): Promise<Uint8Array<ArrayBuffer>>;

package/applications/MapViewer/layerUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * General layer utilities for the map viewer application.
  *
+ * @experimental
  * @internal
  */
 import type Layer from "../../layers/Layer.js";
@@ -11,6 +12,7 @@ import type { FeatureLayerBase } from "../../layers/mixins/FeatureLayerBase.js";
  * advertised in its metadata via `preferredHost` property.
  *
  * @param layer - The layer to check.
+ * @experimental
  * @internal
  */
 export function isUrlHostModified(layer: Layer & Partial<FeatureLayerBase>): boolean;

package/applications/MapViewer/mediaUtils.d.ts

@@ -1,12 +1,13 @@
 /**
  * Media layer utilities for the map viewer application.
  *
+ * @experimental
  * @internal
  */
 import type Extent from "../../geometry/Extent.js";
 import type ControlPointsGeoreference from "../../layers/support/ControlPointsGeoreference.js";
 import type MapView from "../../views/MapView.js";
-import type { MediaElement } from "../../layers/support/media.js";
+import type { MediaElement } from "../../layers/media/types.js";
 
 /**
  * Creates a georeference for a media element and a view extent.
@@ -14,6 +15,7 @@ import type { MediaElement } from "../../layers/support/media.js";
  * @param mediaElement - The media element to create the georeference for.
  * @param extent - The view extent in which fits the georeference.
  * @returns The georeference fitting in the view extent.
+ * @experimental
  * @internal
  */
 export function createDefaultControlPointsGeoreference(mediaElement: MediaElement, extent: Extent): Promise<ControlPointsGeoreference>;
@@ -24,6 +26,7 @@ export function createDefaultControlPointsGeoreference(mediaElement: MediaElemen
  *
  * @param mediaElement - The media element to create the georeference for.
  * @returns A georeference with map points in pixels.
+ * @experimental
  * @internal
  */
 export function createLocalModeControlPointsGeoreference(mediaElement: MediaElement): ControlPointsGeoreference | null | undefined;
@@ -33,6 +36,7 @@ export function createLocalModeControlPointsGeoreference(mediaElement: MediaElem
  *
  * @param properties - Properties
  * @returns A MediaTransformToolsWrapper instance or nil.
+ * @experimental
  * @internal
  */
 export function createMediaTransformToolsWrapper(properties: MediaTransformToolsWrapperProperties): any | null | undefined;
@@ -40,29 +44,59 @@ export function createMediaTransformToolsWrapper(properties: MediaTransformTools
 /**
  * MediaTransformToolsWrapperConstructProperties
  *
+ * @experimental
  * @internal
  */
 export interface MediaTransformToolsWrapperProperties {
-  /** The advanced mode view and media element */
+  /**
+   * The advanced mode view and media element
+   *
+   * @experimental
+   */
   advancedMode: AdvancedMediaTransformToolsWrapperProperties;
-  /** The ImageElement or VideoElement */
+  /**
+   * The ImageElement or VideoElement
+   *
+   * @experimental
+   */
   mediaElement: MediaElement;
-  /** Whether or not to preserve the aspect ration */
+  /**
+   * Whether or not to preserve the aspect ration
+   *
+   * @experimental
+   */
   preserveAspectRatio?: boolean | null;
-  /** Should snapping be enabled for rotation? */
+  /**
+   * Should snapping be enabled for rotation?
+   *
+   * @experimental
+   */
   snapRotation?: boolean | null;
-  /** The MapView instance */
+  /**
+   * The MapView instance
+   *
+   * @experimental
+   */
   view: MapView;
 }
 
 /**
  * AdvancedMediaTransformToolsWrapperConstructProperties
  *
+ * @experimental
  * @internal
  */
 export interface AdvancedMediaTransformToolsWrapperProperties {
-  /** The advanced mode ImageElement or VideoElement */
+  /**
+   * The advanced mode ImageElement or VideoElement
+   *
+   * @experimental
+   */
   mediaElement: MediaElement;
-  /** The advanced mode MapView instance */
+  /**
+   * The advanced mode MapView instance
+   *
+   * @experimental
+   */
   view: MapView;
 }

package/applications/MapViewer/templateUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Table template utilities for the map viewer application.
  *
+ * @experimental
  * @internal
  */
 import type CSVLayer from "../../layers/CSVLayer.js";
@@ -14,7 +15,7 @@ import type KnowledgeGraphSublayer from "../../layers/knowledgeGraph/KnowledgeGr
 import type AttributeTableTemplate from "../../tables/AttributeTableTemplate.js";
 import type TableTemplate from "../../widgets/FeatureTable/support/TableTemplate.js";
 import type FeatureTable from "../../widgets/FeatureTable.js";
-import type { Type as FieldType } from "../../layers/support/fieldType.js";
+import type { FieldType } from "../../layers/support/types.js";
 import type { FeatureTableSupportedLayer } from "../../widgets/FeatureTable/support/types.js";
 
 /**
@@ -25,6 +26,7 @@ import type { FeatureTableSupportedLayer } from "../../widgets/FeatureTable/supp
  * @param template - Template to update with the provided table.
  * @param includeHiddenColumns - Indicates hidden columns should be included in orderByFields (defaults to true).
  * @returns The updated template.
+ * @experimental
  * @internal
  */
 export function syncAttributeTableTemplate(table: FeatureTable, template: AttributeTableTemplate, includeHiddenColumns?: boolean): AttributeTableTemplate;
@@ -37,19 +39,39 @@ export function syncAttributeTableTemplate(table: FeatureTable, template: Attrib
  *
  * @param options - Method parameters.
  * @returns Newly generated AttributeTableTemplate.
+ * @experimental
  * @internal
  */
 export function createDefaultAttributeTableTemplateFromLayer(options: CreateDefaultAttributeTableTemplateFromLayerOptions): Promise<AttributeTableTemplate>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface CreateDefaultAttributeTableTemplateFromLayerOptions {
-  /** Indicates 'attachment' columns should be excluded. */
+  /**
+   * Indicates 'attachment' columns should be excluded.
+   *
+   * @experimental
+   */
   excludeAttachments?: boolean;
-  /** Indicates field types that should be excluded. Defaults to: ["geometry", "blob", "raster", "guid", "xml"]. */
+  /**
+   * Indicates field types that should be excluded. Defaults to: ["geometry", "blob", "raster", "guid", "xml"].
+   *
+   * @experimental
+   */
   excludedFieldTypesOverride?: FieldType[];
-  /** Indicates 'relationship' columns should be excluded. */
+  /**
+   * Indicates 'relationship' columns should be excluded.
+   *
+   * @experimental
+   */
   excludeRelationships?: boolean;
-  /** Layer from which to generate a default template. */
+  /**
+   * Layer from which to generate a default template.
+   *
+   * @experimental
+   */
   layer: CatalogFootprintLayer | CSVLayer | FeatureLayer | GeoJSONLayer | ImageryLayer | KnowledgeGraphSublayer | SceneLayer | WFSLayer;
 }
 
@@ -61,19 +83,39 @@ export interface CreateDefaultAttributeTableTemplateFromLayerOptions {
  *
  * @param options - Method parameters.
  * @returns Newly generated TableTemplate.
+ * @experimental
  * @internal
  */
 export function createDefaultTableTemplateFromLayer(options: CreateDefaultTableTemplateFromLayerOptions): Promise<TableTemplate>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface CreateDefaultTableTemplateFromLayerOptions {
-  /** Indicates 'attachment' columns should be excluded. */
+  /**
+   * Indicates 'attachment' columns should be excluded.
+   *
+   * @experimental
+   */
   excludeAttachments?: boolean;
-  /** Indicates field types that should be excluded. Defaults to: ["geometry", "blob", "raster", "guid", "xml"]. */
+  /**
+   * Indicates field types that should be excluded. Defaults to: ["geometry", "blob", "raster", "guid", "xml"].
+   *
+   * @experimental
+   */
   excludedFieldTypesOverride?: FieldType[];
-  /** Indicates 'relationship' columns should be excluded. */
+  /**
+   * Indicates 'relationship' columns should be excluded.
+   *
+   * @experimental
+   */
   excludeRelationships?: boolean;
-  /** Layer from which to generate a default template. */
+  /**
+   * Layer from which to generate a default template.
+   *
+   * @experimental
+   */
   layer: FeatureTableSupportedLayer;
 }
 
@@ -86,18 +128,38 @@ export interface CreateDefaultTableTemplateFromLayerOptions {
  *
  * @param parameters - Method parameters.
  * @returns Newly generated TableTemplate.
+ * @experimental
  * @internal
  */
 export function createTableTemplateFromAttributeTableTemplate(parameters: CreateTableTemplateFromAttributeTableTemplateParameters): Promise<TableTemplate>;
 
-/** @internal */
+/**
+ * @experimental
+ * @internal
+ */
 export interface CreateTableTemplateFromAttributeTableTemplateParameters {
-  /** Indicates field types that should be excluded. Defaults to: ["geometry", "blob", "raster", "guid", "xml"]. */
+  /**
+   * Indicates field types that should be excluded. Defaults to: ["geometry", "blob", "raster", "guid", "xml"].
+   *
+   * @experimental
+   */
   excludedFieldTypesOverride?: FieldType[];
-  /** Indicates columns should be generated for fields without associated elements. */
+  /**
+   * Indicates columns should be generated for fields without associated elements.
+   *
+   * @experimental
+   */
   includeHiddenFields?: boolean;
-  /** Layer from which to generate a default template. */
+  /**
+   * Layer from which to generate a default template.
+   *
+   * @experimental
+   */
   layer: FeatureTableSupportedLayer;
-  /** Instance of an AttributeTableTemplate used to configure a new TableTemplate. */
+  /**
+   * Instance of an AttributeTableTemplate used to configure a new TableTemplate.
+   *
+   * @experimental
+   */
   template: AttributeTableTemplate;
 }

package/applications/PortalApp/layerUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * General layer utilities for the portal application.
  *
+ * @experimental
  * @internal
  */
 import type FeatureLayer from "../../layers/FeatureLayer.js";
@@ -10,6 +11,7 @@ import type FeatureLayer from "../../layers/FeatureLayer.js";
  *
  * @param layer - The layer to check.
  * @returns `true` if the layer supports field configuration, `false` otherwise.
+ * @experimental
  * @internal
  */
 export function supportsFieldConfiguration(layer: unknown): layer is FeatureLayer;

package/applications/SceneViewer/colorUtils.d.ts

@@ -1,6 +1,7 @@
 /**
  * Color utilities for the Scene Viewer application.
  *
+ * @experimental
  * @internal
  */
 import type Color from "../../Color.js";
@@ -11,6 +12,7 @@ import type Color from "../../Color.js";
  *
  * @param color - Color
  * @returns `true` if color is bright
+ * @experimental
  * @internal
  */
 export function isBright(color: Color): boolean;