ESM: import FieldInfo from "@arcgis/core/popup/FieldInfo.js";
CDN: const FieldInfo = await $arcgis.import("@arcgis/core/popup/FieldInfo.js");
Class: @arcgis/core/popup/FieldInfo
Since: ArcGIS Maps SDK for JavaScript 4.11
Property Overview Any properties can be set, retrieved or listened to. See the Watch for changes topic.Show inherited properties Hide inherited properties
Property DetailsInherited
Property declaredClass Stringreadonly
The name of the class. The declared class name is formatted as esri.folder.className
.
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 as expression/percent-total
.
Class which provides formatting options for numerical or date fields and how they should display within a popup.
timestamp-offset
or date
type field in a Popup, Features, or Feature widget and the MapView has a timezone set other than unknown
, the abbreviated time zone suffix will be omitted from the attribute value. For example, the attribute value will display as 9/28/2014, 7:58 PM
. To display an abbreviated time zone suffix, see the Read more
section.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")
}`
}
}]
};
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")
}`
}
}]
};
timestamp-offset
fields to display in the MapView's time zone with an abbreviated time zone suffix, then the ChangeTimeZone
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 Boolean
A Boolean determining whether users can edit this field. This is not applicable to Arcade expressions.
A string containing the field alias. Not applicable to Arcade expressions as the title is used instead.
Used in a one:many
or many: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"
A string providing an editing hint for editors of the field. This is not applicable to Arcade expressions.
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
and Shape__Length
are two fields that no longer display.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();
Parameters
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 deep clone of the FieldInfo class.
Returns
Type Description FieldInfo A deep clone of the FieldInfo instance.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.
Returns
Type Description * | null | undefined Returns a new instance of this class.Inherited
Method hasHandles(groupKey){Boolean}
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.
Returns true if a named group of handles exist.
Parameter
groupKey *
optionalA group key.
Returns
Type Description Boolean Returnstrue
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
Method removeHandles(groupKey)
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.
Removes a group of handles owned by the object.
Parameter
groupKey *
optionalA group key or an array or collection of group keys to remove.
Example
obj.removeHandles(); // removes handles from default group
obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4