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 | more details The name of the class. | more details | Accessor | |
Layer | more details The layer being viewed. | more details | LayerView | |
Boolean | more details Indicates if the spatialReference of the MapView is supported by the layer view. | more details | LayerView | |
Boolean | more details Value is | more details | LayerView | |
Boolean | more details Value is | more details | LayerView | |
Boolean | more details When | more details | LayerView |
Property Details
-
Since: ArcGIS API for JavaScript 4.7
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
The layer being viewed.
-
Since: ArcGIS API 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 | |
---|---|---|---|---|
Handle | more details Highlights the given feature(s). | more details | GraphicsLayerView | |
Boolean | more details
| more details | LayerView | |
Boolean | more details
| more details | LayerView | |
Boolean | more details
| more details | LayerView | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Promise<Collection<Graphic>> | more details Returns all graphics available for drawing in the layer view as a collection. | more details | GraphicsLayerView | |
Promise | more details
| more details | LayerView |
Method Details
-
highlight(target){Handle}
-
Highlights the given feature(s).
Parameter:optional 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.Returns:Type Description Handle Returns a highlight handler with a remove()
method that can be called to remove the highlight.Example:// 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 === myLayer; })[0].graphic; view.whenLayerView(graphic.layer).then(function(layerView){ layerView.highlight(graphic); }); } }); });
-
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).
-
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.
-
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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
queryGraphics(){Promise<Collection<Graphic>>}Since: ArcGIS API for JavaScript 4.8
-
Returns all graphics available for drawing in the layer view as a collection.
Returns:Type Description Promise<Collection<Graphic>> When resolved, a Collection of all graphics is returned. Example:let 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 }); } }); });
-
Since: ArcGIS API 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.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
Returns:Type 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 });