require(["esri/widgets/FeatureTable/support/TableTemplate"], (TableTemplate) => { /* code goes here */ });
import TableTemplate from "@arcgis/core/widgets/FeatureTable/support/TableTemplate.js";
esri/widgets/FeatureTable/support/TableTemplate
A TableTemplate formats and defines the content of a FeatureTable.
The TableTemplate can be set directly on a FeatureTable or its view model. The template consists of various column templates that can be configured for both individual fields and grouped fields.
const tableTemplate = new TableTemplate({
columnTemplates: [ // takes an array of FieldColumnTemplate and GroupColumnTemplate
{ // autocasts to FieldColumnTemplate
type: "field",
fieldName: "ObjectId",
direction: "asc", // In order to use initialSortPriority, make sure direction is set
initialSortPriority: 1 // This field's sort order takes the second-highest priority.
},
{
type: "field",
fieldName: "NAME",
label: "Name",
direction: "asc", // In order to use initialSortPriority, make sure direction is set
initialSortPriority: 0 // This field's sort order takes the highest priority
},
{
type: "field",
fieldName: "STATUS",
label: "Status",
direction: "asc", // In order to use initialSortPriority, make sure direction is set
initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively.
}]
});
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
A collection of field column templates and/or group column templates that represent an ordered list of column templates. | TableTemplate | ||
The name of the class. | Accessor |
Property Details
-
columnTemplates
columnTemplates Array<(FieldColumnTemplate|GroupColumnTemplate|ColumnTemplate)>autocast
-
A collection of field column templates and/or group column templates that represent an ordered list of column templates.
Column templates are designed to allow the developer the ability to define the structure for columns within the FeatureTable widget.
- See also
Exampleconst tableTemplate = new TableTemplate({ columnTemplates: [ { // autocasts to FieldColumnTemplate type: "field", fieldName: "ObjectId", direction: "asc", initialSortPriority: 1 // This field's sort order takes the second-highest priority. }, { type: "field", fieldName: "NAME", label: "Name", initialSortPriority: 0 // This field's sort order takes the highest priority }, { type: "field", fieldName: "STATUS", label: "Status", direction: "asc", initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively. }] });
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of the TableTemplate class. | TableTemplate | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | TableTemplate | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | TableTemplate |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
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.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
clone
clone(){TableTemplate}
-
Creates a deep clone of the TableTemplate class.
ReturnsType Description TableTemplate A deep clone of the TableTemplate instance.
-
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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.