GraphicsLayerView

Class: esri/views/layers/GraphicsLayerView
Inheritance: GraphicsLayerView LayerView Accessor
Since: ArcGIS API 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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Layer

The layer being viewed.

more details
more detailsLayerView
Boolean

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

more details
more detailsLayerView
Boolean

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

more details
more detailsLayerView
Boolean

When true, the layer is visible in the view.

more details
more detailsLayerView

Property Details

declaredClassStringreadonly inherited

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

layerLayerreadonly inherited

The layer being viewed.

suspendedBooleanreadonly inherited

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

updatingBooleanreadonly inherited

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. Set this property to false to hide the layer from the view.

Default Value: true

Method Overview

NameReturn TypeSummaryClass
Promise

An instance of this class is a Promise.

more details
more detailsLayerView
Object

Highlights the given feature(s).

more details
more detailsGraphicsLayerView
Boolean

An instance of this class is a Promise.

more details
more detailsLayerView
Boolean

An instance of this class is a Promise.

more details
more detailsLayerView
Boolean

An instance of this class is a Promise.

more details
more detailsLayerView
Promise

An instance of this class is a Promise.

more details
more detailsLayerView
Promise<Graphic[]>

Returns all graphics available for drawing in the layer view as an array of Graphic[].

more details
more detailsGraphicsLayerView
Promise

An instance of this class is a Promise.

more details
more detailsLayerView

Method Details

always(callbackOrErrback){Promise}inherited

An instance of this class is a Promise. Therefore always() may be used to execute a function if the promise is rejected or resolved. The input function will always execute no matter the response. For more information about promises, see the Working with Promises guide page.

Parameter:
callbackOrErrback Function
optional

The function to execute when the promise is rejected or resolved.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callbackOrErrback.
Example:
// Although this example uses MapView, any class instance that is a promise may use always() in the same way
var view = new MapView();
view.always(function(){
  // This function will always execute whether or not the promise is resolved or rejected
});

highlight(target){Object}

Since: ArcGIS API for JavaScript 4.4

Highlights the given feature(s).

Known Limitations

Currently the highlight method is only supported in a SceneView.

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:
TypeDescription
ObjectReturns a highlight handler with a remove() method that can be called to remove the highlight.
PropertyTypeDescription
removeFunctionWhen called, removes the highlight of the selected graphics.
See also:
Example:
// highlight feature on click
view.on("click", function(event){
 view.hitTest(event).then(function(response){
   if (response.results[0]) {
     var graphic = response.results[0].graphic;
     view.whenLayerView(graphic.layer).then(function(lyrView){
       lyrView.highlight(graphic);
     })
   }
 })
});

isFulfilled(){Boolean}inherited

An instance of this class is a Promise. Therefore isFulfilled() may be used to verify if the promise is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

An instance of this class is a Promise. Therefore isRejected() may be used to verify if the promise is rejected. If it is rejected, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been rejected.

isResolved(){Boolean}inherited

An instance of this class is a Promise. Therefore isResolved() may be used to verify if the promise is resolved. If it is resolved, true will be returned. See the Working with Promises guide page for more information about promises.

Returns:
TypeDescription
BooleanIndicates whether the promise has been resolved.

otherwise(errback){Promise}inherited

An instance of this class is a Promise. Use otherwise() to call a function once the promise is rejected.

Parameter:
errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of errback.
Example:
// Although this example uses MapView, any class instance that is a promise may use otherwise() in the same way
var view = new MapView();
view.otherwise(function(error){
  // This function will execute if the promise is rejected due to an error
});

queryGraphics(){Promise<Graphic[]>}

Returns all graphics available for drawing in the layer view as an array of Graphic[].

Returns:
TypeDescription
Promise< Graphic[]>When resolved, an array of Graphic[] is returned.
Example:
var lyr = new GraphicsLayer();

// returns all the graphics from the layer view
view.whenLayerView(lyr).then(function(lyrView){
  lyrView.watch("updating", function(val){
    if(!val){  // wait for the layer view to finish updating
      lyrView.queryGraphics().then(function(results){
        console.log(results);  // prints the array of client-side graphics to the console
      });
    }
  });
});

then(callback, errback, progback){Promise}inherited

An instance of this class is a Promise. Therefore then() 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 promise resolves (when the instance of the class loads). The errback executes if the promise fails. See the Working with Promises guide page for additional details.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

progback Function
optional

The function to invoke when the promise emits a progress update.

Returns:
TypeDescription
PromiseReturns 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 then() in the same way
var view = new MapView();
view.then(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
});

API Reference search results

NameTypeModule

There were no match results from your search criteria.