FieldInfoFormat

AMD: require(["esri/popup/support/FieldInfoFormat"], (FieldInfoFormat) => { /* code goes here */ });
ESM: import FieldInfoFormat from "@arcgis/core/popup/support/FieldInfoFormat";
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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

Used only with Date fields.

more details
FieldInfoFormat
String

The name of the class.

more details
Accessor
Boolean

Used only with Number fields.

more details
FieldInfoFormat
Number

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

more details
FieldInfoFormat

Property Details

dateFormat String

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

Possible Values

Format Date Formatting
default 12/31/1969, 19:00
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

Possible Values:"default"|"short-date"|"short-date-short-time"|"short-date-short-time-24"|"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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
FieldInfoFormat

Creates a deep clone of the FieldInfoFormat class.

more details
FieldInfoFormat
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
FieldInfoFormat
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
FieldInfoFormat

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key 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(){FieldInfoFormat}

Creates a deep clone of the FieldInfoFormat class.

Returns
Type Description
FieldInfoFormat A 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 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.

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
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type 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)inherited
Since: ArcGIS API for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A 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");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.