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
Object: esri/plugins/spatialIndex
[ AMD Module Require | Legacy Module Require ]
require(["esri/plugins/spatialIndex"], function(spatialIndex) { /* code goes here */ });
Description
(Added at v3.9)
A static utility module that adds or removes a SpatialIndex instance on a Map or FeatureLayer. Can be included in those classes as a constructor option or through the addPlugin method on those classes.Samples
Search for samples that use this class.Methods
| Name | Return type | Summary |
|---|---|---|
| add(target, options?) | None | Adds an index property to the target instance. |
| remove() | None | Removes the index plugin. |
Method Details
Adds an
index property to the target instance.Parameters:
< |
Required | The map or feature layer to which the index is connected. |
< |
Optional | See the object specifications table below for the structure of the index options object. |
Object Specifications:
<
options>< |
Optional | Whether the processor allow the feature layer to draw its features. Default is true. |
< |
Optional | The indexing system to use. One of "rtree", "kdtree", "quadtree". "kdtree" is only used for points. Default is "rtree". |
< |
Optional | Whether the processor pass the features through without modification or delay to the FeatureLayer. Default is true. |
< |
Required | A SpatialIndex processing instance to use rather than creating a new one. |