Skip to main content

ICluster interface

📖 Description​

Interface that describes a cluster within the form definition.

tip

See the form definition interface for more information about clusters.

📃 Type declaration​

interface ICluster {
  id: string;Readonly
  type?: "nest" | "branch";ReadonlyOptional
  name?: string;ReadonlyOptional
  nodes?: INode[];ReadonlyOptional
  branches?: IBranch[];ReadonlyOptional
  reference?: string;ReadonlyOptional
  version?: string;ReadonlyOptional
  alias?: string;ReadonlyOptional
  readonly?: true;ReadonlyOptional
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🗃ī¸ Properties​

🏷ī¸ alias​

Contains an alias for the cluster or subform.

Type​

string

🏷ī¸ branches​

Contains the branches of the cluster.

Type​

IBranch[]

🏷ī¸ id​

Specifies the unique identifier of the cluster.

Type​

string

🏷ī¸ name​

Specifies the name of the cluster.

Type​

string

🏷ī¸ nodes​

Contains the nodes of the cluster.

Type​

INode[]

🏷ī¸ readonly​

Specifies if the nested branch (subform) is read-only. In that case, the subform cannot be edited in the builder.

Type​

true

caution

Only define this property when the nested branch is read-only. If it's not read-only, omit the property.

🏷ī¸ reference​

Specifies a reference for a cluster that is a nested branch (subform). This property can be used to track the origin of a subform when it was loaded from an external source. For example, the identifier of a subform can be stored in this property.

Type​

string

tip

See the Subforms guide for more information.

🏷ī¸ type​

Specifies the cluster type. Can be one of the following values:

  • nest: This cluster forms a nested branch (subform);
  • branch: This cluster is used to construct a branch (the cluster cannot contain any nodes).

Type​

"nest" | "branch"

caution

For regular clusters, this property should be omitted. It is only there if a cluster forms a nest or is a branch.

🏷ī¸ version​

Specifies a version indicator for a cluster that is a nested branch (subform). This property can be used to track the origin of a subform when it was loaded from an external source. For example, the version number of a subform can be stored in this property.

Type​

string

tip

See the Subforms guide for more information.