@arcgis/core 5.0.0-next.55 → 5.0.0-next.56

package/rest/print.d.ts

@@ -1,3 +1,77 @@
+/**
+ * The print module provides an `executePrint` method that generates a printer-ready version of the map using an
+ * [Export Web Map Task](https://developers.arcgis.com/rest/services-reference/export-web-map-task.htm)
+ * available with ArGIS Server 10.1 and later. This class is used when you want to have more granular control over the user interface,
+ * for example, if you want to provide users the ability to define what appears on the printed page.
+ *
+ * For more information about printing with the `MAP_ONLY` layout, please see
+ * [PrintTemplate#exportOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html#exportOptions).
+ *
+ * Use [PrintParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintParameters.html) to set the printing options.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > No support
+ * >
+ * > There is no current support for printing with any Printing Service published with ArcMap.
+ * > There is no current support for printing [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html). Instead, see [SceneView#takeScreenshot()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#takeScreenshot).
+ * > There is no current support for printing [ImageryLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) when a [ImageryLayer#pixelFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html#pixelFilter)
+ * > is defined.
+ * > There is no current support for printing renderers generated from [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer)
+ * > with an above-and-below theme.
+ * > There is no current support for printing legend items for layers that are sent as a client-side image in the printout.
+ * > There is no current support for printing rotated symbols and labels when the map is rotated, and layers are sent as a client-side image in the printout.
+ * > There is no current support for printing features when using a renderer with `above-and-below` theme.
+ * > There is no current support for printing [GroupLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GroupLayer.html) with blending or effects. Instead, see [MapView#takeScreenshot()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot).
+ * > There is no current support for printing [effects](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#effect) when a [FeatureLayer#blendMode](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#blendMode) is applied to a layer.
+ * > There is no current support for printing layers with the following [blendModes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#blendMode):
+ * > `"average"`, `"destination-atop"`, `"destination-in"`, `"destination-out"`, `"destination-over"`, `"invert"`, `"lighter"`, `"minus"`, `"plus"`, `"reflect"`, `"source-atop"`, `"source-in"`, `"source-out"`, `"vivid-light"`, `"XOR"`.
+ * >
+ * > Versioned support
+ * >
+ * > [Labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-LabelClass.html) currently cannot be printed as part of a FeatureLayer with ArcGIS Server 10.5.1.
+ * > [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) cannot be printed with ArcGIS Server 10.5.1 or earlier.
+ * > [VectorTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-VectorTileLayer.html) printing requires ArcGIS Server 10.5.1 or later.
+ * > Printing layers rendered with the [DotDensityRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html) will create a client-side image of the layer in the printout with ArcGIS Server 10.8.0 or earlier.
+ * > Printing layers using [clustering](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#featureReduction) will create a client-side image of the layer in the printout with [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html) and/or ArcGIS Server 10.9.0 or earlier.
+ * > For printing secure VectorTileLayers with ArcGIS Server 10.5.1 or 10.6.0,
+ * > or for printing VectorTileLayers with ArcGIS Server 10.5.1,
+ * > the [print](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-print.html) will create a client-side image for the VectorTileLayer to use in the printout.
+ * > Printing [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html) will create a client-side image of the layer in the printout with ArcGIS Server 11.4.1 or earlier.
+ * > This has some limitations related to large size printing quality and a dependency on browser window height/width ratio.
+ * > Printing the drawing order of layers configured with the `orderBy` property is supported with ArcGIS Server 11.5.0 or later.
+ * > Printing the background color of a [MapView#background](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#background) or [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-background-ColorBackground.html) requires ArcGIS Server 10.9.0 or later.
+ * > Printing layers with non-standard URLs (e.g. no MapServer, FeatureServer, or ImageServer in the URL) requires ArcGIS Server 10.9.1 or later.
+ * > Printing layers with supported [blendModes](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) requires ArcGIS Server 10.9.1 or later. This is the list of currently supported types:
+ * > `"color-burn"`, `"color-dodge"`, `"color"`, `"darken"`, `"difference"`, `"exclusion"`, `"hard-light"`, `"hue"`, `"lighten"`, `"luminosity"`, `"multiply"`, `"normal"`, `"overlay"`, `"saturation"`, `"screen"`, `"soft-light"`.
+ * > Printing highlighted features with [SimpleFillSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-SimpleFillSymbol.html) with {@link layers/FeatureLayer#highlight FeatureLayers} requires ArcGIS Server 11.4.0 or higher.
+ * > For printing [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) the catalog footprint is sent as a feature collection if the ArcGIS Server version is less than 11.3.1.
+ * > Otherwise, it's sent as a CatalogLayer with the `dynamicGroupLayer` visibility set to `false`. The other layers from the CatalogLayer are sent separately.
+ * >
+ * > Behavior notes
+ * >
+ * > Printing layers using [effects](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#effect) will create a client-side image of the layer in the printout.
+ * > Printing layers using [binning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html) will create a client-side image of the layer in the printout.
+ * > Printing layers using [pie-chart renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html) will create a client-side image of the layer in the printout.
+ * > Printing layers using [TrackInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TrackInfo.html) and/or [TrackInfo#trackLines](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TrackInfo.html#trackLines) will create a client-side image of the layer in the printout.
+ * > Printing [Multipoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-geometry-Multipoint.html) geometries may result in a different output based on the algorithms used to compute labels on the print server versus that of the ArcGIS Maps SDK for JavaScript.
+ * > Printing layers using [highlighted features](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#highlight) is only supported for [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html). For other layer types, see [MapView#takeScreenshot()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#takeScreenshot).
+ * > Printing layers using [spike renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#updateRendererWithSpike) will not apply the spike renderer to the printed legend.
+ * > Legends will print if there is enough space in the template for both the map and the legend.
+ * > The print server does not directly print [SVG](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/symbol) symbols. Rather, they are converted to [PictureMarkerSymbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html) for display.
+ * > Make certain that any resources to be printed are accessible by the print server. For example, if printing a map containing [PictureMarkerSymbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-PictureMarkerSymbol.html),
+ * > the URL to these symbols must be accessible to the print server for it to work properly.
+ * > Currently, charts can only be printed when published as part of a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html), and with ArcGIS Server version 11.2 or later.
+ * > For [Print](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) widget only: if the application and the print service are on the same origin, the name of the downloadable file can be customized with the [TemplateOptions#fileName](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#fileName)
+ * > or [TemplateOptions#title](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print-TemplateOptions.html#title) properties. If not, the name of the downloadable file will be generated by the ArcGIS Enterprise that hosts the print service.
+ *
+ * @since 4.20
+ * @see [Print widget](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Print.html) - _Deprecated since 4.33. Use the [Print component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/) instead._
+ * @see [Print component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-print/)
+ * @see [PrintTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-PrintTemplate.html)
+ */
 import type PrintParameters from "./support/PrintParameters.js";
 import type { RequestOptions } from "../request/types.js";
 import type { PrintResponse } from "./types.js";

package/rest/query.d.ts

@@ -1,3 +1,36 @@
+/**
+ * Executes different types of query operations on a layer. The most common
+ * method used is [executeQueryJSON()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeQueryJSON), which executes the query for JSON results as defined in the
+ * [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html) object that is passed as a parameter to the function.
+ * `executeQueryJSON()` returns a Promise that resolves to a
+ * [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html), which contains the features in the layer
+ * that satisfy the [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html).
+ *
+ * You can also obtain the [number of features](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForCount) that satisfy the
+ * query, the [extent](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForExtent) of features, [related features or records](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeRelationshipQuery)
+ * associated with a feature, [attachments](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeAttachmentQuery) for features or the [featureIds](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-query.html#executeForIds)
+ * of features.
+ *
+ * For example, when working with a feature layer of world cities, to obtain a
+ * [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html) of cities with a population greater than
+ * one million people, use the code below.
+ *
+ * @since 4.19
+ * @see [Query](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html)
+ * @see [AttachmentQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html)
+ * @see [RelationshipQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html)
+ * @see [FeatureSet](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FeatureSet.html)
+ * @example
+ * // query featureLayer for cities with a population greater than one million people
+ * const query = await $arcgis.import("@arcgis/core/rest/query");
+ *
+ * // url to the layer of interest to query
+ * const url = "https://sampleserver6.arcgisonline.com/arcgis/rest/services/SampleWorldCities/MapServer/0";
+ *
+ * const { features } = await query.executeQueryJSON(url, {
+ *   where: "POP > 1000000"
+ * });
+ */
 import type Extent from "../geometry/Extent.js";
 import type SpatialReference from "../geometry/SpatialReference.js";
 import type AttachmentInfo from "./query/support/AttachmentInfo.js";

package/rest/route.d.ts

@@ -1,3 +1,21 @@
+/**
+ * Find routes between two or more locations and optionally get driving directions. The route module
+ * uses ArcGIS Server network analysis services to calculate routes. Network analysis services
+ * allow you to solve simple routing problems as well as complex ones that take into account
+ * multiple stops, barriers, and time windows.
+ *
+ * To work directly with route, the basic pattern is:
+ * 1. Define the URL to the ArcGIS Server REST resource
+ * 2. [Configure the parameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html)
+ * 3. [Solve the route](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-route.html#solve) and then specify [what to do with its results](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html) and handle any errors that may be returned.
+ *
+ * @since 4.19
+ * @see [RouteResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteResult.html)
+ * @see [RouteSolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteSolveResult.html)
+ * @see [RouteParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RouteParameters.html)
+ * @see [Esri Directions and Routing Services](https://developers.arcgis.com/en/features/directions/)
+ * @see [Sample - Route](https://developers.arcgis.com/javascript/latest/sample-code/route/)
+ */
 import type RouteParameters from "./support/RouteParameters.js";
 import type RouteSolveResult from "./support/RouteSolveResult.js";
 import type { RequestOptions } from "../request/types.js";

package/rest/serviceArea.d.ts

@@ -1,3 +1,21 @@
+/**
+ * With the Service area service, you can find the area that can be reached from the input location within a given
+ * travel time or travel distance. A service area is the area that encompasses all streets that can be accessed within
+ * a given distance or travel time from one or more locations, referred to as facilities. Service areas are generally
+ * used to visualize and measure the accessibility of facilities. For example, a three-minute drive-time polygon around
+ * a grocery store can determine which residents are able to reach the store within three minutes and are thus more
+ * likely to shop there. The service can also create multiple concentric service areas around one or more facilities
+ * that can show how accessibility changes with an increase in travel time or travel distance. It can be used, for
+ * example, to determine how many hospitals are within 5-, 10-, and 15-minute drive times of schools. When creating
+ * service areas based on travel times, the service can make use of traffic data, which can influence the area that can
+ * be reached during different times of the day.
+ *
+ * @since 4.19
+ * @see [ServiceAreaParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaParameters.html)
+ * @see [ServiceAreaSolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-ServiceAreaSolveResult.html)
+ * @see [Tutorial: Find service areas](https://developers.arcgis.com/javascript/latest/find-service-areas/)
+ * @see [Solve Service Area - ArcGIS Server REST API](https://developers.arcgis.com/rest/services-reference/enterprise/service-area-sync.htm)
+ */
 import type ServiceAreaParameters from "./support/ServiceAreaParameters.js";
 import type ServiceAreaSolveResult from "./support/ServiceAreaSolveResult.js";
 import type { RequestOptions } from "../request/types.js";

package/rest/support/AreasAndLengthsParameters.d.ts

@@ -14,8 +14,8 @@ export type AreaUnitKebabCase = "acres" | "ares" | "hectares" | "square-miles" |
 export type LengthUnit = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards";
 
 /**
- * Input parameters for the {@link rest/GeometryService!areasAndLengths}
- * method on the {@link rest/GeometryService}.
+ * Input parameters for the [areasAndLengths()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#areasAndLengths)
+ * method on the [geometryService](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html).
  *
  * @since 4.20
  * @see [areasAndLengths()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#areasAndLengths)

package/rest/support/AttachmentQuery.d.ts

@@ -56,7 +56,6 @@ export default class AttachmentQuery extends JSONSupport {
    * Use only for queries that have the same parameters every time the app is used.
    * Some examples of cacheable queries:
    * * Queries based on [preset input](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttachmentQuery.html#where), for example, a drop-down list of US states.
-   * * Queries based on {@link rest/support/AttachmentQuery#geometry preset extents}, for example bookmarks, in web maps.
    *
    * @since 4.24
    */

package/rest/support/AttributeBinsQuery.d.ts

@@ -51,7 +51,7 @@ export interface AttributeBinsQueryProperties extends JSONSupportMixinProperties
 export type BinParameters = AutoIntervalBinParameters | DateBinParameters | FixedBoundariesBinParameters | FixedIntervalBinParameters;
 
 /**
- * This class configures parameters for the [FeatureLayer#queryAttributeBins()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryAttributeBins) method, which groups features in a layer or layer view into bins
+ * This class configures parameters for the [queryAttributeBins](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryAttributeBins) method, which groups features in a layer or layer view into bins
  * based on numeric or date fields. This operation is useful for summarizing and analyzing large datasets by organizing them into meaningful groups, or bins, making it easier to detect patterns,
  * trends, and anomalies across different ranges or time periods.
  *
@@ -64,9 +64,9 @@ export type BinParameters = AutoIntervalBinParameters | DateBinParameters | Fixe
  * crucial for understanding binning and boundary settings. There are four types of bin parameters:
  * | Bin parameter type | Description |
  * | ------------------- | ----------- |
- * | [AutoIntervalBinParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html) | You specify the number of {@link rest/support/AutoIntervalBinParameters#bins}, [AutoIntervalBinParameters#start](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#start) and [AutoIntervalBinParameters#end](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#end) values of the binning. The bin size is calculated by dividing the dataset's range by this number of bins.|
+ * | [AutoIntervalBinParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html) | You specify the number of [numBins](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#numBins), [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#start) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#end) values of the binning. The bin size is calculated by dividing the dataset's range by this number of bins.|
  * | [FixedBoundariesBinParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FixedBoundariesBinParameters.html) | The bins strictly follow the specified [input values](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FixedBoundariesBinParameters.html#boundaries). The first item in the array specifies the lower boundary of the first bin, while the last item specifies the upper boundary of the last bin. Intermediate values represent the lower boundaries of each bin. |
- * | [FixedIntervalBinParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FixedIntervalBinParameters.html) | The number of bins is not important, but the [FixedIntervalBinParameters#interval](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FixedIntervalBinParameters.html#interval) size must match the input data. Each bin will cover a range that exactly fits the specified interval. |
+ * | [FixedIntervalBinParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FixedIntervalBinParameters.html) | The number of bins is not important, but the [interval](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-FixedIntervalBinParameters.html#interval) size must match the input data. Each bin will cover a range that exactly fits the specified interval. |
  * | [DateBinParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DateBinParameters.html) | The [intervals](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DateBinParameters.html#interval) are based on calendar units. For example, with monthly intervals, each bin represents an entire month. |
  *
  * @since 4.32

package/rest/support/AutoIntervalBinParameters.d.ts

@@ -5,8 +5,8 @@ import type { NormalizationBinParametersMixinProperties, NormalizationBinParamet
 export interface AutoIntervalBinParametersProperties extends BinParametersBaseProperties, NormalizationBinParametersMixinProperties, Partial<Pick<AutoIntervalBinParameters, "end" | "numBins" | "start">> {}
 
 /**
- * AutoIntervalBinParameters specifies [AttributeBinsQuery#binParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html#binParameters) on [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html) object.
- * It defines the number of {@link rest/support/AutoIntervalBinParameters#bins}, and the [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#start) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#end) values for binning  on a specified [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#field). Bin size is automatically calculated based
+ * AutoIntervalBinParameters specifies [binParameters](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html#binParameters) on [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AttributeBinsQuery.html) object.
+ * It defines the number of [numBins](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#numBins), and the [start](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#start) and [end](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#end) values for binning  on a specified [field](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-AutoIntervalBinParameters.html#field). Bin size is automatically calculated based
  * on the range between the start and end values and the number of bins. The end value will be included in the last bin.
  * The AutoIntervalBinParameters does not support `timestamp-offset`, `date-only`, or `time-only` field types.
  *
@@ -14,11 +14,11 @@ export interface AutoIntervalBinParametersProperties extends BinParametersBasePr
  * different hours of the day. The bin parameters would be:
  *
  * ```js
- * // Query bins with auto interval bin parameters based on field "total" with 3 bins.
+ * // Query bins with auto interval bin parameters based on field "HOUR" with 24 bins.
  * const binQuery = new AttributeBinsQuery({
  *   where: "Unit = 0",
  *   binParameters: new AutoIntervalBinParameters({
- *     bins: 24,
+ *     numBins: 24,
  *     field: "HOUR", // the field to bin, containing the hours of the day
  *     start: 0, // the lower boundary of the first bin
  *     end: 24 // the upper boundary of the last bin

package/rest/support/DateBinParameters.d.ts

@@ -13,7 +13,7 @@ export interface DateBinParametersProperties extends BinParametersBaseProperties
    * > [!WARNING]
    * >
    * > **Known Limitations**
-   * > Only `days`, `hours`, `minutes`, `seconds` are supported for offset {@link rest/support/DateBinTimeInterval#units}.
+   * > Only `days`, `hours`, `minutes`, `seconds` are supported for offset [unit](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DateBinTimeInterval.html#unit).
    * > The `offset` is only supported with server-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html).
    */
   offset?: DateBinTimeIntervalProperties | null;
@@ -75,7 +75,7 @@ export default class DateBinParameters extends BinParametersBase {
    * > [!WARNING]
    * >
    * > **Known Limitations**
-   * > Only `days`, `hours`, `minutes`, `seconds` are supported for offset {@link rest/support/DateBinTimeInterval#units}.
+   * > Only `days`, `hours`, `minutes`, `seconds` are supported for offset [unit](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DateBinTimeInterval.html#unit).
    * > The `offset` is only supported with server-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html).
    */
   get offset(): DateBinTimeInterval | null | undefined;

package/rest/support/DateBinTimeInterval.d.ts

@@ -17,7 +17,7 @@ export default class DateBinTimeInterval extends DateBinTimeIntervalSuperclass {
    * The unit value is defined via [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DateBinTimeInterval.html#value) property.
    */
   unit: DateBinTimeUnit;
-  /** The numerical value of the time extent. This property works along with {@link rest/support/DateBinTimeInterval#units} to define the time interval or time offset to generate date bins. */
+  /** The numerical value of the time extent. This property works along with [unit](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DateBinTimeInterval.html#unit) to define the time interval or time offset to generate date bins. */
   accessor value: number;
 }
 declare const DateBinTimeIntervalSuperclass: typeof JSONSupport & typeof ClonableMixin

package/rest/support/DensifyParameters.d.ts

@@ -14,7 +14,7 @@ export interface DensifyParametersProperties extends JSONSupportMixinProperties,
 }
 
 /**
- * Input parameters for the {@link rest/GeometryService!densify} method on
+ * Input parameters for the [densify()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geometryService.html#densify) method on
  * the GeometryService.
  *
  * @since 4.20

package/rest/support/DirectionsFeature.d.ts

@@ -77,7 +77,7 @@ export default abstract class DirectionsFeature extends Graphic {
    * };
    */
   accessor attributes: any;
-  /** An array of {@link rest/support/DirectionEvent Direction Events}. */
+  /** An array of [Directions Events](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-DirectionsEvent.html). */
   get events(): DirectionsEvent[] | null | undefined;
   set events(value: DirectionsEventProperties[] | null | undefined);
   /**

package/rest/support/GPMessage.d.ts

@@ -4,7 +4,7 @@ import type { MessageType } from "./interfaces.js";
 export interface GPMessageProperties extends JSONSupportMixinProperties, Partial<Pick<GPMessage, "description" | "type">> {}
 
 /**
- * Represents a message generated during the execution of a {@link rest/Geoprocessor} method.
+ * Represents a message generated during the execution of a [geoprocessor](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-geoprocessor.html) method.
  * It includes information such as
  * when the processing started, what parameter values are being used, the task progress, and
  * warnings of potential problems and errors. It is composed of a message

package/rest/support/LastMileDeliveryParameters.d.ts

@@ -235,7 +235,7 @@ export default class LastMileDeliveryParameters extends LastMileDeliveryParamete
    * If `true`, directions will be generated and configured based on the value of
    * the [directionsLanguage](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-LastMileDeliveryParameters.html#directionsLanguage) property.
    * If `false`, directions will not be generated, and the service returns an empty value
-   * for the feature sets returned by {@link rest/support/lastMileDelivery#getDirectionPoints} and {@link rest/support/lastMileDelivery#getDirectionLines} output parameter
+   * for the feature sets returned by [getDirectionPoints()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-lastMileDelivery.html#getDirectionPoints) and [getDirectionLines()](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-lastMileDelivery.html#getDirectionLines) output parameter
    *
    * @see [Parameters: populate_directions](https://developers.arcgis.com/rest/routing/last-mile-delivery-service/#populate_directions)
    */

package/rest/support/QuantizationParameters.d.ts

@@ -33,12 +33,12 @@ export default abstract class QuantizationParameters extends JSONSupport {
    */
   accessor originPosition: "upper-left" | "lower-left";
   /**
-   * The size of one pixel in the units of the {@link rest/support/QuantizationParameters#outSpatialReference}.
+   * The size of one pixel in the units of the [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference).
    * This number is used to convert coordinates to integers by building a grid with a resolution matching the tolerance.
    * Each coordinate is then snapped to one pixel on the grid. Consecutive coordinates snapped to the same pixel are removed
-   * for reducing the overall response size. The units of tolerance will match the units of {@link rest/support/QuantizationParameters#outSpatialReference}.
+   * for reducing the overall response size. The units of tolerance will match the units of [outSpatialReference](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outSpatialReference).
    * If `outSpatialReference` is not specified, then tolerance is assumed to be in the units of the spatial
-   * reference of the layer. If tolerance is not specified, the {@link rest/support/QuantizationParameters#maxAllowableOffset} is used.
+   * reference of the layer. If tolerance is not specified, the [maxAllowableOffset](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#maxAllowableOffset) is used.
    * If tolerance and `maxAllowableOffset` are not specified, a grid of 10,000 * 10,000 grid is used by default.
    *
    * @default 1

package/rest/support/Query.d.ts

@@ -311,7 +311,6 @@ export interface RangeValue {
  * @see [FeatureLayer#queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#queryFeatures)
  * @see [FeatureLayerView#queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-FeatureLayerView.html#queryFeatures)
  * @see [CSVLayer#queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html#queryFeatures)
- * @see {@link views/layers/CSVLayerView#queryFeatures}
  * @see [SceneLayer#queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#queryFeatures)
  * @see [SceneLayerView#queryFeatures()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-SceneLayerView.html#queryFeatures)
  * @see [Query and filter guide](https://developers.arcgis.com/javascript/latest/query-filter/)

package/rest/support/QueryMixin.d.ts

@@ -58,7 +58,7 @@ export abstract class QueryMixin {
    * [capabilities.query.supportsCacheHint](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#capabilities) is set to `true`.
    * Use only for queries that have the same parameters every time the app is used.
    * Some examples of cacheable queries:
-   * * Queries that fetch {@link rest/support/QueryMixin#outStatistics statistics} or {@link rest/support/QueryMixin#returnGeometry features} on app load.
+   * * Queries that fetch [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#outStatistics) or [features](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-Query.html#returnGeometry) on app load.
    * * Queries based on [preset input](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#where), for example, a drop-down list of US states.
    * * Queries based on [preset extents](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-QueryMixin.html#geometry), for example bookmarks, in web maps.
    */

package/rest/support/RelationshipQuery.d.ts

@@ -37,7 +37,6 @@ export default class RelationshipQuery extends JSONSupport {
    * Use only for queries that have the same parameters every time the app is used.
    * Some examples of cacheable queries:
    * * Queries based on [preset input](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-support-RelationshipQuery.html#where), for example, a drop-down list of US states.
-   * * Queries based on {@link rest/support/RelationshipQuery#geometry preset extents}, for example bookmarks, in web maps.
    *
    * @since 4.24
    */

package/rest/support/interfaces.d.ts

@@ -9,8 +9,7 @@ import type PolygonBarrier from "./PolygonBarrier.js";
 import type PolylineBarrier from "./PolylineBarrier.js";
 import type RouteInfo from "./RouteInfo.js";
 import type Stop from "./Stop.js";
-import type { TimeUnit } from "../../core/timeUtils.js";
-import type { LengthUnit as CoreLengthUnit } from "../../core/units.js";
+import type { TimeUnit, LengthUnit as CoreLengthUnit } from "../../core/units.js";
 
 /**
  * An object describing the parameter values for the

package/rest/symbolService.d.ts

@@ -1,3 +1,12 @@
+/**
+ * Represents [symbol service](https://developers.arcgis.com/rest/services-reference/enterprise/symbol-server.htm) resources exposed by the ArcGIS REST API. This module provides
+ * resources to convert [Scalable Vector Graphics](https://pro.arcgis.com/en/pro-app/latest/help/mapping/layer-properties/scalable-vector-graphics-support.htm) (SVG) to
+ * [CIMSymbols](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html).
+ *
+ * @since 4.25
+ * @see [CIMSymbol](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-CIMSymbol.html)
+ * @see [cimSymbolUtils](https://developers.arcgis.com/javascript/latest/api-reference/esri-symbols-support-cimSymbolUtils.html)
+ */
 import type { RequestOptions } from "../request/types.js";
 import type { GenerateSymbolParameters, GenerateSymbolResponse } from "./types.js";
 

package/smartMapping/heuristics/binLevel.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Function that suggests a [FeatureReductionBinning#fixedBinLevel](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#fixedBinLevel) in a
+ * [FeatureReductionBinning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html) visualization.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > This function is not intended for use in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * @since 4.25
+ */
 import type { BinLevelParams } from "./types.js";
 
 /**

package/smartMapping/heuristics/scaleRange.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Function for determining suggested [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#minScale) and
+ * [max](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#maxScale) scale ranges for an input layer.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Input [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must meet the following conditions:
+ * >   - [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) without the `supportsRenderer` and `supportsLayerQuery` capabilities enabled, unless a predefined
+ * >   [statistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-types.html#SummaryStatisticsResult) object is passed to the `statistics` parameter of the
+ * >   method in conjunction with the layer. To check a SceneLayer's capabilities, use the [SceneLayer#getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method.
+ *
+ * @since 4.12
+ */
 import type { ScaleRangeResult, ScaleRangeParams } from "./types.js";
 
 /**

package/smartMapping/heuristics/sizeRange.d.ts

@@ -1,3 +1,15 @@
+/**
+ * Function for determining the suggested `minSize` and `maxSize` of a
+ * [scale-dependent size visual variable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html).
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > This function is not intended for use in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * @since 4.12
+ */
 import type { SizeRangeResult, SizeRangeParams } from "./types.js";
 
 /**

package/smartMapping/labels/bins.d.ts

@@ -1,3 +1,16 @@
+/**
+ * This object contains a helper method for generating default labels to be set on
+ * a layer's [binning configuration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo).
+ * The default label is based on the [FeatureReductionBinning#renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#renderer). In most cases the default label configuration will
+ * be the total number of features in the bin. This value will be rounded and formatted (e.g. instead of `2385`, the
+ * bin label will display `2.4k`).
+ *
+ * This includes secondary labeling schemes you can experiment with using on your bins.
+ * This module only applies to layers with a point geometry type.
+ *
+ * @since 4.27
+ * @see [FeatureReductionBinning#labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html#labelingInfo)
+ */
 import type KnowledgeGraphSublayer from "../../layers/knowledgeGraph/KnowledgeGraphSublayer.js";
 import type LabelClass from "../../layers/support/LabelClass.js";
 import type { RendererUnion } from "../../renderers/support/typeUtils.js";

package/smartMapping/labels/clusters.d.ts

@@ -1,3 +1,19 @@
+/**
+ * This object contains a helper method for generating default labels to be set on
+ * a layer's [cluster configuration](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo).
+ * The default label is based on the layer's renderer. In most cases the default label configuration will
+ * be the total number of features in the cluster. This value will be rounded and formatted (e.g. instead of `2385`, the
+ * cluster label will display `2.4k`). In some cases, such as renderers with a [SizeVariable](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-visualVariables-SizeVariable.html),
+ * the default label will display the average value of the attribute represented by the size variable.
+ *
+ * [![clustering-generated-labels](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-generated-labels.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+ *
+ * This includes secondary labeling schemes you can experiment with in your clusters. This module only applies to layers with a point geometry type.
+ *
+ * @since 4.16
+ * @see [FeatureReductionCluster#labelingInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#labelingInfo)
+ * @see [Sample - Point clustering - generate suggested configuration](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+ */
 import type LabelClass from "../../layers/support/LabelClass.js";
 import type MapView from "../../views/MapView.js";
 import type { SupportedLayer } from "../support/clusterUtils.js";

package/smartMapping/popup/clusters.d.ts

@@ -1,3 +1,24 @@
+/**
+ * This object contains helper methods for generating popup templates to be set on
+ * a layer's [FeatureReductionCluster#popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate).
+ * The suggested popup templates will include summary information about features in the cluster based on the
+ * layer's renderer. For example, in a layer visualizing population, the cluster popup template will include
+ * the number of features in the cluster and the average population of features in the cluster.
+ *
+ * ![clustering-generated-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-generated-popup.png)
+ *
+ * For layers with
+ * a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.html), the popup will include the predominant unique value info
+ * of features in the cluster.
+ *
+ * [![clustering-types-popup](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/clustering/clustering-types-popup.png)](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+ *
+ * This module only applies to layers with a point geometry type.
+ *
+ * @since 4.16
+ * @see [FeatureReductionCluster#popupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionCluster.html#popupTemplate)
+ * @see [Sample - Point clustering - generate suggested configuration](https://developers.arcgis.com/javascript/latest/sample-code/featurereduction-cluster-filter/)
+ */
 import type SubtypeGroupLayer from "../../layers/SubtypeGroupLayer.js";
 import type SubtypeSublayer from "../../layers/support/SubtypeSublayer.js";
 import type { RendererWithVisualVariablesUnion } from "../../renderers/support/typeUtils.js";

package/smartMapping/popup/templates.d.ts

@@ -1,3 +1,21 @@
+/**
+ * This object contains helper methods for generating popup templates to be set on
+ * a [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html#popupTemplate). The suggested popup templates
+ * will only include information in the popup related to the layer's renderer. For example, the
+ * popup template in the image below was generated based on a layer rendered with a
+ * [predominance](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html) renderer coloring
+ * census tracks based on the decade in which the most homes were built.
+ *
+ * This provides a better default popup template than the traditional approach of providing a long table of unformatted values.
+ *
+ * Suggested default template based on renderer | Traditional default
+ * -----|----------
+ * [![popup-sm-default](https://developers.arcgis.com/javascript/latest/assets/img/apiref/smartMapping/popup-sm-default.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-predominance/) | ![popup-default](https://developers.arcgis.com/javascript/latest/assets/img/apiref/smartMapping/popup-default.png)
+ *
+ * @since 4.16
+ * @see [Sample - Generate a predominance visualization](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-predominance/)
+ * @see [Sample - Generate a dot density visualization](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-dotdensity/)
+ */
 import type { RendererUnion } from "../../renderers/support/typeUtils.js";
 import type { Templates } from "./types.js";
 import type { SupportedLayer } from "./support/utils.js";

package/smartMapping/raster/renderers/classBreaks.d.ts

@@ -1,3 +1,10 @@
+/**
+ * This object contains helper methods for generating class breaks visualizations for raster layers (i.e. [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html), or [WCSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html)) based on a cell or field value.
+ *
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-classBreaks.html#createRenderer) method in this module generates a renderer that may be applied directly to the input layer.
+ *
+ * @since 4.20
+ */
 import type ClassBreaksRenderer from "../../../renderers/ClassBreaksRenderer.js";
 import type { ClassBreaksParameters } from "../../../renderers/support/rasterRendererHelper.js";
 import type { RasterRendererParameters } from "./types.js";

package/smartMapping/raster/renderers/colormap.d.ts

@@ -1,3 +1,10 @@
+/**
+ * This object contains helper methods for generating a [RasterColormapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterColormapRenderer.html) for raster layers (i.e. [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html), [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html)).
+ *
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-colormap.html#createRenderer) method in this module generates a renderer that may be applied directly to the input layer.
+ *
+ * @since 4.20
+ */
 import type RasterColormapRenderer from "../../../renderers/RasterColormapRenderer.js";
 import type { RasterRendererParameters } from "./types.js";
 

package/smartMapping/raster/renderers/flow.d.ts

@@ -1,3 +1,22 @@
+/**
+ * This object contains helper methods for generating a [FlowRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-FlowRenderer.html) for a
+ * `Vector-UV` or `Vector-MagDir` [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) or
+ * [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html).
+ *
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-flow.html#createRenderer) method in this module generates a renderer that may be
+ * applied directly to the input layer.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > FlowRenderer is only supported with [ImageryTileLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryTileLayer.html) and
+ * > [ImageryLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ImageryLayer.html) where the
+ * > [source type](https://pro.arcgis.com/en/pro-app/latest/help/data/imagery/raster-dataset-properties.htm)
+ * > is `Vector-UV` or `Vector-MagDir`.
+ *
+ * @since 4.23
+ */
 import type FlowRenderer from "../../../renderers/FlowRenderer.js";
 import type { VisualVariable } from "../../../renderers/types.js";
 import type { RendererLegendOptionsProperties } from "../../../renderers/support/RendererLegendOptions.js";