import OGCFeatureLayerView from "@arcgis/core/views/layers/OGCFeatureLayerView.js";const OGCFeatureLayerView = await $arcgis.import("@arcgis/core/views/layers/OGCFeatureLayerView.js");- Inheritance:
- OGCFeatureLayerView→
FeatureLikeLayerView→ LayerView→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.16
Represents the LayerView of a OGCFeatureLayer after it has been added to a Map in either a MapView, Map component, SceneView or Scene component.
The OGCFeatureLayerView is responsible for rendering a OGCFeatureLayer's features as graphics in the View.
- See also
Properties
| Property | Type | Class |
|---|---|---|
availableFields readonly inherited | string[] | |
dataUpdating readonly inherited | ||
declaredClass readonly inherited | ||
featureEffect inherited | ||
filter inherited | ||
hasAllFeatures readonly inherited | ||
hasAllFeaturesInView readonly inherited | ||
hasFullGeometries readonly inherited | ||
highlightOptions deprecated inherited | ||
layer readonly | | |
maximumNumberOfFeatures inherited | ||
maximumNumberOfFeaturesExceeded readonly inherited | ||
spatialReferenceSupported readonly inherited | ||
suspended readonly inherited | ||
uid readonly inherited | ||
updating readonly inherited | ||
view readonly inherited | ||
visible inherited | ||
visibleAtCurrentScale readonly inherited | ||
visibleAtCurrentTimeExtent readonly inherited |
availableFields
- Type
- string[]
A list of attribute fields fetched for each feature including fields required for layer's renderer
labelingInfo, elevationInfo, and additional fields defined on the outFields properties.
The availableFields property is populated when the layerView has finished LayerView.updating.
The availableFields is used when filtering or querying features on the client-side.
- See also
Example
const layerView = await view.whenLayerView(layer);
// availableFields will become available once the// layerView finishes updatingawait 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
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.28
Indicates whether the layer view is currently fetching new features. It becomes false once all layer queries have finished executing.
Watch this property along with LayerView.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 when
dataUpdating becomes false. It's important to note that dataUpdating can only be true when updating is also true.
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
- Type
- FeatureEffect | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.22
The featureEffect can be used to draw attention to features of interest. It allows for the selection of features via a FeatureEffect.filter, and an FeatureEffect.includedEffect and FeatureEffect.excludedEffect are applied to those features that respectively pass or fail the filter requirements.
If the featureEffect is set on the layer, it will be inherited by layerView.featureEffect unless the developer overrides it on the layerView. The layerView.featureEffect
will take precedence over layer.featureEffect if 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 featureslayerView.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%)"}); filter
- Type
- FeatureFilter | null | undefined
The attribute, FeatureFilter.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 geometryfeatureLayerView.filter = new FeatureFilter({ where: "percentile >= 30", geometry: filterPolygon, spatialRelationship: "contains", distance: 10, units: "miles"}); hasAllFeatures
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 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 hasAllFeatures is true:
- 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 Query.geometry
property to the View's
extent.
When hasAllFeatures is false:
- 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
Example
const viewElement = document.querySelector("arcgis-map");const layerView = await viewElement.whenLayerView(layer);
// Wait until the initial layer load completesconst 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 dataconst 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 featuresconst results = layerView.hasAllFeatures ? await layerView.queryFeatures(query) : await airQualityLayer.queryFeatures(query);
// process the resultupdateAirQualityStatus(results); hasAllFeaturesInView
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 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.
If false, you may need to query the layer and its service directly to get accurate results.
The hasAllFeaturesInView property will be false if 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
FeatureLayer.definitionExpression during each feature tile query.
- See also
Example
const 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
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 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 hasFullGeometries property.
If it is true, use a query method on the LayerView; otherwise, use the query method on the Layer.
- See also
highlightOptions
- Type
- HighlightOptions | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.26
Options for configuring the highlight. Use the highlight() method on the layer view to highlight a feature
Known Limitations
The highlightOptions on 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}; maximumNumberOfFeatures
- Type
- 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. - This property does not apply to ParquetLayerView and StreamLayerView.
maximumNumberOfFeaturesExceeded
- Type
- 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. - This property does not apply to ParquetLayerView and StreamLayerView.
spatialReferenceSupported
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.23
Indicates if the spatialReference of the MapView or
Map component is supported by the layer view.
When false layer view will be suspended.
Known Limitations
This property is not supported for layer views of a 3D SceneView or Scene component.
- See also
uid
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 4.33
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
updating
- Type
- boolean
Indicates if the layer view is making any updates that will impact what is displayed on the map.
For example, this value is true when renderer, definitionExpression, filter or effect is changed or
if the layer view is in the process of the fetching data.
Watch FeatureLayerView.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); view
- Type
- MapViewOrSceneView
- Since
- ArcGIS Maps SDK for JavaScript 4.28
A reference to the MapView or SceneView associated with the layer view.
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); visibleAtCurrentScale
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.30
When true, the layer is visible in the view at the current scale. This applies to layers that have minScale and maxScale properties set.
Known Limitations
This property isn’t supported for tiled layers in 3D SceneView or in the Scene component
- Default value
- true
visibleAtCurrentTimeExtent
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.30
When true, the layer is visible in the view's View.timeExtent. This applies to layers that have a Layer.visibilityTimeExtent.
- See also
- Default value
- true
Methods
| Method | Signature | Class |
|---|---|---|
createAggregateQuery inherited | createAggregateQuery(): Query | |
createQuery inherited | createQuery(): Query | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
highlight inherited | highlight(target: Graphic | Graphic[] | ObjectId | ObjectId[], options?: LayerViewHighlightOptions): ResourceHandle | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
queryAggregates inherited | queryAggregates(query?: Query, options?: AbortOptions): Promise<FeatureSet> | |
queryAttributeBins inherited | queryAttributeBins(binsQuery: AttributeBinsQuery, options?: AbortOptions): Promise<AttributeBinsFeatureSet> | |
queryExtent inherited | queryExtent(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<any> | |
queryFeatureCount inherited | queryFeatureCount(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<number> | |
queryFeatures inherited | queryFeatures(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<FeatureSet> | |
queryObjectIds inherited | queryObjectIds(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<ObjectId[]> | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
createAggregateQuery
- Signature
-
createAggregateQuery (): Query
- Since
- ArcGIS Maps SDK for JavaScript 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 Query.outFields
property to ["*"] and Query.returnGeometry to true.
The output spatial reference Query.outSpatialReference
is set to the spatial reference of the view.
- See also
- Returns
- Query
The query parameter object.
createQuery
- Signature
-
createQuery (): Query
Creates a query parameter object that can be used to fetch features as they are being
displayed. It sets the query parameter's Query.outFields
property to ["*"] and Query.returnGeometry to true.
The Query.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.
- Returns
- Query
The query object
Example
const query = csvLayerView.createQuery();query.where = "magnitude > 4";csvLayerView.queryFeatures(query).then(function(results) { console.log(results);}).catch(function(error) { console.log(error);}); emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
highlight
- Signature
-
highlight (target: Graphic | Graphic[] | ObjectId | ObjectId[], options?: LayerViewHighlightOptions): ResourceHandle
Highlights the given feature(s) in a layer view using the named HighlightOptions
from the view's View.highlights collection. If no name is provided, the
feature will use the default highlight options.
Release-specific changes:
- As of version 4.32, the
highlightmethod accepts anoptionsparameter which can be used to provide a HighlightOptions.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.highlight(), supported only in a 2D MapView.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| target | The feature(s) to highlight. When passing a graphic or an array of graphics, each feature must have a valid | | |
| options | An object with the following properties. | |
- Returns
- ResourceHandle
Examples
// Highlight features based on a query result
// Add a new set of highlight options to the view's highlights collectionview.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 onelet highlight;
// Query for particular features in a layer and then highlight them with the specified optionsview.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 onelet 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" }); }); } });}); isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); queryAggregates
- Signature
-
queryAggregates (query?: Query, options?: AbortOptions): Promise<FeatureSet>
- Since
- ArcGIS Maps SDK for JavaScript 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).
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the parameters of the query. Leave this parameter empty to query all aggregates in the view. | | |
| options | An object with the following properties. | |
- Returns
- Promise<FeatureSet>
When resolved, returns a FeatureSet containing an array of aggregate features.
Example
// clustered point layerconst layer = new FeatureLayer({ featureReduction: { type: "cluster" }});
const layerView = await view.whenLayerView(layer);await reactiveUtils.whenOnce(() => !layerView.updating);
// features represents all the clusters in the viewconst { features } = await layerView.queryAggregates(); queryAttributeBins
- Signature
-
queryAttributeBins (binsQuery: AttributeBinsQuery, options?: AbortOptions): Promise<AttributeBinsFeatureSet>
- Since
- ArcGIS Maps SDK for JavaScript 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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| binsQuery | Specifies the parameters of the | | |
| options | An object with the following properties. | |
- Returns
- 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() }] });}); queryExtent
- Signature
-
queryExtent (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<any>
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 View2D.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
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies 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 | | |
| options | An object with the following properties. | |
- Returns
- Promise<any>
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.
Examples
let 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
- Signature
-
queryFeatureCount (query?: QueryProperties | null | undefined, options?: AbortOptions): 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 View2D.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
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies 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 | | |
| options | An object with the following properties. | |
Examples
view.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
- Signature
-
queryFeatures (query?: QueryProperties | null | undefined, options?: AbortOptions): 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 View2D.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
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the attributes and spatial filter of the query.
When this parameter is not passed to | | |
| options | An object with the following properties. | |
- Returns
- Promise<FeatureSet>
When resolved, a FeatureSet containing an array of graphic features is returned.
Examples
let 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 layerViewconst 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,}); queryObjectIds
- Signature
-
queryObjectIds (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<ObjectId[]>
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 View2D.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
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies 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 | | |
| options | An object with the following properties. | |
Examples
view.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 layerViewview.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}); when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
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 waylet 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});