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
-
new FieldInfo(properties)
-
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 |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String | The field name as defined by the service or the name of an Arcade expression. more details | FieldInfo | |
FieldInfoFormat | Class which provides formatting options for numerical or date fields and how they should display within a popup. more details | FieldInfo | |
Boolean | A Boolean determining whether users can edit this field. more details | FieldInfo | |
String | A string containing the field alias. more details | FieldInfo | |
String | Used in a | FieldInfo | |
String | A string determining what type of input box editors see when editing the field. more details | FieldInfo | |
String | A string providing an editing hint for editors of the field. more details | FieldInfo | |
Boolean | Indicates whether the field is visible in the popup window. more details | FieldInfo |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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 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.
-
isEditable Boolean
-
A Boolean determining whether users can edit this field. This is not applicable to Arcade expressions.
- Default Value:true
-
label String
-
A string containing the field alias. Not applicable to Arcade expressions as the title is used instead.
-
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 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 String
-
A string providing an editing hint for editors of the field. This is not applicable to Arcade expressions.
-
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. more details | Accessor | ||
FieldInfo | Creates a deep clone of the FieldInfo class. more details | FieldInfo | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | FieldInfo | |
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 | FieldInfo |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: 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 } ); 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.
-
clone(){FieldInfo}
-
Creates a deep clone of the FieldInfo class.
ReturnsType Description FieldInfo A deep clone of the FieldInfo 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.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.
-
Since: ArcGIS Maps SDK for JavaScript 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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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(){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.