require(["esri/widgets/FeatureTemplates/TemplateItem"], (TemplateItem) => { /* code goes here */ });
import TemplateItem from "@arcgis/core/widgets/FeatureTemplates/TemplateItem.js";
esri/widgets/FeatureTemplates/TemplateItem
The item displayed within the FeatureTemplates widget.
Constructors
-
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 |
|---|---|---|---|
The name of the class. | Accessor | ||
The description that is displayed for the template item. | TemplateItem | ||
The label that is displayed for the template item. | TemplateItem | ||
The FeatureLayer associated with the template item. | TemplateItem | ||
The associated FeatureTemplate for the item. | TemplateItem | ||
An object used to create a thumbnail image that represents a feature type in the feature template. | TemplateItem |
Property Details
-
description
Propertydescription String -
The description that is displayed for the template item. This is similar to the description provided in FeatureTemplate.description.
-
label
Propertylabel String -
The label that is displayed for the template item. This is similar to the name provided in FeatureTemplate.name.
-
layer
Propertylayer FeatureLayer -
The FeatureLayer associated with the template item.
-
template
Propertytemplate FeatureTemplate -
The associated FeatureTemplate for the item.
-
thumbnail
Propertythumbnail HTMLElement -
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
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of the template item object. | TemplateItem | ||
Promise | Fetches the thumbnail used to display the template item. | TemplateItem | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();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.
-
clone
Methodclone(){TemplateItem} -
Creates a deep clone of the template item object.
ReturnsType Description TemplateItem Returns a deep clone of the template item.
-
Fetches the thumbnail used to display the template item.
ReturnsType Description Promise Resolves when the thumbnail is loaded.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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");