GraphicsLayerView

Property Overview

Property Details

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

layer Layerreadonly inherited

The layer being viewed.

spatialReferenceSupported Booleanreadonly inherited

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

• suspended

suspended Booleanreadonly inherited

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

See also

• spatialReferenceSupported

updating Booleanreadonly inherited

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false

visible Boolean inherited

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

Method Details

addHandles(handleOrHandles, groupKey)inherited

Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

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(groupKey){Boolean}inherited

Since: ArcGIS API for JavaScript 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(target){Handle}

Highlights the given feature(s).

Parameter

target Graphic|Graphic[]|Number|Number[] 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.

See also

• SceneView.highlightOptions

• Sample: Highlight point features

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(){Boolean}inherited

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(){Boolean}inherited

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(){Boolean}inherited

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(){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
      });
    }
  });
});

removeHandles(groupKey)inherited

Since: ArcGIS API for JavaScript 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(callback, errback){Promise}inherited

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