The item displayed within the FeatureTemplates widget.
Constructors
-
new TemplateItem(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 | |
String | The description that is displayed for the template item. more details | TemplateItem | |
String | The label that is displayed for the template item. more details | TemplateItem | |
FeatureLayer | The FeatureLayer associated with the template item. more details | TemplateItem | |
FeatureTemplate | The associated FeatureTemplate for the item. more details | TemplateItem | |
HTMLElement | An object used to create a thumbnail image that represents a feature type in the feature template. more details | TemplateItem |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
description String
-
The description that is displayed for the template item. This is similar to the description provided in FeatureTemplate.description.
-
label String
-
The label that is displayed for the template item. This is similar to the name provided in FeatureTemplate.name.
-
layer FeatureLayer
-
The FeatureLayer associated with the template item.
-
template FeatureTemplate
-
The associated FeatureTemplate for the item.
-
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
TemplateItem | Creates a deep clone of the template item object. more details | TemplateItem | |
Promise | Fetches the thumbnail used to display the template item. more details | TemplateItem | |
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
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.
-
clone(){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.
-
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"); }
-
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");