FeatureTemplatesViewModel | API Reference | ArcGIS Maps SDK for JavaScript 4.31

Provides the logic for the FeatureTemplates widget.

See also

Example

const templatesVM = new FeatureTemplatesViewModel({
  layers: layers
});

const featureTemplates = new FeatureTemplates({
  viewModel: templatesVM
  container: "templatesDiv"
});

Constructors

FeatureTemplatesViewModel Constructor new FeatureTemplatesViewModel(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Boolean	Used to disable the associated user interface.	FeatureTemplatesViewModel
FilterFunction	Function can be defined to help filter template items within the widget.	FeatureTemplatesViewModel
String\|GroupByFunction	It is possible to group template items.	FeatureTemplatesViewModel
TemplateItem []\|TemplateItemGroup []	The template items or grouped template items.	FeatureTemplatesViewModel
Array<(FeatureLayer\|GeoJSONLayer\|SceneLayer\|SubtypeSublayer\|SubtypeGroupLayer)>	An array of FeatureLayers that are associated with the widget.	FeatureTemplatesViewModel
String	The widget's state.	FeatureTemplatesViewModel

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

disabled Property disabled Boolean Since: ArcGIS Maps SDK for JavaScript 4.28 FeatureTemplatesViewModel since 4.10, disabled added at 4.28.

Used to disable the associated user interface. This does not prevent the view model from functioning programmatically. Methods invoked programmatically still work as expected.

Default Value:false

filterFunction Property 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.

featureTemplatesFilterFunction

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

groupBy Property groupBy String |GroupByFunction

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

items Property items TemplateItem[] |TemplateItemGroup[]readonly

The template items or grouped template items.

layers Property layers Array<(FeatureLayer|GeoJSONLayer|SceneLayer|SubtypeSublayer|SubtypeGroupLayer)>

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

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
Boolean	Returns true if a named group of handles exist.	Accessor
Object	Registers an event handler on the instance.	FeatureTemplatesViewModel
	This method updates the template items with the provided filter.	FeatureTemplatesViewModel
	Removes a group of handles owned by the object.	Accessor
	Selects the template item to use.	FeatureTemplatesViewModel

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.

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

on Method on(type, listener){Object}

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

refresh Method refresh()

This method updates the template items with the provided filter.

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

select Method select(item)

Selects the template item to use.

Parameter

item TemplateItem

The esri/widgets/FeatureTemplates/TemplateItem template item to select.

See also

select event

Event Overview

Name	Type	Summary	Class
	{item: TemplateItem,template: FeatureTemplate}	Fires when a template item is selected.	FeatureTemplatesViewModel

Event Details

select Event select

Fires when a template item is selected. This occurs when the select method is called.

Properties

item TemplateItem

The selected template item.

template FeatureTemplate

The feature template associated with the template item.

See also

Sample - Update FeatureLayer using ApplyEdits

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