@arcgis/core 5.0.0-next.70 → 5.0.0-next.71

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

@@ -2,25 +2,36 @@ import type RasterFunction from "../../../layers/support/RasterFunction.js";
 import type { AbortOptions } from "../../../core/promiseUtils.js";
 import type { RasterLayer } from "../support/adapters/types.js";
 
+/** @since 5.0 */
 export interface RasterRendererParameters extends AbortOptions {
   /**
    * The
    *   input layer for which the renderer is generated. The
    *   [source type](https://pro.arcgis.com/en/pro-app/latest/help/data/imagery/raster-dataset-properties.htm)
    *   of the raster must be `Vector-UV` or `Vector-MagDir`.
+   *
+   * @since 5.0
    */
   layer: RasterLayer;
   /**
    * Specifies the function for how the requested image
    *   should be processed. When `rasterFunction` is applied, the server returns updated service information that reflects custom
    *   processing as defined by the raster function. If not provided, the output renderer is created using the layer's `rasterFunction`.
+   *
+   * @since 5.0
    */
   rasterFunction?: RasterFunction | null;
-  /** Deprecated since 4.27. Use `rasterFunction` instead. */
+  /**
+   * Deprecated since 4.27. Use `rasterFunction` instead.
+   *
+   * @since 5.0
+   */
   renderingRule?: RasterFunction;
   /**
    * Only applicable to multidimensional datasets where a raster layer can contain more than one variable
    *   (such as temperature, humidity, wind speed) with different statistics. Indicate the variable name here.
+   *
+   * @since 5.0
    */
   variableName?: string;
 }

package/smartMapping/raster/support/adapters/types.d.ts

@@ -2,4 +2,5 @@ import type ImageryLayer from "../../../../layers/ImageryLayer.js";
 import type ImageryTileLayer from "../../../../layers/ImageryTileLayer.js";
 import type WCSLayer from "../../../../layers/WCSLayer.js";
 
+/** @since 5.0 */
 export type RasterLayer = ImageryLayer | ImageryTileLayer | WCSLayer;

package/smartMapping/renderers/color.d.ts

@@ -376,12 +376,14 @@ export interface VisualVariableParametersBase extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**
@@ -643,12 +645,14 @@ export interface ClassBreaksRendererParameters extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**
@@ -938,12 +942,14 @@ export interface AgeRendererParameters extends AbortOptions {
    */
   endTime: DateProperties;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/dotDensity.d.ts

@@ -120,12 +120,14 @@ export interface RendererParameters extends AbortOptions {
    */
   dotValueOptimizationEnabled?: boolean | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/heatmap.d.ts

@@ -103,12 +103,14 @@ export interface HeatmapRendererParameters extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/location.d.ts

@@ -66,12 +66,14 @@ export interface RendererParameters extends AbortOptions {
    */
   colorMixMode?: ColorMixModeType | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /** Indicates whether the generated renderer is for a binning or clustering visualization. */

package/smartMapping/renderers/opacity.d.ts

@@ -95,12 +95,14 @@ export interface VisualVariableParameters extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/pieChart.d.ts

@@ -117,12 +117,14 @@ export interface RendererParameters extends AbortOptions {
    */
   attributes?: Attribute[] | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/predominance.d.ts

@@ -153,12 +153,14 @@ export interface RendererParameters extends AbortOptions {
    */
   fields?: FieldInfo[] | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/relationship.d.ts

@@ -182,12 +182,14 @@ export interface RendererParameters extends AbortOptions {
    */
   field2?: FieldInfo | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/size.d.ts

@@ -310,11 +310,13 @@ export interface VisualVariableParamsBase extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could otherwise result in undesired size ranges and stops. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**
@@ -352,13 +354,15 @@ export interface VisualVariableParamsBase extends AbortOptions {
    */
   normalizationField?: string | null;
   /**
-   * _Since 4.30_ Options for specifying the symbol used in a reference size visualization. When defined, creates a proportional size renderer with an outer ring
+   * Options for specifying the symbol used in a reference size visualization. When defined, creates a proportional size renderer with an outer ring
    *   that functions as a reference line representing a maximum data value (or threshold). The ring is proportionally filled by an inner
    *   dot based on the feature's data value specified in `field` (and `normalizationField` if defined). This is a good style for visualizing
    *   ratios and percentages. It works best for gridded datasets where geometries don't overlap, such as styles for
    *   binning (i.e. `forBinning = true`), hexbin layers, or any other layer created with data aggregated to tessellated
    *   shapes. This parameter only applies to layers with a `polygon` geometry type, or any layer that has [binning](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-FeatureReductionBinning.html) enabled.
    *   This parameter is ignored if `valueExpression` is specified in lieu of a `field`.
+   *
+   * @since 4.30
    */
   referenceSizeOptions?: ReferenceSizeParameters | null;
   /**
@@ -376,7 +380,11 @@ export interface VisualVariableParamsBase extends AbortOptions {
    * based on the view's background.
    */
   sizeScheme?: SizeScheme | null;
-  /** _Since 4.33_ Options for specifying the symbol used in a spike theme. */
+  /**
+   * Options for specifying the symbol used in a spike theme.
+   *
+   * @since 4.33
+   */
   spikeOptions?: SpikeOptions | null;
   /**
    * A SQL expression evaluating to a number. When provided, statistics are
@@ -447,9 +455,11 @@ export interface VisualVariableResultBase {
    */
   defaultValuesUsed: boolean;
   /**
-   * _Since 4.30_ Indicates if the polygon layer used to generate the renderer
+   * Indicates if the polygon layer used to generate the renderer
    *   was determined to be gridded. This is done when `referenceSizeOptions` are set for creating
    *   a reference size visualization.
+   *
+   * @since 4.30
    */
   isGrid?: boolean;
   /** The size scheme used by the visual variables. */
@@ -695,12 +705,14 @@ export interface ClassBreaksRendererParameters extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**
@@ -884,12 +896,14 @@ export interface AgeRendererParameters extends AbortOptions {
    */
   endTime: DateProperties;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**
@@ -906,7 +920,9 @@ export interface AgeRendererParameters extends AbortOptions {
   legendOptions?: VisualVariableLegendOptions | null;
   /**
    * Sets a maximum age for the visualization. Even if data exists above this value,
-   *   only statistics will be calculated for values between the `minValue` and `maxValue`. Added at version 4.15.
+   *   only statistics will be calculated for values between the `minValue` and `maxValue`.
+   *
+   * @since 4.15
    */
   maxValue?: number | null;
   /**

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

@@ -37,12 +37,14 @@ export interface RegenerateRendererParameters extends AbortOptions {
    */
   forBinning?: boolean;
   /**
-   * _Since 4.33_ An array of strings indicating which
+   * An array of strings indicating which
    *   parts of the renderer to include in the regeneration.
    *  If not provided, all parts are included by default. The available options are:
    *  - `color-variable`: Only regenerate the color visual variable.
    *  - `size-variable`: Only regenerate the size visual variable.
    *  - `class-breaks`: Regenerate the class breaks for the renderer.
+   *
+   * @since 4.33
    */
   includedParts?: ("color-variable" | "size-variable" | "class-breaks")[];
   /** The layer for which to regenerate the renderer. */

package/smartMapping/renderers/type.d.ts

@@ -158,12 +158,14 @@ export interface RendererParameters extends AbortOptions {
    */
   field3?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/renderers/univariateColorSize.d.ts

@@ -183,12 +183,14 @@ export interface VisualVariablesParamsBase extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /**

package/smartMapping/statistics/types.d.ts

@@ -59,12 +59,14 @@ export interface SummaryStatisticsParameters extends AbortOptions {
    */
   field?: string | null;
   /**
-   * _Since 4.25_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.25
    */
   filter?: FeatureFilter | null;
   /**
@@ -100,7 +102,11 @@ export interface SummaryStatisticsParameters extends AbortOptions {
    * square-root | Computes the square root of the data values. This can be a useful approach for viewing highly skewed data distributions because it reduces the influence of outliers. Only positive values are computed. You should avoid this normalization type if your data contains a significant number of negative values. |
    */
   normalizationType?: NormalizationType | null;
-  /** _Since 4.31_ Indicates the statistics to calculate. If not defined, all statistics are calculated by default. The object should have the following properties. */
+  /**
+   * Indicates the statistics to calculate. If not defined, all statistics are calculated by default. The object should have the following properties.
+   *
+   * @since 4.31
+   */
   outStatisticTypes?: OutStatisticTypes | null;
   /**
    * A SQL expression evaluating to a number. When provided, statistics are
@@ -561,17 +567,23 @@ export interface SummaryStatisticsForAgeParameters extends AbortOptions {
    */
   endTime: DateProperties;
   /**
-   * _Since 4.31_ When defined, only features included in the filter
+   * When defined, only features included in the filter
    *   are considered in the attribute and spatial statistics calculations when determining the final renderer.
    *   This is useful when a lot of variation exists in the data
    *   that could result in undesired data ranges. A common use case would be to set a filter that only
    *   includes features in the current extent of the view where the data is most likely to be viewed. Currently, only
    *   geometry filters with an `intersects` spatial relationship are supported. All other filter types (including `where`) are ignored.
+   *
+   * @since 4.31
    */
   filter?: FeatureFilter | null;
   /** The layer from which to generate age statistics for the given `startTime` and `endTime`. */
   layer: SupportedLayer;
-  /** _Since 4.31_ Indicates the statistics to calculate. If not defined, all statistics are calculated by default. The object should have the following properties. */
+  /**
+   * Indicates the statistics to calculate. If not defined, all statistics are calculated by default. The object should have the following properties.
+   *
+   * @since 4.31
+   */
   outStatisticTypes?: OutStatisticTypes | null;
   /**
    * The start time for the age calculation. This can be a field name or a date

package/smartMapping/symbology/type.d.ts

@@ -103,7 +103,11 @@ export interface GetSchemesParameters {
   basemapTheme?: BasemapTheme | null;
   /** The geometry type of the features to visualize. | mesh */
   geometryType: "point" | "multipoint" | "polyline" | "polygon" | "mesh" | "multipatch" | null;
-  /** _Since 4.31_ Indicates the number of colors to include in the color ramp within the scheme. */
+  /**
+   * Indicates the number of colors to include in the color ramp within the scheme.
+   *
+   * @since 4.31
+   */
   numColors?: number | null;
   /**
    * Determines whether to return a standardized  unique value