Format
require(["esri/support/FieldInfo/Format"], function(Format) { /* code goes here */ });esri/support/FieldInfo/FormatAn object used with numerical or date fields to provide more detail about how the value should be displayed in a popup.
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
- new Format(properties)
- Parameter:properties 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 | Used only with | more details | Format | |
| String | The name of the class. more details | more details | Accessor | |
| Boolean | Used only with | more details | Format | |
| Number | Used only with | more details | Format |
Property Details
- dateFormatString
Used only with
Datefields. Specifies how the date should appear in a popup.Possible Values: short-date | short-date-le | long-date | day-short-month-year | long-month-day-year | short-date-long-time | short-date-le-long-time | short-date-short-time | short-date-le-short-time | short-date-short-time-24 | short-date-le-short-time-24 | short-date-short-time-24 | short-date-le-short-time-24 | long-month-year | short-month-year | year
The name of the class. The declared class name is formatted as
esri.folder.className.
- digitSeparatorBoolean
Used only with
Numberfields. A value oftrueindicates the number should have a digit (or thousands) separator when the value appears in popups. A value offalsemeans that no separator will be used.- Default Value:false
- placesNumber
Used only with
Numberfields 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 | |
|---|---|---|---|---|
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | Format | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Format |
Method Details
- fromJSON(json){*}static
Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input
jsonparameter 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.Parameter:json 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.
Returns:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.