fieldConfiguration

An object defining configuration for fields within a layer, including how to format date, time and number fields. It is also used to override default alias defined in the field schema. Setting properties within the field configuration object is the desired approach for formatting fields since the format property specified via popupInfo.fieldInfos is deprecated and will eventually be removed.

Referenced by: layerDefinition

Properties

Property	Details
alias	An alternate name for the field.
fieldFormat	An object defining how to format date, time and number fields. The fieldFormat property should be used in lieu of the deprecated format property specified via popupInfo.fieldInfos. Must be one of the following values: fieldFormatDateTime fieldFormatNumber
name	The name of the field this configuration applies to.

Field Configuration Example- Date and Time Format Example

This example shows how to define a field configuration for a layer that formats a date field.

{
  "name": "install_date",
  "alias": "Date of Installation",
  "fieldFormat": {
    "type": "date-time",
    "dateStyle": "short",
    "timeStyle": "medium"
  }
}

Field Configuration Example - Numeric Format Example

This example shows how to define a field configuration for a layer that formats a numeric field.

{
  "name": "hr_rate",
  "alias": "Hourly Rate",
  "fieldFormat": {
    "type": "number",
    "style": "decimal",
    "maximumFractionDigits": 2
  }
}