The FeatureTemplates widget is part of the overall editing workflow. Its main purpose is to display templates from one or more feature layers. In addition to displaying feature layer templates, it is also possible to filter and group templates for an easier editing experience. The widget listens for an end user to select a specific template in the widget. Its select event is fired and the resulting template information is returned. This widget can be used in conjunction with FeatureLayer.applyEdits to enable an end user to update one of its feature layers.
- See also
const templates = new FeatureTemplates({
container: "templatesDiv",
layers: layers
});
Constructors
-
new FeatureTemplates(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Example// Typical usage const templates = new FeatureTemplates({ container: "templatesDiv", layers: layers });
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 | |
Specifies whether or not the list should be forced to scroll within its containing element more details | enableListScroll | ||
FilterFunction | Function can be defined to help filter template items within the widget. more details | FeatureTemplates | |
String | Text used to filter items. more details | FeatureTemplates | |
String|GroupByFunction | It is possible to group template items. more details | FeatureTemplates | |
Number | Indicates the heading level to use for the labels of grouped feature templates. more details | FeatureTemplates | |
String | The unique ID assigned to the widget when the widget is created. more details | Widget | |
String | The widget's default label. more details | FeatureTemplates | |
Array<(FeatureLayer|GeoJSONLayer|SceneLayer|SubtypeSublayer|SubtypeGroupLayer)> | An array of Featurelayers to display within the widget. more details | FeatureTemplates | |
FeatureTemplatesViewModel | The view model for this widget. more details | FeatureTemplates | |
Boolean | Indicates whether the widget is visible. more details | Widget | |
VisibleElements | The visible elements that are displayed within the widget. more details | FeatureTemplates |
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
.
-
enableListScroll inner
-
Specifies whether or not the list should be forced to scroll within its containing element
-
filterFunction FilterFunction
-
Function can be defined to help filter template items within the widget. A custom function can be used to aid when searching for templates. It takes a function which passes in an object containing a name property of the template item.
Example// Filter and display templates only if their labels contain the word `Street` function myFilterFunction(filter) { let containsName = filter.label.includes("Street"); return containsName; } // Create the FeatureTemplates widget templates = new FeatureTemplates({ container: "templatesDiv", visibleElements: { filter: false, // disable the default filter UI }, layers: [featureLayer], // in this example, one layer is used filterFunction: myFilterFunction });
-
filterText String
-
Text used to filter items.
-
-
It is possible to group template items. This can aid in managing various template items and how they display within the widget. The values are discussed below.
Type Description Example layer This is the default grouping. Groups template items by layers. geometry Groups template items by geometry type. none The widget displays everything in one list with no grouping. GroupByFunction Custom function that takes an object containing a FeatureTemplate and FeatureLayer. - Default Value:layer
Example// This example shows using a function to check if // the layer title contains the word 'military'. If so, // return a group of items called "All Military Templates" function customGroup(grouping) { // Consolidate all military layers if (grouping.layer.title.toLowerCase().indexOf("military") > -1) { return "All Military Templates" } // Otherwise, group by layer title return grouping.layer.title; } // Create the FeatureTemplates widget templates = new FeatureTemplates({ container: "templatesDiv", layers: layers, groupBy: customGroup });
-
headingLevel NumberSince: ArcGIS Maps SDK for JavaScript 4.20
-
Indicates the heading level to use for the labels of grouped feature templates. By default, the group label is rendered as a level 4 heading (e.g.
<h4>Group label</h4>
). 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:4
- See also
Example// Group label will render as an <h3> featureTemplates.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.
-
An array of Featurelayers to display within the widget. The order in which these layers are set in the array dictates how they display within the widget.
The widget is designed to only display layers that are enabled for editing. It will not display layers that are enabled to only edit attributes.
Example// The layers to display within the widget let militaryUnits = new FeatureLayer({ url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Military/FeatureServer/2" }); let militaryHostile = new FeatureLayer({ url: "http://sampleserver6.arcgisonline.com/arcgis/rest/services/Military/FeatureServer/6" }); let layers = [militaryUnits, militaryHostile]; // Create FeatureTemplates widget templates = new FeatureTemplates({ container: "templatesDiv", layers: layers });
-
viewModel FeatureTemplatesViewModelautocast
-
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 FeatureTemplatesViewModel 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.15
-
The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.
ExamplefeatureTemplates.visibleElements = { filter: false };
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 | Returns true if a named group of handles exist. more details | Accessor | |
Boolean |
| Widget | |
Boolean |
| Widget | |
Boolean |
| Widget | |
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 | ||
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 | ||
Selects the template item to use. more details | FeatureTemplates | ||
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.
-
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.
-
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.24
-
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.
-
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.
-
select(item)
-
Selects the template item to use.
Parameteritem TemplateItemThe template item to select.
- See also
-
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
-
FilterFunction(filterName){Boolean}
-
The filter used when setting the filterFunction property. It takes an object containing a name property of the template item and returns whether or not to include it.
ParametersfilterName ObjectAn object containing a
name
property.Specificationname StringThe name of the template item to filter.
ReturnsType Description Boolean Function is a predicate, to test each element of the array. Return true
to keep item in the template widget, otherwise,false
to remove it.Example// Filter and display templates only if their labels contain the word `Street` function myFilterFunction(filter) { let containsName = filter.label.includes("Street"); return containsName; } // Create the FeatureTemplates widget templates = new FeatureTemplates({ container: "templatesDiv", visibleElements: { filter: false, // disable the default filter UI } layers: [featureLayer], // in this example, one layer is used filterFunction: myFilterFunction });
-
The function used when setting the groupBy property. It is used to customize the grouping of template items. This can aid in managing various template items and how they display within the widget. This takes an object containing a
template
and alayer
property.ParametersSpecificationgrouping ObjectAn object containing the properties referenced below.
Specificationlayer FeatureLayerFeatureLayer instance referenced in layers property.
template FeatureTemplateFeatureTemplate associated with the
layer
.ReturnsType Description String | Object Groups consist of a group key
andlabel
. These are shown in the UI. If both thekey
andlabel
are identical, return astring
. Otherwise, return anobject
withkey/name
properties. This gives finer control of the groups.Examples// This example shows using a function to check if // the layer title contains the word 'military'. If so, // return a group of items called "All Military Templates" function customGroup(grouping) { // Consolidate all military layers if (grouping.layer.title.toLowerCase().indexOf("military") > -1) { return "All Military Templates" } // Otherwise, group by layer title return grouping.layer.title; } // Create the FeatureTemplates widget templates = new FeatureTemplates({ container: "templatesDiv", layers: layers, groupBy: customGroup });
// Group template items by layers. // This function is as same as setting // the groupBy property to "layer" option. function groupByLayer (grouping) { const group = { key: grouping.layer, name: grouping.layer.title }; return group; } // Create the FeatureTemplates widget const templates = new FeatureTemplates({ container: "templatesDiv", layers: layers, groupBy: groupByLayer });
-
VisibleElements
-
The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.
- Property
-
filter Boolean
Indicates whether to the filter will be displayed. Default is
true
.
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
{item: TemplateItem,template: FeatureTemplate} |
Fires when a template item is selected. more details |
FeatureTemplates |
Event Details
-
select
-
Fires when a template item is selected. This occurs when the associated view model's select method is called.
- Properties
-
item TemplateItem
The selected template item.
template FeatureTemplateThe feature template associated with the template item.
- See also
Example// Listen for when a template item is selected templates.on("select", function(evtTemplate) { // Access the selected template item's attributes attributes = evtTemplate.template.prototype.attributes; // Create a new feature with the selected template at cursor location const handler = view.on("click", function(event) { handler.remove(); // remove click event handler. event.stopPropagation(); // Stop click event propagation if (event.mapPoint) { // Create a new feature with the selected template item. editFeature = new Graphic({ geometry: event.mapPoint, attributes: { "IncidentType": attributes.IncidentType } }); // Setup the applyEdits parameter with adds. const edits = { addFeatures: [editFeature] }; featureLayer.applyEdits(params).then(function(editsResult) { if (editsResult.addFeatureResults.length > 0) { console.log("Created a new feature.") } }); } }); });