ActionColumn

AMD: require(["esri/widgets/FeatureTable/ActionColumn"], (ActionColumn) => { /* code goes here */ });
ESM: import ActionColumn from "@arcgis/core/widgets/FeatureTable/ActionColumn.js";
Class: esri/widgets/FeatureTable/ActionColumn
Inheritance: ActionColumn Accessor Column
Since: ArcGIS Maps SDK for JavaScript 4.30

The ActionColumn class works with the FeatureTable and is designed specifically for displaying a singular Calcite Action component for each row in the table. These actions can be configured with a specific icon. The callback function is invoked whenever the action is clicked. Actions can be configured to dynamically display based on provided conditions.

featuretable action column

FeatureTable action column

See also

Constructors

ActionColumn

Constructor
new ActionColumn(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

Function invoked when an individual action is clicked or pressed.

ActionColumn

The name of the class.

Accessor

Indicates if the action should appear disabled.

ActionColumn

Icon used by each action.

ActionColumn

Property Details

callback

Property
callback ActionColumnCallback

Function invoked when an individual action is clicked or pressed.

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

disabled

Property
disabled ActionColumnDisabledFunction |Boolean

Indicates if the action should appear disabled. This prevents interaction with the specific action component. This property accepts a boolean or a function that returns a boolean, therefore making it possible to dynamically disable actions based on a condition (e.g. if a row is selected).

Default Value:null

icon

Property
icon String

Icon used by each action. Accepts Calcite UI icon strings.

Default Value:pencil
See also

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.

Accessor

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor

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();
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.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

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");

Type Definitions

ActionColumnCallback

Type Definition
ActionColumnCallback(params)

Function called when an action is clicked or pressed.

Parameters
Specification
params Object

An object containing information about the associated row and feature.

Specification
feature Graphic

A reference to the associated feature.

index Number

The index of the associated row.

native Event

A reference to the interaction event.

ActionColumnDisabledFunction

Type Definition
ActionColumnDisabledFunction(params){Boolean}

The function that is called when determining if an action should be disabled.

Parameters
Specification
params Object

An object containing information about an associated row and feature.

Specification
feature Graphic

The feature to use when determining if the action should be disabled.

index Number

The row's index position when determining if the action should be disabled.

Returns
Type Description
Boolean Indicates whether the action should be disabled.

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