The RelatedRecordsInfo class provides additional sorting options
when working with related records in a layer's PopupTemplate.
Constructors
-
new RelatedRecordsInfo(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 name of the class. more details | more details | Accessor | |
| RelatedRecordsInfoFieldOrder[] | An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending | more details | RelatedRecordsInfo | |
| Boolean | Indicates whether to display related records in the popup. more details | more details | RelatedRecordsInfo |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className.
-
orderByFields RelatedRecordsInfoFieldOrder[]autocast
-
An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending
ascor descendingdescorder.
-
showRelatedRecords Boolean
-
Indicates whether to display related records in the popup.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| RelatedRecordsInfo | Creates a deep clone of the RelatedRecordsInfo class. more details | more details | RelatedRecordsInfo | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | RelatedRecordsInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | RelatedRecordsInfo |
Method Details
-
clone(){RelatedRecordsInfo}
-
Creates a deep clone of the RelatedRecordsInfo class.
Returns:Type Description RelatedRecordsInfo A deep clone of the RelatedRecordsInfo instance.
-
fromJSON(json){*}static
-
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter 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 ObjectA 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.
-
toJSON(){Object}
-
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.