Defines how a field in the dataset participates (or does not participate) in a popup window. Configuring fields should be handled using the fieldConfiguration objects specified via the associated layer's fieldConfigurations property, instead of the properties on this object. The properties on this object are retained for backward compatibility but behavior may change as the specification evolves.
Referenced by: popupElement fields, popupInfo
Properties
| Property | Details |
|---|---|
| fieldFormat | An object defining how to format date, time and number fields. This property is not supported in the context of popupInfo.fieldInfos. It is only supported in the context of fieldInfo objects defined in popupElement fields. The fieldFormat property is functionally equivalent to the fieldFormat property found in the fieldConfiguration object, and shares the same schema.Must be one of the following values: |
| fieldName | A string containing the field name as defined by the service. Anywhere that a field name is referenced as {field-name} in popupInfo, an Arcade expression can also be referenced as {expression/<expression-name>}. |
| format | A format object used with numerical or date fields to provide more detail about how the value should be displayed in a web map popup window. Deprecation notes: 1) In the context of popupInfo.fieldInfos, this property is deprecated in favor of using the fieldFormat property of the fieldConfiguration objects specified via the associated layer's fieldConfigurations property. 2) In the context of fieldInfos defined in popupElement fields, this property is deprecated in favor of the fieldFormat property listed above. |
| isEditable | A Boolean determining whether users can edit this field. Not applicable to Arcade expressions. |
| label | A string containing the field alias. This can be overridden by the web map author. Not applicable to Arcade expressions as title is used instead. This property is deprecated when used with popupInfo.fieldInfos. Instead, use the alias property from the associated field's fieldConfiguration object. |
| statisticType | Used in a 1:many or many:many relationship to compute the statistics on the field to show in the popup. Valid values: avg, count, max, min, stddev, sum, var |
| stringFieldOption | A string determining what type of input box editors see when editing the field. Applies only to string fields. Not applicable to Arcade expressions. Valid values:
|
| tooltip | A string providing an editing hint for editors of the field. Not applicable to Arcade expressions. |
| visible | A Boolean determining whether the field is visible in the popup window. |
Example
{
"fieldName": "relationships/2/Postcode",
"fieldFormat": {
"type": "number",
"style": "decimal",
"maximumFractionDigits": 2,
"useGrouping": "always"
},
"label": "Postcode",
"isEditable": false,
"visible": false,
"statisticType": "count",
"stringFieldOption": "textbox"
}