Feature

require(["esri/widgets/Feature"], function(Feature) { /* code goes here */ });
Class: esri/widgets/Feature
Inheritance: Feature Widget Accessor
Since: ArcGIS API for JavaScript 4.7

The Feature widget displays a graphic according to its PopupTemplate. This widget is useful in instances where you want to display information about a feature but without the use of a Popup.

For information about gaining full control of widget styles, see the Styling topic.
See also:
Example:
// Create graphic

var graphic = new Graphic({
  geometry: view.center,
  popupTemplate: {
    content: [{
      // add popupTemplate content
    }]
  }
});

var feature = new Feature({
  graphic: graphic,
  map: map,
  spatialReference: spatialReference
});

view.ui.add(feature, "top-right");

Constructors

new Feature(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

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|HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more detailsWidget
String

The name of the class.

more details
more detailsAccessor
Boolean

Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.

more details
more detailsFeature
Graphic

The Graphic used to represent the feature.

more details
more detailsFeature
String

The unique ID assigned to the widget when the widget is created.

more details
more detailsWidget
String

The widget's default label.

more details
more detailsFeature
Map

A reference to the view's Map.

more details
more detailsFeature
SpatialReference

The spatial reference used for Arcade operations.

more details
more detailsFeature
String

The title for the feature.

more details
more detailsFeature
MapView|SceneView

A reference to the MapView or SceneView.

more details
more detailsFeature
FeatureViewModel

The view model for this widget.

more details
more detailsFeature
VisibleElements

The visible elements that are displayed within the widget's graphic.popupTemplate.content.

more details
more detailsFeature

Property Details

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:
// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>
// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});
declaredClass Stringreadonly inherited

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

defaultPopupTemplateEnabled Boolean
Since: ArcGIS API for JavaScript 4.11

Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. Automatic popup templates are supported for layers that support the createPopupTemplate method. (Supported for FeatureLayer, GeoJSONLayer, SceneLayer, CSVLayer, OGCFeatureLayer PointCloudLayer, StreamLayer, and ImageryLayer).

Default Value:false
graphic Graphic

The Graphic used to represent the feature.

Default Value:null
See also:
Example:
var graphic = new Graphic({
  geometry: view.center,
  attributes: {
    "name": "Spruce",
    "family": "Pinaceae",
    "count": 126
  },
  symbol: new SimpleMarkerSymbol({
    style: "square",
    color: "blue",
    size: "8px"
  }),
  popupTemplate: {
    content: [
      {
        // Set popup template content
      }
    ]
  }
});

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label.

map Map
Since: ArcGIS API for JavaScript 4.11

A reference to the view's Map. Use this property when needing to get access to the underlying layers within the map. This can then be used within Arcade expressions.

Default Value:null
See also:
Example:
// The building footprints represent the buildings that intersect a clicked parcel
let buildingFootprints = Intersects($feature, FeatureSetByName($map, "Building Footprints"));
spatialReference SpatialReference
Since: ArcGIS API for JavaScript 4.11

The spatial reference used for Arcade operations.

Default Value:null
See also:
title Stringreadonly

The title for the feature. You can disable this via the visibleElements property.

Default Value:null

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the FeatureViewModel class to access all properties and methods on the widget.

visibleElements VisibleElementsautocast
Since: ArcGIS API for JavaScript 4.11

The visible elements that are displayed within the widget's graphic.popupTemplate.content. This property provides the ability to turn individual elements of the widget's display on/off. See the PopupTemplate.content documentation for additional information on how these elements work.

See also:

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
String

A utility method used for building the value for a widget's class property.

more details
more detailsWidget

Destroys the widget instance.

more details
more detailsWidget
Boolean

Emits an event on the instance.

more details
more detailsWidget
Boolean

Indicates whether there is an event listener on the instance that matches the provided event name.

more details
more detailsWidget
Boolean

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

more details
more detailsWidget
Boolean

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

more details
more detailsWidget
Boolean

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

more details
more detailsWidget

Paginates to the next media info.

more details
more detailsFeature
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Paginates to the previous media info in the specified media content element.

more details
more detailsFeature
Object

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

This method is primarily used by developers when implementing custom widgets.

more details
more detailsWidget

Paginates to a specified media info object.

more details
more detailsFeature
Promise

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

more details
more detailsWidget

Method Details

classes(classNames){String}inherited

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:
classNames String|String[]|Object
repeatable

The class names.

Returns:
Type Description
String The computed class name.
See also:
Example:
// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}
destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:
type String

The name of the event.

event Object
optional

The event payload.

Returns:
Type Description
Boolean true if a listener was notified
hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:
type String

The name of the event.

Returns:
Type Description
Boolean Returns true if the class supports the input event.
isFulfilled(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

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
Since: ArcGIS API for JavaScript 4.19

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
Since: ArcGIS API for JavaScript 4.19

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.
nextMedia(contentElementIndex)

Paginates to the next media info.

Parameter:
contentElementIndex Number

The index position of the media content element.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:
Type Description
Object Returns an event handler with a remove() method that can be called to stop listening for the event(s).
Property Type Description
remove Function When called, removes the listener from the event.
Example:
view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});
own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

previousMedia(contentElementIndex)

Paginates to the previous media info in the specified media content element.

Parameter:
contentElementIndex Number

The index position of the media content element.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:
Type Description
Object The rendered virtual node.
renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

setActiveMedia(contentElementIndex, mediaInfoIndex)

Paginates to a specified media info object. For example, you may have media content which contains multiple mediaInfos. This method allows you to specify the index of the mediaInfos you wish to display.

Prior to version 4.17, this method was named goToMedia.

Parameters:
contentElementIndex Number

The index position of the media content element to be updated.

mediaInfoIndex Number

The index position of the media info object you wish to display.

when(callback, errback){Promise}inherited
Since: ArcGIS API for JavaScript 4.19

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 the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.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
});

Type Definitions

VisibleContentElements
Properties:
attachments Boolean
optional

Indicates whether to display any AttachmentsContent elements. Default is true.

fields Boolean
optional

Indicates whether to display any FieldsContent elements. Default is true.

media Boolean
optional

Indicates whether to display any MediaContent elements. Default is true.

text Boolean
optional

Indicates whether to display any TextContent elements. Default is true.

VisibleElements
Properties:
title Boolean
optional

Indicates whether the title associated with the feature displays. Default value is true.

optional

Indicates whether content for the Feature displays, can also indicate the specific types of content elements by setting it via VisibleContentElements. The default value is true, everything displays.

lastEditInfo Boolean
optional

Indicates whether lastEditInfo is displayed within the feature. Default value is true.