@arcgis/core/views/layers/WFSLayerView
Represents the LayerView of a WFSLayer after it has been added to a Map in either a MapView or SceneView. The WFSLayerView is responsible for rendering a WFSLayer's features as graphics in the View.
- See also
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
A list of attribute fields fetched for each feature including fields required for layer's | WFSLayerView | ||
Indicates whether the layer view is currently fetching new features. | WFSLayerView | ||
The name of the class. | Accessor | ||
The featureEffect can be used to draw attention features of interest. | WFSLayerView | ||
The attribute, geometry, and time extent filter. | WFSLayerView | ||
Indicates whether the layer view contains all available features from the service or source. | WFSLayerView | ||
This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible (for example, if the result is zero). | WFSLayerView | ||
Indicates whether the LayerView contains geometries at full resolution. | WFSLayerView | ||
Options for configuring the highlight. | WFSLayerView | ||
The layer being viewed. | LayerView | ||
The maximum number of features that can be displayed at a time. | WFSLayerView | ||
Signifies whether the maximum number of features has been exceeded. | WFSLayerView | ||
Indicates if the spatialReference of the MapView is supported by the layer view. | LayerView | ||
Value is | LayerView | ||
An automatically generated unique identifier assigned to the instance. | LayerView | ||
Indicates if the layer view is making any updates that will impact what is displayed on the map. | LayerView | ||
A reference to the MapView or SceneView associated with the layer view. | LayerView | ||
When | LayerView | ||
When | LayerView | ||
When | LayerView |
Property Details
-
A list of attribute fields fetched for each feature including fields required for layer's
rendererlabelingInfo,elevationInfo, and additional fields defined on theoutFieldsproperties. TheavailableFieldsproperty is populated when the layerView has finished updating. TheavailableFieldsis used when filtering or querying features on the client-side.- See also
Exampleconst layerView = await view.whenLayerView(layer); // availableFields will become available once the // layerView finishes updating await reactiveUtils.whenOnce(() => !layerView.updating); try { const results = await layerView.queryFeatures({ outFields: layerView.availableFields, where: "DEW_POINT > 10" }); console.log(results.features.length, " features returned"); } catch(error) { console.log("query failed: ", error); }
-
dataUpdating
PropertydataUpdating BooleanreadonlySince: ArcGIS Maps SDK for JavaScript 4.28WFSLayerView since 4.20, dataUpdating added at 4.28. -
Indicates whether the layer view is currently fetching new features. It becomes
falseonce all layer queries have finished executing. Watch this property along with updating property to know when to re-execute client-side queries after an update cycle. For example, a query that returns the number of features available in the layer view should be executed whendataUpdatingbecomesfalse. It's important to note thatdataUpdatingcan only betruewhenupdatingis alsotrue.Example// watch layer view updating and dataUpdating to get the count of features // available in layer view. Only execute the query once new features are fetched. let dataWasUpdated = lv.dataUpdating; reactiveUtils.watch(() => [lv.updating, lv.dataUpdating], ([updating, dataUpdating]) => { dataWasUpdated ||= dataUpdating; if (!updating && dataWasUpdated) { dataWasUpdated = false; lv.queryFeatureCount().then((results)=>{ console.log("number of features in layerView", results); }); } });
-
featureEffect
PropertyfeatureEffect FeatureEffect |null |undefinedautocastSince: ArcGIS Maps SDK for JavaScript 4.22WFSLayerView since 4.20, featureEffect added at 4.22. -
The featureEffect can be used to draw attention features of interest. It allows for the selection of features via a filter, and an includedEffect and excludedEffect are applied to those features that respectively pass or fail the filter requirements.
If the
featureEffectis set on the layer, it will be inherited bylayerView.featureEffectunless the developer overrides it on the layerView. ThelayerView.featureEffectwill take precedence overlayer.featureEffectif both properties are set.Known Limitations
- FeatureEffect is not supported in the following scenarios:
- In 3D SceneViews
- When FeatureReductionCluster is enabled
- When a map is printed
- A FeatureEffect set on a layerView cannot persisted in a WebMap.
Examples// gray out features that fall outside of the 3 mile buffer of the mouse's location // by setting feature effect on excluded features layerView.featureEffect = new FeatureEffect({ filter: new FeatureFilter({ geometry: filterGeometry, spatialRelationship: "intersects", distance: 3, units: "miles" }), excludedEffect: "grayscale(100%) opacity(30%)" });// Apply a drop-shadow feature effect to the features that intersect the borough boundaries, // while applying blur and brightness effects to the features that are excluded from filter criteria. // The resulting map will make it easier to spot if the residents are more likely to experience deprivation // if they live on a borough boundary. const featureFilter = new FeatureFilter({ where: "BoroughEdge='true'" }); layerView.featureEffect = new FeatureEffect({ filter: featureFilter, includedEffect: "drop-shadow(3px, 3px, 3px, black)", excludedEffect: "blur(1px) brightness(65%)" }); - FeatureEffect is not supported in the following scenarios:
-
filter
Propertyfilter FeatureFilter |null |undefinedautocast -
The attribute, geometry, and time extent filter. Only the features that satisfy the filter are displayed on the view.
Example// display rain gauges where their water percent is over 30% // and if the gauges are completely contained by the 10-mile // buffer around the filter geometry featureLayerView.filter = new FeatureFilter({ where: "percentile >= 30", geometry: filterPolygon, spatialRelationship: "contains", distance: 10, units: "miles" });
-
hasAllFeatures
PropertyhasAllFeatures BooleanreadonlySince: ArcGIS Maps SDK for JavaScript 4.29WFSLayerView since 4.20, hasAllFeatures added at 4.29. -
Indicates whether the layer view contains all available features from the service or source. After the layer finishes loading and fetching its data, this property reflects whether all features from the source are available in the layer view.
When
hasAllFeaturesistrue:- The LayerView contains all features from the layer.
- Queries executed on the LayerView run against the entire dataset.
- To restrict queries to features currently visible in the view, set the query’s geometry
property to the View's
extent.
When
hasAllFeaturesisfalse:- The LayerView contains only features available for drawing.
- Queries on the LayerView run against the subset of features available on the client.
- To query the entire dataset with full-resolution geometries, use the query method on the Layer itself.
- See also
Exampleconst viewElement = document.querySelector("arcgis-map"); const layerView = await viewElement.whenLayerView(layer); // Wait until the initial layer load completes const layerView = await viewElement.whenLayerView(airQualityLayer); await reactiveUtils.whenOnce(() => !layerView.updating); // Set up query with outStatistics to compute min, max, and average PM2.5 of all data const query = airQualityLayer.createQuery(); query.outStatistics = [ { statisticType: "avg", onStatisticField: "pm25", outStatisticFieldName: "avg_pm25" }, { statisticType: "min", onStatisticField: "pm25", outStatisticFieldName: "min_pm25" }, { statisticType: "max", onStatisticField: "pm25", outStatisticFieldName: "max_pm25" } ]; // Run the query on all features to get the min, max, and average values. // If `hasAllFeatures` is true, all features from the layer are loaded // and available on the client, so use layerView.queryFeatures for faster performance. // Otherwise, use layer.queryFeatures to run the query against all features const results = layerView.hasAllFeatures ? await layerView.queryFeatures(query) : await airQualityLayer.queryFeatures(query); // process the result updateAirQualityStatus(results);
-
hasAllFeaturesInView
PropertyhasAllFeaturesInView BooleanreadonlySince: ArcGIS Maps SDK for JavaScript 4.29WFSLayerView since 4.20, hasAllFeaturesInView added at 4.29. -
This property helps determine if the layer view has successfully retrieved all relevant data for the current extent, even if no features are visible (for example, if the result is zero). When
true, you can use the layer view's query functions to investigate the features currently displayed on the map. Iffalse, you may need to query the layer and its service directly to get accurate results. The hasAllFeaturesInView property will befalseif some queries failed to execute, or when the layer contains a large number of features and is configured with a display filter. This filter is sent along with the layer's definitionExpression during each feature tile query.- See also
Exampleconst layerView = await viewElement.whenLayerView(featureLayer); reactiveUtils.when( () => !layerView.dataUpdating, async () => { // wait till the layerView finishes fetching its data // layerView has all expected features if (layerView.hasAllFeaturesInView) { const count = await layerView.queryFeatureCount({ geometry: view.extent }); // use the feature count console.log(count, "features in the layerView within the extent"); } else { // LayerView does not have all expected features // for example, the layer may have displayFilterInfo applied // in this case, not all features from the layer will be available // in the layer view as they are filtered out const count = await layer.queryFeatureCount({ geometry: view.extent }); // use the count console.log(count, "features in the layer within the extent"); } } );
-
hasFullGeometries
PropertyhasFullGeometries BooleanreadonlySince: ArcGIS Maps SDK for JavaScript 4.29WFSLayerView since 4.20, hasFullGeometries added at 4.29. -
Indicates whether the LayerView contains geometries at full resolution. After the layer finishes loading and fetching its data, this property reflects whether all geometries were loaded at full resolution without quantization.
To retrieve feature geometries at full resolution when querying, first check the LayerView's
hasFullGeometriesproperty. If it istrue, use a query method on the LayerView; otherwise, use the query method on the Layer.- See also
-
highlightOptions
PropertyhighlightOptions HighlightOptions |null |undefinedautocastSince: ArcGIS Maps SDK for JavaScript 4.26WFSLayerView since 4.20, highlightOptions added at 4.26. Deprecated since version 4.34. Use the View.highlights property instead. -
Options for configuring the highlight. Use the highlight() method on the layer view to highlight a feature.
Known Limitations
- The
highlightOptionson layer views are only supported in 2D MapViews. To configure highlights for a 3D SceneView, use SceneView.highlights instead.
Example// Features in the layerview will be highlighted with bright // yellow colors in the map. const layerView = await view.whenLayerView(layer); layerView.highlightOptions = { color: [255, 255, 0, 1], haloOpacity: 0.9, fillOpacity: 0.2 }; - The
-
maximumNumberOfFeatures
PropertymaximumNumberOfFeatures Number -
The maximum number of features that can be displayed at a time. This setting currently only applies to SceneView. By default, the maximum number of features is estimated automatically depending on the symbology, geometry complexity, memory consumption and display quality profile.
Changing this setting to a higher value may lead to a significant decrease in performance and increase in memory usage.
Known Limitations
The
maximumNumberOfFeaturesis only supported in 3D SceneViews.
-
maximumNumberOfFeaturesExceeded
PropertymaximumNumberOfFeaturesExceeded Boolean -
Signifies whether the maximum number of features has been exceeded. Not all features could be displayed when this value is
true. This setting currently only applies to SceneView.Known Limitations
The
maximumNumberOfFeaturesExceededis only supported in 3D SceneViews.
-
spatialReferenceSupported
InheritedPropertyspatialReferenceSupported BooleanreadonlyInherited from LayerViewSince: ArcGIS Maps SDK for JavaScript 4.23LayerView since 4.0, spatialReferenceSupported added at 4.23. -
Indicates if the spatialReference of the MapView is supported by the layer view. When
falselayer view will be suspended.- See also
-
updating
InheritedPropertyupdating BooleanreadonlyInherited from LayerView -
Indicates if the layer view is making any updates that will impact what is displayed on the map. For example, this value is
truewhen renderer, definitionExpression, filter or effect is changed or if the layer view is in the process of the fetching data.Watch dataUpdating property instead to only know when the data has been updated (e.g. to run statistics query on all feature available in the layer view).
- Default Value:false
Example// Check for the first time layerView.updating becomes false. Then query for // features that are visible within the view associated with the layer view. await reactiveUtils.whenOnce(() => !layerView.updating); const query = layerView.createQuery(); query.geometry = layerView.view.extent; const result = layerView.queryFeatures(query);
-
Inherited from LayerView
Since: ArcGIS Maps SDK for JavaScript 4.28LayerView since 4.0, view added at 4.28. -
Example
// Check for the first time layerView.updating becomes false. Then query for // features that are visible within the view associated with the layer view. await reactiveUtils.whenOnce(() => !layerView.updating); const query = layerView.createQuery(); query.geometry = layerView.view.extent; const result = layerView.queryFeatures(query);
-
visible
InheritedPropertyvisible BooleanInherited from LayerView -
When
true, the layer is visible in the view. Value of this property is inherited from thelayer.visibleunless the developer overrides it. ThelayerView.visiblewill take precedence overlayer.visibleif both properties are set.- Default Value:true
-
visibleAtCurrentScale
InheritedPropertyvisibleAtCurrentScale BooleanreadonlyInherited from LayerViewSince: ArcGIS Maps SDK for JavaScript 4.30LayerView since 4.0, visibleAtCurrentScale added at 4.30. -
When
true, the layer is visible in the view at the current scale. This applies to layers that haveminScaleandmaxScaleproperties set.Known Limitations
- This property is not supported in 3D SceneView tiled layers.
- Default Value:true
- See also
-
visibleAtCurrentTimeExtent
InheritedPropertyvisibleAtCurrentTimeExtent BooleanreadonlyInherited from LayerViewSince: ArcGIS Maps SDK for JavaScript 4.30LayerView since 4.0, visibleAtCurrentTimeExtent added at 4.30. -
When
true, the layer is visible in the view's timeExtent. This applies to layers that have a visibilityTimeExtent.- Default Value:true
- See also
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates query parameter object that can be used to fetch aggregate features as they are being displayed. | WFSLayerView | ||
Creates a query parameter object that can be used to fetch features as they are being displayed. | WFSLayerView | ||
Returns true if a named group of handles exist. | Accessor | ||
Highlights the given feature(s) in a layer view using the named HighlightOptions from the view's highlights collection. | WFSLayerView | ||
| LayerView | ||
| LayerView | ||
| LayerView | ||
Promise<FeatureSet> | Executes a Query against aggregate features (i.e. | WFSLayerView | |
Promise<AttributeBinsFeatureSet> | Executes a AttributeBinsQuery against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an AttributeBinsFeatureSet containing the series of bins. | WFSLayerView | |
Promise<Object> | Executes a Query against features available for drawing in the layerView and returns the Extent of features that satisfy the query. | WFSLayerView | |
Promise<Number> | Executes a Query against features available for drawing in the layerView and returns the number of features that satisfy the query. | WFSLayerView | |
Promise<FeatureSet> | Executes a Query against features available for drawing in the LayerView and returns a FeatureSet. | WFSLayerView | |
Executes a Query against features available for drawing in the layerView and returns array of the ObjectIDs of features that satisfy the input query. | WFSLayerView | ||
Removes a group of handles owned by the object. | Accessor | ||
Promise |
| LayerView |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
createAggregateQuery
MethodcreateAggregateQuery(){Query}Since: ArcGIS Maps SDK for JavaScript 4.25WFSLayerView since 4.20, createAggregateQuery added at 4.25. -
Creates query parameter object that can be used to fetch aggregate features as they are being displayed. It sets the query parameter's outFields property to
["*"]and returnGeometry totrue. The output spatial reference outSpatialReference is set to the spatial reference of the view.ReturnsType Description Query The query parameter object. - See also
-
createQuery
MethodcreateQuery(){Query} -
Creates a query parameter object that can be used to fetch features as they are being displayed. It sets the query parameter's outFields property to
["*"]and returnGeometry totrue. The outSpatialReference is set to the spatial reference of the view. Parameters of the filter currently applied to the layer view are also incorporated in the returned query object. The results will include geometries of features and values for all fields.ReturnsType Description Query The query object Exampleconst query = csvLayerView.createQuery(); query.where = "magnitude > 4"; csvLayerView.queryFeatures(query).then(function(results) { console.log(results); }) .catch(function(error) { console.log(error); });
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
highlight
Methodhighlight(target, options){Handle} -
Highlights the given feature(s) in a layer view using the named HighlightOptions from the view's highlights collection. If no
nameis provided, the feature will use thedefaulthighlight options.Release-specific changes:
- As of version 4.32, the
highlightmethod accepts anoptionsparameter which can be used to provide a name to apply specific HighlightOptions. If nonameis provided, thedefaulthighlight options will be used. - As of version 4.23, the
highlight()method was added to ImageryLayerView, supported only in a 2D MapView.
ParametersThe feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid
objectID. You may alternatively pass one or more objectIDs as a single number, string, or an array of numbers or strings.options ObjectoptionalAn object with the following properties.
Specificationname StringoptionalThe name of the highlight options from the view's highlights collection. If a
nameis provided, the corresponding highlight options will be applied to the feature(s). Otherwise, thedefaulthighlight options will be used.ReturnsType Description Handle Returns a highlight handler with a remove()method that can be called to remove the highlight.Examples// Highlight features based on a query result // Add a new set of highlight options to the view's highlights collection view.highlights.push({ name: "oaks", color: "forestgreen", haloOpacity: 0.8, fillOpacity: 0.3 }); // A handler can be used to remove any previous highlight when applying a new one let highlight; // Query for particualar features in a layer and then highlight them with the specified options view.whenLayerView(treesLayer).then((layerView) => { let query = treesLayer.createQuery(); query.where = "type = 'Quercus'"; treesLayer.queryFeatures(query).then((result) => { // Remove any previous highlight, if it exists highlight?.remove(); // Apply the "oaks" highlight options to the corresponding tree features highlight = layerView.highlight(result.features, {name: "oaks"}); }); });// Use the default highlights collection to apply a highlight to features when you hover over them // A handler can be used to remove any previous highlight when applying a new one let hoverHighlight; view.on("pointer-move", (event) => { // Search for the first feature in the featureLayer at the hovered location view.hitTest(event, { include: layer }).then((response) => { if (response.results[0]) { const graphic = response.results[0].graphic; view.whenLayerView(graphic.layer).then((layerView) => { // Remove any previous highlight, if it exists hoverHighlight?.remove(); // Highlight the hit features with the temporary highlight options, which are pre-configured for this use case hoverHighlight = layerView.highlight(graphic, { name: "temporary" }); }); } }); }); - As of version 4.32, the
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}Inherited from LayerView -
isFulfilled()may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled,truewill be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}Inherited from LayerView -
isRejected()may be used to verify if creating an instance of the class is rejected. If it is rejected,truewill be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}Inherited from LayerView -
isResolved()may be used to verify if creating an instance of the class is resolved. If it is resolved,truewill be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
queryAggregates
MethodqueryAggregates(query, options){Promise<FeatureSet>}Since: ArcGIS Maps SDK for JavaScript 4.25WFSLayerView since 4.20, queryAggregates added at 4.25. -
Executes a Query against aggregate features (i.e. clusters or bins) available for drawing in the layerView and returns a FeatureSet. If query parameters are not provided, all aggregates available for drawing are returned along with their attributes that are available on the client. Fields referenced in statistic queries or in the where clause must first be defined as aggregate fields.
Known Limitations
This method currently does not support spatial queries (i.e. the Query.geometry option and its related properties).
Parametersoptional Autocasts from ObjectSpecifies the parameters of the query. Leave this parameter empty to query all aggregates in the view.
options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<FeatureSet> When resolved, returns a FeatureSet containing an array of aggregate features. Example// clustered point layer const layer = new FeatureLayer({ featureReduction: { type: "cluster" } }); const layerView = await view.whenLayerView(layer); await reactiveUtils.whenOnce(() => !layerView.updating); // features represents all the clusters in the view const { features } = await layerView.queryAggregates();
-
queryAttributeBins
MethodqueryAttributeBins(binsQuery, options){Promise<AttributeBinsFeatureSet>}Since: ArcGIS Maps SDK for JavaScript 4.32WFSLayerView since 4.20, queryAttributeBins added at 4.32. -
Executes a AttributeBinsQuery against features available for drawing, which groups features into bins based on ranges in numeric or date fields, and returns an AttributeBinsFeatureSet containing the series of bins. Please refer to the 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.
Notes
- The
queryAttributeBins()method is unrelated to querying bins in FeatureReductionBinning.
ParametersAutocasts from ObjectSpecifies the parameters of the
queryAttributeBins()operation. The binParameters property must be set.options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<AttributeBinsFeatureSet> When resolved, returns a 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. 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 }) }); layerView.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() }] }); }); - The
-
queryExtent
MethodqueryExtent(query, options){Promise<Object>} -
Executes a Query against features available for drawing in the layerView and returns the Extent of features that satisfy the query.
Notes
- Attribute values used in attribute queries executed against LayerViews are case sensitive.
- Ensure the fields being queried are included in the availableFields list; otherwise, the query may fail or return incomplete results.
- To get an extent of all the features in a layer rather than only those currently available on the client,
check the hasAllFeatures property on the LayerView.
If
hasAllFeaturesistrue, thenqueryExtent()on the LayerView returns anextentbased on all features available in the layer that satisfy the query, not just those currently loaded on the client. Otherwise, usequeryExtent()on the Layer to get the extent based on all features available in the layer that satisfy the query. - Spatial queries can be performed on quantized geometries within the LayerView. The resolution of these geometries is
only as precise as the scale resolution of the view.
Geometries returned from any LayerView query will match the view's scale resolution.
To retrieve feature geometries at full resolution, first check the LayerView's hasFullGeometries property. If it is
true, use thequeryExtent()method on the LayerView; otherwise, use thequeryExtent()method on the Layer. - Spatial queries have the same limitations as those listed in the projectOperator documentation.
- Spatial queries are not currently supported if the layerView has any of the following SpatialReferences:
- GDM 2000 (4742) – Malaysia
- Gusterberg (Ferro) (8042) – Austria/Czech Republic
- ISN2016 (8086) - Iceland
- SVY21 (4757) - Singapore
Parametersoptional Autocasts from ObjectSpecifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the
geometryparameter in the query object to the view's extent.options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<Object> 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 | null The extent of the features that satisfy the query. Exampleslet layer = new CSVLayer({ url: csvUrl // URL to a csv file }); const layerView = await view.whenLayerView(layer); await reactiveUtils.whenOnce(() => !layerView.updating); const results = await layerView.queryExtent() view.goTo(results.extent); // go to the extent of all the graphics in the layerView// Expand the extent so that a feature (i.e. point feature) // won't be off screen after the end of goTo animation. const { extent } = await layerView.queryExtent() const zoomScale = 16000; extent.expand((zoomScale / view.scale) * view.resolution); view.goTo(extent);
-
queryFeatureCount
MethodqueryFeatureCount(query, options){Promise<Number>} -
Executes a Query against features available for drawing in the layerView and returns the number of features that satisfy the query. If query parameters are not provided, the count of all features available for drawing is returned.
Notes
- Attribute values used in attribute queries executed against LayerViews are case sensitive.
- Ensure the fields being queried are included in the availableFields list; otherwise, the query may fail or return incomplete results.
- To get a count of all features in a layer rather than only those currently available on the client,
check the hasAllFeatures property on the LayerView.
If
hasAllFeaturesistrue, thenqueryFeatureCount()on the LayerView returns the count of all features from the entire dataset that satisfy the query, not just those currently loaded on the client. Otherwise, usequeryFeatureCount()on the layer to get the count based on all features available in the layer that satisfy the query. - Spatial queries can be performed on quantized geometries within the LayerView. The resolution of these geometries is
only as precise as the scale resolution of the view.
Geometries returned from any LayerView query will match the view's scale resolution.
To retrieve feature geometries at full resolution, first check the LayerView's hasFullGeometries property. If it is
true, use thequeryFeatureCount()method on the LayerView; otherwise, use thequeryFeatureCount()method on the Layer. - Spatial queries have the same limitations as those listed in the projectOperator documentation.
- Spatial queries are not currently supported if the layerView has any of the following SpatialReferences:
- GDM 2000 (4742) – Malaysia
- Gusterberg (Ferro) (8042) – Austria/Czech Republic
- ISN2016 (8086) - Iceland
- SVY21 (4757) - Singapore
Parametersoptional Autocasts from ObjectSpecifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the
geometryparameter in the query object to the view's extent.options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<Number> When resolved, returns the number of features satisfying the query. Examplesview.on("click", (event) => { let query = new Query(); query.geometry = event.mapPoint; // obtained from a view click event query.spatialRelationship = "intersects"; const layerView = await view.whenLayerView(layer); await reactiveUtils.whenOnce(() => !layerView.updating); const count = await layerView.queryFeatureCount(query); console.log(count); // prints the number of the client-side graphics that satisfy the query });const layerView = await view.whenLayerView(layer); const count = await layerView.queryFeatureCount() console.log(count); // prints the total number of client-side graphics to the console
-
queryFeatures
MethodqueryFeatures(query, options){Promise<FeatureSet>} -
Executes a Query against features available for drawing in the LayerView and returns a FeatureSet. If query parameters are not provided, then a default query is created using createQuery() method and all features that pass the layer view filter are returned along with their attributes that are available on the client.
Notes
- Attribute values used in attribute queries executed against LayerViews are case sensitive.
- Ensure the fields being queried are included in the availableFields list; otherwise, the query may fail or return incomplete results.
- To execute a query against all features in a layer rather than only those currently available on the client, check the hasAllFeatures
property on the LayerView. If
hasAllFeaturesistrue, thenqueryFeatures()on the LayerView returns all features from the entire dataset that satisfy the query, not just those currently loaded on the client. Otherwise, usequeryFeatures()on the layer to query against all features available in the layer that satisfy the query. - Spatial queries can be performed on quantized geometries within the LayerView. The resolution of these geometries is
only as precise as the scale resolution of the view.
Geometries returned from any LayerView query will match the view's scale resolution.
To retrieve feature geometries at full resolution, first check the LayerView's hasFullGeometries property. If it is
true, use thequeryFeatures()method on the LayerView; otherwise, use thequeryFeatures()method on the Layer. - Spatial queries have the same limitations as those listed in the projectOperator documentation.
- Spatial queries are not currently supported if the FeatureLayerView has any of the following SpatialReferences:
- GDM 2000 (4742) – Malaysia
- Gsterberg (Ferro) (8042) – Austria/Czech Republic
- ISN2016 (8086) - Iceland
- SVY21 (4757) - Singapore
Parametersoptional Autocasts from ObjectSpecifies the attributes and spatial filter of the query. When this parameter is not passed to
queryFeatures()method, then a default query is created using createQuery() method and all features that pass the layer view filter are returned along with their attributes that are available on the client. To only return features visible in the view, set thegeometryparameter in the query object to the view's extent.options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsType Description Promise<FeatureSet> When resolved, a FeatureSet containing an array of graphic features is returned. Exampleslet layer = new FeatureLayer({ url: fsUrl // points to a Feature Service layer url }); let query = new Query(); query.geometry = new Extent({ xmin: -9177811, ymin: 4247000, xmax: -9176791, ymax: 4247784, spatialReference: 102100 }); query.spatialRelationship = "intersects"; const layerView = await view.whenLayerView(layer); await reactiveUtils.whenOnce(() => !layerView.updating); const results = await layerView.queryFeatures(query); console.log(results.features); // prints the array of client-side graphics to the consolelet layer = new FeatureLayer({ url: fsUrl // points to a Feature Service layer url }); // returns all the graphics from the layerView const layerView = await view.whenLayerView(layer); await reactiveUtils.whenOnce(() => !layerView.updating); const results = await layerView.queryFeatures() console.log(results.features); // prints all the client-side graphics to the consolelayerView.queryFeatures({ geometry: mapPoint, // 6 pixels around a point at the view resolution to query around a finger. distance: view.resolution * 6, });
-
Executes a Query against features available for drawing in the layerView and returns array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all features available for drawing are returned.
Notes
- Attribute values used in attribute queries executed against LayerViews are case sensitive.
- Ensure the fields being queried are included in the availableFields list; otherwise, the query may fail or return incomplete results.
- To execute a query against all features in a layer rather than only those currently available on the client,
check the hasAllFeatures property on the LayerView.
If
hasAllFeaturesistrue, thenqueryObjectIds()on the LayerView returns all features from the entire dataset that satisfy the query, not just those currently loaded on the client. Otherwise, usequeryObjectIds()on the layer to query against all features available in the layer that satisfy the query. - Spatial queries can be performed on quantized geometries within the LayerView. The resolution of these geometries is
only as precise as the scale resolution of the view.
Geometries returned from any LayerView query will match the view's scale resolution.
To retrieve feature geometries at full resolution, first check the LayerView's hasFullGeometries property. If it is
true, use thequeryObjectIds()method on the LayerView; otherwise, use thequeryObjectIds()method on the Layer. - Spatial queries have the same limitations as those listed in the projectOperator documentation.
- Spatial queries are not currently supported if the layerView has any of the following SpatialReferences:
- GDM 2000 (4742) – Malaysia
- Gusterberg (Ferro) (8042) – Austria/Czech Republic
- ISN2016 (8086) - Iceland
- SVY21 (4757) - Singapore
Parametersoptional Autocasts from ObjectSpecifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the
geometryparameter in the query object to the view's extent.options ObjectoptionalAn object with the following properties.
Specificationsignal AbortSignal|null|undefinedoptionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named
AbortErrorwhen an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.ReturnsExamplesview.on("click", async (event) => { let query = new Query(); query.geometry = event.mapPoint; // obtained from a view click event query.spatialRelationship = "intersects"; const layerView = await view.whenLayerView(layer) await reactiveUtils.whenOnce(() => !layerView.updating); const ids = await layerView.queryObjectIds(query); console.log(ids); // prints the ids of the client-side graphics to the console= });// returns all the Ids from the graphics in the layerView view.whenLayerView(layer).then(function(layerView){ return layerView.queryObjectIds() }).then(function(ids){ console.log(ids); // prints the ids of all the client-side graphics to the console });
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from LayerView
-
when()may be leveraged once an instance of the class is created. This method takes two input parameters: aonFulfilledfunction and anonRejectedfunction. TheonFulfilledexecutes when the instance of the class loads. TheonRejectedexecutes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new promise for the result of onFulfilledthat may be used to chain additional functions.Example// Although this example uses MapView, any class instance that is a promise may use when() in the same way let view = new MapView(); view.when(function(){ // This function will execute once the promise is resolved }, function(error){ // This function will execute if the promise is rejected due to an error });