@arcgis/core 5.1.0-next.101 → 5.1.0-next.102

package/layers/support/SubtypeSublayer.d.ts

@@ -5,6 +5,7 @@ import type SpatialReference from "../../geometry/SpatialReference.js";
 import type SubtypeGroupLayer from "../SubtypeGroupLayer.js";
 import type FeatureTemplate from "./FeatureTemplate.js";
 import type Field from "./Field.js";
+import type FieldConfiguration from "./FieldConfiguration.js";
 import type FieldsIndex from "./FieldsIndex.js";
 import type LabelClass from "./LabelClass.js";
 import type Relationship from "./Relationship.js";
@@ -29,6 +30,7 @@ import type { QueryProperties } from "../../rest/support/Query.js";
 import type { RelationshipQueryProperties } from "../../rest/support/RelationshipQuery.js";
 import type { CreatePopupTemplateOptions } from "../../support/popupUtils.js";
 import type { AttributeTableTemplateProperties } from "../../tables/AttributeTableTemplate.js";
+import type { FieldConfigurationProperties } from "./FieldConfiguration.js";
 import type { FormTemplateProperties } from "../../form/FormTemplate.js";
 import type { LabelClassProperties } from "./LabelClass.js";
 import type { PopupTemplateProperties } from "../../PopupTemplate.js";
@@ -48,6 +50,58 @@ export interface SubtypeSublayerProperties extends LoadableMixinProperties, Iden
    * @since 4.31
    */
   attributeTableTemplate?: AttributeTableTemplateProperties | null;
+  /**
+   * An array of [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) objects that control how fields are displayed in popups and other UI elements. Each object specifies options for an individual field, such as its display name, via `alias`, and formatting rules, via `fieldFormat`. Assign this property before the layer loads to ensure the configurations take effect. For more information, see the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) documentation.
+   * If no field configurations are provided, they are automatically created when a [popupTemplate](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#popupTemplate) is assigned to the layer. If no [popupTemplate](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#popupTemplate) is set, you can manually define field configurations to customize how fields are shown.
+   * > [!WARNING]
+   * >
+   * > Support is limited in version 5.1. For details, see the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) documentation.
+   *
+   * To modify field configurations, clone [fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations), make the changes, and then reassign the updated clone back to [fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations).
+   *
+   * @since 5.1
+   * @see [SubtypeSublayer.getFieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#getFieldConfiguration)
+   * @see [SubtypeSublayer.getFieldAlias](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#getFieldAlias)
+   * @example
+   * // Adding a new field configuration
+   * const addNewConfig = (layer, fieldName, alias, fieldFormat) => {
+   *   // Check if there is already an existing configuration for fieldName
+   *   const existingConfig = layer.getFieldConfiguration(fieldName);
+   *   if (!existingConfig) {
+   *     const newConfig = new FieldConfiguration({ name: fieldName, alias, fieldFormat });
+   *     const newConfigs = clone(layer.fieldConfigurations);
+   *     newConfigs.push(newConfig);
+   *     layer.fieldConfigurations = newConfigs;
+   *   }
+   * };
+   * @example
+   * // Updating an existing field configuration
+   * const updateConfig = (layer, fieldName, alias, fieldFormat) => {
+   *   const existingConfig = layer.getFieldConfiguration(fieldName);
+   *   if (existingConfig) {
+   *     const newConfig = existingConfig.clone();
+   *     newConfig.alias = alias;
+   *     newConfig.fieldFormat = fieldFormat;
+   *
+   *     const index = layer.fieldConfigurations.indexOf(existingConfig);
+   *     const newConfigs = clone(layer.fieldConfigurations);
+   *     newConfigs[index] = newConfig;
+   *     layer.fieldConfigurations = newConfigs;
+   *   }
+   * };
+   * @example
+   * // Deleting an existing field configuration
+   * const deleteConfig = (layer, fieldName) => {
+   *   const existingConfig = layer.getFieldConfiguration(fieldName);
+   *   if (existingConfig) {
+   *     const index = layer.fieldConfigurations.indexOf(existingConfig);
+   *     var newConfigs = clone(layer.fieldConfigurations);
+   *     newConfigs.splice(index, 1);
+   *     layer.fieldConfigurations = newConfigs;
+   *   }
+   * };
+   */
+  fieldConfigurations?: FieldConfigurationProperties[] | null;
   /**
    * The [template](https://developers.arcgis.com/javascript/latest/references/core/form/FormTemplate/) used in an associated layer's [FeatureForm](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/). All of the properties and field configurations set on the layer's [FeatureForm](https://developers.arcgis.com/javascript/latest/references/core/widgets/FeatureForm/) are handled via the [FormTemplate](https://developers.arcgis.com/javascript/latest/references/core/form/FormTemplate/).
    *
@@ -230,6 +284,59 @@ export default class SubtypeSublayer extends SubtypeSublayerSuperclass {
    * @since 4.26
    */
   get effectiveEditingEnabled(): boolean;
+  /**
+   * An array of [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) objects that control how fields are displayed in popups and other UI elements. Each object specifies options for an individual field, such as its display name, via `alias`, and formatting rules, via `fieldFormat`. Assign this property before the layer loads to ensure the configurations take effect. For more information, see the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) documentation.
+   * If no field configurations are provided, they are automatically created when a [popupTemplate](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#popupTemplate) is assigned to the layer. If no [popupTemplate](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#popupTemplate) is set, you can manually define field configurations to customize how fields are shown.
+   * > [!WARNING]
+   * >
+   * > Support is limited in version 5.1. For details, see the [FieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) documentation.
+   *
+   * To modify field configurations, clone [fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations), make the changes, and then reassign the updated clone back to [fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations).
+   *
+   * @since 5.1
+   * @see [SubtypeSublayer.getFieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#getFieldConfiguration)
+   * @see [SubtypeSublayer.getFieldAlias](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#getFieldAlias)
+   * @example
+   * // Adding a new field configuration
+   * const addNewConfig = (layer, fieldName, alias, fieldFormat) => {
+   *   // Check if there is already an existing configuration for fieldName
+   *   const existingConfig = layer.getFieldConfiguration(fieldName);
+   *   if (!existingConfig) {
+   *     const newConfig = new FieldConfiguration({ name: fieldName, alias, fieldFormat });
+   *     const newConfigs = clone(layer.fieldConfigurations);
+   *     newConfigs.push(newConfig);
+   *     layer.fieldConfigurations = newConfigs;
+   *   }
+   * };
+   * @example
+   * // Updating an existing field configuration
+   * const updateConfig = (layer, fieldName, alias, fieldFormat) => {
+   *   const existingConfig = layer.getFieldConfiguration(fieldName);
+   *   if (existingConfig) {
+   *     const newConfig = existingConfig.clone();
+   *     newConfig.alias = alias;
+   *     newConfig.fieldFormat = fieldFormat;
+   *
+   *     const index = layer.fieldConfigurations.indexOf(existingConfig);
+   *     const newConfigs = clone(layer.fieldConfigurations);
+   *     newConfigs[index] = newConfig;
+   *     layer.fieldConfigurations = newConfigs;
+   *   }
+   * };
+   * @example
+   * // Deleting an existing field configuration
+   * const deleteConfig = (layer, fieldName) => {
+   *   const existingConfig = layer.getFieldConfiguration(fieldName);
+   *   if (existingConfig) {
+   *     const index = layer.fieldConfigurations.indexOf(existingConfig);
+   *     var newConfigs = clone(layer.fieldConfigurations);
+   *     newConfigs.splice(index, 1);
+   *     layer.fieldConfigurations = newConfigs;
+   *   }
+   * };
+   */
+  get fieldConfigurations(): FieldConfiguration[] | null | undefined;
+  set fieldConfigurations(value: FieldConfigurationProperties[] | null | undefined);
   /**
    * An array of fields in the layer. Each field represents an attribute
    * that may contain a value for each feature in the layer. For example,
@@ -638,6 +745,19 @@ export default class SubtypeSublayer extends SubtypeSublayerSuperclass {
    * }
    */
   applyEdits(edits: Edits, options?: EditOptions): Promise<EditsResult>;
+  /**
+   * Creates default field configuration objects that define the display properties of fields.
+   * These field configurations are generated from the layer's [fields](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fields) property.
+   *
+   * @returns An array of field configuration objects, or `null` if the layer does not have any fields that require formatting.
+   * @since 5.1
+   * @see [SubtypeSublayer.fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations)
+   * @returns An array of field configuration objects, or `null` if the layer does not have any fields that require formatting.
+   * @example
+   * const fieldConfigs = layer.createFieldConfigurations();
+   * layer.fieldConfigurations = fieldConfigs;
+   */
+  createFieldConfigurations(): FieldConfiguration[] | null | undefined;
   /**
    * Creates a popup template for the layer, populated with all the fields of the layer.
    *
@@ -708,6 +828,33 @@ export default class SubtypeSublayer extends SubtypeSublayerSuperclass {
    * @see [fields](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fields)
    */
   getField(fieldName: string): Field | null | undefined;
+  /**
+   * Returns the alias of the specified field. Previously, this value was commonly retrieved from [Layer.popupTemplate.fieldInfos[x].label](https://developers.arcgis.com/javascript/latest/references/core/popup/FieldInfo/#label) or [Layer.fields[x].alias](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Field/#alias). While these properties are still supported, this method is now the recommended approach for obtaining a field's alias.
+   *
+   * The alias is resolved in the following order:
+   *
+   * 1. [Field configuration alias](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations)
+   * 2. [Field alias](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fields) defined on the field.
+   *
+   * @param fieldName - The name of the field for which to get the alias.
+   * @returns The alias of the specified field.
+   * @since 5.1
+   * @see [SubtypeSublayer.fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations)
+   * @see [SubtypeSublayer.getFieldConfiguration](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#getFieldConfiguration)
+   */
+  getFieldAlias(fieldName: string): string | null | undefined;
+  /**
+   * Returns the [FieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/) for the specified field. The field configuration provides optional formatting and display information for the field.
+   *
+   * Previously, field formatting was commonly retrieved from [Layer.popupTemplate.fieldInfos[x].format](https://developers.arcgis.com/javascript/latest/references/core/popup/FieldInfo/#format). This is no longer needed, instead use [Layer.getFieldConfiguration(fieldname).fieldFormat](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FieldConfiguration/#fieldFormat) to retrieve the field configuration formatting.
+   *
+   * @param fieldName - The name of the field for which to get the configuration.
+   * @returns The field configuration of the specified field.
+   * @since 5.1
+   * @see [SubtypeSublayer.fieldConfigurations](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#fieldConfigurations)
+   * @see [SubtypeSublayer.getFieldAlias](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/#getFieldAlias)
+   */
+  getFieldConfiguration(fieldName: string): FieldConfiguration | null | undefined;
   /**
    * Returns the [Domain](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Domain/) associated with the given field name. The domain can be either a
    * [CodedValueDomain](https://developers.arcgis.com/javascript/latest/references/core/layers/support/CodedValueDomain/) or [RangeDomain](https://developers.arcgis.com/javascript/latest/references/core/layers/support/RangeDomain/).

package/layers/support/TelemetryData.d.ts

@@ -16,6 +16,8 @@ export interface TelemetryDataProperties {
   lineOfSight?: PolylineProperties | null;
   /** The location of the sensor. */
   sensorLocation?: PointProperties | null;
+  /** The path that the moving sensor follows through the duration of the video collection. */
+  sensorPath?: PolylineProperties | null;
   /** The trail of the sensor. */
   sensorTrail?: PolylineProperties | null;
 }
@@ -41,6 +43,9 @@ export default class TelemetryData extends TelemetryDataSuperclass {
   /** The location of the sensor. */
   get sensorLocation(): Point | null | undefined;
   set sensorLocation(value: PointProperties | null | undefined);
+  /** The path that the moving sensor follows through the duration of the video collection. */
+  get sensorPath(): Polyline | null | undefined;
+  set sensorPath(value: PolylineProperties | null | undefined);
   /** The trail of the sensor. */
   get sensorTrail(): Polyline | null | undefined;
   set sensorTrail(value: PolylineProperties | null | undefined);

package/layers/support/TelemetryData.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{__decorate as o}from"tslib";import{ClonableMixin as t}from"../../core/Clonable.js";import{JSONSupport as e}from"../../core/JSONSupport.js";import{property as r,subclass as s}from"../../core/accessorSupport/decorators.js";import i from"../../geometry/Point.js";import p from"../../geometry/Polygon.js";import l from"../../geometry/Polyline.js";let n=class extends(t(e)){constructor(o){super(o),this.frameCenter=null,this.frameOutline=null,this.lineOfSight=null,this.sensorLocation=null,this.sensorTrail=null}};o([r({type:i})],n.prototype,"frameCenter",void 0),o([r({type:p})],n.prototype,"frameOutline",void 0),o([r({type:l})],n.prototype,"lineOfSight",void 0),o([r({type:i})],n.prototype,"sensorLocation",void 0),o([r({type:l})],n.prototype,"sensorTrail",void 0),n=o([s("esri.layers.support.TelemetryData")],n);export{n as default};
+import{__decorate as o}from"tslib";import{ClonableMixin as t}from"../../core/Clonable.js";import{JSONSupport as e}from"../../core/JSONSupport.js";import{property as r,subclass as s}from"../../core/accessorSupport/decorators.js";import i from"../../geometry/Point.js";import p from"../../geometry/Polygon.js";import l from"../../geometry/Polyline.js";let n=class extends(t(e)){constructor(o){super(o),this.frameCenter=null,this.frameOutline=null,this.lineOfSight=null,this.sensorLocation=null,this.sensorPath=null,this.sensorTrail=null}};o([r({type:i})],n.prototype,"frameCenter",void 0),o([r({type:p})],n.prototype,"frameOutline",void 0),o([r({type:l})],n.prototype,"lineOfSight",void 0),o([r({type:i})],n.prototype,"sensorLocation",void 0),o([r({type:l})],n.prototype,"sensorPath",void 0),o([r({type:l})],n.prototype,"sensorTrail",void 0),n=o([s("esri.layers.support.TelemetryData")],n);export{n as default};

package/layers/support/TelemetryDisplay.d.ts

@@ -1,11 +1,12 @@
 import type { ClonableMixin } from "../../core/Clonable.js";
 import type { JSONSupport } from "../../core/JSONSupport.js";
 
-export interface TelemetryDisplayProperties extends Partial<Pick<TelemetryDisplay, "frame" | "frameCenter" | "frameOutline" | "lineOfSight" | "sensorLocation" | "sensorTrail">> {}
+export interface TelemetryDisplayProperties extends Partial<Pick<TelemetryDisplay, "frame" | "frameCenter" | "frameOutline" | "lineOfSight" | "sensorLocation" | "sensorPath" | "sensorTrail">> {}
 
 /**
  * The TelemetryDisplay class is used to choose what telemetry data to display on the map.
- * The class contains options for the frame center, frame outline, line of sight, sensor location, and sensor trail.
+ * The class contains options for the frame center, frame outline, line of sight, sensor location,
+ * sensor path and sensor trail.
  *
  * @since 4.30
  * @see [VideoLayer.telemetryDisplay](https://developers.arcgis.com/javascript/latest/references/core/layers/VideoLayer/#telemetryDisplay)
@@ -42,6 +43,13 @@ export default class TelemetryDisplay extends TelemetryDisplaySuperclass {
    * @default true
    */
   accessor sensorLocation: boolean;
+  /**
+   * Determines if the sensor path is displayed.
+   *
+   * @default true
+   * @since 5.1
+   */
+  accessor sensorPath: boolean;
   /**
    * Determines if the sensor trail is displayed.
    *

package/layers/support/TelemetryDisplay.js

@@ -1,2 +1,2 @@
 /* COPYRIGHT Esri - https://js.arcgis.com/5.1/LICENSE.txt */
-import{__decorate as o}from"tslib";import{ClonableMixin as r}from"../../core/Clonable.js";import{JSONSupport as t}from"../../core/JSONSupport.js";import{property as e,subclass as s}from"../../core/accessorSupport/decorators.js";const i={type:Boolean,json:{write:!0}};let p=class extends(r(t)){constructor(o){super(o),this.frame=!1,this.frameCenter=!1,this.frameOutline=!0,this.lineOfSight=!0,this.sensorLocation=!0,this.sensorTrail=!0}};o([e(i)],p.prototype,"frame",void 0),o([e(i)],p.prototype,"frameCenter",void 0),o([e(i)],p.prototype,"frameOutline",void 0),o([e(i)],p.prototype,"lineOfSight",void 0),o([e(i)],p.prototype,"sensorLocation",void 0),o([e(i)],p.prototype,"sensorTrail",void 0),p=o([s("esri.layers.support.TelemetryDisplay")],p);export{p as default};
+import{__decorate as o}from"tslib";import{ClonableMixin as t}from"../../core/Clonable.js";import{JSONSupport as r}from"../../core/JSONSupport.js";import{property as e,subclass as s}from"../../core/accessorSupport/decorators.js";const i={type:Boolean,json:{write:!0}};let p=class extends(t(r)){constructor(o){super(o),this.frame=!1,this.frameCenter=!1,this.frameOutline=!0,this.lineOfSight=!0,this.sensorLocation=!0,this.sensorPath=!0,this.sensorTrail=!0}};o([e(i)],p.prototype,"frame",void 0),o([e(i)],p.prototype,"frameCenter",void 0),o([e(i)],p.prototype,"frameOutline",void 0),o([e(i)],p.prototype,"lineOfSight",void 0),o([e(i)],p.prototype,"sensorLocation",void 0),o([e(i)],p.prototype,"sensorPath",void 0),o([e(i)],p.prototype,"sensorTrail",void 0),p=o([s("esri.layers.support.TelemetryDisplay")],p);export{p as default};