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

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

@@ -3,8 +3,8 @@ import type Polygon from "../../../../geometry/Polygon.js";
 import type AlgorithmicColorRamp from "../../../../rest/support/AlgorithmicColorRamp.js";
 import type FeatureSet from "../../../../rest/support/FeatureSet.js";
 import type MultipartColorRamp from "../../../../rest/support/MultipartColorRamp.js";
+import type { RasterBandStatistics, RasterHistogram } from "../../types.js";
 import type { BaseRasterFunctionParameters, RasterArgument } from "../types.js";
-import type { RasterBandStatistics, RasterHistogram } from "../../../support/types.js";
 import type { RasterColorRampName, RasterColormapName } from "../../../../renderers/support/raster/types.js";
 
 /**
@@ -13,7 +13,11 @@ import type { RasterColorRampName, RasterColormapName } from "../../../../render
  * @since 4.28
  */
 export interface ColormapParameters extends BaseRasterFunctionParameters {
-  /** The colormap. */
+  /**
+   * The colormap.
+   *
+   * @since 5.0
+   */
   colormap: number[][] | RasterValueToColor[];
 }
 
@@ -23,9 +27,17 @@ export interface ColormapParameters extends BaseRasterFunctionParameters {
  * @since 4.28
  */
 export interface RasterValueToColor {
-  /** Color represented using [r,g,b] or [r,g,b,a], or the color's name or hex string. */
+  /**
+   * Color represented using [r,g,b] or [r,g,b,a], or the color's name or hex string.
+   *
+   * @since 5.0
+   */
   color: number[] | string;
-  /** Pixel value. */
+  /**
+   * Pixel value.
+   *
+   * @since 5.0
+   */
   value: number;
 }
 
@@ -35,7 +47,11 @@ export interface RasterValueToColor {
  * @since 4.28
  */
 export interface ColormapByNameParameters extends BaseRasterFunctionParameters {
-  /** The name of a predefined colorramp or colormap. */
+  /**
+   * The name of a predefined colorramp or colormap.
+   *
+   * @since 5.0
+   */
   colorRampName: RasterColorRampName | RasterColormapName;
 }
 
@@ -45,19 +61,37 @@ export interface ColormapByNameParameters extends BaseRasterFunctionParameters {
  * @since 4.28
  */
 export interface ColormapByRampParameters extends BaseRasterFunctionParameters {
-  /** A colorramp */
+  /**
+   * A colorramp
+   *
+   * @since 5.0
+   */
   colorRamp: AlgorithmicColorRamp | MultipartColorRamp;
 }
 
+/** @since 5.0 */
 export interface StatisticsHistogramParameters extends BaseRasterFunctionParameters {
-  /** The histogram parameter. */
+  /**
+   * The histogram parameter.
+   *
+   * @since 5.0
+   */
   histograms?: RasterHistogram[];
-  /** The statistics parameter. */
+  /**
+   * The statistics parameter.
+   *
+   * @since 5.0
+   */
   statistics: RasterBandStatistics[];
 }
 
+/** @since 5.0 */
 export interface TableParameters extends BaseRasterFunctionParameters {
-  /** The attribute table represented using a feature set. */
+  /**
+   * The attribute table represented using a feature set.
+   *
+   * @since 5.0
+   */
   attributeTable: FeatureSet;
 }
 
@@ -67,9 +101,17 @@ export interface TableParameters extends BaseRasterFunctionParameters {
  * @since 4.28
  */
 export interface ExtractBandByIdParameters extends BaseRasterFunctionParameters {
-  /** The 0-based band ids. */
+  /**
+   * The 0-based band ids.
+   *
+   * @since 5.0
+   */
   bandIds: number[];
-  /** Indicate whether to use best possible matching band when the requested band is missing. */
+  /**
+   * Indicate whether to use best possible matching band when the requested band is missing.
+   *
+   * @since 5.0
+   */
   missingBandAction?: "fail" | "best-match";
 }
 
@@ -79,9 +121,17 @@ export interface ExtractBandByIdParameters extends BaseRasterFunctionParameters
  * @since 4.28
  */
 export interface ExtractBandByNameParameters extends BaseRasterFunctionParameters {
-  /** The band names. */
+  /**
+   * The band names.
+   *
+   * @since 5.0
+   */
   bandNames: string[];
-  /** Indicate whether to use best possible matching band when the requested band is missing. */
+  /**
+   * Indicate whether to use best possible matching band when the requested band is missing.
+   *
+   * @since 5.0
+   */
   missingBandAction?: "fail" | "best-match";
 }
 
@@ -91,9 +141,17 @@ export interface ExtractBandByNameParameters extends BaseRasterFunctionParameter
  * @since 4.28
  */
 export interface ExtractBandByWavelengthParameters extends BaseRasterFunctionParameters {
-  /** The band wavelengths. */
+  /**
+   * The band wavelengths.
+   *
+   * @since 5.0
+   */
   bandWavelengths: number[];
-  /** Indicate whether to use best possible matching band when the requested band is missing. */
+  /**
+   * Indicate whether to use best possible matching band when the requested band is missing.
+   *
+   * @since 5.0
+   */
   missingBandAction?: "fail" | "best-match";
 }
 
@@ -103,13 +161,29 @@ export interface ExtractBandByWavelengthParameters extends BaseRasterFunctionPar
  * @since 4.32
  */
 export interface ColorCompositeByIdParameters extends BaseRasterFunctionParameters {
-  /** Blue band id. */
+  /**
+   * Blue band id.
+   *
+   * @since 5.0
+   */
   blueBand: number;
-  /** Green band id. */
+  /**
+   * Green band id.
+   *
+   * @since 5.0
+   */
   greenBand: number;
-  /** The composition method. */
+  /**
+   * The composition method.
+   *
+   * @since 5.0
+   */
   method: "id";
-  /** Red band id. */
+  /**
+   * Red band id.
+   *
+   * @since 5.0
+   */
   redBand: number;
 }
 
@@ -120,22 +194,51 @@ export interface ColorCompositeByIdParameters extends BaseRasterFunctionParamete
  * @since 4.32
  */
 export interface ColorCompositeByNameParameters extends BaseRasterFunctionParameters {
-  /** Blue band name or expression, e.g. "B1-B2" */
+  /**
+   * Blue band name or expression, e.g. "B1-B2"
+   *
+   * @since 5.0
+   */
   blueBand: string;
-  /** Green band name or expression, e.g. "B2" */
+  /**
+   * Green band name or expression, e.g. "B2"
+   *
+   * @since 5.0
+   */
   greenBand: string;
-  /** The composition method. */
+  /**
+   * The composition method.
+   *
+   * @since 5.0
+   */
   method: "name";
-  /** Red band name or expression, e.g. "B1" */
+  /**
+   * Red band name or expression, e.g. "B1"
+   *
+   * @since 5.0
+   */
   redBand: string;
 }
 
+/** @since 5.0 */
 export interface RemapParameters extends BaseRasterFunctionParameters {
-  /** When true, unmatched pixel values are passed through or replaced with a constant. When false, unmatched pixel values are set to NoData. */
+  /**
+   * When true, unmatched pixel values are passed through or replaced with a constant. When false, unmatched pixel values are set to NoData.
+   *
+   * @since 5.0
+   */
   allowUnmatched?: boolean;
-  /** Range maps. */
+  /**
+   * Range maps.
+   *
+   * @since 5.0
+   */
   rangeMaps?: PixelValueRangeMap[];
-  /** The value that will replace missing or unmatched values in the output when allowUnmatched is true. */
+  /**
+   * The value that will replace missing or unmatched values in the output when allowUnmatched is true.
+   *
+   * @since 5.0
+   */
   replacementValue?: number;
 }
 
@@ -145,42 +248,83 @@ export interface RemapParameters extends BaseRasterFunctionParameters {
  * @since 4.28
  */
 export interface PixelValueRangeMap {
-  /** The mapped pixel value. Null or undefined will produce NoData as the output. */
+  /**
+   * The mapped pixel value. Null or undefined will produce NoData as the output.
+   *
+   * @since 5.0
+   */
   output?: number | null;
-  /** The pixel value range. */
+  /**
+   * The pixel value range.
+   *
+   * @since 5.0
+   */
   range: [
       number,
       number
   ];
 }
 
+/** @since 5.0 */
 export interface TransposeBitsParameters extends BaseRasterFunctionParameters {
-  /** Specify a raster to be used to fill in all bits that are not involved in the transpose. */
+  /**
+   * Specify a raster to be used to fill in all bits that are not involved in the transpose.
+   *
+   * @since 5.0
+   */
   fillRaster?: RasterArgument;
-  /** The position of the input bits. */
+  /**
+   * The position of the input bits.
+   *
+   * @since 5.0
+   */
   inputBitPositions: number[];
-  /** The position of the output bits. */
+  /**
+   * The position of the output bits.
+   *
+   * @since 5.0
+   */
   outputBitPositions: number[];
 }
 
+/** @since 5.0 */
 export interface MaskParameters extends BaseRasterFunctionParameters {
-  /** The included values for each band. Each band is specified using a range [from, to]. */
+  /**
+   * The included values for each band. Each band is specified using a range [from, to].
+   *
+   * @since 5.0
+   */
   includedRanges?: [
       number,
       number
   ][];
-  /** Result is no data if all bands are nodata when match-all is specified, any if any band is nodata when match-any is specified. Default is match-any. */
+  /**
+   * Result is no data if all bands are nodata when match-all is specified, any if any band is nodata when match-any is specified. Default is match-any.
+   *
+   * @since 5.0
+   */
   noDataInterpretation?: "match-any" | "match-all";
-  /** The nodata values for each band. */
+  /**
+   * The nodata values for each band.
+   *
+   * @since 5.0
+   */
   noDataValues?: number[][];
 }
 
+/** @since 5.0 */
 export interface ClipParameters extends BaseRasterFunctionParameters {
-  /** An extent or a polygon geometry to define the clip shape. */
+  /**
+   * An extent or a polygon geometry to define the clip shape.
+   *
+   * @since 5.0
+   */
   geometry: Extent | Polygon;
   /**
    * When `false`, the imagery within the clip geometry will be kept in the output. When `true`, imagery outside of the clip geometry will be kept and the imagery
    * inside the clip geometry will be discarded.
+   *
+   * @since 5.0
    */
   keepOutside?: boolean;
 }

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

@@ -7,11 +7,23 @@ import type { BaseRasterFunctionParameters, RasterArgument, RasterPrimaryArgumen
  * @since 4.28
  */
 export interface SetNullParameters extends BaseRasterFunctionParameters {
-  /** The false raster. */
+  /**
+   * The false raster.
+   *
+   * @since 5.0
+   */
   falseRaster: RasterArgument;
-  /** The output pixel type, default is unknown. */
+  /**
+   * The output pixel type, default is unknown.
+   *
+   * @since 5.0
+   */
   outputPixelType?: RasterPixelType;
-  /** The input raster. */
+  /**
+   * The input raster.
+   *
+   * @since 5.0
+   */
   raster: RasterPrimaryArgument;
 }
 
@@ -21,21 +33,47 @@ export interface SetNullParameters extends BaseRasterFunctionParameters {
  * @since 4.28
  */
 export interface ConditionalParameters extends BaseRasterFunctionParameters {
-  /** The false raster. */
+  /**
+   * The false raster.
+   *
+   * @since 5.0
+   */
   falseRaster: RasterArgument;
-  /** The output pixel type, default is unknown. */
+  /**
+   * The output pixel type, default is unknown.
+   *
+   * @since 5.0
+   */
   outputPixelType?: RasterPixelType;
-  /** The input raster. */
+  /**
+   * The input raster.
+   *
+   * @since 5.0
+   */
   raster: RasterPrimaryArgument;
-  /** The true raster. */
+  /**
+   * The true raster.
+   *
+   * @since 5.0
+   */
   trueRaster: RasterArgument;
 }
 
+/** @since 5.0 */
 export type StatType = "majority" | "max" | "mean" | "median" | "min" | "minority" | "range" | "stddev" | "sum" | "variety";
 
+/** @since 5.0 */
 export interface CalculatorParameters extends BaseNRasterFunctionParameters {
-  /** The expression. */
+  /**
+   * The expression.
+   *
+   * @since 5.0
+   */
   expression: string;
-  /** The input names. */
+  /**
+   * The input names.
+   *
+   * @since 5.0
+   */
   inputNames: string[];
 }

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

@@ -1,25 +1,63 @@
 import type { BaseNRasterFunctionParameters } from "../types.js";
 
+/** @since 5.0 */
 export interface WeightedSumParameters extends BaseNRasterFunctionParameters {
-  /** The field used to perform the weighted sum. Default is Value. */
+  /**
+   * The field used to perform the weighted sum. Default is Value.
+   *
+   * @since 5.0
+   */
   fields?: string[];
-  /** The weight for each raster. */
+  /**
+   * The weight for each raster.
+   *
+   * @since 5.0
+   */
   weights: number[];
 }
 
+/** @since 5.0 */
 export interface WeightedOverlayParameters extends BaseNRasterFunctionParameters {
-  /** The field used to perform the weighted sum. Default is Value. */
+  /**
+   * The field used to perform the weighted sum. Default is Value.
+   *
+   * @since 5.0
+   */
   fields?: string[];
-  /** The maximum scale of the mapped output. */
+  /**
+   * The maximum scale of the mapped output.
+   *
+   * @since 5.0
+   */
   maxScale: number;
-  /** The minimum scale of the mapped output */
+  /**
+   * The minimum scale of the mapped output
+   *
+   * @since 5.0
+   */
   minScale: number;
-  /** The nodata values for each input raster. */
+  /**
+   * The nodata values for each input raster.
+   *
+   * @since 5.0
+   */
   noDataValues?: number[][];
-  /** The restricted values for each input raster. */
+  /**
+   * The restricted values for each input raster.
+   *
+   * @since 5.0
+   */
   restrictedValues?: number[][];
-  /** The value to scale map for each input raster. Each raster's map is represented using an array of [fromValue, toScale]. */
+  /**
+   * The value to scale map for each input raster. Each raster's map is represented using an array of [fromValue, toScale].
+   *
+   * @since 5.0
+   */
   valueToScaleMaps?: number[][][];
-  /** The relative weight for each raster. This will be normalized internally to make the total weight 100%. */
+  /**
+   * The relative weight for each raster. This will be normalized internally to make the total weight 100%.
+   *
+   * @since 5.0
+   */
   weights: number[];
 }

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

@@ -1,14 +1,31 @@
 import type { FocalStatisticsType } from "../focalStatUtils.js";
 import type { BaseNRasterFunctionParameters, BaseRasterFunctionParameters } from "../types.js";
 
+/** @since 5.0 */
 export interface StatisticsParameters extends BaseRasterFunctionParameters {
-  /** Number of columns. */
+  /**
+   * Number of columns.
+   *
+   * @since 5.0
+   */
   cols: number;
-  /** When true only fills noData pixels */
+  /**
+   * When true only fills noData pixels
+   *
+   * @since 5.0
+   */
   fillNoDataOnly?: boolean;
-  /** Number of rows. */
+  /**
+   * Number of rows.
+   *
+   * @since 5.0
+   */
   rows: number;
-  /** The statistics type */
+  /**
+   * The statistics type
+   *
+   * @since 5.0
+   */
   statisticsType: FocalStatisticsType;
 }
 
@@ -18,12 +35,17 @@ export interface StatisticsParameters extends BaseRasterFunctionParameters {
  * @since 4.32
  */
 export interface ArgStatisticsParameters extends BaseNRasterFunctionParameters {
-  /** The statistics type. */
+  /**
+   * The statistics type.
+   *
+   * @since 5.0
+   */
   statisticsType: "max" | "min" | "median";
   /**
    * A constant value that will be used when no definitive maximum or minimum can be attained.
    *
    * @default 100
+   * @since 5.0
    */
   undefinedClass?: number;
 }
@@ -34,10 +56,22 @@ export interface ArgStatisticsParameters extends BaseNRasterFunctionParameters {
  * @since 4.32
  */
 export interface ArgStatisticsDurationParameters extends BaseNRasterFunctionParameters {
-  /** The highest value equal to or less than the end of the duration. */
+  /**
+   * The highest value equal to or less than the end of the duration.
+   *
+   * @since 5.0
+   */
   maxValue: number;
-  /** The lowest value equal to or greater than the beginning of the duration. */
+  /**
+   * The lowest value equal to or greater than the beginning of the duration.
+   *
+   * @since 5.0
+   */
   minValue: number;
-  /** The statistics type. */
+  /**
+   * The statistics type.
+   *
+   * @since 5.0
+   */
   statisticsType: "duration";
 }