TemplateItem | API Reference | ArcGIS Maps SDK for JavaScript 4.30

The item displayed within the FeatureTemplates widget.

See also

Constructors

TemplateItem Constructor new TemplateItem(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	The name of the class.	Accessor
String	The description that is displayed for the template item.	TemplateItem
String	The label that is displayed for the template item.	TemplateItem
FeatureLayer	The FeatureLayer associated with the template item.	TemplateItem
FeatureTemplate	The associated FeatureTemplate for the item.	TemplateItem
HTMLElement	An object used to create a thumbnail image that represents a feature type in the feature template.	TemplateItem

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.

description Property description String

The description that is displayed for the template item. This is similar to the description provided in FeatureTemplate.description.

label Property label String

The label that is displayed for the template item. This is similar to the name provided in FeatureTemplate.name.

layer Property layer FeatureLayer

The FeatureLayer associated with the template item.

template Property template FeatureTemplate

The associated FeatureTemplate for the item.

thumbnail Property thumbnail HTMLElementreadonly

An object used to create a thumbnail image that represents a feature type in the feature template. This is similar to FeatureTemplate.thumbnail.

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
TemplateItem	Creates a deep clone of the template item object.	TemplateItem
Promise	Fetches the thumbnail used to display the template item.	TemplateItem
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

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.

clone Method clone(){TemplateItem}

Creates a deep clone of the template item object.

Returns

Type	Description
TemplateItem	Returns a deep clone of the template item.

fetchThumbnail Method fetchThumbnail(){Promise}static

Fetches the thumbnail used to display the template item.

Returns

Type	Description
Promise	Resolves when the thumbnail is loaded.

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

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