FeatureTemplate

AMD: require(["esri/layers/support/FeatureTemplate"], (FeatureTemplate) => { /* code goes here */ });
ESM: import FeatureTemplate from "@arcgis/core/layers/support/FeatureTemplate";
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
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

Description of the feature template.

more detailsFeatureTemplate
Stringmore details

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

more detailsFeatureTemplate
Stringmore details

Name of the feature template.

more detailsFeatureTemplate
Objectmore details

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

more detailsFeatureTemplate
Objectmore details

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

more detailsFeatureTemplate

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

description String

Description of the feature template.

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 String

Name of the feature template.

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 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

Name Return Type Summary Class
*more details

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

more detailsFeatureTemplate
Objectmore details

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

more detailsFeatureTemplate

Method Details

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.
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.