FieldGroupConfig

AMD: require(["esri/widgets/FeatureForm/FieldGroupConfig"], (FieldGroupConfig) => { /* code goes here */ });
ESM: import FieldGroupConfig from "@arcgis/core/widgets/FeatureForm/FieldGroupConfig";
Class: esri/widgets/FeatureForm/FieldGroupConfig
Inheritance: FieldGroupConfig Accessor
Since: ArcGIS API for JavaScript 4.10

Configuration options for configuring grouped fields.

If working in the FeatureForm widget, set the field configurations via FieldElement(s) or GroupElement(s) within the form's template elements.

Constructors

new FieldGroupConfig(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
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

The field's description.

more detailsFieldGroupConfig
FieldConfig[]more details

An array of field configurations belonging to a group.

more detailsFieldGroupConfig
Stringmore details

The field's label.

more detailsFieldGroupConfig
Stringmore details

A reference to an Arcade expression that returns a boolean value.

more detailsFieldGroupConfig

Property Details

declaredClass Stringreadonly inherited

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

description String

The field's description. The description is shown below the field.

fieldConfig FieldConfig[]autocast

An array of field configurations belonging to a group.

If working in the FeatureForm widget, set the field configurations via FieldElement(s) or GroupElement(s) within the form's template elements.

label String

The field's label. The label is shown above the field.

visibilityExpression String
Since: ArcGIS API for JavaScript 4.11

A reference to an Arcade expression that returns a boolean value. When this expression evaluates to true, the element is displayed. When the expression evaluates to false the element is not displayed. If no expression is provided, the default behavior is that the element is displayed. Care must be taken when defining a visibility expression for a non-nullable field i.e. to make sure that such fields either have default values or are made visible to users so that they can provide a value before submitting the form.

This only affects how the field is rendered. It does not have any impact on the attribute's values.

Default Value:null
See also:
Example:
// Array of two field configurations.
// The first one displays the feature's status whereas
// the second one only displays if the resolution of
// the issue if the status is "Completed"
// and the resolution value is not null.

fieldConfig: [{
  name: "status",
  editable: false, // not an editable field
  label: "Issue status",
  description: "E.g. submitted, received, in progress, or completed."
},{
  name: "resolution",
  label: "Resolution",
  editable: false,
  description: "Resolution if status is 'Completed'",
  visibilityExpression: "($feature.status == 'Completed') && (!(IsEmpty($feature.resolution)))"
}]

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