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

package/layers/mixins/TrackableLayer.d.ts

@@ -1,4 +1,33 @@
-import "../../interfaces";
+import type TrackInfo from "../support/TrackInfo.js";
+import type { TrackInfoProperties } from "../support/TrackInfo.js";
 
-import TrackableLayer = __esri.TrackableLayer;
-export { TrackableLayer };
+export interface TrackableLayerProperties {
+  /**
+   * Allows you to render track data for a layer, including a track line, previous observations, and latest observations.
+   * For `trackInfo` to work, the layer must have {@link layers/mixins/TrackableLayer#timeInfo layer.timeInfo} defined with a valid
+   * [TimeInfo#trackIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#trackIdField).
+   *
+   * @beta
+   * @since 4.32
+   */
+  trackInfo?: TrackInfoProperties | null;
+}
+
+/**
+ * Mixin for layers that support track info.
+ *
+ * @since 4.32
+ */
+export abstract class TrackableLayer {
+  constructor(...args: any[]);
+  /**
+   * Allows you to render track data for a layer, including a track line, previous observations, and latest observations.
+   * For `trackInfo` to work, the layer must have {@link layers/mixins/TrackableLayer#timeInfo layer.timeInfo} defined with a valid
+   * [TimeInfo#trackIdField](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-TimeInfo.html#trackIdField).
+   *
+   * @beta
+   * @since 4.32
+   */
+  get trackInfo(): TrackInfo | null | undefined;
+  set trackInfo(value: TrackInfoProperties | null | undefined);
+}

package/layers/mixins/properties/ILayerWithGetFeatureTitle.d.ts

@@ -0,0 +1,13 @@
+import type { TimeZone } from "../../../time/interfaces.js";
+
+/** Options for generating a feature title. */
+export interface FeatureTitleOptions {
+  /**
+   * Indicates whether to fetch missing fields from the service if they are not already present in the graphic.
+   *
+   * @default false
+   */
+  fetchMissingFields?: boolean;
+  /** The time zone to use when formatting date fields in the title. If `null`, the default time zone is used. */
+  timeZone?: TimeZone | null;
+}

package/layers/mixins/properties/ILayerWithGetField.d.ts

@@ -0,0 +1,6 @@
+import type Graphic from "../../../Graphic.js";
+
+export interface FieldDomainOptions {
+  /** The feature to which the [Domain](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-Domain.html) is assigned. */
+  feature?: Graphic;
+}

package/layers/mixins/properties/ILayerWithSave.d.ts

@@ -0,0 +1,11 @@
+import type PortalFolder from "../../../portal/PortalFolder.js";
+
+export interface SaveOptions {
+  /** Indicates whether to ignore saving unsupported layers or layers with unsupported content, such as unsupported symbology. */
+  ignoreUnsupported?: boolean;
+}
+
+export interface SaveAsOptions extends SaveOptions {
+  /** The portal folder where the layer's portal item will be saved. */
+  folder?: PortalFolder;
+}

package/layers/ogc/wcsUtils.d.ts

@@ -1,3 +1,23 @@
-import "../../interfaces";
+import type { AbortOptions } from "../../core/promiseUtils.js";
+import type { CustomParameters } from "../mixins/CustomParametersMixin.js";
+import type { WCSVersion } from "../raster/datasets/interfaces.js";
+import type { WCSCapabilities } from "../raster/datasets/wcsCapabilitiesParser.js";
 
-export const getCapabilities: __esri.wcsUtils["getCapabilities"];
+/**
+ * Fetches the capabilities metadata offered by the WCS service, including supported versions and coverages information.
+ *
+ * @param url - The URL to the WCS service endpoint.
+ * @param options
+ * @returns The WCS Capabilities for the service.
+ * @example
+ * const capabilities = await wcsUtils.getCapabilities(url);
+ * // use capabilities information
+ */
+export function getCapabilities(url: string, options?: GetCapabilitiesOptions): Promise<WCSCapabilities>;
+
+export interface GetCapabilitiesOptions extends AbortOptions {
+  /** A list of key-value pairs of parameters to append to the url. */
+  customParameters?: CustomParameters | null;
+  /** The version of the WCS service. */
+  version?: WCSVersion | null;
+}

package/layers/ogc/wfsUtils.d.ts

@@ -1,4 +1,169 @@
-import "../../interfaces";
+import type Extent from "../../geometry/Extent.js";
+import type SpatialReference from "../../geometry/SpatialReference.js";
+import type Field from "../support/Field.js";
+import type { AbortOptions } from "../../core/promiseUtils.js";
+import type { FeatureGeometryType } from "../../geometry/support/typeUtils.js";
+import type { CustomParameters } from "../mixins/CustomParametersMixin.js";
 
-export const getCapabilities: __esri.wfsUtils["getCapabilities"];
-export const getWFSLayerInfo: __esri.wfsUtils["getWFSLayerInfo"];
+export interface GetCapabilitiesOptions extends AbortOptions {
+  /** A list of key-value pairs of parameters to append to the url. */
+  customParameters?: CustomParameters | null;
+}
+
+/**
+ * Fetches the GetCapabilities document of a WFS service which contains information about the
+ * list of layers in the service and the available operations.
+ *
+ * @param url - The URL to the WFS endpoint.
+ * @param options
+ * @returns The WFS Capabilities for the service.
+ * @example
+ * const capabilities = await wfsUtils.getCapabilities(url);
+ * const layerInfo = await wfsUtils.getWFSLayerInfo(capabilities, "layer");
+ *
+ * const layer = WFSLayer.fromWFSLayerInfo(layerInfo);
+ *
+ * // Same as
+ * const layer = WFSLayer({
+ *   url,
+ *   name: "layer"
+ * });
+ */
+export function getCapabilities(url: string, options?: GetCapabilitiesOptions): Promise<WFSCapabilities>;
+
+/**
+ * WFS service information about the available layers and operations.
+ *
+ * @see [getCapabilities()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getCapabilities)
+ * @see [getWFSLayerInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getWFSLayerInfo)
+ */
+export interface WFSCapabilities {
+  /** An array of featureTypes (or layers) available in the WFS service. */
+  readonly featureTypes: Array<WFSFeatureType>;
+  /** Information about the operations needed to consume the WFS service. */
+  readonly operations: WFSOperations;
+}
+
+/**
+ * Information about some operations of the WFS service.
+ *
+ * @see [WFSCapabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSCapabilities)
+ */
+export interface WFSOperations {
+  DescribeFeatureType: WFSOperationsDescribeFeatureType;
+  GetCapabilities: WFSOperationsGetCapabilities;
+  GetFeature: WFSOperationsGetFeature;
+}
+
+export interface WFSOperationsGetCapabilities {
+  /** The URL to the GetCapabilities endpoint. */
+  url: string;
+}
+
+export interface WFSOperationsDescribeFeatureType {
+  /** The URL to the DescribeFeatureType endpoint. */
+  url: string;
+}
+
+export interface WFSOperationsGetFeature {
+  /** Value of the geojson-like output format parameter (if any) to send with the GetFeature call. */
+  outputFormat: string | null;
+  /** Indicates if the GetFeature request supports pagination. */
+  supportsPagination: boolean;
+  /** The URL to the GetFeature endpoint. */
+  url: string;
+}
+
+export type WFSFeatureTypeName = `${string}:${string}`;
+
+/**
+ * Provides information about an individual feature type, or layer, found in the WFS service.
+ *
+ * @see [WFSCapabilities](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSCapabilities)
+ */
+export interface WFSFeatureType {
+  /** the default spatialReference wkid used when not explicitely specified in the GetFeature call. */
+  defaultSpatialReference: number;
+  /** The description of the featureType. */
+  description: string;
+  /** The extent of the features. */
+  extent?: Extent | null;
+  /** The name of the featureType. */
+  name: string;
+  /** The prefix of the namespace. */
+  namespacePrefix: string;
+  /** The namespaceUri of the featureType. */
+  namespaceUri: string;
+  /** An array of spatialReference wkids that are supported on the featureType. */
+  supportedSpatialReferences: number[];
+  /** The title of the featureType. */
+  title: string;
+  /** The type name of the featureType. This will be of the format `namespacePrefix:name`. */
+  typeName: WFSFeatureTypeName;
+}
+
+export interface WFSLayerInfoOptions extends WFSLayerPartialInfoOptions, WFSLayerTypeInfoOptions {}
+
+/**
+ * The layer info from the WFS service.
+ *
+ * @see [getWFSLayerInfo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#getWFSLayerInfo)
+ */
+export interface WFSLayerInfo {
+  /** The custom parameters applied to the layer. */
+  customParameters?: CustomParameters | null;
+  /** The extent of the layer. */
+  extent?: Extent | null;
+  /** The fields on the layer. */
+  fields: Field[];
+  /** The geometry type of the features in the layer. */
+  geometryType: FeatureGeometryType;
+  /** The name of the layer in the WFS service to display. */
+  name: string;
+  /** The namespace URI for the layer name. */
+  namespaceUri: string;
+  /** The field containing the object ID. */
+  objectIdField: string;
+  /** The spatial reference of the layer. */
+  spatialReference: SpatialReference;
+  /** Determines whether the X and Y coordinates should be swapped. */
+  swapXY: boolean;
+  /** The URL to the WFS service. */
+  url: string;
+  wfsCapabilities: WFSCapabilities;
+}
+
+/**
+ * Returns the [WFSLayerInfo](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-ogc-wfsUtils.html#WFSLayerInfo) from the capabilities of the WFS service. Can be used in conjunction with getCapabilities
+ *
+ * @param capabilities - The capabilities of the WFS service.
+ * @param name - The type name to get information for. If not specified, the first layer of the service is chosen.
+ * @param namespaceUri - The namespace URI of the type name. If not specified, the first namespace found for the `name` is chosen.
+ * @param options - An object specifying additional options. See the
+ *   object specification table below for the required properties of this object.
+ * @returns The layer info that can be used to create a [WFSLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-WFSLayer.html)
+ * @example
+ * const capabilities = await wfsUtils.getCapabilities(url);
+ * const layerInfo = await wfsUtils.getWFSLayerInfo(capabilities, "layer");
+ *
+ * const layer = WFSLayer.fromWFSLayerInfo(layerInfo);
+ *
+ * // Same as
+ * const layer = WFSLayer({
+ *   url,
+ *   name: "layer"
+ * });
+ */
+export function getWFSLayerInfo(capabilities: WFSCapabilities, name?: string | null, namespaceUri?: string | null, options?: WFSLayerInfoOptions): Promise<WFSLayerInfo>;
+
+export interface WFSLayerPartialInfoOptions extends AbortOptions {
+  /** The desired spatial reference for the layer. By default will use the default spatial reference of the feature type. */
+  spatialReference?: SpatialReference;
+}
+
+export interface WFSLayerTypeInfoOptions extends DescribeFeatureTypeOptions {}
+
+export interface DescribeFeatureTypeOptions extends AbortOptions {
+  /** A list of key-value pairs of parameters to append to the url. */
+  customParameters?: CustomParameters | null;
+}

package/layers/orientedImagery/core/ElevationSourceDefinitions.d.ts

@@ -0,0 +1,8 @@
+import type { ClonableMixin } from "../../../core/Clonable.js";
+import type { JSONSupport } from "../../../core/JSONSupport.js";
+
+export abstract class ConstantElevation extends ConstantElevationSuperclass {
+  /** The constant ground elevation value. The elevation value should have the same units as that of the cameraLocation's spatial reference system (SRS). */
+  accessor constantElevation: number;
+}
+declare const ConstantElevationSuperclass: typeof JSONSupport & typeof ClonableMixin

package/layers/orientedImagery/interfaces.d.ts

@@ -0,0 +1,57 @@
+import type { TimeUnit } from "../../core/timeUtils.js";
+
+export type OrientedImageryType = "horizontal" | "nadir" | "oblique" | "360" | "inspection" | "terrestrial-frame-video" | "aerial-frame-video" | "terrestrial-360-video" | "aerial-360-video";
+
+export type Accuracy = [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+
+export type AffineTransformations = [
+    number,
+    number,
+    number,
+    number,
+    number,
+    number
+];
+
+export type PrincipalOffsetPoint = [
+    number,
+    number
+];
+
+export type RadialDistortionCoefficients = [
+    number,
+    number,
+    number
+];
+
+export type TangentialDistortionCoefficients = [
+    number,
+    number
+];
+
+/** The elevation source. */
+export interface ElevationSource {
+  /** The level of details (LODs) of the elevation source. */
+  lod?: number | null;
+  /** The raster function used in the elevation source. */
+  rasterFunction?: string | null;
+  /** The url of the elevation source. */
+  url: string;
+}
+
+/** The unit of constant elevation value measured in meters. */
+export interface ConstantElevation {
+  /** The constant associated with the elevation source. */
+  constantElevation: number;
+}
+
+export type TimeIntervalUnit = Extract<TimeUnit, "days" | "hours" | "minutes" | "months" | "weeks" | "years">;

package/layers/orientedImagery/transformations/imageToWorld.d.ts

@@ -1,3 +1,45 @@
-import "../../../interfaces";
+import type Point from "../../../geometry/Point.js";
+import type { ReadonlyArrayOrCollection } from "../../../core/Collection.js";
+import type { ImageToWorldProperties, UpdateElevationProps } from "./interfaces.js";
+import type { LocationInImageSpace } from "../../../widgets/OrientedImageryViewer/interfaces.js";
 
-export const imageToWorld: __esri.imageToWorld["imageToWorld"];
+/**
+ * Transforms image coordinates in pixels to a point or an array of points specifying the corresponding geographic world coordinates. The function supports both single points and collections of points.
+ *
+ * @param pixelOrPixels - A single `Pixel` object or an `ArrayOrCollection<Pixel>` representing the image coordinates in `x` and `y` (in rows and columns) to be transformed. Here (0, 0) corresponds to the center of the upper left pixel.
+ * @param properties - An object containing the properties required for the transformation, such as camera location, rotation matrix, and image dimensions.
+ * @param updateElevationProps - An object containing the properties required for correcting the elevation of the output point, resulting in a more accurate z-value. This is an optional parameter.
+ * @returns A `Point` object if a single pixel is provided, or an array of `Point` objects if a collection of pixels is provided.
+ * @example
+ * const pixel = {
+ *    x: 2601.062988,
+ *    y: 1297.00708,
+ *    };
+ *
+ * const properties: {
+ *    affineTransformations: [2015.5, 1, 0, 1511.5, 0, -1],
+ *    averageElevation: 0,
+ *    cameraLocation: new Point({
+ *      x: -13045995.27,
+ *      y: 4036379.178,
+ *      z: 1.549999952,
+ *      spatialReference: SpatialReference.WebMercator,
+ *    }),
+ *    cameraPitch: 90,
+ *    cameraRoll: 0,
+ *    farDistance: 30,
+ *    horizontalFieldOfView: 65.47045135,
+ *    imageHeight: 3024,
+ *    imageWidth: 4032,
+ *    rotationMatrix: [
+ *      -0.6710996455056446, 4.539564596921633e-17, -0.7413671599161904,
+ *      -0.7413671599161904, -4.1093001638870556e-17, 0.6710996455056446,
+ *       0, 1, 6.123233995736766e-17
+ *     ],
+ *    verticalFieldOfView: 46.39718246,
+ * },
+ *
+ * const groundLocation = imageToWorld(pixel, properties);
+ * console.log(imageLocation);
+ */
+export function imageToWorld(pixelOrPixels: LocationInImageSpace | ReadonlyArrayOrCollection<LocationInImageSpace>, properties: ImageToWorldProperties, updateElevationProps?: UpdateElevationProps): Promise<Point | Point[]>;

package/layers/orientedImagery/transformations/interfaces.d.ts

@@ -0,0 +1,98 @@
+import type Point from "../../../geometry/Point.js";
+import type ElevationSampler from "../../support/ElevationSampler.js";
+import type { AffineTransformations, PrincipalOffsetPoint, RadialDistortionCoefficients, TangentialDistortionCoefficients } from "../interfaces.js";
+import type { ConstantElevation } from "../core/ElevationSourceDefinitions.js";
+
+export interface WorldToImageRequiredProperties {
+  /** A fixed length array of 6 numbers corresponding to the camera affine values A0, A1, A2, B0, B1, B2. The coefficient of the affine transformation establishes a relationship between the sensor space and image space. The direction is from ground to image. A0, A1, and A2 represent the translation in x direction, while B0, B1, and B2 represent the translation in y direction. Please refer to the [Oriented Imagery table](https://pro.arcgis.com/en/pro-app/latest/help/data/imagery/oriented-imagery-table.htm) for more information on the afffine values. */
+  affineTransformations: AffineTransformations;
+  /** A Point representing the camera location in world coordinates where the image was captured. */
+  cameraLocation: Point;
+  /** The row-wise sorted rotation matrix that defines the transformation from image space to map space, specified as an array of nine floating-point values. */
+  rotationMatrix: [
+      number,
+      number,
+      number,
+      number,
+      number,
+      number,
+      number,
+      number,
+      number
+  ];
+}
+
+export interface WorldToImageWithFOVAndImageSize extends WorldToImageRequiredProperties {
+  /** The camera's field-of-view in a horizontal direction. The unit is degrees. The valid values range from 0 through 360. */
+  horizontalFieldOfView: number;
+  /** Height of the image used for world to image transformation, in pixels. This parameter is used if the focal length is not provided. */
+  imageHeight: number;
+  /** image used for world to image transformation, in pixels. This parameter is used if the focal length is not provided. */
+  imageWidth: number;
+  /** The camera's field-of-view in the vertical direction. The unit is degrees. The valid values range from 0 through 180. */
+  verticalFieldOfView: number;
+}
+
+export interface WorldToImageWithFocalLength extends WorldToImageRequiredProperties {
+  /** The focal length of the camera lens. The unit can be microns, millimeters, or pixels. This parameter is used if ImageWidth and ImageHeight are not provided. */
+  focalLength: number;
+}
+
+export interface WorldToImageOptionalProperties {
+  /** A fixed length array of 2 numbers specifying the x-coordinate and  y-coordinate of the principal point of the autocollimation. The units must be the same as the unit used for FocalLength. The default value is [0,0]. This is an optional parameter. */
+  principalOffsetPoint?: PrincipalOffsetPoint;
+  /** The radial distortion is specified as an array of three numbers, indicating [K1,K2,K3] coefficient values. The coupling unit is the same as the unit specified for FocalLength. The default value is [0,0,0]. This is an optional parameter. */
+  radialDistortionCoefficients?: RadialDistortionCoefficients;
+  /** The tangential distortion is specified as  an array of three numbers, indicating [P1,P2] coefficient values. The coupling unit is the same as the unit used for FocalLength. The default value is [0,0]. This is an optional parameter. */
+  tangentialDistortionCoefficients?: TangentialDistortionCoefficients;
+}
+
+/**
+ * Represents the properties required for transforming world coordinates to image coordinates.
+ * For more information on the properties, please refer to the [Oriented Imagery table](https://pro.arcgis.com/en/pro-app/latest/help/data/imagery/oriented-imagery-table.htm).
+ */
+export type WorldToImageProperties = WorldToImageOptionalProperties
+  & (WorldToImageWithFocalLength | WorldToImageWithFOVAndImageSize);
+
+export interface ImageToWorldRequiredProperties extends WorldToImageRequiredProperties {
+  /** The height of the ground at the camera's location (specified by cameraLocation), determined by subtracting the camera's height from the absolute z-coordinate of the location. This value can be adjusted as needed. The elevation value should have the same units as that of the cameraLocation's patial reference system (SRS). */
+  averageElevation: number;
+  /**
+   * The camera orientation of the second rotation around the x-axis of the camera. The value is in degrees. The direction of measurement for heading is in positive counterclockwise direction.
+   * The CameraPitch is zero degrees when the camera is facing straight down to the ground. The valid range of CameraPitch values is from 0 through 180 degrees. CameraPitch is 180 degrees for a camera facing straight up, and 90 degrees for a camera facing horizontally.
+   */
+  cameraPitch: number;
+  /** The camera orientation of the final rotation around the z-axis of the camera in the positive clockwise direction. The value is in degrees. Valid values range from -90 to 90. */
+  cameraRoll: number;
+  /** The farthest usable distance of the imagery from the camera position. This value determines the far plane of the visible frustum. The intersection of the frustum far plane with the ground defines the footprint, which is used to determine whether an image is returned when you click the map. The unit is meters. Values must be greater than zero. */
+  farDistance: number;
+  /** The camera's field-of-view in a horizontal direction. The unit is degrees. The valid values range from 0 through 360. */
+  horizontalFieldOfView: number;
+  /** The camera's field-of-view in the vertical direction. The unit is degrees. The valid values range from 0 through 180. */
+  verticalFieldOfView: number;
+}
+
+/**
+ * Represents the properties required for transforming image coordinates to world coordinates.
+ * For more information on the properties, please refer to the [Oriented Imagery table](https://pro.arcgis.com/en/pro-app/latest/help/data/imagery/oriented-imagery-table.htm).
+ */
+export type ImageToWorldProperties = ImageToWorldRequiredProperties
+  & WorldToImageOptionalProperties
+  & (WorldToImageWithFocalLength | WorldToImageWithFOVAndImageSize);
+
+/** Represents the properties required for updating the elevation of the output point. Users can either provide values from an elevationSampler or constantElevation. */
+export type UpdateElevationProps = UpdateElevationWithConstant | UpdateElevationWithSampler;
+
+/** Represents the properties required for updating the elevation of the output point with a constant value. */
+export interface UpdateElevationWithConstant {
+  /** An elevation source. */
+  elevationSource: UpdateElevationPropsWithConstantElevationSource;
+}
+
+export type UpdateElevationPropsWithConstantElevationSource = Pick<ConstantElevation, "constantElevation">;
+
+/** Represents the properties required for updating the elevation of the output point with an elevation sampler. */
+export interface UpdateElevationWithSampler {
+  /** A cache of elevation values created from an elevation service used for synchronously querying elevation information for geometries. For more information on creating an elevation sampler, please refer [ElevationSampler](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ElevationSampler.html). The elevation value should have the same units as that of the cameraLocation's spatial reference system (SRS). */
+  elevationSample: ElevationSampler;
+}

package/layers/orientedImagery/transformations/worldToImage.d.ts

@@ -1,3 +1,43 @@
-import "../../../interfaces";
+import type Point from "../../../geometry/Point.js";
+import type { ReadonlyArrayOrCollection } from "../../../core/Collection.js";
+import type { WorldToImageProperties } from "./interfaces.js";
+import type { LocationInImageSpace } from "../../../widgets/OrientedImageryViewer/interfaces.js";
 
-export const worldToImage: __esri.worldToImage["worldToImage"];
+/**
+ * Transforms a point or an array of points from geographic world coordinates to image space coordinates. The function supports both single points and collections of points.
+ *
+ * @param pointOrPoints - A single `Point` or an array or collection of points representing the geographic coordinates to be transformed.
+ * @param properties - An object containing the properties required for the transformation, such as camera location (selected feature), affineTransformations, rotation matrix, focalLength, imageHeight, imageWidth, horizontalFieldOfView and verticalFieldOfView.
+ * @returns A `LocationInImageSpace` which is an object with `x` and `y` properties representing the image coordinates (in rows and columns), where (0, 0) corresponds to the center of the upper left pixel. This function returns a `LocationInImageSpace` object if a single point is provided, or an array of `LocationInImageSpace` objects if a collection of points is provided.
+ * @example
+ * const point = new Point({
+ *    x: -13045967.713,
+ *    y: 4036342.97,
+ *    z: 0,
+ *    spatialReference: SpatialReference.WebMercator,
+ * });
+ *
+ * const properties = {
+ *    affineTransformations: [2015.5, 1, 0, 1511.5, 0, -1],
+ *    cameraLocation: new Point({
+ *      x: -13045995.27,
+ *      y: 4036379.178,
+ *      z: 1.549999952,
+ *      spatialReference: SpatialReference.WebMercator,
+ *      }),
+ *    horizontalFieldOfView: 65.47045135,
+ *    imageHeight: 3024,
+ *    imageWidth: 4032,
+ *    rotationMatrix: [
+ *      -0.6710996455056446, 4.539564596921633e-17, -0.7413671599161904,
+ *      -0.7413671599161904, -4.1093001638870556e-17, 0.6710996455056446,
+ *       0, 1, 6.123233995736766e-17
+ *     ],
+ *    verticalFieldOfView: 46.39718246,
+ * };
+ *
+ * const imageLocation = worldToImage(point, properties);
+ *
+ * console.log(imageLocation);
+ */
+export function worldToImage(pointOrPoints: Point | ReadonlyArrayOrCollection<Point>, properties: WorldToImageProperties): LocationInImageSpace | LocationInImageSpace[];

package/layers/pointCloudFilters/PointCloudBitfieldFilter.d.ts

@@ -1,4 +1,52 @@
-import "../../interfaces";
+import type PointCloudFilter from "./PointCloudFilter.js";
+import type { PointCloudFilterProperties } from "./PointCloudFilter.js";
 
-import PointCloudBitfieldFilter = __esri.PointCloudBitfieldFilter;
-export default PointCloudBitfieldFilter;
+export interface PointCloudBitfieldFilterProperties extends PointCloudFilterProperties, Partial<Pick<PointCloudBitfieldFilter, "requiredClearBits" | "requiredSetBits">> {}
+
+/**
+ * Points can be classified using flags that indicate special characteristics associated with the point like
+ * the direction of the flight or the method used to create the point. The flags are stored as a bit encoded field
+ * and the PointCloudBitfieldFilter can be used to filter points that have certain flags set. Each flag is defined
+ * by its bit position and value. If the flag is set its value is `1`, otherwise its value is `0`.
+ *
+ * The data format of the points determines the bit position of each flag. You can read more about
+ * this in the [LAS specification v1.4](https://www.asprs.org/wp-content/uploads/2010/12/LAS_1_4_r13.pdf).
+ *
+ * For example for the [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html) used in the
+ * [Filter points in a PointCloudLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-pointcloud-filters/) the only available flag
+ * is the Scan direction, which is stored on bit position 6. The Scan direction flag has the value `1` only when the point was collected when the direction of the scan
+ * was positive (which means from the left to the right side of the in-track direction). To only show points with
+ * a positive scan direction we can set the requiredSetBit to `[6]` in the PointCloudBitfieldFilter:
+ *
+ * ```js
+ * const pointCloudLayer = new PointCloudLayer({
+ *  url: "https://tiles.arcgis.com/tiles/Imiq6naek6ZWdour/arcgis/rest/services/PointCloud_urban/SceneServer/",
+ *  filters: [{
+ *    type: "bitfield",
+ *    field: "FLAGS",
+ *    requiredSetBits: [6]
+ *  }]
+ * });
+ * ```
+ *
+ * The field for the PointCloudBitfieldFilter should be set to the field where the flags are stored. For most
+ * datasets this is the `FLAGS` field.
+ *
+ * @since 4.10
+ * @see [Sample - Filter points in a PointCloudLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-pointcloud-filters/)
+ */
+export default class PointCloudBitfieldFilter extends PointCloudFilter {
+  constructor(properties?: PointCloudBitfieldFilterProperties);
+  /**
+   * An array of bit positions where the bit value must be `0`, otherwise the point will not be displayed.
+   * Use this property to filter points based on the classification flag stored at that bit position.
+   */
+  accessor requiredClearBits: number[] | null | undefined;
+  /**
+   * An array of bit positions where the bit value must be `1`, otherwise the point will not be displayed.
+   * Use this property to filter points based on the classification flag stored at that bit position.
+   */
+  accessor requiredSetBits: number[] | null | undefined;
+  /** For PointCloudBitfieldFilter the type is always `bitfield`. */
+  get type(): "bitfield";
+}

package/layers/pointCloudFilters/PointCloudFilter.d.ts

@@ -1,4 +1,58 @@
-import "../../interfaces";
+import type { JSONSupport, JSONSupportMixinProperties } from "../../core/JSONSupport.js";
 
-import PointCloudFilter = __esri.PointCloudFilter;
-export default PointCloudFilter;
+export interface PointCloudFilterProperties extends JSONSupportMixinProperties, Partial<Pick<PointCloudFilter, "field">> {}
+
+export type PointCloudFilterType = "value" | "bitfield" | "return";
+
+/**
+ * Point cloud filters are used to hide points that do not satisfy the filter criteria.
+ *
+ * There are two types of filters that can be assigned to [PointCloudLayer#filters](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html#filters):
+ *
+ * [PointCloudValueFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudValueFilter.html) is useful for filtering points based
+ * on their classification value. If only the points that represent ground and buildings should be displayed,
+ * the following filter can be set:
+ *
+ * ```js
+ * const pcLayer = new PointCloudLayer({
+ *   ...,
+ *   filters: [{
+ *     type: "value",
+ *     field: "CLASS_CODE",
+ *     mode: "include",
+ *     // values include ground(2) and building(6)
+ *     values: [2, 6]
+ *   }]
+ * });
+ * ```
+ *
+ * [PointCloudReturnFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudReturnFilter.html) is used to filter points based on the return value
+ * stored with each point in the `RETURNS` field. The following filter can be set to display only the points that represent the highest feature in
+ * a landscape:
+ *
+ * ```js
+ * const pointCloudLayer = new PointCloudLayer({
+ *  ...,
+ *  filters: [{
+ *    type: "return",
+ *    field: "RETURNS",
+ *    values: ["firstOfMany", "single"]
+ *  }]
+ * });
+ * ```
+ *
+ * Filters can also be combined by setting several filters on one layer. Only points that satisfy all filters are displayed.
+ *
+ * @since 4.10
+ * @see [Sample - Filter points in a PointCloudLayer](https://developers.arcgis.com/javascript/latest/sample-code/layers-pointcloud-filters/)
+ * @see [PointCloudLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-PointCloudLayer.html)
+ * @see [PointCloudReturnFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudReturnFilter.html)
+ * @see [PointCloudValueFilter](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-pointCloudFilters-PointCloudValueFilter.html)
+ */
+export default class PointCloudFilter extends JSONSupport {
+  constructor(properties?: PointCloudFilterProperties);
+  /** The field used for applying the filter. */
+  accessor field: string | null | undefined;
+  /** The type of filter. */
+  get type(): PointCloudFilterType;
+}