GraphicsLayerView

Class: esri/views/layers/GraphicsLayerView
Inheritance: GraphicsLayerView LayerView Accessor
Since: ArcGIS Maps SDK for JavaScript 4.4

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

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

Accessor
HighlightOptions

Options for configuring the highlight.

GraphicsLayerView
Layer

The layer being viewed.

LayerView
Boolean

Indicates if the spatialReference of the MapView is supported by the layer view.

LayerView
Boolean

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

LayerView
Boolean

Indicates if the layer view is making any updates that will impact what is displayed on the map.

LayerView
MapView|SceneView

A reference to the MapView or SceneView associated with the layer view.

LayerView
Boolean

When true, the layer is visible in the view.

LayerView

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
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.

highlightOptions

Property
highlightOptions HighlightOptions
Since: ArcGIS Maps SDK for JavaScript 4.26 GraphicsLayerView 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 layerView's highlightOptions will take precedence over the view's highlightOptions 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
};

layer

Inherited
Property
layer Layerreadonly
Inherited from LayerView

The layer being viewed.

spatialReferenceSupported

Inherited
Property
spatialReferenceSupported Booleanreadonly
Inherited from LayerView
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.

See also

suspended

Inherited
Property
suspended Booleanreadonly
Inherited from LayerView

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

updating

Inherited
Property
updating Booleanreadonly
Inherited from LayerView

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).

Default Value:false
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);

view

Inherited
Property
view MapView|SceneViewreadonly
Inherited from LayerView
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);

visible

Inherited
Property
visible Boolean
Inherited from LayerView

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.

Default Value:true

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
Boolean

Returns true if a named group of handles exist.

Accessor
Handle

Highlights the given feature(s) in a layer view.

GraphicsLayerView
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

LayerView
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

LayerView
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

LayerView
Promise<Collection<Graphic>>

Returns all graphics available for drawing in the layer view as a collection.

GraphicsLayerView

Removes a group of handles owned by the object.

Accessor
Promise

when() may be leveraged once an instance of the class is created.

LayerView

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
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
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
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 *
optional

A group key.

Returns
Type 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

Method
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:

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, string or an array of numbers or strings.

Returns
Type Description
Handle Returns a highlight handler with a remove() method that can be called to remove the highlight.
Examples
// highlight features based on a query result
let highlight;
view.whenLayerView(treesLayer).then(function(layerView){
  layerView.highlightOptions = {
    color: "#FF00FF", //bright fuchsia
    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);
     });
    }
  });
});

isFulfilled

Inherited
Method
isFulfilled(){Boolean}
Inherited from LayerView

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

Inherited
Method
isRejected(){Boolean}
Inherited from LayerView

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

Inherited
Method
isResolved(){Boolean}
Inherited from LayerView

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.

queryGraphics

Method
queryGraphics(){Promise<Collection<Graphic>>}
Since: ArcGIS Maps SDK for JavaScript 4.8 GraphicsLayerView since 4.4, queryGraphics added at 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
const layerView = await view.whenLayerView(layer);
await reactiveUtils.whenOnce(() => !layerView.updating);
const results = await layerView.queryGraphics();
console.log(results);  // prints the array of client-side graphics to the console

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
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 *
optional

A 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");

when

Inherited
Method
when(callback, errback){Promise}
Inherited from LayerView
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
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The 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
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.