require(["esri/widgets/FeatureTable/support/GroupColumnTemplate"], (GroupColumnTemplate) => { /* code goes here */ });
import GroupColumnTemplate from "@arcgis/core/widgets/FeatureTable/support/GroupColumnTemplate.js";
esri/widgets/FeatureTable/support/GroupColumnTemplate
A GroupColumnTemplate formats and defines the structure of a GroupColumn within a FeatureTable widget.
The GroupColumnTemplate is set directly on the table's template or its view model. The FeatureTable's tableTemplate contains a collection of field/group column templates.
- See also
const groupColumnTemplate = new GroupColumnTemplate({
fieldName: "full_name",
label: "Full name"
});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 |
|---|---|---|---|
| Array<(FieldColumnTemplate|GroupColumnTemplate)> | A collection of field column templates and/or group column templates that represent an ordered list of column templates. | GroupColumnTemplate | |
| String | The name of the class. | Accessor | |
| String | A string value containing the column alias. | ColumnTemplateBase | |
| String | The 'type' of column that the template represents. | GroupColumnTemplate | |
| Boolean | Indicates whether the column is visible. | ColumnTemplateBase |
Property Details
-
columnTemplates
PropertycolumnTemplates Array<(FieldColumnTemplate|GroupColumnTemplate)>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
Example// Create a new table template const tableTemplate = new TableTemplate({ columnTemplates: [{ // Autocasts to new GroupColumnTemplate type: "group", label: "Inspector information", columnTemplates: [{ // Autocasts to new FieldColumnTemplate type: "field", fieldName: "inspector", label: "name" },{ type: "field", fieldName: "inspemail", label: "Email address" },{ type: "field", fieldName: "insp_date", label: "Date of inspection" }] }] });
-
label
InheritedPropertylabel StringInherited from ColumnTemplateBase -
A string value containing the column alias.
-
type
Propertytype Stringreadonly -
The 'type' of column that the template represents.
For GroupColumnTemplate the type is always "group".
-
visible
InheritedPropertyvisible BooleanInherited from ColumnTemplateBase -
Indicates whether the column is visible.
- Default Value:true
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 new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | ColumnTemplateBase | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | ColumnTemplateBase |
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.
-
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
jsonparameter 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 trueif 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
InheritedMethodtoJSON(){Object}Inherited from ColumnTemplateBase -
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.