Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: SpatialIndex
[ AMD Module Require | Legacy Module Require ]
dojo.require("esri.process.SpatialIndex")
Description
(Added at v3.9)
Builds and maintains a spatial index of feature geometry in one or more FeatureLayer.Samples
Search for samples that use this class.Class hierarchy
esri/process.Processor |_esri/process.SpatialIndex
Constructors
| Name | Summary |
|---|---|
| new esri.process.SpatialIndex(options?) | Creates a SpatialIndex. |
Properties
| Name | Type | Summary |
|---|---|---|
| drawFeatures | Boolean | Allow the feature layer to draw the features. |
| fetchWithWorker | Boolean | Should features be fetched through the Worker. |
| layers | FeatureLayer[] | Layer(s) connected to the processor. |
| passFeatures | Boolean | Pass features back to layer without delay before processing. |
| requireWorkerSupport | Boolean | Require support for Worker in order to use this processor. |
Methods
| Name | Return type | Summary |
|---|---|---|
| addLayer(layer) | None | Add layer to processor. |
| intersects(test, layerId?, getRects?) | Promise | Searches index for items which intersect the test object. |
| nearest(criteria, layerId?) | Promise | Searches for the nearest point(s) to the passed point within the specified criteria. |
| removeLayer(layer) | None | Remove layer from processor. |
| setMap(map) | None | Synchronize the layers the processor handles with the map's GraphicsLayer and GraphicsLayer subclasses (FeatureLayer etc). |
| start() | None | Start the processor. |
| stop() | None | Stop the processor. |
| unsetMap() | None | Unset the map and detach processor from all layers. |
Events
[ On Style Events | Connect Style Event ]
All On Style event listeners receive a single event object. Additionally, the event object also contains a 'target' property whose value is the object which fired the event.
Events
| Name | Event Object | Summary |
|---|---|---|
| start | Fires when the processor is started. | |
| stop | Fires when the processor is stopped. |
Constructor Details
Creates a SpatialIndex.
Parameters:
< |
Optional | Configuration options for the processor. |
options properties: < |
Optional | Start processing features immediately. Default is true. |
< |
Optional | Whether the processor allow the feature layer to draw its features. Default is true. |
< |
Optional | Whether the processor do the layer's I/O via a worker. Default is false. |
< |
Optional | Index system specific options. |
< |
Optional | The indexing system to use. Either "rtree" or "kdtree". "kdtree" is only used for points. Default is "rtree". |
< |
Optional | A FeatureLayer or array of FeatureLayers to attach the processor to. Ignored if map is provided. |
< |
Optional | Uses all FeatureLayers associated with the map in the processor. Remains in sync with the map's layers. Takes precedence over layer option. |
< |
Optional | Whether the processor pass the features through without modification or delay to the FeatureLayer. Default is true. |
< |
Optional | Whether the processor require Workers to function properly. Default is true. |
Property Details
<Boolean
BooleanAllow the feature layer to draw the features. This interacts with the
passFeatures option. If both are true, then the layer will behave normally. If both are false, then the layer won't receive the features until the processor is finished and then won't draw them. The other combinations will either cause the features to be passed immediately, but not drawn; or passed only after processing but then drawn as normal.Known values:
true | falseDefault value:
true<Boolean
BooleanShould features be fetched through the Worker. In
OnDemandMode, it is almost always faster to fetch the features via the main thread and then allow the processor to pass them to the process worker.Known values:
true | falseDefault value:
false<FeatureLayer[]
FeatureLayer[]Layer(s) connected to the processor.
<Boolean
BooleanPass features back to layer without delay before processing.
Known values:
true | falseDefault value:
true<Boolean
BooleanRequire support for Worker in order to use this processor. The default is
true. If this is the case and the client's browser does not support Workers then this process won't attach or start and the feature layer will be unaffected by this process. You should only modify this value to false with very careful consideration. Use false with extreme caution. A value of false could cause significant slow downs and even crashes on older browsers.Known values:
true | falseDefault value:
trueMethod Details
Add layer to processor.
Parameters:
< |
Required | FeatureLayer to be added. |
Searches index for items which intersect the test object. This is a bounding box search.
Return type:
PromiseSearches for the nearest point(s) to the passed point within the specified criteria.
Return type:
PromiseParameters:
< |
Required | See the object specifications table below for the structure of the criteria object. |
< |
Optional | ID assigned to the layer. |
Object Specifications:
<
criteria>< |
Optional | The maximum number of nearest points to return. |
< |
Optional | The maximum distance from the search point to return points. |
< |
Optional | A function which determines if the point should be included in the results. |
< |
Required | (Required) The point to find the nearest neighbors. |
Remove layer from processor.
Parameters:
< |
Required | FeatureLayer to be removed. |
Synchronize the layers the processor handles with the map's GraphicsLayer and GraphicsLayer subclasses (FeatureLayer etc).
Parameters:
< |
Required | The map instance to synchronize layers with. |
Event Details
[ On Style Events | Connect Style Event ]