import Relationship from "@arcgis/core/layers/support/Relationship.js";const Relationship = await $arcgis.import("@arcgis/core/layers/support/Relationship.js");- Inheritance:
- Relationship→
Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.7
Describes a layer's relationship with another layer or table. These relationships are listed in the ArcGIS Services directory as described in the REST API documentation.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
| | ||
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| |
cardinality
- Type
- Cardinality
The cardinality which specifies the number of objects in the origin FeatureLayer related to the number of objects in the destination FeatureLayer. Please see the Desktop help for additional information on cardinality.
composite
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.16
Indicates whether the relationship is composite. In a composite relationship, a destination object cannot exist independently of its origin object.
id
- Type
- number
The unique ID for the relationship. These ids for the relationships the FeatureLayer participates in are listed in the ArcGIS Services directory.
relationshipTableId
- Type
- number
- Since
- ArcGIS Maps SDK for JavaScript 4.16
The relationship table id.
role
- Type
- Role
- Since
- ArcGIS Maps SDK for JavaScript 4.16
Indicates whether the table participating in the relationship is the origin or destination table.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- any
Returns a new instance of this class.
clone
- Signature
-
clone (): this
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
- Returns
- this
A deep clone of the class instance that invoked this method.
toJSON
- Signature
-
toJSON (): any
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
- Returns
- any
The ArcGIS portal JSON representation of an instance of this class.