Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

visibleBoolean inherited

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

Method Details

highlight(target){Object}

Highlights the given feature(s).

Known Limitations

Currently the highlight method is only supported in a SceneView.

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
Object	Returns a highlight handler with a remove() method that can be called to remove the highlight. Property Type Description remove Function When called, removes the highlight of the selected graphics.

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) {
      var 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<Graphic[]>}

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

Returns:

Type	Description
Promise<Graphic[]>	When resolved, an array of Graphic[] is returned.

Example:

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

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 then() in the same way
var 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
});