FieldsContent

AMD: require(["esri/popup/content/FieldsContent"], (FieldsContent) => { /* code goes here */ });
ESM: import FieldsContent from "@arcgis/core/popup/content/FieldsContent";
Class: esri/popup/content/FieldsContent
Inheritance: FieldsContent Content Accessor
Since: ArcGIS Maps SDK for JavaScript 4.11

A FieldsContent popup element 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 FieldsContent popup element
// 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 FieldsContent element
let fieldsElement = new FieldsContent({
  fieldInfos: [fieldInfo1, fieldInfo2]
});

Constructors

new FieldsContent(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
Accessor
String

Describes the field's content in detail.

more details
FieldsContent
FieldInfo[]

Array of fieldInfos.

more details
FieldsContent
String

Heading indicating what the field's content represents.

more details
FieldsContent
String

The type of popup element displayed.

more details
FieldsContent

Property Details

declaredClass Stringreadonly inherited

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

description String
Since: ArcGIS Maps SDK for JavaScript 4.19

Describes the field's content in detail.

fieldInfos FieldInfo[]autocast

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.

title String
Since: ArcGIS Maps SDK for JavaScript 4.19

Heading indicating what the field's content represents.

type Stringreadonly

The type of popup element displayed.

For FieldsContent the type is always "fields".

Default Value:fields

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
FieldsContent

Creates a deep clone of the FieldsContent class.

more details
FieldsContent
*

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

more details
FieldsContent
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
FieldsContent

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone(){FieldsContent}

Creates a deep clone of the FieldsContent class.

Returns
Type Description
FieldsContent A deep clone of the FieldsContent 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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.