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

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

@@ -1,3 +1,10 @@
+/**
+ * This object contains helper methods for generating an RGB [stretch visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.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), or [WCSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html)).
+ *
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-rgb.html#createRenderer) method in this module generates a renderer that may be applied directly to the input layer.
+ *
+ * @since 4.20
+ */
 import type RasterStretchRenderer from "../../../renderers/RasterStretchRenderer.js";
 import type { RasterStretchType } from "../../../renderers/types.js";
 import type { RasterRendererParameters } from "./types.js";

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

@@ -1,3 +1,10 @@
+/**
+ * This object contains helper methods for generating a [RasterShadedReliefRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterShadedReliefRenderer.html) to render elevation values in 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-shadedRelief.html#createRenderer) method in this module generates a renderer that may be applied directly to the input layer.
+ *
+ * @since 4.20
+ */
 import type RasterShadedReliefRenderer from "../../../renderers/RasterShadedReliefRenderer.js";
 import type AlgorithmicColorRamp from "../../../rest/support/AlgorithmicColorRamp.js";
 import type MultipartColorRamp from "../../../rest/support/MultipartColorRamp.js";

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

@@ -1,3 +1,10 @@
+/**
+ * This object contains helper methods for generating a single-band [stretch visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-RasterStretchRenderer.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), or [WCSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WCSLayer.html)).
+ *
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-raster-renderers-stretch.html#createRenderer) method in this module generates a renderer that may be applied directly to the input layer.
+ *
+ * @since 4.20
+ */
 import type RasterStretchRenderer from "../../../renderers/RasterStretchRenderer.js";
 import type AlgorithmicColorRamp from "../../../rest/support/AlgorithmicColorRamp.js";
 import type MultipartColorRamp from "../../../rest/support/MultipartColorRamp.js";

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

@@ -1,3 +1,10 @@
+/**
+ * This object contains helper methods for generating a [UniqueValueRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-UniqueValueRenderer.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-uniqueValue.html#createRenderer) method in this module generates a renderer that may be applied directly to the input layer.
+ *
+ * @since 4.20
+ */
 import type UniqueValueRenderer from "../../../renderers/UniqueValueRenderer.js";
 import type AlgorithmicColorRamp from "../../../rest/support/AlgorithmicColorRamp.js";
 import type MultipartColorRamp from "../../../rest/support/MultipartColorRamp.js";

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

@@ -1,3 +1,23 @@
+/**
+ * This object contains helper methods for generating a [VectorFieldRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-VectorFieldRenderer.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-vectorField.html#createRenderer) method in this module generates a renderer that may be
+ * applied directly to the input layer.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > VectorFieldRenderer 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`.
+ * > VectorFieldRenderer is only supported in 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+ *
+ * @since 4.20
+ */
 import type VectorFieldRenderer from "../../../renderers/VectorFieldRenderer.js";
 import type { RotationType } from "../../../core/quantity.js";
 import type { RasterRendererParameters } from "./types.js";

package/smartMapping/raster/support/colorRamps.d.ts

@@ -1,3 +1,10 @@
+/**
+ * This module provides convenience methods for querying color ramps (arrays of colors) used for raster renderers
+ * in the `module:esri/smartMapping/raster/color/renderers` modules.
+ *
+ * @since 4.29
+ * @see [Sample - ImageryTileLayer - shaded relief renderer](https://developers.arcgis.com/javascript/latest/sample-code/layers-imagery-renderer/)
+ */
 import type Color from "../../../Color.js";
 import type AlgorithmicColorRamp from "../../../rest/support/AlgorithmicColorRamp.js";
 import type MultipartColorRamp from "../../../rest/support/MultipartColorRamp.js";

package/smartMapping/raster/support/utils.d.ts

@@ -1,3 +1,8 @@
+/**
+ * This object contains utility methods for obtaining information about supported renderers of 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)).
+ *
+ * @since 4.20
+ */
 import type { RasterRendererUnion } from "../../../renderers/support/rasterTypeUtils.js";
 import type { RasterRendererParameters } from "../renderers/types.js";
 

package/smartMapping/renderers/color.d.ts

@@ -1,3 +1,20 @@
+/**
+ * This object contains helper methods for generating data-driven visualizations with continuous
+ * color or class breaks based on a field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
+ * The methods in this module generate renderer or visual variable objects that may be applied directly to a supported layer. The
+ * renderers specify how features should be visualized based on data values and colors compatible with the view's background.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. To check a SceneLayer's capabilities, use the [SceneLayer#getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method.
+ * > You cannot generate renderers and visual variables using SQL expressions for client-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * > in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * @since 4.2
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type Basemap from "../../Basemap.js";
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type ClassBreaksRenderer from "../../renderers/ClassBreaksRenderer.js";

package/smartMapping/renderers/dotDensity.d.ts

@@ -1,3 +1,24 @@
+/**
+ * This object contains a helper method for generating a [dot density visualization](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html).
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-dotDensity.html#createRenderer) method uses the view's background to determine the most
+ * appropriate dot color for each attribute. It also queries the layer for spatial statistics to determine
+ * an appropriate [dot value](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html#dotValue) for the
+ * given scale. The starting dot value isn't necessarily what will work best for your data. Rather, it
+ * is a suggestion that should give you a good starting point for authoring a dot density renderer.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [DotDensityRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-DotDensityRenderer.html) is currently not supported in 3D [SceneViews](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ * > Only layers with polygon geometries are supported.
+ *
+ * @since 4.12
+ * @see [Sample - Generate a predominance visualization](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-predominance/)
+ * @see [ArcGIS Blog: Creating a predominance visualization with Arcade](https://www.esri.com/arcgis-blog/products/js-api-arcgis/mapping/creating-a-predominance-visualization-with-arcade/)
+ * @see [ArcGIS Blog: Map Multiple Attributes at Once using Predominance](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/map-multiple-attributes-at-once-using-predominance/)
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type DotDensityRenderer from "../../renderers/DotDensityRenderer.js";
 import type MapView from "../../views/MapView.js";

package/smartMapping/renderers/heatmap.d.ts

@@ -1,3 +1,20 @@
+/**
+ * This object contains a helper method for generating a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) for a point [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
+ *
+ * It is important to note that the input layer must have features available in the input view
+ * for the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-heatmap.html#createRenderer) method to generate a meaningful heatmap.
+ * Otherwise, the method will fail.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitation**
+ * >
+ * > Only layers with point geometries are supported.
+ *
+ * @since 4.11
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ * @see [Sample - Explore point data with a heatmap](https://developers.arcgis.com/javascript/latest/sample-code/visualization-heatmap/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type HeatmapRenderer from "../../renderers/HeatmapRenderer.js";
 import type { AbortOptions } from "../../core/promiseUtils.js";

package/smartMapping/renderers/location.d.ts

@@ -1,3 +1,13 @@
+/**
+ * This object contains helper methods for generating location-only visualizations (not data-driven) in
+ * a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-location.html#createRenderer) method generates a
+ * [SimpleRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-SimpleRenderer.html) object that may be applied directly to the layer. This
+ * renderer contains a single symbol with a color optimally selected based on the background of the view.
+ *
+ * @since 4.2
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type SimpleRenderer from "../../renderers/SimpleRenderer.js";
 import type { AbortOptions } from "../../core/promiseUtils.js";

package/smartMapping/renderers/opacity.d.ts

@@ -1,3 +1,22 @@
+/**
+ * This object contains a helper method for generating data-driven visualizations with continuous
+ * opacity based on data returned from a field value or expression in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
+ *
+ * The [createVisualVariable()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-opacity.html#createVisualVariable) method
+ * generates an {@link renderers/Renderer#OpacityVisualVariable opacity visual variable}
+ * with default alpha values that are optimally mapped to data values based on the statistics of the indicated field.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. To check a SceneLayer's capabilities, use the [SceneLayer#getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method.
+ * > You cannot generate renderers and visual variables using SQL expressions for client-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * > in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * @since 4.6
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type AuthoringInfo from "../../renderers/support/AuthoringInfo.js";
 import type OpacityVariable from "../../renderers/visualVariables/OpacityVariable.js";

package/smartMapping/renderers/pieChart.d.ts

@@ -1,3 +1,22 @@
+/**
+ * This object contains a helper method for generating a pie chart for every feature.
+ *
+ *
+ * For example, suppose you have a layer of U.S. counties with fields containing the total sales of various crops:
+ * wheat, soybeans, corn, cotton, and vegetables.
+ * You can use the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-pieChart.html#createRenderer) method in this module to generate a chart for each feature visualizing the proportion
+ * of each crop type for every county.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Only supported in 2D [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+ * > Only supported in layers with `point` and `polygon` geometries.
+ *
+ * @since 4.24
+ * @see [PieChartRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-PieChartRenderer.html)
+ */
 import type CSVLayer from "../../layers/CSVLayer.js";
 import type FeatureLayer from "../../layers/FeatureLayer.js";
 import type GeoJSONLayer from "../../layers/GeoJSONLayer.js";

package/smartMapping/renderers/predominance.d.ts

@@ -1,3 +1,30 @@
+/**
+ * This object contains a helper method for generating a predominance visualization.
+ * Visualizing predominance involves coloring a [layer's](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) features based on which attribute among a set of competing
+ * numeric attributes wins or beats the others in total count. Common applications of this include visualizing
+ * election results, survey results, and demographic majorities.
+ *
+ * For example, suppose you have a layer of U.S. counties with fields containing the total sales of various crops: wheat, soybeans, corn, cotton, and vegetables.
+ * You can use the [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html#createRenderer) method in this module to generate a default visualization depicting the winner, or most
+ * predominant crop, in each county.
+ *
+ * The example below depicts the predominant decade in which homes were constructed based on a city's block groups.
+ *
+ * [![predominance-size](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/predominance-default.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-predominance/)
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Currently, 3D symbols can only be generated for layers with a `point` geometry type.
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. 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.9
+ * @see [Sample - Generate a predominance visualization](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-predominance/)
+ * @see [ArcGIS Blog: Creating a predominance visualization with Arcade](https://www.esri.com/arcgis-blog/products/js-api-arcgis/mapping/creating-a-predominance-visualization-with-arcade/)
+ * @see [ArcGIS Blog: Map Multiple Attributes at Once using Predominance](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/map-multiple-attributes-at-once-using-predominance/)
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type UniqueValueRenderer from "../../renderers/UniqueValueRenderer.js";
 import type * as opacityCreator from "./opacity.js";

package/smartMapping/renderers/relationship.d.ts

@@ -1,3 +1,51 @@
+/**
+ * This object contains a helper method for creating a renderer for exploring the relationship between two numeric attributes.
+ * This is commonly known as a [bivariate choropleth](https://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/)
+ * visualization. This renderer classifies each variable in either 2, 3, or 4 classes along separate color ramps. One of those ramps
+ * is rotated 90 degrees and overlaid on the other to create a 2x2, 3x3, or 4x4 square grid. The x-axis indicates the range of
+ * values for one variable, and the y-axis indicates the range for the second variable. The squares running diagonal from the
+ * lower left corner to the upper right corner indicate features where the two variables may be related or in agreement with one
+ * another.
+ *
+ * <figure>
+ * <a href="https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/what-is-a-relationship-map" target="_blank"><img src="https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-legend.png" alt="Relationship renderer legend"></a>
+ * <figcaption style="border-left: none;margin-top:0">
+ *   The legend of a relationship renderer resembles a grid of two single-hue sequential color ramps overlaid on each other, forming a third
+ *   hue along a diagonal line, which indicates where the two variables could potentially be related.
+ * </figcaption>
+ * </figure>
+ *
+ * The lower right and upper left corners indicate features where one field has high values and the other field low values and
+ * vice versa. The image below shows what this style looks like on a map of U.S. counties where the percent of the population diagnosed
+ * with Diabetes is compared to the percent of the population that is obese.
+ *
+ * [![relationship-obesity-diabetes](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-2d-example.png)](https://www.arcgis.com/home/webmap/viewer.html?webmap=c09aee5d3fee41c489fdffec21cb270a)
+ *
+ * While this visualization style was originally designed for 2D choropleth maps, it is particularly useful in 3D scenes where
+ * bivariate visualizations of color and size would not otherwise be possible since the size of features is reserved for real-world sizes of objects,
+ * such as buildings. Therefore, the relationship renderer becomes ideal for creating thematic bivariate visualizations of
+ * 3d object [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html).
+ *
+ * [![Generate a relationship visualization](https://developers.arcgis.com/javascript/latest/assets/img/apiref/renderers/smartmapping/relationship-3d-example.png)](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-relationship/)
+ *
+ * Keep in mind that even if you observe a positive relationship between the two variables of interest, it doesn't mean they
+ * are statistically correlated. It also doesn't imply the presence of one variable influences the other. Therefore, this
+ * renderer should be used judiciously with some prior knowledge that two variables may likely be related.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. 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.9
+ * @see [Samples - Generate a relationship visualization](https://developers.arcgis.com/javascript/latest/sample-code/visualization-sm-relationship/)
+ * @see [ArcGIS Blog - What is a Relationship Map?](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/what-is-a-relationship-map/)
+ * @see [ArcGIS Blog - How to Make a Relationship Map in ArcGIS Online](https://www.esri.com/arcgis-blog/products/arcgis-online/mapping/how-to-make-a-relationship-map-in-arcgis-online/)
+ * @see [Bivariate Choropleth Maps: A How-to Guide](https://www.joshuastevens.net/cartography/make-a-bivariate-choropleth-map/)
+ * @see [Wikipedia - Bivariate map](https://en.wikipedia.org/wiki/Bivariate_map)
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type Color from "../../Color.js";
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type UniqueValueRenderer from "../../renderers/UniqueValueRenderer.js";

package/smartMapping/renderers/size.d.ts

@@ -1,3 +1,21 @@
+/**
+ * This object contains helper methods for generating data-driven visualizations with continuous
+ * size or class breaks based on a field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
+ * The methods in this module generate renderer or visual variable objects that may be applied directly to a supported layer. The
+ * renderers specify how features should be visualized based on data values and the view's background.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Currently, 3D symbols can only be generated for layers with a `point` geometry type.
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with `mesh` [SceneLayer#geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) or [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) without the `supportsRenderer` and `supportsLayerQuery` capabilities enabled are not supported 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.
+ * > You cannot generate renderers and visual variables using SQL expressions for client-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * > in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * @since 4.2
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type ClassBreaksRenderer from "../../renderers/ClassBreaksRenderer.js";
 import type UniqueValueRenderer from "../../renderers/UniqueValueRenderer.js";

package/smartMapping/renderers/support/rendererUtils.d.ts

@@ -1,3 +1,11 @@
+/**
+ * This module provides a function for regenerating renderers based on the current state of the layer and view.
+ * This is useful when you want to update a renderer based on changes to the layer's data, the data
+ * visible in the view, binning configuration, or the view's scale.
+ *
+ * @since 4.31
+ * @see [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html)
+ */
 import type FeatureFilter from "../../../layers/support/FeatureFilter.js";
 import type { MapViewOrSceneView } from "../../../views/MapViewOrSceneView.js";
 import type { AbortOptions } from "../../../core/promiseUtils.js";

package/smartMapping/renderers/support/spikeUtils.d.ts

@@ -1,3 +1,9 @@
+/**
+ * This module provides utility functions for creating and updating spike symbols for size renderers
+ * generated with a `spike` theme.
+ *
+ * @since 4.33
+ */
 import type Color from "../../../Color.js";
 import type CIMSymbol from "../../../symbols/CIMSymbol.js";
 import type { PrimitiveOverride } from "../../../symbols/cim/CIMTypes.js";

package/smartMapping/renderers/type.d.ts

@@ -1,3 +1,21 @@
+/**
+ * This object contains helper methods for generating data-driven visualizations with unique types (or categories)
+ * based on a field value from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
+ * The [createRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-type.html#createRenderer) method generates a
+ * [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) object that may be applied directly to the layer used to
+ * generate it. This
+ * renderer contains unique values with colors best suited to the view's background.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. To check a SceneLayer's capabilities, use the [SceneLayer#getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method.
+ * > Generating renderers and visual variables using SQL expressions is currently restricted to feature services hosted on [ArcGIS Online](https://www.arcgis.com).
+ *
+ * @since 4.4
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type PointCloudUniqueValueRenderer from "../../renderers/PointCloudUniqueValueRenderer.js";
 import type UniqueValueRenderer from "../../renderers/UniqueValueRenderer.js";

package/smartMapping/renderers/univariateColorSize.d.ts

@@ -1,3 +1,32 @@
+/**
+ * This object contains helper methods for generating data-driven univariate visualizations using both continuous
+ * color and continuous size based on a single field value or expression from features in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
+ * The [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-univariateColorSize.html#createContinuousRenderer) method generates a
+ * [Renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-Renderer.html) object that may be applied directly to a supported layer. This
+ * renderer contains a continuous color and size ramp with optimal colors based on the view's background
+ * and mapped to specific break values based on the statistics of the indicated field or expression.
+ *
+ * Alternately, you can use the {@link smartMapping/renderers/univariateColorSize#createvisualvariables createVisualVariable()} method to
+ * generate a {@link renderers/Renderer#ColorVisualVariable color}
+ * and a {@link renderers/Renderer#ColorVisualVariable size visual variable}
+ * with default stops and colors that are optimally chosen based on the statistics of the indicated field.
+ *
+ * Since thematic size
+ * may be difficult to interpret on its own in 3D extrusions, adding a color ramp representing the same
+ * data helps effectively communicate the story of the visualization so it's more easily understood by the audience.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Currently 3D symbols can only be generated for layers with a `point` geometry type.
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with `mesh` [SceneLayer#geometryType](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#geometryType) or [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) without the `supportsRenderer` and `supportsLayerQuery` capabilities enabled are not supported 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.
+ * > You cannot generate renderers and visual variables using SQL expressions for client-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * > in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * @since 4.2
+ * @see [Styles and data visualization](https://developers.arcgis.com/javascript/latest/visualization/)
+ */
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type ClassBreaksRenderer from "../../renderers/ClassBreaksRenderer.js";
 import type AuthoringInfo from "../../renderers/support/AuthoringInfo.js";

package/smartMapping/statistics/classBreaks.d.ts

@@ -1,3 +1,17 @@
+/**
+ * Function for generating class breaks for an input field in a [FeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) based
+ * on a given classification method and normalization type.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. To check a SceneLayer's capabilities, use the [SceneLayer#getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method.
+ * > You cannot generate statistics using SQL expressions for client-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * > in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ *
+ * @since 4.2
+ */
 import type { ClassBreaksParams, ClassBreaksResult } from "./types.js";
 
 /**

package/smartMapping/statistics/heatmapStatistics.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Function for generating statistics from a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) for
+ * a [HeatmapRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-HeatmapRenderer.html) visualization.
+ *
+ * It is important to note that the input layer must have features available in the input view
+ * for the [heatmapStatistics()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-heatmapStatistics.html#heatmapStatistics) method to generate pixel intensity statistics.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > Only layers with point geometries are supported.
+ *
+ * @since 4.8
+ */
 import type { HeatmapStatisticsParams, HeatmapStatisticsResult } from "./types.js";
 
 /**

package/smartMapping/statistics/histogram.d.ts

@@ -1,3 +1,20 @@
+/**
+ * Generates a histogram based on data in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) for a given field.
+ * The returned object can be used for displaying
+ * a histogram in the UI within visualization authoring applications and analytical apps that query and
+ * display statistics.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. To check a SceneLayer's capabilities, use the [SceneLayer#getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method.
+ * > You cannot generate statistics using SQL expressions for client-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * > in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ * >  The `normalizationType` parameter only normalizes data returned by a `field`. It does not apply to values returned from a `valueExpression` or `sqlExpression`.
+ *
+ * @since 4.2
+ */
 import type { HistogramParams, HistogramResult } from "./types.js";
 
 /**

package/smartMapping/statistics/predominantCategories.d.ts

@@ -1,3 +1,9 @@
+/**
+ * Function for generating category statistics for a [predominance](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html)
+ * renderer.
+ *
+ * @since 4.13
+ */
 import type { PredominantCategoriesParams, PredominantCategoriesResult } from "./types.js";
 
 /**

package/smartMapping/statistics/summaryStatistics.d.ts

@@ -1,3 +1,18 @@
+/**
+ * Function for generating attribute statistics in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) based on
+ * values returned from a given field.
+ *
+ * > [!WARNING]
+ * >
+ * > **Known Limitations**
+ * >
+ * > [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) must have 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 provided to the `statistics` parameter of the method. To check a SceneLayer's capabilities, use the [SceneLayer#getFieldUsageInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html#getFieldUsageInfo) method.
+ * > You cannot generate statistics using SQL expressions for client-side [FeatureLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html)
+ * > in a [SceneView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html).
+ * >  The `normalizationType` parameter only normalizes data returned by a `field`. It does not apply to values returned from a `valueExpression` or `sqlExpression`.
+ *
+ * @since 4.2
+ */
 import type { SummaryStatisticsParams, SummaryStatisticsResult } from "./types.js";
 
 /**

package/smartMapping/statistics/summaryStatisticsForAge.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Function for generating statistics for the age of features in a layer based on a given start time and end time.
+ *
+ * @since 4.13
+ * @see [colorRendererCreator.createAgeRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer)
+ * @see [sizeRendererCreator.createAgeRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer)
+ */
 import type { SummaryStatisticsForAgeParams, SummaryStatisticsResult } from "./types.js";
 
 /**
@@ -5,7 +12,7 @@ import type { SummaryStatisticsForAgeParams, SummaryStatisticsResult } from "./t
  * the difference between a given end time from a start time) in a [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html).
  *
  * @param parameters - See the table below for details of each parameter.
- * @returns Returns a promise that resolves to {@link smartMapping/statistics/summaryStatisticsForAge#SummaryStatisticsResult}.
+ * @returns Returns a promise that resolves to [SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-types.html#SummaryStatisticsResult).
  * @example
  * summaryStatisticsForAge({
  *   layer: featureLayer,

package/smartMapping/statistics/support/ageUtils.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Provides utility functions for generating [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) expressions
+ * intended for use in an [age renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer).
+ *
+ * @since 4.13
+ * @see [colorRendererCreator.createAgeRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-color.html#createAgeRenderer)
+ * @see [sizeRendererCreator.createAgeRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createAgeRenderer)
+ */
 import type { SupportedLayer } from "../../types.js";
 import type { DateType, UnitType } from "../../support/utils.js";
 

package/smartMapping/statistics/support/predominanceUtils.d.ts

@@ -1,3 +1,10 @@
+/**
+ * Provides utility functions for generating [Arcade](https://developers.arcgis.com/javascript/latest/arcade/) and SQL expressions
+ * intended for use in an [predominance renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html).
+ *
+ * @since 4.23
+ * @see [predominance renderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-predominance.html)
+ */
 import type CSVLayer from "../../../layers/CSVLayer.js";
 import type FeatureLayer from "../../../layers/FeatureLayer.js";
 import type GeoJSONLayer from "../../../layers/GeoJSONLayer.js";
@@ -27,7 +34,7 @@ import type SubtypeSublayer from "../../../layers/support/SubtypeSublayer.js";
  */
 export function getPredominanceExpressions(layer: FeatureLayer | SceneLayer | CSVLayer | GeoJSONLayer | WFSLayer | OGCFeatureLayer | StreamLayer | OrientedImageryLayer | KnowledgeGraphSublayer | SubtypeGroupLayer | CatalogFootprintLayer | SubtypeSublayer, fieldNames: string[]): PredominantExpressions;
 
-/** The result object returned from the {@link smartMapping/statistics/support/predominanceUtils#getAgeExpressions} method. */
+/** The result object returned from the [getPredominanceExpressions()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-support-predominanceUtils.html#getPredominanceExpressions) method. */
 export interface PredominantExpressions {
   /** The Arcade and SQL expressions used to query the server or client-side layer for statistics of the percentage among all competing fields comprised by the predominant category. */
   opacity: OpacityExpressionInfo;

package/smartMapping/statistics/types.d.ts

@@ -1,3 +1,8 @@
+/**
+ * A module for importing types used in smart mapping statistics modules.
+ *
+ * @since 4.33
+ */
 import type Graphic from "../../Graphic.js";
 import type FeatureFilter from "../../layers/support/FeatureFilter.js";
 import type { MapViewOrSceneView } from "../../views/MapViewOrSceneView.js";
@@ -8,7 +13,7 @@ import type { SupportedLayer } from "../types.js";
 import type { UnitType, DateType } from "../support/utils.js";
 import type { OutStatisticTypes } from "../../statistics/types.js";
 
-/** The result returned from the {@link smartMapping/statistics/types#histogram} method. */
+/** The result returned from the [histogram()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram) method. */
 export interface HistogramResult {
   /** An array of objects representing each bin in the histogram. */
   bins: HistogramBin[];