Skip To ContentArcGIS for DevelopersSign In Dashboard

FieldInfoFormat

require(["esri/popup/support/FieldInfoFormat"], function(FieldInfoFormat) { /* code goes here */ });
Class: esri/popup/support/FieldInfoFormat
Inheritance: FieldInfoFormat Accessor
Since: ArcGIS API for JavaScript 4.11

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:
Example:
let fieldInfo = new FieldInfo({
  fieldName: "PROMINENCE_ft",
  label: "Prominence (feet)",
  //autocasts to FieldInfo.Format
  format: {
    places: 0,
    digitSeparator: true
  }
};

Constructors

new FieldInfoFormat(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

Used only with Date fields.

more details
more detailsFieldInfoFormat
String

The name of the class.

more details
more detailsAccessor
Boolean

Used only with Number fields.

more details
more detailsFieldInfoFormat
Number

Used only with Number fields to specify the number of supported decimal places that should appear in popups.

more details
more detailsFieldInfoFormat

Property Details

dateFormat String

Used only with Date fields. Specifies how the date should appear in a popup.

Possible Values

FormatDate Formatting
default12/31/1969, 19:00
short-date12/31/1969
short-date-short-time12/31/1969, 7:00 PM
short-date-long-time12/31/1969, 7:00:00 PM
short-date-long-time-2412/31/1969, 19:00:00
long-month-day-yearDecember 31, 1969
long-month-day-year-short-timeDecember 31, 1969, 7:00 PM
long-month-day-year-short-time-24December 31, 1969, 19:00
long-month-day-year-long-timeDecember 31, 1969, 7:00:00 PM
long-month-day-year-long-time-24December 31, 1969, 19:00:00
day-short-month-yearDec 31, 1969
day-short-month-year-short-timeDec 31, 1969, 7:00 PM
day-short-month-year-short-time-24Dec 31, 1969, 19:00
day-short-month-year-long-timeDec 31, 1969, 7:00:00 PM
day-short-month-year-long-time-24Dec 31, 1969, 19:00:00
long-dateWednesday, December 31, 1969
long-date-short-timeWednesday, December 31, 1969, 7:00 PM
long-date-short-time-24Wednesday, December 31, 1969, 19:00
long-date-long-timeWednesday, December 31, 1969, 7:00:00 PM
long-date-long-time-24Wednesday, December 31, 1969, 19:00:00
long-month-yearDecember 1969
short-month-yearDec 1969
year1969

Possible Values:"default"|"short-date"|"short-date-short-time"|"short-date-long-time"|"short-date-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:
declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

digitSeparator Boolean

Used only with Number fields. A value of true indicates the number should have a digit (or thousands) separator when the value appears in popups. A value of false means that no separator will be used.

Default Value:false
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

NameReturn TypeSummaryClass
FieldInfoFormat

Creates a deep clone of the FieldInfoFormat class.

more details
more detailsFieldInfoFormat
*

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 detailsFieldInfoFormat
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsFieldInfoFormat

Method Details

Creates a deep clone of the FieldInfoFormat class.

Returns:
TypeDescription
FieldInfoFormatA deep clone of the FieldInfoFormat instance.
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 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.

Parameter:
json Object

A 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:
TypeDescription
*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() guide topic for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...