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

The FieldOrder class indicates the field display order for the related records in a layer's PopupTemplate.

See also:

Constructors

new FieldOrder(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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The attribute value of the field selected that will drive the sorting of related records.

more details
more detailsFieldOrder
String

Set the ascending or descending sort order of the returned related records.

more details
more detailsFieldOrder

Property Details

declaredClassStringreadonly inherited

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

fieldString

The attribute value of the field selected that will drive the sorting of related records.

orderString

Set the ascending or descending sort order of the returned related records.

Possible Values: asc | desc

Method Overview

NameReturn TypeSummaryClass
FieldOrder

Creates a deep clone of the FieldOrder class.

more details
more detailsFieldOrder
*

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 detailsFieldOrder
Object

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

more details
more detailsFieldOrder

Method Details

clone(){FieldOrder}

Creates a deep clone of the FieldOrder class.

Returns:
TypeDescription
FieldOrderA deep clone of the FieldOrder 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 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:
TypeDescription
*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() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...