require(["esri/widgets/Feature"], (Feature) => { /* code goes here */ });
import Feature from "@arcgis/core/widgets/Feature.js";
esri/widgets/Feature
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.
When popup templates define Arcade expressions as calculated values referenced in any popup template content or as expression elements, the map and spatialReference properties must be defined in the Feature widget for the Arcade to execute.
- See also
// 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
-
new Feature(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String|HTMLElement | The ID or node representing the DOM element containing the widget. more details | Widget | |
String | The name of the class. more details | Accessor | |
Boolean | Enables automatic creation of a popup template for layers that have popups enabled but no popupTemplate defined. more details | Feature | |
Graphic | The Graphic used to represent the feature. more details | Feature | |
Number | Indicates the heading level to use for the title of the feature widget. more details | Feature | |
String | The unique ID assigned to the widget when the widget is created. more details | Widget | |
String | The widget's default label. more details | Feature | |
Map | A reference to the view's Map. more details | Feature | |
SpatialReference | The spatial reference used for Arcade operations. more details | Feature | |
String | The title for the feature. more details | Feature | |
MapView|SceneView | A reference to the MapView or SceneView. more details | Feature | |
FeatureViewModel | The view model for this widget. more details | Feature | |
Boolean | Indicates whether the widget is visible. more details | Widget | |
VisibleElements | The visible elements that are displayed within the widget's graphic.popupTemplate.content. more details | Feature |
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" });
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
defaultPopupTemplateEnabled BooleanSince: ArcGIS Maps SDK 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).Starting with version 4.28,
date
fields are formatted using theshort-date-short-time
preset dateFormat rather thanlong-month-day-year
in default popup templates created by setting thedefaultPopupTemplateEnabled
property totrue
. 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 Graphic
-
The Graphic used to represent the feature.
- Default Value:null
- See also
Examplelet 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 NumberSince: ArcGIS Maps SDK for JavaScript 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
Example// feature title will render as an <h3> feature.headingLevel = 3;
-
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 MapSince: ArcGIS Maps SDK 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 is required when Arcade expressions are defined in the Feature widget or the layer's popup template.
- 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 SpatialReferenceSince: ArcGIS Maps SDK 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
- See also
-
A reference to the MapView or SceneView. Set this to link the widget to a specific view.
This property must be set for
date
andtimestamp-offset
fields displayed in the Feature widget to respect the view's time zone.
-
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.
-
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 VisibleElementsSince: ArcGIS Maps SDK 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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
String | A utility method used for building the value for a widget's | Widget | |
Destroys the widget instance. more details | Widget | ||
Boolean | Emits an event on the instance. more details | Widget | |
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | Widget | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Paginates to the next media info. more details | Feature | ||
Object | Registers an event handler on the instance. more details | Widget | |
Adds one or more handles which are to be tied to the lifecycle of the widget. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Paginates to the previous media info in the specified media content element. more details | Feature | ||
Removes a group of handles owned by the object. more details | Accessor | ||
Object | This method is primarily used by developers when implementing custom widgets. more details | Widget | |
Renders widget to the DOM immediately. more details | Widget | ||
This method is primarily used by developers when implementing custom widgets. more details | Widget | ||
Paginates to a specified media info object. more details | Feature | ||
Promise |
| Widget |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.Parameterrepeatable The class names.
ReturnsType Description String The computed class name. 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.
-
Emits an event on the instance. This method should only be used when creating subclasses of this class.
Parameterstype StringThe name of the event.
event ObjectoptionalThe event payload.
ReturnsType Description Boolean true
if a listener was notified
-
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Since: ArcGIS Maps SDK 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
Since: ArcGIS Maps SDK 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
Since: ArcGIS Maps SDK 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
nextMedia(contentElementIndex)
-
Paginates to the next media info.
ParametercontentElementIndex NumberThe index position of the media content element.
-
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersAn event or an array of events to listen for.
listener FunctionThe function to call when the event fires.
ReturnsType 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. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
own(handleOrHandles)inheritedSince: ArcGIS Maps SDK for JavaScript 4.24Deprecated 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.
ParameterhandleOrHandles WatchHandle|WatchHandle[]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)
-
ParametercontentElementIndex Number
The index position of the media content element.
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.
ReturnsType 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 themediaInfos
you wish to display.Prior to version 4.17, this method was named
goToMedia
.ParameterscontentElementIndex NumberThe index position of the media content element to be updated.
mediaInfoIndex NumberThe index position of the media info object you wish to display.
-
Since: ArcGIS Maps SDK for JavaScript 4.19
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType 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
-
- Properties
-
attachments BooleanDefault Value:true
Indicates whether to display any AttachmentsContent elements.
fields BooleanDefault Value:trueIndicates whether to display any FieldsContent elements.
media BooleanDefault Value:trueIndicates whether to display any MediaContent elements.
text BooleanDefault Value:trueIndicates whether to display any TextContent elements.
expression BooleanDefault Value:trueIndicates 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
-
- Properties
-
title BooleanDefault Value:true
Indicates whether the title associated with the feature displays.
content Boolean|VisibleContentElementsDefault Value:trueIndicates whether content for the Feature displays, can also indicate the specific types of content elements by setting it via VisibleContentElements.
lastEditInfo BooleanDefault Value:trueIndicates whether lastEditInfo is displayed within the feature.