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

A FieldsContentElement represents the FieldInfo associated with a feature. If this is not set within the content, it will revert to whatever may be set within the PopupTemplate.fieldInfos property.

popuptemplate-fields-element

See also:
Example:
// Create the FieldsInfo for the FieldsContentElement
// Field Info 1
let fieldInfo1 = new FieldInfo({
  fieldName: "relationships/0/Point_Count_COMMON", // using a related table's field
  label: "Sum of species tree count",
  visible: true,
  format: fieldFormat2,
  statisticType: "sum"
});

// Field Info 2
let fieldInfo2 = new FieldInfo({
  fieldName: "BLOCKCE10",
  label: "Block",
  visible: true
});

// Create the FieldsContentElement
let fieldsElement = new FieldsContentElement({
  fieldInfos: [fieldInfo1, fieldInfo2]
});

Constructors

new Fields(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
FieldInfo[]

Object array of fieldInfos.

more details
more detailsFields
String

The type of popup element displayed.

more details
more detailsFields

Property Details

declaredClassStringreadonly inherited

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

Object array of fieldInfos. If the fieldInfos property is not provided directly within the content, the popup will display whatever is set in the PopupTemplate.fieldInfos.

typeStringreadonly

The type of popup element displayed.

Default Value:fields

Method Overview

NameReturn TypeSummaryClass
Fields

Creates a deep clone of the FieldsContentElement class.

more details
more detailsFields
*

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

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

more details
more detailsFields

Method Details

clone(){Fields}

Creates a deep clone of the FieldsContentElement class.

Returns:
TypeDescription
FieldsA deep clone of the FieldsContentElement 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...