Skip to main content

Cluster class

📖 Description​

The Cluster class represents a cluster (also known as a section in the builder UI) in the form definition.

🗃️ Fields​

🏷️ branches​

Retrieves the collection of child branches.

Type​

Branches

🏷️ enumerator​

Contains the cluster enumerator. This is a chronological number for each cluster. The first cluster has a enumerator value of 1.

Type​

number

🏷️ id​

Retrieves the identifier of the cluster.

Type​

string

🏷️ index​

Retrieves the zero-based index of the cluster in the Clusters collection.

Type​

number

🏷️ isEvaluating​

Retrieves if the cluster is evaluating.

Type​

boolean

🏷️ isFirst​

Retrieves if the cluster is the first cluster in the Clusters collection.

Type​

boolean

🏷️ isLast​

Retrieves if the cluster is the last cluster in the Clusters collection.

Type​

boolean

🏷️ props​

Retrieves the properties of the cluster.

Type​

ICluster

🏷️ runner​

Retrieves a reference to the RunnerFoundation instance.

Type​

RunnerFoundation

▶️ Methods​

🔧 getValidation​

Retrieves the validation state for the supplied context.

Signature​

getValidation(context: Context): "unknown" | "pass" | "fail"

Parameters​

NameTypeOptionalDescription
contextContextNoReference to the context.

Return value​

Returns the validation state of the cluster. It can be one of the following values:

  • unknown: There is no validation state available yet;
  • pass: Validation succeeded;
  • fail: Validation failed.