On this page

The hide attribute profile conditionally decides if a field/attribute should be shown in the Attributes Panel.

This profile can be used to hide fields when another condition is true. For example hiding certain fields which are not relevant to the type of feature being captured.

Profile variables

Variable Name	Type	Description
`$map`	FeatureSetCollection	The list of layers in the web map. Can be used with the `FeatureSetByName` or `FeatureSetById` function to get a particular layer in the map. This can then be queried.
`$userId`	Text	The unique user ID of the editor who is logged into the application.
`$userName`	Text	The full name of the editor who is logged into the application.
`$userIdentity`	Text	Provides a credential instance. This can be used when accessing external layers with the `FeatureLayer` function. The credentials represent the user’s logged in credentials.
`$session`	Dictionary	A dictionary containing key value pairs. The dictionary contains all the session variables that have been configured in the app. When the application first launches, the user will be asked for values for the session variables. They can also (if configured) change session variables in the application. This provides programmatic access to the user’s choices / settings.
`$editingLayer`	FeatureSet	The layer to which `$feature` belongs to. Can be queried to find other records.
`$feature`	Feature	The feature that has been edited, added or worked on.
`$value`	Any	The value to test in the script. Certain rules, such as the restrict domain values rule, pass in a value for the current field value.
`$parentFeature`	Feature	If there is a geographic contains relationship for the current feature being edited, this variable will contain the parent (or containing feature).
`$routeFeature`	Feature	If the feature is a linear referencing feature, this variable will reference source route/line feature.

Return types

Boolean

Value	Description
`true`	The attribute is hidden.
`false`	The attribute is shown.

Example

Hidden based on the value of another field:

/** Conditionally hide the display of a field.
 *
 *  When this script returns true, the field will be hidden. This example
 *  shows hiding a field when another attribute of the feature is of a
 *  specific value.
 *
 * @returns - (boolean)
 */

if ($feature.developmentType == "residential") {
  // hide the field
  return true;
} else {
  // the development type value is not residential, therefore display the field.
  return false;
}
false