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

The name of the class.

more details
more detailsAccessor
String

Description of the feature template.

more details
more detailsFeatureTemplate
String

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

more details
more detailsFeatureTemplate
String

Name of the feature template.

more details
more detailsFeatureTemplate
Object

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

more details
more detailsFeatureTemplate
Object

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

more details
more detailsFeatureTemplate

Property Details

declaredClassStringreadonly inherited

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.

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

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.

Known 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

NameReturn TypeSummaryClass
*

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

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

more details
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 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:
TypeDescription
*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.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.