npm - @arcgis/core - Versions diffs - 5.2.0-next.33 → 5.2.0-next.34 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (210) hide show

package/layers/WFSLayer.d.ts CHANGED Viewed

@@ -701,13 +701,12 @@ export default class WFSLayer extends WFSLayerSuperclass {
    */
   getFieldDomain(fieldName: string, options?: FieldDomainOptions): DomainUnion | null | undefined;
   /**
-   * Executes a [AttributeBinsQuery](https://developers.arcgis.com/javascript/latest/references/core/rest/support/AttributeBinsQuery/) against a WFSLayer, 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 [WFSLayer](https://developers.arcgis.com/javascript/latest/references/core/layers/WFSLayer/), 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]
    * >
@@ -716,178 +715,209 @@ export default class WFSLayer extends WFSLayerSuperclass {
    * > 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 an [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 contains statistics summarizing the data in the bin, including count, average, standard deviation, etc.
+   * @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/)
    * @see [Sample - Attribute Bins Query](https://developers.arcgis.com/javascript/latest/sample-code/query-attribute-bins/)
-   * @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()
-   *     }]
-   *   });
-   * });
    */
   queryAttributeBins(binsQuery: AttributeBinsQueryProperties, options?: RequestOptions): Promise<AttributeBinsFeatureSet>;
   /**
-   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the layer 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]
-   * >
-   * > **Known Limitations**
-   * >
-   * > Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/)
-   * >   documentation.
-   * > Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
-   * >   - GDM 2000 (4742) – Malaysia
-   * >   - Gusterberg (Ferro) (8042) – Austria/Czech Republic
+   * > - 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
+   * > [WFSLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/WFSLayerView/#queryExtent).
+   * > - Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) documentation.
+   * > - Spatial queries are currently not supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
+   * >   - GDM 2000 (4742) - Malaysia
+   * >   - Gusterberg (Ferro) (8042) - Austria/Czech Republic
    * >   - ISN2016 (8086) - Iceland
    * >   - SVY21 (4757) - Singapore
    *
-   * @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((result) =>{
+   *   // go to the extent of the result satisfying the query
+   *   viewElement.goTo(result.extent);
+   * });
+   * ```
+   * @example
+   * ```js
+   * const query = new Query();
+   * query.where = "region = 'Southern California'";
+   *
+   * 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 layer 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]
-   * >
-   * > **Known Limitations**
-   * >
-   * > Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/)
-   * >   documentation.
-   * > Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
-   * >   - GDM 2000 (4742) – Malaysia
-   * >   - Gusterberg (Ferro) (8042) – Austria/Czech Republic
+   * > - To query the count of features available in the view on the client-side rather than making a server-side query, use
+   * > [WFSLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/WFSLayerView/#queryFeatureCount).
+   * > - Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) documentation.
+   * > - Spatial queries are currently not supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
+   * >   - GDM 2000 (4742) - Malaysia
+   * >   - Gusterberg (Ferro) (8042) - Austria/Czech Republic
    * >   - ISN2016 (8086) - Iceland
    * >   - SVY21 (4757) - Singapore
    *
-   * @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
+   * ```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 layer 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 [Graphic](https://developers.arcgis.com/javascript/latest/references/core/Graphic/)
-   * features, which can be added to the [view's graphics](https://developers.arcgis.com/javascript/latest/references/core/views/View/#graphics).
-   * This array will not be populated if zero results are found.
+   * 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]
    * >
-   * > **Known Limitations**
-   * >
-   * > Attribute values used in attribute queries executed against WSFLayer are case sensitive.
-   * > Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/)
-   * >   documentation.
-   * > Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
-   * >   - GDM 2000 (4742) – Malaysia
-   * >   - Gusterberg (Ferro) (8042) – Austria/Czech Republic
+   * > **Notes**
+   * > - To query features visible in the view on the client-side rather than making a server-side query, use
+   * > [WFSLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/WFSLayerView/#queryFeatures).
+   * > - Attribute values used in attribute queries executed against these layers are case sensitive.
+   * > - Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) documentation.
+   * > - Spatial queries are currently not supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
+   * >   - GDM 2000 (4742) - Malaysia
+   * >   - Gusterberg (Ferro) (8042) - Austria/Czech Republic
    * >   - ISN2016 (8086) - Iceland
    * >   - SVY21 (4757) - Singapore
    *
-   * @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
+   * const results = await layer.queryFeatures();
+   * // prints the array of result graphics to the console
+   * console.log(results.features);
+   * ```
+   * @example
+   * ```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" ];
+   *
+   * 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
+   * queryParams.geometry = extentForRegionOfInterest;
+   * // Add to the layer's current definitionExpression
+   * queryParams.where = queryParams.where + " AND TYPE = 'Extreme'";
+   *
+   * // query the layer with the modified params object
+   * const results = await layer.queryFeatures(queryParams);
+   * // prints the array of result graphics to the console
+   * console.log(results.features);
+   * ```
+   * @example
+   * ```js
+   * // query all features from the layer and only return
+   * // attributes specified in outFields.
+   * const query = { // autocasts as Query
+   *   where: "1=1", // select all features
+   *   returnGeometry: false,
+   *   outFields: ["State_Name", "City_Name", "pop2010"]
+   * };
+   *
+   * 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>;
   /**
-   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the layer and returns an
+   * Executes a [Query](https://developers.arcgis.com/javascript/latest/references/core/rest/support/Query/) against the feature service and returns an
    * 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]
-   * >
-   * > **Known Limitations**
-   * >
-   * > Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/)
-   * >   documentation.
-   * > Spatial queries are not currently supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
-   * >   - GDM 2000 (4742) – Malaysia
-   * >   - Gusterberg (Ferro) (8042) – Austria/Czech Republic
+   * > - To query the ObjectIDs of features visible in the view on the client-side rather than making a server-side query, use
+   * > [WFSLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/WFSLayerView/#queryObjectIds).
+   * > - Spatial queries have the same limitations as those listed in the [projectOperator](https://developers.arcgis.com/javascript/latest/references/core/geometry/operators/projectOperator/) documentation.
+   * > - Spatial queries are currently not supported if the layer view has any of the following [SpatialReferences](https://developers.arcgis.com/javascript/latest/references/core/geometry/SpatialReference/):
+   * >   - GDM 2000 (4742) - Malaysia
+   * >   - Gusterberg (Ferro) (8042) - Austria/Czech Republic
    * >   - ISN2016 (8086) - Iceland
    * >   - SVY21 (4757) - Singapore
    *
-   * @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.
-   * @returns When resolved, returns an array of numbers representing the object IDs of the features
-   *                   satisfying the query.
+   * @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
+   * ```js
+   * const query = new Query({
+   *   where: "SUB_REGION = 'Pacific'"
+   * });
+   *
+   * const ids = await layer.queryObjectIds(query);
+   * console.log(ids); // an array of object IDs
+   * ```
    */
   queryObjectIds(query?: QueryProperties | null | undefined, options?: RequestOptions): Promise<number[]>;
 }