FieldsContent | References | ArcGIS Maps SDK for JavaScript

import FieldsContent from "@arcgis/core/popup/content/FieldsContent.js";

Inheritance:: FieldsContent→Content→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.11

A FieldsContent popup element represents the FieldInfo associated with a feature. If the fieldInfos is not set, 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: format: {
    digitSeparator: true,
    places: 0
  },
  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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`FieldsContentProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`description`	`string \| null \| undefined`
`fieldInfos`	`FieldInfo[] \| null \| undefined`
`title`	`string \| null \| undefined`
`type` readonly	`"fields"`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

description

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.19

Describes the field's content in detail. Starting at version 4.30, the description supports rendering HTML.

fieldInfos

autocast Property

Type: FieldInfo[] | null | undefined

Array of fieldInfos. FieldInfos set within the FieldsContent take precedence over the PopupTemplate.fieldInfos. If the fieldInfos property is not provided directly within the content, the popup will display whatever is set in the PopupTemplate.fieldInfos.

title

Property

Type: string | null | undefined

Since: ArcGIS Maps SDK for JavaScript 4.19

Heading indicating what the field's content represents. Starting at version 4.30, the title supports rendering HTML.

type

readonly Property

Type: "fields"

The type of popup element displayed.

See also

Default value: "fields"

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): FieldsContent`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): FieldsContent

Creates a deep clone of the FieldsContent class.

Returns: FieldsContent
A deep clone of the FieldsContent instance.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.