Class: @arcgis/core/views/layers/CSVLayerView
Since: ArcGIS Maps SDK for JavaScript 4.4
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Name Type Summary Class availableFields String[]A list of attribute fields fetched for each feature including fields required for layer's rendererlabelingInfo, elevationInfo, and additional fields defined on the outFields properties.
Indicates whether the layer view is currently fetching new features.
CSVLayerView declaredClass StringThe name of the class.
Accessor featureEffect FeatureEffect|null|undefinedThe featureEffect can be used to draw attention features of interest.
CSVLayerView filter FeatureFilter|null|undefinedThe attribute, geometry, and time extent filter.
CSVLayerView hasAllFeatures BooleanIndicates whether the layer view contains all available features from the service.
CSVLayerView hasAllFeaturesInView BooleanThis 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).
CSVLayerView hasFullGeometries BooleanIndicates whether the layer view has geometries at full resolution.
CSVLayerView highlightOptions HighlightOptions|null|undefinedOptions for configuring the highlight.
CSVLayerView layer LayerThe layer being viewed.
LayerView maximumNumberOfFeatures NumberThe maximum number of features that can be displayed at a time.
CSVLayerView maximumNumberOfFeaturesExceeded BooleanSignifies whether the maximum number of features has been exceeded.
CSVLayerView spatialReferenceSupported BooleanIndicates if the spatialReference of the MapView is supported by the layer view.
LayerView suspended BooleanValue is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).
An automatically generated unique identifier assigned to the instance.
LayerView updating BooleanIndicates if the layer view is making any updates that will impact what is displayed on the map.
LayerView view MapView|SceneViewA reference to the MapView or SceneView associated with the layer view.
LayerView visible BooleanWhen true, the layer is visible in the view.
When true, the layer is visible in the view at the current scale.
When true, the layer is visible in the view's timeExtent.
availableFields String[]readonly
Since: ArcGIS Maps SDK for JavaScript 4.11 CSVLayerView since 4.4, availableFields added at 4.11.
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 updating. The availableFields is used when filtering or querying features on the client-side.
Example
const 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 Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.28 CSVLayerView since 4.4, dataUpdating added at 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 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);
});
}
});Inherited
Property declaredClass Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.
The name of the class. The declared class name is formatted as esri.folder.className.
Since: ArcGIS Maps SDK for JavaScript 4.22 CSVLayerView since 4.4, 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 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.
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%)"
});Since: ArcGIS Maps SDK for JavaScript 4.11 CSVLayerView since 4.4, filter added at 4.11.
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 Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.29 CSVLayerView since 4.4, hasAllFeatures added at 4.29.
Indicates whether the layer view contains all available features from the service. In a 2D MapView, it returns true for point feature layers when all points have been loaded by the application. Similarly, in a 3D SceneView, it returns true for point, line, and polygon feature layers if all available features have been successfully loaded. Otherwise, it returns false. This property should be checked only once after the layer has finished loading and fetching its data.
hasAllFeaturesInView Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.29 CSVLayerView since 4.4, 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. 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 definitionExpression during each feature tile query.
hasFullGeometries Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.29 CSVLayerView since 4.4, hasFullGeometries added at 4.29.
Indicates whether the layer view has geometries at full resolution. This property returns true only if the layer has loaded all geometries at full resolution without quantization. In a 2D MapView, it returns true for point feature layers when all points have been loaded by the application. Similarly, in a 3D SceneView, it returns true for point, line, and polygon feature layers if all available features have been successfully loaded. Otherwise, it returns false. This property should be checked only once after the layer has finished loading and fetching its data.
Since: ArcGIS Maps SDK for JavaScript 4.26 CSVLayerView since 4.4, highlightOptions added at 4.26.
Options for configuring the highlight. Use the highlight() method on the layer view to highlight a feature. The layer view's highlightOptions will take precedence over a 2D MapView's highlights.
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
};Inherited
Property layer Layerreadonly
The layer being viewed.
maximumNumberOfFeatures Number
Since: ArcGIS Maps SDK for JavaScript 4.10 CSVLayerView since 4.4, maximumNumberOfFeatures added at 4.10.
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 maximumNumberOfFeatures is only supported in 3D SceneViews.
maximumNumberOfFeaturesExceeded Boolean
Since: ArcGIS Maps SDK for JavaScript 4.10 CSVLayerView since 4.4, maximumNumberOfFeaturesExceeded added at 4.10.
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 maximumNumberOfFeaturesExceeded is only supported in 3D SceneViews.
Inherited
Property spatialReferenceSupported Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.23 LayerView since 4.0, spatialReferenceSupported added at 4.23.
Indicates if the spatialReference of the MapView is supported by the layer view. When false layer view will be suspended.
Inherited
Property suspended Booleanreadonly
Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).
Inherited
Property uid Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 LayerView since 4.0, uid added at 4.33.
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
Inherited
Property updating Booleanreadonly
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 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).
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);Since: ArcGIS Maps SDK for JavaScript 4.28 LayerView since 4.0, view added at 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);Inherited
Property visible Boolean
When true, the layer is visible in the view. Value of this property is inherited from the layer.visible unless the developer overrides it. The layerView.visible will take precedence over layer.visible if both properties are set.
Inherited
Property visibleAtCurrentScale Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.30 LayerView 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 have minScale and maxScale properties set.
Known Limitations
Inherited
Property visibleAtCurrentTimeExtent Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.30 LayerView 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.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
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(){Query}
Since: ArcGIS Maps SDK for JavaScript 4.25 CSVLayerView since 4.4, 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 to true. The output spatial reference outSpatialReference is set to the spatial reference of the view.
Returns
Type Description Query The query parameter object. createQuery(){Query}
Since: ArcGIS Maps SDK for JavaScript 4.12 CSVLayerView since 4.4, createQuery added at 4.12.
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 to true. 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.
Returns
Type Description Query The query objectExample
const query = csvLayerView.createQuery();
query.where = "magnitude > 4";
csvLayerView.queryFeatures(query).then(function(results) {
console.log(results);
})
.catch(function(error) {
console.log(error);
});Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue if 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(target, options){Handle}
Highlights the given feature(s) in a layer view using the named HighlightOptions from the view's highlights collection. If no name is provided, the feature will use the default highlight options. The layer view's highlightOptions will take precedence over a 2D MapView's highlights.
Release-specific changes:
highlight method accepts an options parameter which can be used to provide a name to apply specific HighlightOptions. If no name is provided, the default highlight options will be used.highlight() method was added to ImageryLayerView, supported only in a 2D MapView.Parameters
The 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.
An object with the following properties.
Specification
optionalThe name of the highlight options from the view's highlights collection. If a name is provided, the corresponding highlight options will be applied to the feature(s). Otherwise, the default highlight options will be used.
Returns
Type Description Handle Returns a highlight handler with aremove() 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" });
});
}
});
});Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been resolved. queryAggregates(query, options){Promise<FeatureSet>}
Since: ArcGIS Maps SDK for JavaScript 4.25 CSVLayerView since 4.4, 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).
Parameters
optionalSpecifies the parameters of the query. Leave this parameter empty to query all aggregates in the view.
optionalAn object with the following properties.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
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();Since: ArcGIS Maps SDK for JavaScript 4.32 CSVLayerView since 4.4, 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
queryAttributeBins() method is only supported in 2D MapView when executed on layer views.queryAttributeBins() method is unrelated to querying bins in FeatureReductionBinning.Parameters
Specifies the parameters of the queryAttributeBins() operation. The binParameters property must be set.
An object with the following properties.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
Type 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()
}]
});
}); queryExtent(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.
Known Limitations
Parameters
optionalSpecifies 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 geometry parameter in the query object to the view's extent.
An object with the following properties.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
Type 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.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(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.
Known Limitations
Parameters
optionalSpecifies 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 geometry parameter in the query object to the view's extent.
An object with the following properties.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
Type Description Promise<Number> When resolved, returns the number of features satisfying the query.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(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. For client-side attribute queries, relevant fields should exist in availableFields list for the query to be successful.
To execute a query against all the features in a layer rather than only those in the client, you must use the queryFeatures() method on the layer.
Known Limitations
Parameters
optionalSpecifies 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 the geometry parameter in the query object to the view's extent.
An object with the following properties.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
Type Description 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 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,
}); queryObjectIds(query, options){Promise<Array<(number|string)>>}
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.
Known Limitations
Parameters
optionalSpecifies 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 geometry parameter in the query object to the view's extent.
An object with the following properties.
Specification
optionalSignal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.
Returns
Type Description Promise<Array<(number|string)>> When resolved, returns an array representing the ObjectIDs of the features satisfying the query.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 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
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");Inherited
Method when(callback, errback){Promise}
Since: ArcGIS Maps SDK for JavaScript 4.6 LayerView since 4.0, when added at 4.6.
when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.
Parameters
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new promise for the result ofcallback that 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
});RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4