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 |
---|---|---|---|
Indicates if the column width will automatically adjust to account for large content. | ColumnTemplateBase | ||
A collection of field column templates and/or group column templates that represent an ordered list of column templates. | GroupColumnTemplate | ||
The name of the class. | Accessor | ||
The unique field name as defined by the data source. | ColumnTemplateBase | ||
Controls the flex-grow property for the column. | ColumnTemplateBase | ||
Custom function for rendering cell content that is called when the column is rendered in the table. | ColumnTemplateBase | ||
Indicates if the the column is frozen in place at the beginning of the table. | ColumnTemplateBase | ||
Indicates if the column is frozen in place at the end of the table. | ColumnTemplateBase | ||
The string value indicating the icon displayed in the header cell of the column. | ColumnTemplateBase | ||
Indicates whether the column is in an invalid state. | ColumnTemplateBase | ||
The default label displayed in the column header cell. | ColumnTemplateBase | ||
Indicates whether the column is resizable. | ColumnTemplateBase | ||
Indicates cell content should be wrapped and displayed on multiple lines within the cell. | ColumnTemplateBase | ||
The 'type' of column that the template represents. | GroupColumnTemplate | ||
Indicates whether the column is visible. | ColumnTemplateBase |
Property Details
-
autoWidth
InheritedPropertyautoWidth Boolean
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, autoWidth added at 4.30. -
Indicates if the column width will automatically adjust to account for large content. The column ignores the current width property when
autoWidth
istrue
.- Default Value:false
-
columnTemplates
columnTemplates 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" }] }] });
-
fieldName
InheritedPropertyfieldName String
Inherited from ColumnTemplateBase -
The unique field name as defined by the data source.
-
flexGrow
InheritedPropertyflexGrow Number
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, flexGrow added at 4.30. -
Controls the flex-grow property for the column. When set to
0
, cell width is fixed.- Default Value:1
-
formatFunction
InheritedPropertyformatFunction FormatFunction
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, formatFunction added at 4.30. -
Custom function for rendering cell content that is called when the column is rendered in the table. The function should return the formatted content to display within a table's cell. This can be a string, number, an HTML element, or equivalent node type (e.g. a Calcite component). If the content is an HTML element, it is appended to the root element. If the content is a string or number, it is set as the innerHTML of the root element. This property is useful when you want to customize the cell content. For example, you can use this property to create a custom cell renderer that displays a progress bar in the cell. The progress bar can be used to show the progress of a task.
Example// The following example demonstrates how to use the formatFunction property to create a custom cell renderer that displays a progress bar in the cell. The progress bar can be used to show the progress of a task. columnTemplate.formatFunction = (column, feature, index, value )=> { const progress = document.createElement("progress"); progress.max = 100; progress.value = value; return progress; };
-
frozen
InheritedPropertyfrozen Booleanreadonly
Inherited from ColumnTemplateBase -
Indicates if the the column is frozen in place at the beginning of the table. Column must be first in the FeatureTable's column's, or next to other frozen columns.
- Default Value:false
-
frozenToEnd
InheritedPropertyfrozenToEnd Booleanreadonly
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, frozenToEnd added at 4.30. -
Indicates if the column is frozen in place at the end of the table. Column must be last in the FeatureTable's column's, or next to other columns with
frozenToEnd
set totrue
.- Default Value:false
-
icon
InheritedPropertyicon String
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, icon added at 4.30. -
The string value indicating the icon displayed in the header cell of the column.
- See also
-
invalid
InheritedPropertyinvalid Boolean
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, invalid added at 4.30. -
Indicates whether the column is in an invalid state.
- Default Value:false
-
label
InheritedPropertylabel String
Inherited from ColumnTemplateBase -
The default label displayed in the column header cell.
-
resizable
InheritedPropertyresizable Boolean
Inherited from ColumnTemplateBaseSince: ArcGIS Maps SDK for JavaScript 4.30ColumnTemplateBase since 4.24, resizable added at 4.30. -
Indicates whether the column is resizable.
- Default Value:true
-
textWrap
InheritedPropertytextWrap Boolean
Inherited from ColumnTemplateBase -
Indicates cell content should be wrapped and displayed on multiple lines within the cell.
This causes rows to expand when tall content is visible in the viewport. Scrolling tall cells into the viewport may cause the table to visually jump depending on the height of the expanding rows.
- Default Value:false
-
type
type Stringreadonly
-
The 'type' of column that the template represents.
For GroupColumnTemplate the type is always "group".
-
visible
InheritedPropertyvisible Boolean
Inherited 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 | |
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. | 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
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
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.