@arcgis/core 5.2.0-next.162 → 5.2.0-next.164

package/layers/SceneLayer.d.ts

@@ -266,21 +266,33 @@ export interface SceneLayerProperties extends LayerProperties, APIKeyMixinProper
    */
   timeExtent?: TimeExtentProperties | null;
   /**
-   * TimeInfo provides information such as date fields that store
-   * [start](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField)
-   * and [end](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField) time
-   * for each feature and the [TimeInfo.fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent)
-   * for the layer.
+   * Defines temporal information for a layer, such as [start](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField) and [end](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField)
+   * date fields used to track when features remain visible, as well as the layer's [full time extent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent).
+   * If `timeInfo` is configured on the underlying service, it is automatically read and used by the layer.
    *
-   * If timeInfo configuration exists on the service it gets read and used from there. A developer
-   * can overwrite or create a timeInfo configuration on initialization.
-   * The timeInfo parameters cannot be changed after the layer is [loaded](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/#load).
+   * The `timeInfo` property can be set or overridden in the scene layer constructor or at runtime.
+   * When overriding `timeInfo`, ensure that `startField` and `endField` correspond to valid date fields in the layer's schema.
+   * To calculate a `fullTimeExtent` that covers all dates in the configured `startField` and `endField`, call
+   * the [getTimeExtentFromLayers()](https://developers.arcgis.com/javascript/latest/references/core/support/timeUtils/#getTimeExtentFromLayers) function. Then assign the result to `layer.timeInfo.fullTimeExtent`.
    *
    * TimeInfo's [startField](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField) and [endField](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField)
    * can be `date`, `date-only` or `timestamp-offset` [field type](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Field/#type) for [SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/)
    * and [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingComponentSublayer/).
    *
    * @since 4.30
+   * @example
+   * // update layer's timeInfo at runtime
+   * sceneLayer.timeInfo = {
+   *   startField: "DateField",
+   *   timeZone: "UTC"
+   * };
+   *
+   * // calculate the fullTimeExtent based on startField
+   * const fullTimeExtent = getTimeExtentFromLayers([sceneLayer]);
+   * sceneLayer.timeInfo.fullTimeExtent = fullTimeExtent;
+   * @example
+   * // set layer's timeInfo to null
+   * sceneLayer.timeInfo = null;
    */
   timeInfo?: TimeInfoProperties | null;
   /**
@@ -1043,21 +1055,33 @@ export default class SceneLayer extends SceneLayerSuperclass {
   get timeExtent(): TimeExtent | null | undefined;
   set timeExtent(value: TimeExtentProperties | null | undefined);
   /**
-   * TimeInfo provides information such as date fields that store
-   * [start](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField)
-   * and [end](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField) time
-   * for each feature and the [TimeInfo.fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent)
-   * for the layer.
+   * Defines temporal information for a layer, such as [start](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField) and [end](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField)
+   * date fields used to track when features remain visible, as well as the layer's [full time extent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent).
+   * If `timeInfo` is configured on the underlying service, it is automatically read and used by the layer.
    *
-   * If timeInfo configuration exists on the service it gets read and used from there. A developer
-   * can overwrite or create a timeInfo configuration on initialization.
-   * The timeInfo parameters cannot be changed after the layer is [loaded](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/#load).
+   * The `timeInfo` property can be set or overridden in the scene layer constructor or at runtime.
+   * When overriding `timeInfo`, ensure that `startField` and `endField` correspond to valid date fields in the layer's schema.
+   * To calculate a `fullTimeExtent` that covers all dates in the configured `startField` and `endField`, call
+   * the [getTimeExtentFromLayers()](https://developers.arcgis.com/javascript/latest/references/core/support/timeUtils/#getTimeExtentFromLayers) function. Then assign the result to `layer.timeInfo.fullTimeExtent`.
    *
    * TimeInfo's [startField](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField) and [endField](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField)
    * can be `date`, `date-only` or `timestamp-offset` [field type](https://developers.arcgis.com/javascript/latest/references/core/layers/support/Field/#type) for [SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/)
    * and [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/buildingSublayers/BuildingComponentSublayer/).
    *
    * @since 4.30
+   * @example
+   * // update layer's timeInfo at runtime
+   * sceneLayer.timeInfo = {
+   *   startField: "DateField",
+   *   timeZone: "UTC"
+   * };
+   *
+   * // calculate the fullTimeExtent based on startField
+   * const fullTimeExtent = getTimeExtentFromLayers([sceneLayer]);
+   * sceneLayer.timeInfo.fullTimeExtent = fullTimeExtent;
+   * @example
+   * // set layer's timeInfo to null
+   * sceneLayer.timeInfo = null;
    */
   get timeInfo(): TimeInfo | null | undefined;
   set timeInfo(value: TimeInfoProperties | null | undefined);

package/layers/SubtypeGroupLayer.d.ts

@@ -5,6 +5,7 @@ import type Layer from "./Layer.js";
 import type Field from "./support/Field.js";
 import type SubtypeSublayer from "./support/SubtypeSublayer.js";
 import type PortalItem from "../portal/PortalItem.js";
+import type DynamicWorkspaceLayer from "../rest/layerSources/DynamicWorkspaceLayer.js";
 import type AttachmentInfo from "../rest/query/support/AttachmentInfo.js";
 import type FeatureSet from "../rest/support/FeatureSet.js";
 import type Query from "../rest/support/Query.js";
@@ -30,10 +31,41 @@ import type { RequestOptions } from "../request/types.js";
 import type { AttachmentQueryProperties } from "../rest/support/AttachmentQuery.js";
 import type { QueryProperties } from "../rest/support/Query.js";
 import type { RelationshipQueryProperties } from "../rest/support/RelationshipQuery.js";
+import type { DynamicWorkspaceLayerProperties } from "../rest/layerSources/DynamicWorkspaceLayer.js";
 import type { SubtypeSublayerProperties } from "./support/SubtypeSublayer.js";
 import type { ReadonlyArrayOrCollection } from "../core/Collection.js";
 
 export interface SubtypeGroupLayerProperties extends LayerProperties, APIKeyMixinProperties, CustomParametersMixinProperties, PortalLayerProperties, OperationalLayerProperties, RefreshableLayerProperties, ScaleRangeLayerProperties, TemporalLayerProperties, BlendLayerProperties, DisplayFilteredLayerProperties, FeatureLayerBaseProperties, Partial<Pick<SubtypeGroupLayer, "outFields">> {
+  /**
+   * A dynamic workspace source that identifies a pre-authored ArcGIS Pro layer file (`.lyrx`) in a registered workspace.
+   * Set this property instead of `layerId` to use the workspace layer as the data source for this SubtypeGroupLayer.
+   * The map service must have dynamic layers enabled, and the workspace layer must have a subtype field.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > A SubtypeGroupLayer with a `dynamicDataSource` cannot be persisted to web maps, web scenes, or portal items.
+   *
+   * @internal
+   * @beta
+   * @since 5.2
+   * @see [DynamicWorkspaceLayer](https://developers.arcgis.com/javascript/latest/references/core/rest/layerSources/DynamicWorkspaceLayer/)
+   * @example
+   * ```js
+   * const DynamicWorkspaceLayer = await $arcgis.import("@arcgis/core/rest/layerSources/DynamicWorkspaceLayer.js");
+   * const SubtypeGroupLayer = await $arcgis.import("@arcgis/core/layers/SubtypeGroupLayer.js");
+   *
+   * const layer = new SubtypeGroupLayer({
+   *   url: "<your-map-service-url>"
+   * });
+   * layer.dynamicDataSource = new DynamicWorkspaceLayer({
+   *   workspaceId: "lyrx_folder",
+   *   layerId: "SubtypeGroup.lyrx"
+   * });
+   * ```
+   */
+  dynamicDataSource?: DynamicWorkspaceLayerProperties | null;
   /**
    * A [Collection](https://developers.arcgis.com/javascript/latest/references/core/core/Collection/) of [SubtypeSublayer](https://developers.arcgis.com/javascript/latest/references/core/layers/support/SubtypeSublayer/) objects that allow
    * you to alter the properties of one or more sublayers of the SubtypeGroupLayer.
@@ -185,6 +217,37 @@ export default class SubtypeGroupLayer extends SubtypeGroupLayerSuperclass {
    */
   "@eventTypes": SubtypeGroupLayerEvents;
   constructor(properties?: SubtypeGroupLayerProperties);
+  /**
+   * A dynamic workspace source that identifies a pre-authored ArcGIS Pro layer file (`.lyrx`) in a registered workspace.
+   * Set this property instead of `layerId` to use the workspace layer as the data source for this SubtypeGroupLayer.
+   * The map service must have dynamic layers enabled, and the workspace layer must have a subtype field.
+   *
+   * > [!WARNING]
+   * >
+   * > **Known Limitations**
+   * >
+   * > A SubtypeGroupLayer with a `dynamicDataSource` cannot be persisted to web maps, web scenes, or portal items.
+   *
+   * @internal
+   * @beta
+   * @since 5.2
+   * @see [DynamicWorkspaceLayer](https://developers.arcgis.com/javascript/latest/references/core/rest/layerSources/DynamicWorkspaceLayer/)
+   * @example
+   * ```js
+   * const DynamicWorkspaceLayer = await $arcgis.import("@arcgis/core/rest/layerSources/DynamicWorkspaceLayer.js");
+   * const SubtypeGroupLayer = await $arcgis.import("@arcgis/core/layers/SubtypeGroupLayer.js");
+   *
+   * const layer = new SubtypeGroupLayer({
+   *   url: "<your-map-service-url>"
+   * });
+   * layer.dynamicDataSource = new DynamicWorkspaceLayer({
+   *   workspaceId: "lyrx_folder",
+   *   layerId: "SubtypeGroup.lyrx"
+   * });
+   * ```
+   */
+  get dynamicDataSource(): DynamicWorkspaceLayer | null | undefined;
+  set dynamicDataSource(value: DynamicWorkspaceLayerProperties | null | undefined);
   /**
    * Determines if the layer is editable.
    *

package/layers/ViewshedLayer.d.ts

@@ -84,16 +84,22 @@ export interface ViewshedLayerProperties extends LayerProperties, OperationalLay
  *
  * > [!WARNING]
  * >
- * > **Known Limitations**
- * >
- * > This layer is only supported in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
- * > The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.
+ * > **Things to consider:**
+ * > * This analysis is only supported in a 3D [SceneView](https://developers.arcgis.com/javascript/latest/references/core/views/SceneView/).
+ * > * The results of the tool vary depending on the zoom level, as changes in zoom level affect the level of detail (LOD) of the scene geometry.
+ * > * Snapping, tooltips, display units, and input units used during interactive placement and editing are inherited from
+ * [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/).
+ * >   * Snapping is enabled by default. This can be temporarily disabled by holding the `CTRL` key.
+ * >   * Layer types currently supported for snapping are: [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/), [GraphicsLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GraphicsLayer/) (except Mesh geometries),
+ * > [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/GeoJSONLayer/), [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/), [CSVLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/CSVLayer/),
+ * > [3D Object SceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/SceneLayer/), and [BuildingSceneLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/BuildingSceneLayer/).
  *
  * @since 4.31
  * @see [ViewshedLayerView](https://developers.arcgis.com/javascript/latest/references/core/views/layers/ViewshedLayerView/)
  * @see [Viewshed](https://developers.arcgis.com/javascript/latest/references/core/analysis/Viewshed/)
  * @see [ViewshedAnalysis](https://developers.arcgis.com/javascript/latest/references/core/analysis/ViewshedAnalysis/)
  * @see [ViewshedAnalysisView3D](https://developers.arcgis.com/javascript/latest/references/core/views/3d/analysis/ViewshedAnalysisView3D/)
+ * @see [ViewOptions](https://developers.arcgis.com/javascript/latest/references/core/views/interactive/options/ViewOptions/)
  * @see [Sample - ViewshedLayer in slides](https://developers.arcgis.com/javascript/latest/sample-code/layers-viewshed/)
  */
 export default class ViewshedLayer extends ViewshedLayerSuperclass {

package/layers/WMSLayer.d.ts

@@ -3,7 +3,6 @@ import type Collection from "../core/Collection.js";
 import type Extent from "../geometry/Extent.js";
 import type SpatialReference from "../geometry/SpatialReference.js";
 import type Layer from "./Layer.js";
-import type TimeInfo from "./support/TimeInfo.js";
 import type WMSSublayer from "./support/WMSSublayer.js";
 import type TimeExtent from "../time/TimeExtent.js";
 import type TimeInterval from "../time/TimeInterval.js";
@@ -17,7 +16,6 @@ import type { PortalLayer, PortalLayerProperties } from "./mixins/PortalLayer.js
 import type { RefreshableLayer, RefreshableLayerEvents, RefreshableLayerProperties } from "./mixins/RefreshableLayer.js";
 import type { ScaleRangeLayer, ScaleRangeLayerProperties } from "./mixins/ScaleRangeLayer.js";
 import type { TemporalLayer, TemporalLayerProperties } from "./mixins/TemporalLayer.js";
-import type { TimeInfoProperties } from "./support/TimeInfo.js";
 import type { WMSDimension } from "./wms/types.js";
 import type { TimeExtentProperties } from "../time/TimeExtent.js";
 import type { TimeIntervalProperties } from "../time/TimeInterval.js";
@@ -150,39 +148,6 @@ export interface WMSLayerProperties extends LayerProperties, PortalLayerProperti
    * });
    */
   timeExtent?: TimeExtentProperties | null;
-  /**
-   * TimeInfo provides information such as date fields that store
-   * [start](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField)
-   * and [end](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField) time
-   * for each feature and the [TimeInfo.fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent)
-   * for the layer. The `timeInfo` property is automatically set at layer initialization if the layer has one or more time dimensions.
-   * The [TimeInfo.fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent) for `timeInfo` is
-   * automatically set to the union of all time dimension extents.
-   * The timeInfo parameters cannot be changed after the layer is [loaded](https://developers.arcgis.com/javascript/latest/references/core/layers/WMSLayer/#load).
-   *
-   * @since 4.17
-   * @example
-   * // create geojson layer from usgs earthquakes geojson feed
-   * const geojsonLayer = new GeoJSONLayer({
-   *   url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_month.geojson",
-   *   copyright: "USGS Earthquakes",
-   *   fields: [
-   *     { "name": "mag", "type": "double" },
-   *     { "name": "place", "type": "string" },
-   *     { "name": "time", "type": "date" }, // date field
-   *     { "name": "depth", "type": "double" }
-   *   ],
-   *   // timeInfo can be used to do temporal queries
-   *   // set the startField and endField.
-   *   // timeExtent is automatically calculated from the
-   *   // the start and end date fields
-   *   // The date values must be in milliseconds number from the UNIX epoch specified in UTC.
-   *   timeInfo: {
-   *     startField: "time"
-   *   }
-   * });
-   */
-  timeInfo?: TimeInfoProperties | null;
   /**
    * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/references/core/time/TimeInterval/). This allows
    * users to overlay features from two or more time-aware layers with different time extents.
@@ -215,6 +180,7 @@ export interface WMSLayerProperties extends LayerProperties, PortalLayerProperti
    *     }
    *   }
    * });
+   * @see [Sample - Time Bar with actions and layer timeOffset](https://developers.arcgis.com/javascript/latest/sample-code/time-bar-time-offset/)
    * @example
    * // Offset a CSV Layer containing hurricanes from 2015 so that they appear in 2019 (+4 years).
    * let layer = new CSVLayer({
@@ -678,40 +644,6 @@ export default class WMSLayer extends WMSLayerSuperclass {
    */
   get timeExtent(): TimeExtent | null | undefined;
   set timeExtent(value: TimeExtentProperties | null | undefined);
-  /**
-   * TimeInfo provides information such as date fields that store
-   * [start](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#startField)
-   * and [end](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#endField) time
-   * for each feature and the [TimeInfo.fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent)
-   * for the layer. The `timeInfo` property is automatically set at layer initialization if the layer has one or more time dimensions.
-   * The [TimeInfo.fullTimeExtent](https://developers.arcgis.com/javascript/latest/references/core/layers/support/TimeInfo/#fullTimeExtent) for `timeInfo` is
-   * automatically set to the union of all time dimension extents.
-   * The timeInfo parameters cannot be changed after the layer is [loaded](https://developers.arcgis.com/javascript/latest/references/core/layers/WMSLayer/#load).
-   *
-   * @since 4.17
-   * @example
-   * // create geojson layer from usgs earthquakes geojson feed
-   * const geojsonLayer = new GeoJSONLayer({
-   *   url: "https://earthquake.usgs.gov/earthquakes/feed/v1.0/summary/all_month.geojson",
-   *   copyright: "USGS Earthquakes",
-   *   fields: [
-   *     { "name": "mag", "type": "double" },
-   *     { "name": "place", "type": "string" },
-   *     { "name": "time", "type": "date" }, // date field
-   *     { "name": "depth", "type": "double" }
-   *   ],
-   *   // timeInfo can be used to do temporal queries
-   *   // set the startField and endField.
-   *   // timeExtent is automatically calculated from the
-   *   // the start and end date fields
-   *   // The date values must be in milliseconds number from the UNIX epoch specified in UTC.
-   *   timeInfo: {
-   *     startField: "time"
-   *   }
-   * });
-   */
-  get timeInfo(): TimeInfo | null | undefined;
-  set timeInfo(value: TimeInfoProperties | null | undefined);
   /**
    * A temporary offset of the time data based on a certain [TimeInterval](https://developers.arcgis.com/javascript/latest/references/core/time/TimeInterval/). This allows
    * users to overlay features from two or more time-aware layers with different time extents.
@@ -744,6 +676,7 @@ export default class WMSLayer extends WMSLayerSuperclass {
    *     }
    *   }
    * });
+   * @see [Sample - Time Bar with actions and layer timeOffset](https://developers.arcgis.com/javascript/latest/sample-code/time-bar-time-offset/)
    * @example
    * // Offset a CSV Layer containing hurricanes from 2015 so that they appear in 2019 (+4 years).
    * let layer = new CSVLayer({