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

package/layers/raster/functions/creators/createBandIndexFunctions.d.ts

@@ -1,63 +1,150 @@
 import type { BaseRasterFunctionParameters } from "../types.js";
 
+/** @since 5.0 */
 export interface NDVIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
-  /** Output values are linearly scaled to 0 to 200 when scientificOutput is false. Default is true. */
+  /**
+   * Output values are linearly scaled to 0 to 200 when scientificOutput is false. Default is true.
+   *
+   * @since 5.0
+   */
   scientificOutput?: boolean;
 }
 
+/** @since 5.0 */
 export interface SAVIBandParameters extends BaseRasterFunctionParameters {
-  /** The amount of green vegetation cover from 0 to 1. Default is 0.33. */
+  /**
+   * The amount of green vegetation cover from 0 to 1. Default is 0.33.
+   *
+   * @since 5.0
+   */
   factor?: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface TSAVIBandParameters extends BaseRasterFunctionParameters {
-  /** The adjustment factor to minimize soil noise. Default is 1.5. */
+  /**
+   * The adjustment factor to minimize soil noise. Default is 1.5.
+   *
+   * @since 5.0
+   */
   factor?: number;
-  /** The soil line intercept. Default is 0.5. */
+  /**
+   * The soil line intercept. Default is 0.5.
+   *
+   * @since 5.0
+   */
   intercept?: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
-  /** The soil line slope. Default is 0.33. */
+  /**
+   * The soil line slope. Default is 0.33.
+   *
+   * @since 5.0
+   */
   slope?: number;
 }
 
+/** @since 5.0 */
 export interface MSAVIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface GEMIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface PVIBandParameters extends BaseRasterFunctionParameters {
-  /** The soil line gradient. Default is 0.5. */
+  /**
+   * The soil line gradient. Default is 0.5.
+   *
+   * @since 5.0
+   */
   gradient?: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
-  /** The soil line slope. Default is 0.3. */
+  /**
+   * The soil line slope. Default is 0.3.
+   *
+   * @since 5.0
+   */
   slope?: number;
 }
 
+/** @since 5.0 */
 export interface LandsatBandParameters extends BaseRasterFunctionParameters {
-  /** The bandIds array representing Landsat band 1, 2, 3, 4, 5, 7. */
+  /**
+   * The bandIds array representing Landsat band 1, 2, 3, 4, 5, 7.
+   *
+   * @since 5.0
+   */
   bandIds: [
       number,
       number,
@@ -68,8 +155,13 @@ export interface LandsatBandParameters extends BaseRasterFunctionParameters {
   ];
 }
 
+/** @since 5.0 */
 export interface SultanParameters extends BaseRasterFunctionParameters {
-  /** The bandIds array representing band 1, 3, 4, 5, 6. */
+  /**
+   * The bandIds array representing band 1, 3, 4, 5, 6.
+   *
+   * @since 5.0
+   */
   bandIds: [
       number,
       number,
@@ -79,166 +171,384 @@ export interface SultanParameters extends BaseRasterFunctionParameters {
   ];
 }
 
+/** @since 5.0 */
 export interface VARIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based blue band id. */
+  /**
+   * The 0-based blue band id.
+   *
+   * @since 5.0
+   */
   blueBandId: number;
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface GDNVIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
 }
 
+/** @since 5.0 */
 export interface SRBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface NDVIreBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red edge band id. */
+  /**
+   * The 0-based red edge band id.
+   *
+   * @since 5.0
+   */
   reBandId: number;
 }
 
+/** @since 5.0 */
 export interface SRreBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red edge band id. */
+  /**
+   * The 0-based red edge band id.
+   *
+   * @since 5.0
+   */
   reBandId: number;
 }
 
+/** @since 5.0 */
 export interface MTVI2BandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface RTVICoreBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red edge band id. */
+  /**
+   * The 0-based red edge band id.
+   *
+   * @since 5.0
+   */
   reBandId: number;
 }
 
+/** @since 5.0 */
 export interface CIreBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red edge band id. */
+  /**
+   * The 0-based red edge band id.
+   *
+   * @since 5.0
+   */
   reBandId: number;
 }
 
+/** @since 5.0 */
 export interface CIgBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
 }
 
+/** @since 5.0 */
 export interface NDWIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
 }
 
+/** @since 5.0 */
 export interface EVIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based blue band id. */
+  /**
+   * The 0-based blue band id.
+   *
+   * @since 5.0
+   */
   blueBandId: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface IronOxideBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based blue band id. */
+  /**
+   * The 0-based blue band id.
+   *
+   * @since 5.0
+   */
   blueBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface FerrousMineralsBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based shortwave infrared band id. */
+  /**
+   * The 0-based shortwave infrared band id.
+   *
+   * @since 5.0
+   */
   swirBandId: number;
 }
 
+/** @since 5.0 */
 export interface ClayMineralsBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based shortwave infrared band id centering around 1.5—1.75µm. */
+  /**
+   * The 0-based shortwave infrared band id centering around 1.5—1.75µm.
+   *
+   * @since 5.0
+   */
   swir1BandId: number;
-  /** The 0-based shortwave infrared band id centering around 2.08—2.35µm. */
+  /**
+   * The 0-based shortwave infrared band id centering around 2.08—2.35µm.
+   *
+   * @since 5.0
+   */
   swir2BandId: number;
 }
 
+/** @since 5.0 */
 export interface WNDWIBandParameters extends BaseRasterFunctionParameters {
-  /** A weighted coefficient ranging from 0 to 1. Default is 0.5. */
+  /**
+   * A weighted coefficient ranging from 0 to 1. Default is 0.5.
+   *
+   * @since 5.0
+   */
   alpha?: number;
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based shortwave infrared band id. */
+  /**
+   * The 0-based shortwave infrared band id.
+   *
+   * @since 5.0
+   */
   swirBandId: number;
 }
 
+/** @since 5.0 */
 export interface BAIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based red band id. */
+  /**
+   * The 0-based red band id.
+   *
+   * @since 5.0
+   */
   redBandId: number;
 }
 
+/** @since 5.0 */
 export interface NBRBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based shortwave infrared band id. */
+  /**
+   * The 0-based shortwave infrared band id.
+   *
+   * @since 5.0
+   */
   swirBandId: number;
 }
 
+/** @since 5.0 */
 export interface NDBIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based shortwave infrared band id. */
+  /**
+   * The 0-based shortwave infrared band id.
+   *
+   * @since 5.0
+   */
   swirBandId: number;
 }
 
+/** @since 5.0 */
 export interface NDMIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based near infrared band id. */
+  /**
+   * The 0-based near infrared band id.
+   *
+   * @since 5.0
+   */
   nirBandId: number;
-  /** The 0-based shortwave infrared band id. */
+  /**
+   * The 0-based shortwave infrared band id.
+   *
+   * @since 5.0
+   */
   swirBandId: number;
 }
 
+/** @since 5.0 */
 export interface NDSIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based shortwave infrared band id. */
+  /**
+   * The 0-based shortwave infrared band id.
+   *
+   * @since 5.0
+   */
   swirBandId: number;
 }
 
+/** @since 5.0 */
 export interface MNDWIBandParameters extends BaseRasterFunctionParameters {
-  /** The 0-based green band id. */
+  /**
+   * The 0-based green band id.
+   *
+   * @since 5.0
+   */
   greenBandId: number;
-  /** The 0-based shortwave infrared band id. */
+  /**
+   * The 0-based shortwave infrared band id.
+   *
+   * @since 5.0
+   */
   swirBandId: number;
 }
 
+/** @since 5.0 */
 export interface CustomBandParameters extends BaseRasterFunctionParameters {
-  /** The custom band index, e.g. (b1 - b0) / (b1 + b0) */
+  /**
+   * The custom band index, e.g. (b1 - b0) / (b1 + b0)
+   *
+   * @since 5.0
+   */
   bandIndexes: string;
 }

package/layers/raster/functions/creators/createChangeFunctions.d.ts

@@ -1,9 +1,18 @@
 import type { KeepMethod } from "../changeDetectionUtils.js";
 import type { Base2RasterFunctionParameters, ChangeMethod } from "../types.js";
 
+/** @since 5.0 */
 export interface ComputeChangeParameters extends Base2RasterFunctionParameters {
-  /** Choose what to keep for categorical changes. */
+  /**
+   * Choose what to keep for categorical changes.
+   *
+   * @since 5.0
+   */
   keepMethod?: KeepMethod;
-  /** The method used to compute changes. */
+  /**
+   * The method used to compute changes.
+   *
+   * @since 5.0
+   */
   method: ChangeMethod;
 }

package/layers/raster/functions/creators/createConversionFunctions.d.ts

@@ -1,16 +1,31 @@
 import type { BaseRasterFunctionParameters } from "../types.js";
 
+/** @since 5.0 */
 export interface GrayscaleParameters extends BaseRasterFunctionParameters {
-  /** The weights applied to each input band. Weights are often applied because some bands have variable importance depending on the application. */
+  /**
+   * The weights applied to each input band. Weights are often applied because some bands have variable importance depending on the application.
+   *
+   * @since 5.0
+   */
   weights: number[];
 }
 
+/** @since 5.0 */
 export interface ColorspaceConversionParameters extends BaseRasterFunctionParameters {
-  /** The conversion type. */
+  /**
+   * The conversion type.
+   *
+   * @since 5.0
+   */
   conversionType: "rgb-to-hsv" | "hsv-to-rgb";
 }
 
+/** @since 5.0 */
 export interface SpectralConversionParameters extends BaseRasterFunctionParameters {
-  /** The matrix used to convert the input raster arranged in row-major order. */
+  /**
+   * The matrix used to convert the input raster arranged in row-major order.
+   *
+   * @since 5.0
+   */
   conversionMatrix: number[] | number[][];
 }