require(["esri/popup/support/FieldInfoFormat"], (FieldInfoFormat) => { /* code goes here */ });
import FieldInfoFormat from "@arcgis/core/popup/support/FieldInfoFormat.js";
esri/popup/support/FieldInfoFormat
The FieldInfoFormat
class is used with numerical or date fields to provide more detail
about how the value should be displayed in a popup. Use this class in place of the legacy
formatting functions: DateString
, DateFormat
, and/or NumberFormat
.
When formatting Number
fields, you must set both the digitSeparator
and places
properties for the formatting to take effect.
- 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 |
---|---|---|---|
Used only with | FieldInfoFormat | ||
The name of the class. | Accessor | ||
Used only with | FieldInfoFormat | ||
Used only with | FieldInfoFormat |
Property Details
-
dateFormat
dateFormat String
-
Used only with
Date
fields. Specifies how the date should appear in a popup.Possible Values
Format Date Formatting short-date 12/31/1969 short-date-short-time 12/31/1969, 7:00 PM short-date-short-time-24 12/31/1969, 19:00 short-date-long-time 12/31/1969, 7:00:00 PM short-date-long-time-24 12/31/1969, 19:00:00 long-month-day-year December 31, 1969 long-month-day-year-short-time December 31, 1969, 7:00 PM long-month-day-year-short-time-24 December 31, 1969, 19:00 long-month-day-year-long-time December 31, 1969, 7:00:00 PM long-month-day-year-long-time-24 December 31, 1969, 19:00:00 day-short-month-year Dec 31, 1969 day-short-month-year-short-time Dec 31, 1969, 7:00 PM day-short-month-year-short-time-24 Dec 31, 1969, 19:00 day-short-month-year-long-time Dec 31, 1969, 7:00:00 PM day-short-month-year-long-time-24 Dec 31, 1969, 19:00:00 long-date Wednesday, December 31, 1969 long-date-short-time Wednesday, December 31, 1969, 7:00 PM long-date-short-time-24 Wednesday, December 31, 1969, 19:00 long-date-long-time Wednesday, December 31, 1969, 7:00:00 PM long-date-long-time-24 Wednesday, December 31, 1969, 19:00:00 long-month-year December 1969 short-month-year Dec 1969 year 1969 - The
time-only
date fields will only honor the time component (i.e. ShortTime, ShortTime24, LongTime or LongTime24) in a dateFormat. Date formats without a time component are not supported by time-only fields. - Starting with version 4.28,
date
fields are formatted using theshort-date-short-time
format rather thanlong-month-day-year
in popup templates created with thecreatePopupTemplate()
method. This is also the case for default popup templates created by setting thedefaultPopupTemplateEnabled
property totrue
on the Popup, Features, or Feature widgets. For example, previously a date that may have appeared as"December 30, 1997"
will now appear as"12/30/1997 6:00 PM"
. 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") }` } }] };
Possible Values:"short-date" |"short-date-short-time" |"short-date-short-time-24" |"short-date-long-time" |"short-date-long-time-24" |"short-date-le" |"short-date-le-short-time" |"short-date-le-short-time-24" |"short-date-le-long-time" |"short-date-le-long-time-24" |"long-month-day-year" |"long-month-day-year-short-time" |"long-month-day-year-short-time-24" |"long-month-day-year-long-time" |"long-month-day-year-long-time-24" |"day-short-month-year" |"day-short-month-year-short-time" |"day-short-month-year-short-time-24" |"day-short-month-year-long-time" |"day-short-month-year-long-time-24" |"long-date" |"long-date-short-time" |"long-date-short-time-24" |"long-date-long-time" |"long-date-long-time-24" |"long-month-year" |"short-month-year" |"year"
- See also
- The
-
digitSeparator
digitSeparator Boolean
-
Used only with
Number
fields. A value oftrue
indicates the number should have a digit (or thousands) separator when the value appears in popups. A value offalse
means that no separator will be used.- Default Value:false
-
places
places Number
-
Used only with
Number
fields to specify the number of supported decimal places that should appear in popups. Any places beyond this value are rounded.
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
this | Creates a deep clone of this object. | FieldInfoFormat | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | FieldInfoFormat | |
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. | FieldInfoFormat |
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 deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
ReturnsType Description this A deep clone of the class instance that invoked this method.
-
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.