IFieldInfo

Interface

Defines how a field in the dataset participates (or does not participate) in a popup window.

Properties

Property Type Notes
fieldName Optional any

A string containing the field name as defined by the service. Anywhere that a fieldname is referenced as {field-name} in popupInfo, an Arcade expression can also be referenced as{expression/}`.

format Optional IFieldFormat

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.

isEditable Optional boolean

A Boolean determining whether users can edit this field. Not applicable to Arcade expressions.

label Optional string

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.

stringFieldOption Optional "textbox" | "textarea" | "richtext"

A string determining what type of input box editors see when editing the field. Applies only to string fields. Not applicable to Arcade expressions.

tooltip Optional string

A string providing an editing hint for editors of the field. Not applicable to Arcade expressions.

visible Optional boolean

A Boolean determining whether the field is visible in the popup window.


Interface defined in packages/arcgis-rest-common-types/src/webmap.ts:57