Relationship
require(["esri/layers/support/Relationship"], function(Relationship) { /* code goes here */ });esri/layers/support/RelationshipDescribes 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.
- See also:
Constructors
- new Relationship(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The cardinality which specifies the number of objects in the origin FeatureLayer related to the number of objects in the destination FeatureLayer. more details | more details | Relationship | |
| String | The name of the class. more details | more details | Accessor | |
| Number | The unique ID for the relationship. more details | more details | Relationship | |
| String | The field used to establish the relate within the FeatureLayer. more details | more details | Relationship | |
| String | The name of the relationship. more details | more details | Relationship | |
| Number | The unique ID of the related FeatureLayer. more details | more details | Relationship |
Property Details
- cardinalityString
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.
Possible values: one-to-one | one-to-many | many-to-many
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className.
- idNumber
The unique ID for the relationship. These ids for the relationships the FeatureLayer participates in are listed in the ArcGIS Services directory.
- keyFieldString
The field used to establish the relate within the FeatureLayer.
- nameString
The name of the relationship.
The unique ID of the related FeatureLayer.