AttributeTableRelationshipElement

AMD: require(["esri/tables/elements/AttributeTableRelationshipElement"], (AttributeTableRelationshipElement) => { /* code goes here */ });
ESM: import AttributeTableRelationshipElement from "@arcgis/core/tables/elements/AttributeTableRelationshipElement.js";
Class: esri/tables/elements/AttributeTableRelationshipElement
Inheritance: AttributeTableRelationshipElementAttributeTableElementAccessor
Since: ArcGIS Maps SDK for JavaScript 4.31

An AttributeTableRelationshipElement element defines how a relationship between layers and tables participates and displays within a FeatureTable.

See also

Constructors

AttributeTableRelationshipElement

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

The name of the class.

Accessor

The table element's description which provides the purpose behind it.

AttributeTableElement

A string value containing the field alias.

AttributeTableElement

The numeric id value for the defined relationship.

AttributeTableRelationshipElement

Indicates the type of attribute table element.

AttributeTableRelationshipElement

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.

description

Inherited
Property
description String
Inherited from AttributeTableElement

The table element's description which provides the purpose behind it.

label

Inherited
Property
label String
Inherited from AttributeTableElement

A string value containing the field alias.

relationshipId

Property
relationshipId Number

The numeric id value for the defined relationship. This value can be found on the service itself or on the service's relationships resource if supportsRelationshipResource is true.

type

Property
type Stringreadonly

Indicates the type of attribute table element.

For AttributeTableRelationshipElement the type is always "relationship".

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

Creates a deep clone of the AttributeTableRelationshipElement class.

AttributeTableRelationshipElement
*

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

AttributeTableElement

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

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

AttributeTableElement

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.

clone

Method
clone(){AttributeTableRelationshipElement}

Creates a deep clone of the AttributeTableRelationshipElement class.

Returns
Type Description
AttributeTableRelationshipElement A deep clone of the AttributeTableRelationshipElement instance.

fromJSON

Inherited
Method
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

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

toJSON

Inherited
Method
toJSON(){Object}
Inherited from AttributeTableElement

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.