require(["esri/widgets/FeatureTable/support/ColumnTemplateBase"], (ColumnTemplateBase) => { /* code goes here */ });
import ColumnTemplateBase from "@arcgis/core/widgets/FeatureTable/support/ColumnTemplateBase.js";
esri/widgets/FeatureTable/support/ColumnTemplateBase
The base class for all column templates used by the tableTemplate within the FeatureTable widget.
ColumnTemplateBase
is a base class which has no constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. | Accessor | |
String|null | Controls the sort order of the column. | ColumnTemplateBase | |
Number | Use this in combination with FeatureTable.multiSortEnabled and FeatureTable.direction properties to set sorting functionality on multiple columns. | ColumnTemplateBase | |
String | A string value containing the column alias. | ColumnTemplateBase | |
ButtonMenuConfig | Set this object to customize the column's menu content. | ColumnTemplateBase | |
Boolean | Indicates whether the field column can be sorted. | ColumnTemplateBase | |
String | Aligns the columns cell content horizontally. | ColumnTemplateBase | |
String | The 'type' of column that the template represents. | ColumnTemplateBase | |
Boolean | Indicates whether the column is visible. | ColumnTemplateBase |
Property Details
-
Controls the sort order of the column. This property will only be honored on one column in the FeatureTable widget. If direction is specified on more than one fieldColumn in the same FeatureTable, it will only be honored on the column with the highest index. For example, let's say the first column called
ObjectId
is set toasc
and another column later in the table order also has a set direction, the initialObjectId
column's direction will be ignored for the last one with the set direction.Use this in combination with the FieldColumnTemplate.initialSortPriority and FeatureTable.multiSortEnabled properties to set sorting functionality for multiple columns.
Possible Value Description asc Sorts the column in ascending order. desc Sorts the column in descending order. null No sort is applied to the column. Possible Values:"asc"|"desc"
- Default Value:null
- See also
-
initialSortPriority
initialSortPriority Number
-
Use this in combination with FeatureTable.multiSortEnabled and FeatureTable.direction properties to set sorting functionality on multiple columns. This property indicates the index of the sorted column when compared to other columns, with lower numbers taking a higher priority.
If no sort priority is set, the priority defaults to the most recently-sorted column. This occurs when sorting via the UI, or programmatically by calling FeatureTable.sortColumn. For example, using the example snippet below, the sort order priority is set for three columns, with "Status" having the least priority. Calling
table.sortColumn("Status", "asc")
would update theStatus
column to the highest priority. This would also occur if manually sorting via the column's UI.- Default Value:null
- See also
Exampleconst table = new FeatureTable({ layer: featureLayer, multiSortEnabled: true, tableTemplate: { // autocastable to TableTemplate columnTemplates: [{ // autocastable to FieldColumnTemplate fieldName: "ObjectId", direction: "asc", initialSortPriority: 1, // This field's sort order takes second-highest priority. }, { fieldName: "Name", direction: "asc", initialSortPriority: 0, // This field's sort order takes the highest priority. }, { fieldName: "Status", direction: "asc", initialSortPriority: 2 // This field's sort order is prioritized after Name and ObjectId, respectively. }] } container: "tableDiv" });
-
label
label String
-
A string value containing the column alias.
-
menuConfig
menuConfig ButtonMenuConfig
-
Set this object to customize the column's menu content.
- See also
-
sortable
sortable Boolean
-
Indicates whether the field column can be sorted.
- Default Value:true
-
textAlign
textAlign String
-
Aligns the columns cell content horizontally. Supported values: "start" | "center" | "end".
Possible Values:"start"|"center"|"end"
- Default Value:start
-
type
type Stringreadonly
-
The 'type' of column that the template represents.
Possible Values:"column"|"field"|"group"
-
visible
visible Boolean
-
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
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.