AttachmentsColumn | API Reference | ArcGIS Maps SDK for JavaScript 4.31

The AttachmentsColumn class works with the FeatureTable to display attachment counts for each feature in the table. If a feature has attachments and the table is configured to enable Attachments, the count is displayed in the cell. Whereas the cell is empty if the feature does not have attachments. This column is always appended to the end of the table.

This class should be used for observing potential changes. It is designed primarily to read and not interact directly with the attachment columns.

attachments columns

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String	The sanitized label displayed within the FeatureTable header for the attachments column.	AttachmentsColumn
String	The Calcite Icon displayed within the FeatureTable header for the attachments column.	AttachmentsColumn
CatalogFootprintLayer\|CSVLayer\|FeatureLayer\|GeoJSONLayer\|ImageryLayer\|KnowledgeGraphSublayer\|SceneLayer\|WFSLayer	The associated CatalogFootprintLayer, CSVLayer, FeatureLayer, GeoJSONLayer, ImageryLayer, KnowledgeGraphSublayer, SceneLayer, or WFSLayer containing the fields and attributes to display within the widget.	AttachmentsColumn
Boolean	Indicates whether the attachments column is sortable.	AttachmentsColumn
String	The text alignment of the attachments column.	AttachmentsColumn
Boolean	Attempts to display attachment thumbnail previews as images instead of generic icons.	thumbnailAppearance
Number	Controls the number of attachment thumbnail previews to display in each cell.	thumbnailCount
String	Controls the scale of attachment thumbnail icons.	thumbnailIconScale
Boolean	Controls if attachments thumbnail previews are rendered in each cell.	thumbnailsEnabled

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

effectiveLabel Property effectiveLabel Stringreadonly

The sanitized label displayed within the FeatureTable header for the attachments column.

See also

icon Property icon String

The Calcite Icon displayed within the FeatureTable header for the attachments column.

Default Value:"attachment"

See also

Calcite Icon Search

The associated CatalogFootprintLayer, CSVLayer, FeatureLayer, GeoJSONLayer, ImageryLayer, KnowledgeGraphSublayer, SceneLayer, or WFSLayer containing the fields and attributes to display within the widget.

sortable Property sortable Booleanreadonly

Indicates whether the attachments column is sortable.

textAlign Property textAlign Stringreadonly

The text alignment of the attachments column.

thumbnailAppearance Property thumbnailAppearance Booleaninner

Attempts to display attachment thumbnail previews as images instead of generic icons. Only applies if the attachment is an image, otherwise an icon is still used.

Default Value:true

thumbnailCount Property thumbnailCount Numberinner

Controls the number of attachment thumbnail previews to display in each cell.

Default Value:8

thumbnailIconScale Property thumbnailIconScale Stringinner

Controls the scale of attachment thumbnail icons. Does not apply to images.

Default Value:s

thumbnailsEnabled Property thumbnailsEnabled Booleaninner

Controls if attachments thumbnail previews are rendered in each cell. Otherwise, only the total attachment count is displayed.

Default Value:true

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Boolean	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");