FeatureTemplate

require(["esri/layers/support/FeatureTemplate"], function(FeatureTemplate) { /* code goes here */ });

Class: esri/layers/support/FeatureTemplate

Inheritance: FeatureTemplate Accessor

Since: ArcGIS API 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

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

Type	Summary	Class
String	The name of the class. more details	more details	Accessor
String	Description of the feature template. more details	more details	FeatureTemplate
String	Name of the default drawing tool defined for the template to create a feature. more details	more details	FeatureTemplate
String	Name of the feature template. more details	more details	FeatureTemplate
Object	An instance of the prototypical feature described by the feature template. more details	more details	FeatureTemplate
Object	An object used to create a thumbnail image that represents a feature type in the feature template. more details	more details	FeatureTemplate

Property Details

declaredClassStringreadonly inherited Since: ArcGIS API for JavaScript 4.7

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

descriptionString

Description of the feature template.

drawingToolString

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

nameString

Name of the feature template.

prototypeObject

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(evt) {
  var park = fl.templates[0].prototype;
  newPark = new Graphic({
    attributes: park.attributes,
    geometry: evt.mapPoint
  });

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

thumbnailObject

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

Properties:

contentType Object

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

Name	Return Type	Summary	Class
	*	Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details	more details	FeatureTemplate
	Object	Converts an instance of this class to its ArcGIS portal JSON representation. more details	more details	FeatureTemplate

Method Details

fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. 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.

toJSON(){Object}

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