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 Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
String | more details The name of the class. | more details | Accessor | |
String | more details Description of the feature template. | more details | FeatureTemplate | |
String | more details Name of the default drawing tool defined for the template to create a feature. | more details | FeatureTemplate | |
String | more details Name of the feature template. | more details | FeatureTemplate | |
Object | more details An instance of the prototypical feature described by the feature template. | more details | FeatureTemplate | |
Object | more details An object used to create a thumbnail image that represents a feature type in the feature template. | more details | FeatureTemplate |
Property Details
-
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 StringThe base64EncodedImageData presenting the thumbnail image.
height NumberThe height of the thumbnail.
width NumberThe 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 details | FeatureTemplate | |
more details Adds one or more handles which are to be tied to the lifecycle of the object. | more details | Accessor | ||
Object | more details Converts an instance of this class to its ArcGIS portal JSON representation. | 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 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 ObjectA 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.
-
own(handleOrHandles)inheritedSince: ArcGIS API for JavaScript 4.24
-
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.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }); handle.remove(); // Assign a handle using own() this.own(reactiveUtils.whenOnce(() => !view.updating) .then(() => { wkidSelect.disabled = false; }));
Parameter:handleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
-
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.