require(["esri/popup/FieldInfo"], (FieldInfo) => { /* code goes here */ });
import FieldInfo from "@arcgis/core/popup/FieldInfo.js";
esri/popup/FieldInfo
The FieldInfo
class defines how a Field participates,
or in some cases, does not participate, in a PopupTemplate.
- See also
let fieldInfo = new FieldInfo({
fieldName: 'PROMINENCE_ft',
label: 'Prominence (feet)',
//autocasts to FieldInfo.Format
format: {
places: 0,
digitSeparator: true
}
});
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The field name as defined by the service or the name of an Arcade expression. | FieldInfo | ||
Class which provides formatting options for numerical or date fields and how they should display within a popup. | FieldInfo | ||
A Boolean determining whether users can edit this field. | FieldInfo | ||
A string containing the field alias. | FieldInfo | ||
Used in a | FieldInfo | ||
A string determining what type of input box editors see when editing the field. | FieldInfo | ||
A string providing an editing hint for editors of the field. | FieldInfo | ||
Indicates whether the field is visible in the popup window. | FieldInfo |
Property Details
-
fieldName
fieldName String
-
The field name as defined by the service or the name of an Arcade expression. Arcade expression names are defined in the expressionInfos property of the PopupTemplate. When referencing Arcade expressions, you must preface the name with
expression/
, such asexpression/percent-total
.- See also
-
format
format FieldInfoFormat
-
Class which provides formatting options for numerical or date fields and how they should display within a popup.
- Set the popupTemplate.fieldInfos property for any fields that need to have number formatting for chart/text elements.
- If displaying a
timestamp-offset
ordate
type field in a Popup, Features, or Feature widget and the MapView has a timezone set other thanunknown
, the abbreviated time zone suffix will be omitted from the attribute value. For example, the attribute value will display as9/28/2014, 7:58 PM
. To display an abbreviated time zone suffix, see theRead more
section.
- If the user wants
date
fields to show a time zone suffix (e.g.9/28/2014, 7:58 PM PST
), then the Arcade Text function can be used to format the field value. This can be done either with ExpressionContent or attribute expressions.// Attribute expression using expressionInfos to append the time zone suffix to a date field. // Date field types will show in the MapView's current time zone. layer.popupTemplate = { title: "Display time zones", fieldInfos: [{ fieldName: "expression/date-with-time-zone-suffix", }], expressionInfos: [{ expression: `Text($feature.date_Field, "M/D/Y, h:mm A ZZZZ")`, name: "date-with-time-zone-suffix", }], content: [{ type: "fields" }] };
// ExpressionContent to append the time zone suffix to a date field. // Date field types will show in the MapView's current time zone by default. layer.popupTemplate = { title: "Display time zones", content: [{ type: "expression", expressionInfo: { expression: `return { type : 'text', text : Text($feature.date_Field, "M/D/Y, h:mm A ZZZZ") }` } }] };
- If the user wants
timestamp-offset
fields to display in the time zone from the server with an abbreviated time zone suffix, then the Arcade Text function can be used to format the field value. This can be done either with ExpressionContent or attribute expressions.// Attribute expression using expressionInfos to append the time zone suffix to a timestamp-offset field. layer.popupTemplate = { title: "Display time zones", fieldInfos: [{ fieldName: "expression/TSO-from-server", }], expressionInfos: [{ expression: `Text($feature.TimestampOffset_Field, "M/D/Y, h:mm A ZZZZ")`, name: "TSO-from-server", }], content: [{ type: "fields" }] };
// ExpressionContent to append the time zone suffix to a timestamp-offset field. layer.popupTemplate = { title: "Display time zones", content: [{ type: "expression", expressionInfo: { expression: `return { type : 'text', text : Text($feature.TimestampOffset_Field, "M/D/Y, h:mm A ZZZZ") }` } }] };
- If the user wants
timestamp-offset
fields to display in the MapView's time zone with an abbreviated time zone suffix, then theChangeTimeZone
Arcade function can be used to format the value.// Attribute expression using expressionInfos to append the MapView's current time zone suffix to a timestamp-offset field layer.popupTemplate = { title: "Display time zones", fieldInfos: [{ fieldName: "expression/TSO-matching-view-tz", }], expressionInfos: [{ expression: `Text(ChangeTimeZone($feature.TimestampOffset_Field, GetEnvironment().timeZone), "M/D/Y, h:mm A ZZZZ")`, name: "TSO-matching-view-tz", }], content: [{ type: "fields" }] };
// ExpressionContent to append the MapView's current time zone suffix to a timestamp-offset field layer.popupTemplate = { title: "Display time zones", content: [{ type: "expression", expressionInfo: { expression: `return { type: "text", text: Text(ChangeTimeZone($feature.TimestampOffset_Field, GetEnvironment().timeZone), "M/D/Y, h:mm A ZZZZ") }` } }] };
-
isEditable
isEditable Boolean
-
A Boolean determining whether users can edit this field. This is not applicable to Arcade expressions.
- Default Value:true
-
label
label String
-
A string containing the field alias. Not applicable to Arcade expressions as the title is used instead.
-
statisticType
statisticType String
-
Used in a
one:many
ormany:many
relationship to compute the statistics on the field to show in the popup. If the property is present, must be one of the following values:Possible Values:"count" |"sum" |"min" |"max" |"avg" |"stddev" |"var"
-
stringFieldOption
stringFieldOption String
-
A string determining what type of input box editors see when editing the field. Applies only to string fields. This is not applicable to Arcade expressions. If this property is present, it must be one of the following values:
Possible Values:"rich-text" |"text-area" |"text-box"
- Default Value:"text-box"
-
tooltip
tooltip String
-
A string providing an editing hint for editors of the field. This is not applicable to Arcade expressions.
-
visible
visible Boolean
-
Indicates whether the field is visible in the popup window.
As of version 4.16, the default Popup has been improved to no longer display system fields that do not hold significant value, e.g.
Shape__Area
andShape__Length
are two fields that no longer display.- Default Value:true
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of the FieldInfo class. | FieldInfo | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | FieldInfo | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | FieldInfo |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.