Feature | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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.

If wanting to show a feature's content with actions, related records, or clustering configuration, etc., then use the Features widget.

When Arcade expressions that use $map or geometry functions are defined in any popup template content or as expression elements, the map and spatialReference properties need to be defined in the Feature widget.

See also

Example

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

// map and spatialReference must be set for Arcade
// expressions to execute and display content
let feature = new Feature({
  graphic: graphic,
  map: map,
  spatialReference: spatialReference
});

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

Constructors

Feature Constructor 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

Type	Summary	Class
String\|HTMLElement	The ID or node representing the DOM element containing the widget.	Widget
String	The name of the class.	Accessor
Boolean	Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined.	Feature
Graphic	The Graphic used to represent the feature.	Feature
Number	Indicates the heading level to use for the title of the feature widget.	Feature
String	Icon which represents the widget.	Feature
String	The unique ID assigned to the widget when the widget is created.	Widget
String	The widget's default label.	Feature
Point	The location of the graphic to be displayed.	Feature
Map	A map is required when the input graphic has a popupTemplate that contains Arcade expressions in ExpressionInfo or ExpressionContent that may use the `$map` profile variable to access data from layers within a map.	Feature
SpatialReference	The spatial reference used for Arcade operations.	Feature
String	Dates and times displayed in the widget will be displayed in this time zone.	Feature
String	The title for the feature.	Feature
MapView\|SceneView	A reference to the MapView or SceneView.	Feature
FeatureViewModel	The view model for this widget.	Feature
Boolean	Indicates whether the widget is visible.	Widget
VisibleElements	The visible elements that are displayed within the widget's graphic.popupTemplate.content.	Feature

Property Details

container Inherited Property container String |HTMLElement Inherited from Widget

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

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

defaultPopupTemplateEnabled Property defaultPopupTemplateEnabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.11 Feature since 4.7, defaultPopupTemplateEnabled added at 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).

Starting with version 4.28, date fields are formatted using the short-date-short-time preset dateFormat rather than long-month-day-year in default popup templates created by setting the defaultPopupTemplateEnabled property to true. For example, previously a date that may have appeared as "December 30, 1997" will now appear as "12/30/1997 6:00 PM".

Default Value:false

graphic Property graphic Graphic

The Graphic used to represent the feature.

Default Value:null

See also

PopupTemplate.content

Example

let 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
      }
    ]
  }
});

headingLevel Property headingLevel Number Since: ArcGIS Maps SDK for JavaScript 4.20 Feature since 4.7, headingLevel added at 4.20.

Indicates the heading level to use for the title of the feature widget. By default, the title is rendered as a level 2 heading (e.g. <h2>Title of content</h2>). Depending on the widget's placement in your app, you may need to adjust this heading for proper semantics. This is important for meeting accessibility standards.

Default Value:2

See also

Heading Elements

Example

// feature title will render as an <h3>
feature.headingLevel = 3;

icon Property icon String Since: ArcGIS Maps SDK for JavaScript 4.27 Feature since 4.7, icon added at 4.27.

Icon which represents the widget. It is typically used when the widget is controlled by another one (e.g. in the Expand widget).

Default Value:"polygon"

See also

Calcite Icon Search

id Inherited Property id String Inherited from Widget

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 Property label String

The widget's default label.

location Property location Point Since: ArcGIS Maps SDK for JavaScript 4.31 Feature since 4.7, location added at 4.31.

The location of the graphic to be displayed.

map Property map Map Since: ArcGIS Maps SDK for JavaScript 4.11 Feature since 4.7, map added at 4.11.

A map is required when the input graphic has a popupTemplate that contains Arcade expressions in ExpressionInfo or ExpressionContent that may use the $map profile variable to access data from layers within a map. Without a map, expressions that use $map will throw an error.

Alternatively, the view property can be used to provide the map instance for this property.

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 Property spatialReference SpatialReference Since: ArcGIS Maps SDK for JavaScript 4.11 Feature since 4.7, spatialReference added at 4.11.

The spatial reference used for Arcade operations. This property should be set if the Feature widget executes Arcade expressions that contain geometry functions.

Default Value:null

See also

timeZone Property timeZone String Since: ArcGIS Maps SDK for JavaScript 4.29 Feature since 4.7, timeZone added at 4.29.

Dates and times displayed in the widget will be displayed in this time zone. By default this time zone is inherited from MapView.timeZone. When a MapView is not associated with the widget then the property will fallback to the system time zone.

Possible Values

Value	Description
system	Dates and times will be displayed in the timezone of the device or browser.
unknown	Dates and time are not adjusted for any timezone.
Specified IANA timezone	Dates and times will be displayed in the specified IANA time zone. See wikipedia - List of tz database time zones.

title Property title Stringreadonly

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

Default Value:null

See also

headingLevel

view Property view MapView |SceneView

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

The Feature widget requires a view if the user expects it to display content in any of the following situations:

The graphic has a popupTemplate containing Arcade expressions in ExpressionInfo or ExpressionContent that use geometry functions or reference the $map profile variable (i.e. access data from layers within a map).
Content is displayed from the popup template of an aggregate feature (i.e. a cluster or bin).
Values from date and timestamp-offset fields should respect the view's time zone.

viewModel Property viewModel FeatureViewModelautocast

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.

visible Inherited Property visible Boolean Inherited from Widget

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the css display value of "none".

Default Value:true

Example

// Hides the widget in the view
widget.visible = false;

visibleElements Property visibleElements VisibleElements Since: ArcGIS Maps SDK for JavaScript 4.11 Feature since 4.7, visibleElements added at 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

PopupTemplate.content

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
String	A utility method used for building the value for a widget's `class` property.	Widget
	Destroys the widget instance.	Widget
Boolean	Emits an event on the instance.	Widget
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name.	Widget
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	Widget
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	Widget
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	Widget
	Paginates to the next media info.	Feature
Object	Registers an event handler on the instance.	Widget
	Adds one or more handles which are to be tied to the lifecycle of the widget.	Widget
	Executes after widget is ready for rendering.	Widget
	Paginates to the previous media info in the specified media content element.	Feature
	Removes a group of handles owned by the object.	Accessor
Object	This method is implemented by subclasses for rendering.	Widget
	Renders widget to the DOM immediately.	Widget
	Schedules widget rendering.	Widget
	Paginates to a specified media info object.	Feature
Promise	`when()` may be leveraged once an instance of the class is created.	Widget

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.

classes Inherited Method classes(classNames){String} Inherited from Widget

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.

Example

// .tsx syntax showing how to set css classes while rendering the widget

render() {
  const dynamicClasses = {
    [css.flip]: this.flip,
    [css.primary]: this.primary
  };

  return (
    <div class={classes(css.root, css.mixin, dynamicClasses)} />
  );
}

destroy Inherited Method destroy() Inherited from Widget

Destroys the widget instance.

emit Inherited Method emit(type, event){Boolean} Inherited from Widget

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 Inherited Method hasEventListener(type){Boolean} Inherited from Widget

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.

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

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isFulfilled added at 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 Inherited Method isRejected(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isRejected added at 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 Inherited Method isResolved(){Boolean} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, isResolved added at 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 Method nextMedia(contentElementIndex)

Paginates to the next media info.

Parameter

contentElementIndex Number

The index position of the media content element.

on Inherited Method on(type, listener){Object} Inherited from Widget

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

Parameters

type String|String []

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns

Type Description

Object

Returns an event handler with a remove() method that should 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 Inherited Method own(handleOrHandles) Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.24 Widget since 4.2, own added at 4.24. Deprecated since 4.28 Use addHandles() instead.

Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

Parameter

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize Inherited Method postInitialize() Inherited from Widget

Executes after widget is ready for rendering.

previousMedia Method 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.

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

render Inherited Method render(){Object} Inherited from Widget

This method is implemented by subclasses for rendering.

Returns

Type	Description
Object	The rendered virtual node.

renderNow Inherited Method renderNow() Inherited from Widget

Renders widget to the DOM immediately.

scheduleRender Inherited Method scheduleRender() Inherited from Widget

Schedules widget rendering. This method is useful for changes affecting the UI.

setActiveMedia Method 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 Inherited Method when(callback, errback){Promise} Inherited from Widget Since: ArcGIS Maps SDK for JavaScript 4.19 Widget since 4.2, when added at 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`.

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 Type Definition VisibleContentElements

Properties: attachments Boolean

optional
Default Value:true

Indicates whether to display any AttachmentsContent elements.

fields Boolean

optional
Default Value:true

Indicates whether to display any FieldsContent elements.

media Boolean

optional
Default Value:true

Indicates whether to display any MediaContent elements.

text Boolean

optional
Default Value:true

Indicates whether to display any TextContent elements.

expression Boolean

optional
Default Value:true

Indicates whether to display any ExpressionContent elements. When defining content for expression elements, the map and spatialReference properties must be defined for the expressions to execute and render content in the widget.

VisibleElements Type Definition VisibleElements

Properties: title Boolean

optional
Default Value:true

Indicates whether the title associated with the feature displays.

content Boolean|VisibleContentElements

optional
Default Value:true

Indicates whether content for the Feature displays, can also indicate the specific types of content elements by setting it via VisibleContentElements.

lastEditedInfo Boolean

optional
Default Value:true

Indicates whether lastEditInfo is displayed within the feature.