RelationshipColumn | API Reference | ArcGIS Maps SDK for JavaScript 4.31

The RelationshipColumn class works with the FeatureTable to display any associated related records for each feature in the table. This column will only be displayed if the related layer or table is also added to the map. If a feature has related records and the table is configured to enable related records, the count of related records is displayed in the cell. Whereas the cell is empty if the feature does not have related records. 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 relationship columns.

relationship columns

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Boolean	Indicates whether the column displays collapsed.	RelationshipColumn
String	The name of the class.	Accessor
String	The sanitized label displayed within the FeatureTable header for the relationship column.	RelationshipColumn
String	The Calcite Icon displayed within the FeatureTable header for the attachments column.	RelationshipColumn
FeatureLayer\|SceneLayer	The layer that contains the features being displayed in the table.	RelationshipColumn
Relationship	Returns the Relationship of the relatedlayer to find a relationship that has the same id as the relationshipId.	RelationshipColumn
FeatureLayer\|SceneLayer	The layer that contains the related features being displayed in the table.	RelationshipColumn
Relationship	Returns the first relationship from layer's`relationships` that matches the relationshipId.	RelationshipColumn
Number	The unique ID for the relationship.	RelationshipColumn
Number	Indicates whether the relationship column can be resized.	RelationshipColumn
String	The text alignment of the relationship column.	RelationshipColumn
Number\|String	Default width of the relationship column in pixels.	RelationshipColumn

Property Details

collapsed Property collapsed Boolean

Indicates whether the column displays collapsed. If collapsed, the header will always display as empty.

Default Value:false

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 relationship column. If the label is not provided, the name of the relationship is used. If the relationship name is not provided, the title of the related layer is used.

See also

icon Property icon String

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

Default Value:"link"

See also

Calcite Icon Search

layer Property layer FeatureLayer |SceneLayerreadonly

The layer that contains the features being displayed in the table.

originRelationship Property originRelationship Relationshipreadonly

Returns the Relationship of the relatedlayer to find a relationship that has the same id as the relationshipId.

relatedLayer Property relatedLayer FeatureLayer |SceneLayerreadonly

The layer that contains the related features being displayed in the table.

relationship Property relationship Relationshipreadonly

Returns the first relationship from layer's relationships that matches the relationshipId.

relationshipId Property relationshipId Numberreadonly

The unique ID for the relationship.

See also

Relationship.id

resizable Property resizable Numberreadonly

Indicates whether the relationship column can be resized. This is always set to true.

textAlign Property textAlign Stringreadonly

The text alignment of the relationship column.

width Property width Number |String

Default width of the relationship column in pixels.

Default Value:"200px"

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