RelatedRecordsInfo

require(["esri/popup/RelatedRecordsInfo"], function(RelatedRecordsInfo) { /* code goes here */ });
Class: esri/popup/RelatedRecordsInfo
Inheritance: RelatedRecordsInfo Accessor
Since: ArcGIS API for JavaScript 4.11

The RelatedRecordsInfo class provides additional sorting options when working with related records in a layer's PopupTemplate.

See also:

Constructors

new RelatedRecordsInfo(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
String

The name of the class.

more details
more detailsAccessor
RelatedRecordsInfoFieldOrder[]

An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending asc or descending desc order.

more details
more detailsRelatedRecordsInfo
Boolean

Indicates whether to display related records in the popup.

more details
more detailsRelatedRecordsInfo

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

An array of RelatedRecordsInfoFieldOrder objects indicating the field display order for the related records and whether they should be sorted in ascending asc or descending desc order.

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 detailsRelatedRecordsInfo
*

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

more details
more detailsRelatedRecordsInfo
Object

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

more details
more detailsRelatedRecordsInfo

Method Details

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 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.
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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.