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

package/layers/AnnotationFeatureLayer.d.ts

@@ -245,114 +245,148 @@ export default class AnnotationFeatureLayer extends AnnotationFeatureLayerSuperc
    */
   findSublayerForSubtypeCode(subtypeCode: number): AnnotationFeatureSublayer | null | undefined;
   /**
-   * 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
-   * > [AnnotationFeatureLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#queryExtent) method.
-   *
-   * @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.
+   * > - 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
+   * > [AnnotationFeatureLayerView.queryExtent()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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 - 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((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
+   * ```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 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
-   * > [AnnotationFeatureLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#queryFeatureCount) method.
-   *
-   * @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.
+   * > - To query the count of features available in the view on the client-side rather than making a server-side query, use
+   * > [AnnotationFeatureLayerView.queryFeatureCount()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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 - 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 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 [AnnotationFeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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
+   * > [AnnotationFeatureLayerView.queryFeatures()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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/AnnotationFeatureLayer/#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/)
+   * > based on `meter` units, then [FeatureLayer.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, 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 AnnotationFeatureLayer({
-   *   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
+   * 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>;
   /**
@@ -360,25 +394,34 @@ export default class AnnotationFeatureLayer extends AnnotationFeatureLayerSuperc
    * 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
-   * > [AnnotationFeatureLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#queryObjectIds) method.
-   *
-   * @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.
+   * > - To query the ObjectIDs of features visible in the view on the client-side rather than making a server-side query, use
+   * > [AnnotationFeatureLayerView.queryObjectIds()](https://developers.arcgis.com/javascript/latest/references/core/views/layers/AnnotationFeatureLayerView/#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 - 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<ObjectId[]>;
 }