@arcgis/core 5.0.0-next.51 → 5.0.0-next.53

package/layers/pointCloudFilters/PointCloudReturnFilter.d.ts

@@ -1,4 +1,49 @@
-import "../../interfaces";
+import type PointCloudFilter from "./PointCloudFilter.js";
+import type { PointCloudFilterProperties } from "./PointCloudFilter.js";
 
-import PointCloudReturnFilter = __esri.PointCloudReturnFilter;
-export default PointCloudReturnFilter;
+export interface PointCloudReturnFilterProperties extends PointCloudFilterProperties, Partial<Pick<PointCloudReturnFilter, "includedReturns">> {}
+
+/**
+ * Laser pulses emitted from a lidar system can have several returns depending on the surfaces that they encounter.
+ * The return number is stored within each point in the `RETURNS` field. For example, the first return is associated with the highest point
+ * in the landscape. In some cases the laser pulse returns only one point representing the ground.
+ *
+ * ![pcl-return-filter](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/pcl-return-filter.png)
+ *
+ * A [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) can be filtered using a PointCloudReturnFilter based on the information
+ * in the `RETURNS` field. Points can be filtered using the values in the [includedReturns](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudReturnFilter.html#includedReturns).
+ *
+ * For example, to filter points representing the highest features in the landscape, the following filter can be set:
+ *
+ * ```js
+ * const pointCloudLayer = new PointCloudLayer({
+ *  ...,
+ *  filters: [{
+ *    type: "return",
+ *    field: "RETURNS",
+ *    includedReturns: ["firstOfMany", "single"]
+ *  }]
+ * });
+ * ```
+ *
+ * @since 4.10
+ * @see [Sample - Filter points in a PointCloudLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-pointcloud-filters/)
+ */
+export default class PointCloudReturnFilter extends PointCloudFilter {
+  constructor(properties?: PointCloudReturnFilterProperties);
+  /**
+   * An array of return types used to filter points. Possible values for the return types are:
+   *
+   * Value | Description
+   * ------|------------
+   * `firstOfMany` | The point was the first to be collected in a series of many returns.
+   * `last` | The last point in a series of many returns or a single point.
+   * `lastOfMany` | The last point in a series of many returns.
+   * `single` | All the points that were collected from laser pulses with a single return.
+   */
+  accessor includedReturns: PointCloudStatus[];
+  /** The type of filter. */
+  get type(): "return";
+}
+
+export type PointCloudStatus = "last" | "firstOfMany" | "lastOfMany" | "single";

package/layers/pointCloudFilters/PointCloudValueFilter.d.ts

@@ -1,4 +1,51 @@
-import "../../interfaces";
+import type PointCloudFilter from "./PointCloudFilter.js";
+import type { PointCloudFilterProperties } from "./PointCloudFilter.js";
 
-import PointCloudValueFilter = __esri.PointCloudValueFilter;
-export default PointCloudValueFilter;
+export interface PointCloudValueFilterProperties extends PointCloudFilterProperties, Partial<Pick<PointCloudValueFilter, "mode" | "values">> {}
+
+/**
+ * Every lidar point can have a classification that defines the type of surface that reflected
+ * the laser pulse. The different categories (for example building, high vegetation, ground) are defined
+ * using numeric integer codes in the LAS files.
+ * The full list of categories including the corresponding codes can be found in the LAS specification.
+ *
+ * PointCloudValueFilter is used to filter points based on the category that they belong to.
+ * For example, to display only points that belong to vegetation, the following filter can be set on the
+ * layer:
+ *
+ * ```js
+ * const pcLayer = new PointCloudLayer({
+ *   url: "https://tiles.arcgis.com/tiles/z2tnIkrLQ2BRzr6P/arcgis/rest/services/SONOMA_AREA1_LiDAR_RGB/SceneServer",
+ *   filters: [{
+ *     type: "value",
+ *     field: "CLASS_CODE",
+ *     mode: "include",
+ *     // values includes high vegetation(5)
+ *     values: [5]
+ *   }]
+ * });
+ * ```
+ *
+ * [![pcl-value-filter](https://developers.arcgis.com/javascript/latest/assets/img/apiref/layers/pcl-value-filter.png)](https://developers.arcgis.com/javascript/latest/sample-code/layers-pointcloud-filters/)
+ *
+ * @since 4.10
+ * @see [Sample - Filter points in a PointCloudLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-pointcloud-filters/)
+ */
+export default class PointCloudValueFilter extends PointCloudFilter {
+  constructor(properties?: PointCloudValueFilterProperties);
+  /**
+   * Whether points should be included or excluded from the filter.
+   *
+   * @default "exclude"
+   */
+  accessor mode: PointCloudValueFilterMode;
+  /** The type of filter. */
+  get type(): "value";
+  /**
+   * An array of numeric values representing the classification codes
+   * that the filter should apply.
+   */
+  accessor values: number[];
+}
+
+export type PointCloudValueFilterMode = "exclude" | "include";

package/layers/pointCloudFilters/typeUtils.d.ts

@@ -0,0 +1,5 @@
+import type PointCloudBitfieldFilter from "./PointCloudBitfieldFilter.js";
+import type PointCloudReturnFilter from "./PointCloudReturnFilter.js";
+import type PointCloudValueFilter from "./PointCloudValueFilter.js";
+
+export type PointCloudFilterTypes = PointCloudValueFilter | PointCloudBitfieldFilter | PointCloudReturnFilter;

package/layers/raster/datasets/interfaces.d.ts

@@ -0,0 +1,2 @@
+
+export type WCSVersion = "1.0.0" | "1.1.0" | "1.1.1" | "1.1.2" | "2.0.1";

package/layers/raster/datasets/pixelReader.d.ts

@@ -0,0 +1,10 @@
+
+export interface IteratorRecord {}
+
+export interface PixelData {}
+
+export interface PixelBlockRecord extends PixelData, IteratorRecord {}
+
+export interface PixelFeatureSetRecord extends PixelBlockRecord {}
+
+export interface PixelFeatureSet extends PixelData {}

package/layers/raster/datasets/wcsCapabilitiesParser.d.ts

@@ -0,0 +1,48 @@
+import type Extent from "../../../geometry/Extent.js";
+import type { WCSVersion } from "./interfaces.js";
+
+/** Coverage information associated with a WCS service. */
+export interface CoverageBrief {
+  /** The subtype of the coverage. */
+  coverageSubType?: string;
+  /** The id of the coverage. */
+  id: string;
+  /** The extent of the coverage. */
+  lonLatEnvelope?: Extent;
+}
+
+/** A list of URLs for the WCS service resources. It is necessary for a WCS client to communicate correctly with your WCS service. */
+export interface OnlineResources {
+  /** The URL to the describeCoverage endpoint. */
+  describeCoverage: string;
+  /** The URL to the getCapabilities endpoint. */
+  getCapabilities: string;
+  /** The URL to the getCoverage endpoint. */
+  getCoverage: string;
+}
+
+/**
+ * WCS service information about the available coverages, versions, extensions and more.
+ *
+ * @see [getCapabilities()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wcsUtils.html#getCapabilities)
+ */
+export interface WCSCapabilities {
+  /** Information about the available coverages. */
+  coverages: CoverageBrief[];
+  /** Information about the available grid coverages. */
+  gridCoverages: CoverageBrief[];
+  /** Name of the WCS service. */
+  name: string;
+  /** Online resources for the WCS service. */
+  onlineResources: OnlineResources;
+  /** Application profiles supported by the WCS service. */
+  profiles?: string[];
+  /** Formats supported by the WCS service. */
+  supportedFormats?: string[];
+  /** Interpolations supported by the WCS service. */
+  supportedInterpolations?: string[];
+  /** The versions supported by the WCS service. */
+  supportedVersions: string[];
+  /** The WCS service version. */
+  version: WCSVersion;
+}

package/layers/raster/datasets/wcsCoverageParser.d.ts

@@ -0,0 +1,352 @@
+import type Extent from "../../../geometry/Extent.js";
+import type Polygon from "../../../geometry/Polygon.js";
+import type RasterInfo from "../../support/RasterInfo.js";
+import type { WCSVersion } from "./interfaces.js";
+import type { RasterInterpolation } from "../../support/RasterTypes.js";
+
+/**
+ * Coverage information associated with a WCS service. It returns information related to coordinate reference systems, spatial and range domains, and formats supported by a service.
+ *
+ * @since 4.26
+ */
+export interface CoverageInfo {
+  /** Coverage band names. */
+  bandNames: string[];
+  /**
+   * Coverage
+   * description for different versions.
+   */
+  coverageDescription: CoverageDescriptionV100 | CoverageDescriptionV110 | CoverageDescriptionV201;
+  /** Service coverage description. */
+  description: string;
+  /** Service coverage id. */
+  id: string;
+  /** Spatial extent of the coverage. */
+  lonLatEnvelope?: Extent;
+  /** Coverage raster info. */
+  rasterInfo: RasterInfo;
+  /** Formats supported by a service. */
+  supportedFormats: string[];
+  /** Interpolation supported by a service. */
+  supportedInterpolations?: RasterInterpolation[];
+  /** Service coverage title. */
+  title: string;
+  /** Indicates if the EPSG axis is used. */
+  useEPSGAxis: boolean;
+  /** The service version. */
+  version: WCSVersion;
+}
+
+export interface RangeSet {
+  /** Provides additional information on compound valued range set. */
+  axis: RangeAxis[];
+  /** Range set label. */
+  label: string;
+  /** Range set name. */
+  name: string;
+  /** The null values is used when valid values are not available. */
+  nullValues?: number[] | null;
+}
+
+export interface RangeAxis {
+  /** Range axis label. */
+  label: string;
+  /** Range axis name. */
+  name: string;
+  /** Range axis values. */
+  values: string[];
+}
+
+export interface DomainSet {
+  /** Spatial domain of a coverage. */
+  spatialDomain: SpatialDomain;
+  /** Temporal domain or extent of a coverage. */
+  temporalDomain?: TemporalDomain | null;
+}
+
+export interface SpatialDomain {
+  /** Spatial domain columns. */
+  columns: number;
+  /** Spatial domain extent. */
+  envelope: Extent;
+  /** Spatial domain x, y offset. */
+  offset: SpatialDomainOffset;
+  /** Spatial domain x, y origin. */
+  origin: SpatialDomainOrigin;
+  /** Spatial domain rows. */
+  rows: number;
+}
+
+export interface SpatialDomainOffset {
+  /** Spatial domain x offset. */
+  x: number;
+  /** Spatial domain y offset. */
+  y: number;
+}
+
+export interface SpatialDomainOrigin {
+  /** Spatial domain x origin. */
+  x: number;
+  /** Spatial domain y origin. */
+  y: number;
+}
+
+/**
+ * Temporal domain or extent of a coverage.
+ *
+ * @since 4.26
+ */
+export interface TemporalDomain {
+  /** Start date for the temporal domain of a coverage. */
+  begin: Date;
+  /** End date for the temporal domain of a coverage. */
+  end: Date;
+  /** The numerical value of the temporal domain or extent. */
+  resolution?: number | null;
+  /** Temporal units such as day, month, year etc. */
+  units?: string | null;
+  /** Date values available in the temporal domain. */
+  values?: Date[] | null;
+}
+
+/**
+ * Coverage description for WCS service version 1.0.0.
+ *
+ * @since 4.26
+ */
+export interface CoverageDescriptionV100 {
+  /** Coverage description. */
+  description: string;
+  /** Describes the spatial and temporal domain of a coverage. */
+  domainSet: DomainSet;
+  /** Coverage label. */
+  label: string;
+  /** Spatial extent of the coverage. */
+  lonLatEnvelope: Extent;
+  /** Coverage name. */
+  name: string;
+  /**
+   * Defines the properties (categories, measures, or values) assigned to each location in the domain. It can numeric or text values, or
+   * it can be a compound values such as income by race, or radiance by wave length. A compound range set may have more than one control parameter or set of “bins”, for
+   * quantities related to values of several parameters (such as counts of wildlife tabulated both by size and by species).
+   */
+  rangeSet: RangeSet[];
+  /** Coordinate reference systems supported by a coverage. */
+  supportedCRSs: CoverageDescriptionV100SupportedCRSs;
+  /** Formats supported by a coverage. */
+  supportedFormats: string[];
+  /** Interpolations supported by a coverage. */
+  supportedInterpolations: string[];
+  /** Coverage version. It is always "1.0" for `CoverageDescriptionV100`. */
+  readonly version: "1.0";
+}
+
+export interface CoverageDescriptionV100SupportedCRSs {
+  /** The native coordinate reference system of a coverage – that is, the coordinate reference systems in which coverages can be obtained without any distortion or degradation of the data. */
+  nativeCRSs: string[];
+  /** Coordinate reference systems in which the coverage can both accept GetCoverage requests and deliver coverage responses. */
+  requestResponseCRSs: string[];
+}
+
+export interface RangeSetV110 {
+  /** Range abstract. */
+  abstract?: string | null;
+  /** Provides additional information on compound valued range. */
+  axis: RangeSetV110Axis[];
+  /** Range definition. */
+  definition: string;
+  /** Range description. */
+  description?: string | null;
+  /** Range identifier. */
+  identifier: string;
+  /** Null values. */
+  nullValues: number[];
+  /** Interpolations supported by the range. */
+  supportedInterpolations: string[];
+  /** Range title. */
+  title?: string | null;
+}
+
+export interface RangeSetV110Axis {
+  /** The axis bandNoDataValues. */
+  bandNoDataValues?: number[];
+  /** The axis data type. */
+  dataType: string;
+  /** The range axis identifier. */
+  identifier: string;
+  /** The axis unit of measurement. */
+  uom: string;
+  /** The axis values. */
+  values: string[];
+}
+
+export interface SpatialDomainV110 extends SpatialDomain {
+  /** Specifies spatial resolution of the coordinate reference system. */
+  gridBaseCRS: string;
+  /** Indicates if the EPSG axis is used. */
+  useEPSGAxis: boolean;
+}
+
+export interface DomainSetV110 {
+  /** Spatial extent or domain of a coverage. */
+  spatialDomain: SpatialDomainV110;
+  /** Temporal domain or extent of the coverage. */
+  temporalDomain: TemporalDomain | null;
+}
+
+/**
+ * Coverage description for WCS service version 1.1.0.
+ *
+ * @since 4.26
+ */
+export interface CoverageDescriptionV110 {
+  /** Coverage abstract. */
+  abstract: string;
+  /** Describes the spatial and temporal domain of a coverage. */
+  domain: DomainSetV110;
+  /** Coverage identifier. */
+  identifier: string;
+  /** Coverage metadata. */
+  metadata?: string;
+  /**
+   * Defines the properties (categories, measures, or values) assigned to each location in the domain. It can numeric or text values, or
+   * it can be a compound values such as income by race, or radiance by wave length. A compound range set may have more than one control parameter or set of “bins”, for
+   * quantities related to values of several parameters (such as counts of wildlife tabulated both by size and by species).
+   */
+  range: RangeSetV110[];
+  /** Resolution x, y. */
+  resolution: CoverageDescriptionV110Resolution;
+  /** Coordinate reference systems supported by a coverage. */
+  supportedCRSs: string[];
+  /** Formats supported by a coverage. */
+  supportedFormats: string[];
+  /** Coverage title. */
+  title: string;
+  /** Coverage version. It is always "1.1" for `CoverageDescriptionV110`. */
+  readonly version: "1.1";
+}
+
+export interface CoverageDescriptionV110Resolution {
+  /** Resolution x. */
+  x: number;
+  /** Resolution y. */
+  y: number;
+}
+
+export interface BoundedByV201 {
+  /** The coverage's axis name. */
+  axisLabels: string[];
+  /** Start date for the temporal extent of a coverage. */
+  beginPosition?: Date | null;
+  /** End date for the temporal extent of the coverage. */
+  endPosition?: Date | null;
+  /** The spatial extent of a coverage. */
+  envelope: Extent;
+  /** The spatial extent dimensions. */
+  envelopeAllDims: BoundedByV201EnvelopeAllDims;
+  /** Is east first. */
+  isEastFirst: boolean;
+  /** List of unit of measure (uom) labels for all the axis. */
+  uomLabels: string[] | null;
+}
+
+export interface BoundedByV201EnvelopeAllDims {
+  /** Spatial extent min x and y. */
+  maxs: number[];
+  /** Spatial extent min x and y. */
+  mins: number[];
+}
+
+export interface RangeFieldV201 {
+  /** Allowed values for the range type. */
+  allowedValues?: number[] | null;
+  /** Range type description. */
+  description?: string | null;
+  /** Range type name. */
+  name: string;
+  /** Number that represents null value. */
+  nilValue?: number | null;
+  /** Unit of measurement for the range type. */
+  uom: string;
+}
+
+export interface DomainSetV201 {
+  /** Axis labels. */
+  axisLabels: string[];
+  /** Domain columns of a coverage. */
+  columns: number;
+  /** Domain grid samples. */
+  gridSamples: number[];
+  /** Has same axis labels as bounded by. */
+  hasSameAxisLabelsAsBoundedBy: boolean;
+  /** Domain offset. */
+  offset: number[];
+  /** Domain origin. */
+  origin: number[];
+  /** Domain x, y resolution. */
+  resolution: DomainSetV201Resolution;
+  /** Domain rows of a coverage. */
+  rows: number;
+}
+
+export interface DomainSetV201Resolution {
+  /** Resolution x. */
+  x: number;
+  /** Resolution.y. */
+  y: number;
+}
+
+export interface EOCoverageMetadata {
+  /** Earth observation. */
+  observation: EOCoverageMetadataObservation;
+}
+
+export interface EOCoverageMetadataObservation {
+  /** Earth observation acquisition type. */
+  acquisitionType?: string | null;
+  /** Earth observation footprint. */
+  footprint?: Polygon | null;
+  /** Earth observation identifier. */
+  identifier: string;
+  /** Earth observation phenomenon time. */
+  phenomenonTime?: TemporalDomain | null;
+  /** Earth observation resultTime. */
+  resultTime?: TemporalDomain | null;
+  /** Earth observation status. */
+  status?: string | null;
+}
+
+/**
+ * Coverage description for WCS service version 2.0.1
+ *
+ * @since 4.26
+ */
+export interface CoverageDescriptionV201 {
+  /** Spatial and temporal extent of a coverage. */
+  boundedBy: BoundedByV201;
+  /** Coverage function. */
+  coverageFunction?: any | null;
+  /** Coverage id. */
+  coverageId: string;
+  /** Domains associated with a coverage. */
+  domainSet: DomainSetV201;
+  /** The WCS 2.0 Earth Observation coverage metadata. */
+  eoMetadata?: EOCoverageMetadata | null;
+  /** Coverage extension. */
+  extension?: string | null;
+  /** Describes the semantics of the range set values supported by a coverage. */
+  rangeType: RangeFieldV201[][];
+  /** Service x,y resolution. */
+  resolution: CoverageDescriptionV201Resolution;
+  /** Service parameters. */
+  serviceParameters: Record<string, any>;
+  /** Service version. */
+  readonly version: "2.0";
+}
+
+export interface CoverageDescriptionV201Resolution {
+  /** Resolution x. */
+  x: number;
+  /** Resolution y. */
+  y: number;
+}

package/layers/raster/functions/changeDetectionUtils.d.ts

@@ -0,0 +1,2 @@
+
+export type KeepMethod = "all" | "changed" | "unchanged";

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

@@ -0,0 +1,70 @@
+import type { BaseRasterFunctionParameters } from "../interfaces.js";
+import type { RasterBandStatistics } from "../../../support/interfaces.js";
+
+export type KebabConvolutionTypes = "user-defined" | "line-detection-horizontal" | "line-detection-vertical" | "line-detection-left-diagonal" | "line-detection-right-diagonal" | "gradient-north" | "gradient-west" | "gradient-east" | "gradient-south" | "gradient-north-east" | "gradient-north-west" | "smooth-arithmetic-mean" | "smoothing3x3" | "smoothing5x5" | "sharpening3x3" | "sharpening5x5" | "laplacian3x3" | "laplacian5x5" | "sobel-horizontal" | "sobel-vertical" | "sharpen" | "sharpen2" | "point-spread" | "none";
+
+/** @since 4.28 */
+export interface ConvolutionFunctionParameters extends BaseRasterFunctionParameters {
+  /** The convolution type. */
+  convolutionType: Exclude<KebabConvolutionTypes, "user-defined">;
+}
+
+/** @since 4.28 */
+export interface ConvolutionFunctionCustomParameters extends BaseRasterFunctionParameters {
+  /** The number of columns, only needed for user-defined kernel */
+  cols: number;
+  /** The convolution type must be "user-defined". */
+  convolutionType?: "user-defined";
+  /** The kernel size of rows x columns arranged in row-major order. */
+  kernel: number[];
+  /** The number of rows, only needed for user-defined kernel. */
+  rows: number;
+}
+
+/**
+ * ***********************************************
+ *
+ *                 contrastBrightness
+ */
+export interface ContrastBrightnessParameters extends BaseRasterFunctionParameters {
+  /** Brightness offset from -100 to 100. */
+  brightnessOffset: number;
+  /** Contrast offset from -100 to 100. */
+  contrastOffset: number;
+}
+
+export interface BaseStretchParameters extends BaseRasterFunctionParameters {
+  /** When true, perform dynamic range adjustment (not supported on client side) */
+  dynamicRangeAdjustment?: boolean;
+  /** The gamma values used for each band, needed when useGamma is true. */
+  gamma?: number[];
+  /** The maximum output value. Default is 255. */
+  outputMax?: number;
+  /** The minimum output value. Default is 0. */
+  outputMin?: number;
+  /** When true, gamma stretch is applied. */
+  useGamma?: boolean;
+}
+
+export interface MinMaxStretchParameters extends BaseStretchParameters {
+  /**
+   * The avg and stddev in each band's statistics
+   * is used along with numberOfStandardDeviations to calculate the cut off pixels values beling stretched. Default is the input data source's statistics.
+   */
+  statistics?: RasterBandStatistics[];
+}
+
+export interface StddevStretchParameters extends MinMaxStretchParameters {
+  /**
+   * Values with in the given number of standard deviations are stretched to
+   * [outputMin, outputMax], those fall outside are clamped.
+   */
+  numberOfStandardDeviations?: number;
+}
+
+export interface PercentClipStretchParameters extends BaseStretchParameters {
+  /** Percentage of the highest pixel values to be excluded. */
+  maxPercent?: number;
+  /** Percentage of the lowest pixel values to be excluded. */
+  minPercent?: number;
+}