Configuration options for configuring grouped fields.
Constructors
-
new FieldGroupConfig(properties)
-
Parameterproperties 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 | The name of the class. more details | Accessor | |
String | The field's description. more details | FieldGroupConfig | |
FieldConfig[] | An array of field configurations belonging to a group. more details | FieldGroupConfig | |
String | The field's label. more details | FieldGroupConfig | |
String | An Arcade expression following the specification defined by the Constraint Arcade Profile. more details | FieldGroupConfig |
Property Details
-
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 or Editor widgets, 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 StringSince: ArcGIS Maps SDK for JavaScript 4.11Deprecated since version 4.23. Set fields via the GroupElement.visibilityExpression
-
An Arcade expression following the specification defined by the Constraint Arcade Profile. Expressions may reference field values using the
$feature
profile variable and must return eithertrue
orfalse
.When this expression evaluates to
true
, the element is displayed. When the expression evaluates tofalse
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
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)))" }]
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
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 |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK 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 } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");