GroupColumnTemplate

AMD: require(["esri/widgets/FeatureTable/support/GroupColumnTemplate"], (GroupColumnTemplate) => { /* code goes here */ });
ESM: import GroupColumnTemplate from "@arcgis/core/widgets/FeatureTable/support/GroupColumnTemplate";
Class: esri/widgets/FeatureTable/support/GroupColumnTemplate
Inheritance: GroupColumnTemplate ColumnTemplateBase Accessor
Since: ArcGIS API for JavaScript 4.24

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 and/or group column templates.

See also
Example
const groupColumnTemplate = new GroupColumnTemplate({
  fieldName: "full_name",
  label: "Full name"
});

Constructors

new GroupColumnTemplate(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.
Show inherited properties Hide inherited properties
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.

more details
GroupColumnTemplate
String

The name of the class.

more details
Accessor
String

A string value containing the column alias.

more details
ColumnTemplateBase
String

The 'type' of column that the template represents.

more details
GroupColumnTemplate
Boolean

Indicates whether the column is visible.

more details
ColumnTemplateBase

Property Details

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"
    }]
  }]
});
declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

A string value containing the column alias.

type Stringreadonly

The 'type' of column that the template represents.

For GroupColumnTemplate the type is always "group".

visible Boolean inherited

Indicates whether the column is visible.

Default Value:true

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
ColumnTemplateBase
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
ColumnTemplateBase

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API for JavaScript 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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.

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 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
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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");
}
removeHandles(groupKey)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}inherited

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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.