@arcgis/core 5.2.0-next.32 → 5.2.0-next.34

package/layers/FeatureLayer.d.ts

@@ -1649,7 +1649,7 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * > `objectId`.
    *
    * @param attachmentQuery - Specifies the attachment parameters for query.
-   * @param options - An object with the following properties.
+   * @param options - Additional request options. See [RequestOptions](https://developers.arcgis.com/javascript/latest/references/core/request/types/#RequestOptions).
    * @returns When resolved, returns an object containing
    * [AttachmentInfos](https://developers.arcgis.com/javascript/latest/references/core/rest/query/support/AttachmentInfo/) grouped by the source
    * feature objectIds.
@@ -1696,13 +1696,12 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    */
   queryAttachments(attachmentQuery: AttachmentQueryProperties, options?: RequestOptions): Promise<Record<string, AttachmentInfo[]>>;
   /**
-   * Executes a [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsQuery/) against a feature service, which groups features into bins based on ranges in numeric or date fields, and returns a
+   * Executes a [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsQuery/) against a [FeatureLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/), which groups features into bins based on ranges in numeric or date fields, and returns a
    * [AttributeBinsFeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsFeatureSet/) containing the series of bins. Please refer to the [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsQuery/) document for more detailed information
    * on how to configure the bin parameters.
    *
-   * Binned data can condense complex information into meaningful insight. This query allows you to classify data into meaningful categories and summarize the data within each bin with summary statistics.
-   * Binned data can be effectively visualized in histograms (or bar charts), providing clearer insights into data distributions and trends.
-   * It can reveal underlying patterns that might be obscured in raw data. For example, bins can show concentrations of values in common ranges.
+   * Binned data can condense complex information into meaningful insight. This query allows you to classify data into meaningful categories and summarize the data
+   * within each bin with summary statistics.
    *
    * > [!WARNING]
    * >
@@ -1711,200 +1710,132 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * > The `queryAttributeBins()` method is unrelated to querying bins in [FeatureReductionBinning](https://developers.arcgis.com/javascript/latest/references/core/layers/support/FeatureReductionBinning/).
    *
    * @param binsQuery - Specifies the parameters of the `queryAttributeBins()` operation. The [AttributeBinsQuery.binParameters](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsQuery/#binParameters) property must be set.
-   * @param options - An object with the following properties.
-   * @returns When resolved, returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) containing
-   * a series of bins. Each feature in the [AttributeBinsFeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsFeatureSet/) represents a bin. The attributes of each feature contains statistics summarizing the data in the bin, including count, average, standard deviation, etc.
-   * @since 4.32
-   * @see [Sample - Attribute Bins Query](https://developers.arcgis.com/javascript/latest/sample-code/query-attribute-bins/)
+   * @param options - Abort options that can be passed into an asynchronous method to allow termination.
+   * @returns When resolved, returns a [AttributeBinsFeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsFeatureSet/) containing a series of bins. Each feature in the AttributeBinsFeatureSet
+   * represents a bin. The attributes of each feature contain statistics summarizing the data in the bin, including count, average, standard deviation, etc.
+   * @since 4.33
    * @see [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsQuery/)
-   * @example
-   * // Query the temperature field in the feature layer and create a histogram
-   * // Analyze temperature data over a year, create 100 bins for different temperature ranges
-   * // to assess frequency and identify patterns.
-   * const binQuery = new AttributeBinsQuery({
-   *   where: "UnitTop = 0",
-   *   binParameters: new AutoIntervalBinParameters({
-   *     bins: 100,
-   *     field: "temp",
-   *     start: 0, // lowest temp value to be included in the bin query
-   *     end: 30 // highest temp value to be included
-   *   })
-   * });
-   *
-   * layer.queryAttributeBins(query).then((results) => {
-   *   const bins = results.features.map((bin) => {
-   *     return {
-   *       minValue: bin.attributes.lowerBoundary,
-   *       maxValue: bin.attributes.upperBoundary,
-   *       count: bin.attributes.temperature_count,
-   *     };
-   *   });
-   *
-   *   // get the lower boundary of the first bin
-   *   const min = results.features[0].attributes.lowerBoundary;
-   *   // get the upper boundary of the last bin
-   *   const max = results.features[results.features.length - 1].attributes.upperBoundary;
-   *   // calculate the average for the bins
-   *   const average = results.features[0].attributes.lowerBoundary + results.features[results.features.length - 1].attributes.upperBoundary) / 2;
-   *
-   *   const histogram = new Histogram({
-   *     container: "histogramDiv",
-   *     bins: bins,
-   *     min: min,
-   *     max: max,
-   *     average: average,
-   *     barCreatedFunction:(index, element) => {
-   *       element.setAttribute("fill", "#FFA500");
-   *       element.setAttribute("opacity", 0.5);
-   *     },
-   *     labelFormatFunction: (value, type) => {
-   *       return (Math.round(value)).toLocaleString();
-   *     },
-   *     dataLines: [{
-   *       value: histogram.min,
-   *       label: histogram.min.toLocaleString()
-   *     }, {
-   *       value: histogram.average,
-   *       label: histogram.average.toLocaleString()
-   *     }, {
-   *       value: histogram.max,
-   *       label: histogram.max.toLocaleString()
-   *     }]
-   *   });
-   * });
+   * @see [Sample - Attribute Bins Query](https://developers.arcgis.com/javascript/latest/sample-code/query-attribute-bins/)
    */
   queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: RequestOptions): Promise<AttributeBinsFeatureSet>;
   /**
-   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service and
-   * returns the [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/) of features that satisfy the query. If no
-   * parameters are specified, then the extent and count of all features
-   * satisfying the layer's configuration/filters are returned.
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service and returns the [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/) of features that satisfy the query. If no
+   * parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned.
+   *
    *
    * > [!WARNING]
-   * >
-   * > To query for the extent of features/graphics available to or visible in the
-   * > [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) on the client rather than making a server-side query, you must use the
-   * > [FeatureLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryExtent) method.
+   * > - To query for the extent of features/graphics visible in the view on the client-side rather than making a server-side query, you must use the
+   * > [FeatureLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryExtent).
+   * 
    *
-   * @param query - Specifies the attributes and spatial
-   * filter of the query. If no parameters are specified, then the extent and count of all features
-   * satisfying the layer's configuration/filters are returned.
-   * @param options - An object with the following properties.
+   * @param query - Specifies the attributes and spatial filter of the query. If no parameters are specified, then the extent and count of all features satisfying the layer's configuration/filters are returned.
+   * @param options - Additional request options. See [RequestOptions](https://developers.arcgis.com/javascript/latest/references/core/request/types/#RequestOptions).
    * @returns When resolved, returns the extent and count of the features
    * that satisfy the input query. See the object specification table below for details.
    * Property | Type | Description
    * ---------|------|-------------
    * count | Number | The number of features that satisfy the input query.
-   * extent | [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/) \| null | The extent of the features that satisfy the query.
+   * extent | [Extent](https://developers.arcgis.com/javascript/latest/references/core/geometry/Extent/) | The extent of the features that satisfy the query.
    * @see [Sample - Zoom to extent of all features](https://developers.arcgis.com/javascript/latest/sample-code/featurelayer-queryextent/)
    * @example
+   * ```js
    * // Queries for the extent of all features matching the layer's configurations
    * // e.g. definitionExpression
-   * layer.queryExtent().then(function(results){
-   *   // go to the extent of the results satisfying the query
-   *   view.goTo(results.extent);
+   * layer.queryExtent().then((result) =>{
+   *   // go to the extent of the result satisfying the query
+   *   viewElement.goTo(result.extent);
    * });
+   * ```
    * @example
-   * const layer = new FeatureLayer({
-   *   url: fsUrl  // points to a Feature Service layer url
-   * });
-   *
+   * ```js
    * const query = new Query();
    * query.where = "region = 'Southern California'";
    *
-   * layer.queryExtent(query).then((results) =>{
-   *   view.goTo(results.extent);  // go to the extent of the results satisfying the query
+   * const result = await layer.queryExtent(query);
+   * viewElement.goTo(result.extent);  // go to the extent of the result satisfying the query
    * });
+   * ```
    */
   queryExtent(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<{
       count: number;
       extent: Extent | null;
   }>;
   /**
-   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service and
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service or layer data and
    * returns the number of features that satisfy the query. If no parameters are specified,
    * the total number of features satisfying the layer's configuration/filters is returned.
    *
+   *
    * > [!WARNING]
-   * >
-   * > To query for the count of features/graphics available to or visible in the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/)
-   * > on the client rather than making a server-side query, you must use the
-   * > [FeatureLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryFeatureCount) method.
+   * > - To query the count of features available in the view on the client-side rather than making a server-side query, use
+   * > [FeatureLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryFeatureCount).
+   * 
    *
-   * @param query - Specifies the attributes and
-   * spatial filter of the query. If no parameters are specified, the total number of features
-   * satisfying the layer's configuration/filters is returned.
-   * @param options - An object with the following properties.
+   * @param query - Specifies the attributes and spatial filter of the query. If no parameters are specified, the total number of features satisfying the layer's configuration/filters is returned.
+   * @param options - Additional request options. See [RequestOptions](https://developers.arcgis.com/javascript/latest/references/core/request/types/#RequestOptions).
    * @returns When resolved, returns the number of features that satisfy the query.
    * @see [Sample - Query features from a FeatureLayer](https://developers.arcgis.com/javascript/latest/sample-code/featurelayer-query/)
    * @example
+   * ```js
    * // Queries for the count of all features matching the layer's configurations
    * // e.g. definitionExpression
    * layer.queryFeatureCount().then((numFeatures) => {
    *   // prints the total count to the console
    *   console.log(numFeatures);
    * });
+   * ```
    * @example
-   * const layer = new FeatureLayer({
-   *   url: fsUrl  // points to a Feature Service layer url
-   * });
-   *
+   * ```js
    * const query = new Query();
    * query.where = "region = 'Southern California'";
    *
    * const featureCount = await layer.queryFeatureCount(query);
    * console.log(featureCount);  // prints the number of results satisfying the query
+   * ```
    */
   queryFeatureCount(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<number>;
   /**
-   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service and returns a
-   * [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) once the promise resolves.
-   * A [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) contains an array of [features](https://developers.arcgis.com/javascript/latest/references/core/Graphic/).
-   * See the [querying](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#querying)
-   * section for more information on how to query features from a layer.
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against a feature service or layer data and returns a
+   * [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) once the promise resolves. A FeatureSet contains an array of [features](https://developers.arcgis.com/javascript/latest/references/core/Graphic/).
    *
    * > [!WARNING]
    * >
    * > **Notes**
-   * >
-   * > To query features available to or visible in the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) on the client rather than making a server-side query, you must
-   * > use the [FeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryFeatures) method.
-   * >
-   * > When querying a service with z-values and no [vertical coordinate system](https://doc.esri.com/en/arcgis-pro/latest/help/mapping/properties/vertical-coordinate-systems.html) information,
-   * > the z-values will automatically be converted to match the [Query.outSpatialReference](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/#outSpatialReference) units.
+   * > - To query features visible in the view on the client-side rather than making a server-side query, use
+   * > [FeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryFeatures).
+   * > - When querying a feature service with z-values and no [vertical coordinate system](https://doc.esri.com/en/arcgis-pro/latest/help/mapping/properties/vertical-coordinate-systems.html)
+   * > information, z-values are automatically converted to match [Query.outSpatialReference](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/#outSpatialReference) units.
    * > Example: The service has a horizontal spatial reference using `feet` units and the query is made with `outSpatialReference`
    * > based on `meter` units, then [queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/layers/FeatureLayer/#queryFeatures) automatically converts the values from `feet` to `meter` units.
+   * 
    *
-   * @param query - Specifies the attributes and spatial
-   * filter of the query. If no parameters are specified, then all features satisfying the layer's
-   * configuration/filters are returned.
-   * @param options - An object with the following properties.
-   * @returns When resolved, a [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) containing
-   * an array of graphic features is returned.
-   * @see [Sample - Query features from a FeatureLayer](https://developers.arcgis.com/javascript/latest/sample-code/featurelayer-query/)
+   * @param query - Specifies the attributes and spatial filter of the query. If no parameters are specified, all features satisfying the layer's configuration/filters are returned.
+   * @param options - Additional request options. See [RequestOptions](https://developers.arcgis.com/javascript/latest/references/core/request/types/#RequestOptions).
+   * @returns When resolved, returns a [FeatureSet](https://developers.arcgis.com/javascript/latest/references/core/rest/support/FeatureSet/) containing an array of graphic features.
+   * @see [Samples using queryFeatures() method](https://developers.arcgis.com/javascript/latest/sample-code/?tagged=queryfeatures)
    * @see [Query and filter guide](https://developers.arcgis.com/javascript/latest/query-filter/)
    * @example
+   * ```js
    * // Queries for all the features matching the layer's configurations
    * // e.g. definitionExpression
-   * layer.queryFeatures().then((results) => {
-   *   // prints the array of result graphics to the console
-   *   console.log(results.features);
-   * });
+   * const results = await layer.queryFeatures();
+   * // prints the array of result graphics to the console
+   * console.log(results.features);
+   * ```
    * @example
-   * const layer = new FeatureLayer({
-   *   url: fsUrl  // points to a Feature Service layer url
-   * });
-   *
+   * ```js
+   * // create a query object to filter features by setting desired properties
    * const query = new Query();
    * query.where = "STATE_NAME = 'Washington'";
    * query.outSpatialReference = { wkid: 102100 };
    * query.returnGeometry = true;
    * query.outFields = [ "CITY_NAME" ];
    *
-   * layer.queryFeatures(query).then((results) => {
-   *   console.log(results.features);  // prints the array of features to the console
-   * });
+   * const results = await layer.queryFeatures(query);
+   * console.log(results.features);  // prints the array of features to the console
+   * ```
    * @example
+   * ```js
    * // Get a query object for the layer's current configuration
    * const queryParams = layer.createQuery();
    * // set a geometry for filtering features by a region of interest
@@ -1913,15 +1844,12 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * queryParams.where = queryParams.where + " AND TYPE = 'Extreme'";
    *
    * // query the layer with the modified params object
-   * layer.queryFeatures(queryParams).then((results) => {
-   *   // prints the array of result graphics to the console
-   *   console.log(results.features);
-   * });
+   * const results = await layer.queryFeatures(queryParams);
+   * // prints the array of result graphics to the console
+   * console.log(results.features);
+   * ```
    * @example
-   * const layer = new FeatureLayer({
-   *   url: fsUrl  // points to a Feature Service layer url
-   * });
-   *
+   * ```js
    * // query all features from the layer and only return
    * // attributes specified in outFields.
    * const query = { // autocasts as Query
@@ -1932,6 +1860,7 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    *
    * const results = await layer.queryFeatures(query);
    * console.log(results.features);  // prints the array of features to the console
+   * ```
    */
   queryFeatures(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<FeatureSet>;
   /**
@@ -1939,36 +1868,34 @@ export abstract class __FeatureLayerSansType extends FeatureLayerSuperclass {
    * array of Object IDs for features that satisfy the input query. If no parameters are specified,
    * then the Object IDs of all features satisfying the layer's configuration/filters are returned.
    *
+   *
    * > [!WARNING]
-   * >
-   * > To query for ObjectIDs of features available to or visible in the [View](https://developers.arcgis.com/javascript/latest/references/core/views/View/) on the client rather
-   * > than making a server-side query, you must use the
-   * > [FeatureLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryObjectIds) method.
+   * > - To query the ObjectIDs of features visible in the view on the client-side rather than making a server-side query, use
+   * > [FeatureLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/FeatureLayerView/#queryObjectIds).
+   * 
    *
-   * @param query - Specifies the attributes and spatial
-   * filter of the query. If no parameters are specified, then the Object IDs of all features
-   * satisfying the layer's configuration/filters are returned.
-   * @param options - An object with the following properties.
+   * @param query - Specifies the attributes and spatial filter of the query. If no parameters are specified, then the Object IDs of all features satisfying the layer's configuration/filters are returned.
+   * @param options - Additional request options. See [RequestOptions](https://developers.arcgis.com/javascript/latest/references/core/request/types/#RequestOptions).
    * @returns When resolved, returns an array of numbers representing the object IDs of the features satisfying the query.
    * @see [Sample - Query Related Features](https://developers.arcgis.com/javascript/latest/sample-code/query-related-features/)
    * @example
+   * ```js
    * // Queries for all the Object IDs of features matching the layer's configurations
    * // e.g. definitionExpression
    * layer.queryObjectIds().then((results) => {
    *   // prints the array of Object IDs to the console
    *   console.log(results);
    * });
+   * ```
    * @example
-   * const layer = new FeatureLayer({
-   *   url: "https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer/3"
-   * });
-   *
+   * ```js
    * const query = new Query({
    *   where: "SUB_REGION = 'Pacific'"
    * });
    *
    * const ids = await layer.queryObjectIds(query);
-   * console.log(ids);  // an array of object IDs
+   * console.log(ids); // an array of object IDs
+   * ```
    */
   queryObjectIds(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<ObjectId[]>;
   /**