Provides the logic for the FeatureTemplates widget.
- See also
const templatesVM = new FeatureTemplatesViewModel({
layers: layers
});
const featureTemplates = new FeatureTemplates({
viewModel: templatesVM
container: "templatesDiv"
});
Constructors
-
new FeatureTemplatesViewModel(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 | The name of the class. more details | Accessor | |
FilterFunction | Function can be defined to help filter template items within the widget. more details | FeatureTemplatesViewModel | |
String|GroupByFunction | It is possible to group template items. more details | FeatureTemplatesViewModel | |
TemplateItem[]|TemplateItemGroup[] | The template items or grouped template items. more details | FeatureTemplatesViewModel | |
Array<(FeatureLayer|GeoJSONLayer|SceneLayer|SubtypeSublayer|SubtypeGroupLayer)> | An array of Featurelayers that are associated with the widget. more details | FeatureTemplatesViewModel | |
String | The widget's state. more details | FeatureTemplatesViewModel |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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 names contain the word `Street` function myFilterFunction(filter) { let containsName = filter.label.includes("Street"); return containsName; } // Create the FeatureTemplates widget const templates = new FeatureTemplates({ container: "templatesDiv", visibleElements = { filter: false // does not display the default feature templates filter }, layers: [featureLayer], // in this example, one layer is used filterFunction: myFilterFunction });
-
-
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 });
-
-
The template items or grouped template items.
-
An array of Featurelayers that are associated with 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 });
-
state Stringreadonly
-
The widget's state. Possible values are in the table below.
Value Description ready Dependencies are met and has valid property values. loading Layers are still loading and not ready yet. disabled No layers are available to load. Possible Values:"ready"|"loading"|"disabled"
- Default Value:disabled
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 | ||
Boolean | Emits an event on the instance. more details | FeatureTemplatesViewModel | |
Boolean | Indicates whether there is an event listener on the instance that matches the provided event name. more details | FeatureTemplatesViewModel | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Object | Registers an event handler on the instance. more details | FeatureTemplatesViewModel | |
This method updates the template items with the provided filter. more details | FeatureTemplatesViewModel | ||
Removes a group of handles owned by the object. more details | Accessor | ||
Selects the template item to use. more details | FeatureTemplatesViewModel |
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.
-
emit(type, event){Boolean}
-
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
-
hasEventListener(type){Boolean}
-
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"); }
-
on(type, listener){Object}
-
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); });
-
refresh()
-
This method updates the template items with the provided filter.
-
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");
-
select(item)
-
Selects the template item to use.
Parameteritem TemplateItemThe esri/widgets/FeatureTemplates/TemplateItem template item to select.
- See also
Event Overview
Name | Type | Summary | Class |
---|---|---|---|
{item: TemplateItem,template: FeatureTemplate} |
Fires when a template item is selected. more details |
FeatureTemplatesViewModel |
Event Details
-
select
-
Fires when a template item is selected. This occurs when the 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 templatesVM.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.") } }); } }); });