FeatureTemplate

AMD: require(["esri/layers/support/FeatureTemplate"], (FeatureTemplate) => { /* code goes here */ });
ESM: import FeatureTemplate from "@arcgis/core/layers/support/FeatureTemplate.js";
Class: esri/layers/support/FeatureTemplate
Inheritance: FeatureTemplate Accessor
Since: ArcGIS Maps SDK for JavaScript 4.4

Feature templates define all the information required to create a new feature in a feature layer. These include information such as the default attribute values with which a feature will be created, and the default tool used to create that feature.

Constructors

FeatureTemplate

Constructor
new FeatureTemplate(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
Name Type Summary Class

The name of the class.

Accessor

Description of the feature template.

FeatureTemplate

Name of the default drawing tool defined for the template to create a feature.

FeatureTemplate

Name of the feature template.

FeatureTemplate

An instance of the prototypical feature described by the feature template.

FeatureTemplate

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

FeatureTemplate

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

description

Property
description String

Description of the feature template.

drawingTool

Property
drawingTool String

Name of the default drawing tool defined for the template to create a feature.

Possible Values:"auto-complete-polygon" |"circle" |"ellipse" |"freehand" |"line" |"none" |"point" |"polygon" |"rectangle" |"arrow" |"triangle" |"left-arrow" |"right-arrow" |"up-arrow" |"down-arrow"

name

Property
name String

Name of the feature template.

prototype

Property
prototype Object

An instance of the prototypical feature described by the feature template. It specifies default values for the attribute fields and does not contain geometry.

Example
// this snippet code shows how to create a feature based on
// feature type prototype. Creates a new feature assigns
// default values for the attributes to the new feature.
view.on("click", function(event) {
  let park = fl.templates[0].prototype;
  newPark = new Graphic({
    attributes: park.attributes,
    geometry: event.mapPoint
  });

  let promise = fl.applyEdits({addFeatures: [newPark]});
  editResultsHandler(promise);
});

thumbnail

Property
thumbnail Object

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

Properties
contentType String

The MIME type of the image.

Possible Values:"image"|"png"|"jpg"|"jpeg"

imageData String

The base64EncodedImageData presenting the thumbnail image.

height Number

The height of the thumbnail.

width Number

The width of the thumbnail.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
this

Creates a deep clone of this object.

FeatureTemplate
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

FeatureTemplate

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Converts an instance of this class to its ArcGIS portal JSON representation.

FeatureTemplate

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(){this}

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns
Type Description
this A deep clone of the class instance that invoked this method.

fromJSON

Method
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns
Type Description
* Returns a new instance of this class.

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

toJSON

Method
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.