Fields
require(["esri/support/ContentElement/Fields"], function(FieldsContentElement) { /* code goes here */ });
esri/support/ContentElement/Fields
A FieldsContentElement
represents fieldInfo associated with a feature. If this is not set within the content, it will revert to whatever may be set within the PopupTemplate.Fieldinfo property.
- See also:
// Create the FieldsInfo for the Fields Content Element
// Field Info 1
let fieldInfo2 = 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 fieldInfo4 = new FieldInfo({
fieldName: "BLOCKCE10",
visible: true,
label: "Block"
});
// Create the Fields Content Element
let fieldsElement = new FieldsContentElement({
fieldInfos: [fieldInfo1, fieldInfo2]
});
Constructors
- new Fields(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 | |
FieldInfo[] | Object array of fieldInfos. more details | more details | Fields | |
String | The type of popup element displayed. more details | more details | Fields |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className
.
- fieldInfosFieldInfo[]autocast
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Fields | Creates a deep clone of the FieldsContentElement class. more details | more details | Fields | |
* | 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 | Fields | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Fields |
Method Details
- clone(){Fields}
Creates a deep clone of the FieldsContentElement class.
Returns:Type Description Fields A 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 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.