Skip to content
import FeatureTemplate from "@arcgis/core/layers/support/FeatureTemplate.js";
Inheritance:
FeatureTemplateAccessor
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

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

description

Property
Type
string | null | undefined

Description of the feature template.

drawingTool

Property
Type
DrawingTool | null | undefined

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

name

Property
Type
string | null | undefined

Name of the feature template.

prototype

Property
Type
FeatureTemplatePrototype

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
Type
FeatureTemplateThumbnail | null | undefined

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

Methods

MethodSignatureClass
fromJSON
inherited static
fromJSON(json: any): any
clone
inherited
clone(): this
toJSON
inherited
toJSON(): any

fromJSON

inheritedstatic Method
Signature
fromJSON (json: any): any
Inherited from: JSONSupportMixin

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.

Parameters
ParameterTypeDescriptionRequired
json
any

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
any

Returns a new instance of this class.

clone

inherited Method
Signature
clone (): this
Inherited from: ClonableMixin

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
this

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

toJSON

inherited Method
Signature
toJSON (): any
Inherited from: JSONSupportMixin

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

Returns
any

The ArcGIS portal JSON representation of an instance of this class.

Type definitions

DrawingTool

Type definition
Type
"auto-complete-polygon" | "circle" | "ellipse" | "freehand" | "line" | "none" | "point" | "polygon" | "rectangle" | "arrow" | "triangle" | "left-arrow" | "right-arrow" | "up-arrow" | "down-arrow"