Represents the LayerView of a GraphicsLayer after it has been added to a Map in either a MapView or SceneView.
The GraphicsLayerView is responsible for rendering a GraphicsLayer's features as graphics in the View. The methods in the GraphicsLayerView provide developers with the ability to query graphics in the view. See the code snippets in the methods below for examples of how to access client-side graphics from the view.
- See also
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
HighlightOptions | Options for configuring the highlight. more details | GraphicsLayerView | |
Layer | The layer being viewed. more details | LayerView | |
Boolean | Indicates if the spatialReference of the MapView is supported by the layer view. more details | LayerView | |
Boolean | Value is | LayerView | |
Boolean | Value is | LayerView | |
Boolean | When | LayerView |
Property Details
-
Since: ArcGIS Maps SDK for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
highlightOptions HighlightOptionsSince: ArcGIS Maps SDK for JavaScript 4.26
-
Options for configuring the highlight. Use the highlight() method on the layer view to highlight a feature. The layerView's
highlightOptions
will take precedence over the view'shighlightOptions
if both properties are set.Known Limitations
- The
highlightOptions
on layer views are only supported in 2D MapView.
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
-
The layer being viewed.
-
Since: ArcGIS Maps SDK for JavaScript 4.23
-
Indicates if the spatialReference of the MapView is supported by the layer view. When
false
layer view will be suspended.- See also
-
Value is
true
if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).- See also
-
Value is
true
when the layer is updating; for example, if it is in the process of fetching data.- Default Value:false
-
When
true
, the layer is visible in the view. Value of this property is inherited from thelayer.visible
unless the developer overrides it. ThelayerView.visible
will take precedence overlayer.visible
if both properties are set.- Default Value:true
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Handle | Highlights the given feature(s) in a layer view. more details | GraphicsLayerView | |
Boolean |
| LayerView | |
Boolean |
| LayerView | |
Boolean |
| LayerView | |
Promise<Collection<Graphic>> | Returns all graphics available for drawing in the layer view as a collection. more details | GraphicsLayerView | |
Removes a group of handles owned by the object. more details | Accessor | ||
Promise |
| LayerView |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
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){Handle}
-
Highlights the given feature(s) in a layer view. The layerView's highlightOptions will take precedence over the view's
highlightOptions
if both properties are set.Release specific changes:
- At version 4.23, the
highlight()
method was added to ImageryLayerView.
Parameteroptional The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid
objectID
. You may alternatively pass one or more objectIDs as a single number or an array.ReturnsType Description Handle Returns a highlight handler with a remove()
method that can be called to remove the highlight.- See also
Examples// highlight features based on a query result let highlight; view.whenLayerView(treesLayer).then(function(layerView){ layerView.highlightOptions = { color: "#FF00FF", //bright fuschia haloOpacity: 0.8, fillOpacity: 0.3 }; let query = treesLayer.createQuery(); query.where = "type = 'Quercus'"; treesLayer.queryFeatures(query).then(function(result){ highlight?.remove(); highlight = layerView.highlight(result.features); }); });
// highlight feature on pointer-move view.on("pointer-move", function(event){ view.hitTest(event).then(function(response){ if (response.results.length) { let graphic = response.results.filter(function (result) { return result.graphic.layer === treesLayer; })[0].graphic; view.whenLayerView(graphic.layer).then(function(layerView){ layerView.highlight(graphic); }); } }); });
- At version 4.23, the
-
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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
queryGraphics(){Promise<Collection<Graphic>>}Since: ArcGIS Maps SDK for JavaScript 4.8
-
Returns all graphics available for drawing in the layer view as a collection.
ReturnsType Description Promise<Collection<Graphic>> When resolved, a Collection of all graphics is returned. Examplelet layer = new GraphicsLayer(); // returns all the graphics from the layer view view.whenLayerView(layer).then(function(layerView){ layerView.watch("updating", function(val){ if(!val){ // wait for the layer view to finish updating layerView.queryGraphics().then(function(results){ console.log(results); // prints the array of client-side graphics to the console }); } }); });
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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");
-
Since: ArcGIS Maps SDK for JavaScript 4.6
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType Description Promise Returns a new promise for the result of callback
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 });