ja-set-state

Sub Schemas

The schema defines the following additional types:

JASetStateOnButtonConfig (action.set-state)

Properties of the JASetStateOnButtonConfig object:

instanceId (InstanceId | Expression)

when (Expression | boolean)

When the property is set to 'false', the action will not execute. Default is 'true'.

options (Set State Action Options, required)

Options related to Jig Actions on bottom panel

Properties of the options object:

title (string | Expression | TextWithFormat | TextLocale, required)

Title of action displayed on a button.

icon (icon-name | string)

Icon of action displayed on a button.

The object must be any of the following types:

icon (icon-name)

icon (string)

style (object)

More of them can be true. It will be evaluated based on priority.

isHidden (boolean | string)

Hides the button when true

The object must be any of the following types:

isHidden (string)

state (string, required)

Additional restrictions:

• Regex pattern: ^=@ctx\.solution\.state\.[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$

value (string | number | boolean | string, required)

The object must be any of the following types:

value (string)

JASetStateInBackgroundConfig (action.set-state)

Properties of the JASetStateInBackgroundConfig object:

instanceId (InstanceId | Expression)

when (Expression | boolean)

When the property is set to 'false', the action will not execute. Default is 'true'.

options (Set State Action Options, required)

Options related to Jig Actions on bottom panel

Properties of the options object:

state (string, required)

Additional restrictions:

• Regex pattern: ^=@ctx\.solution\.state\.[a-zA-Z][a-zA-Z0-9_-]{0,48}[a-zA-Z0-9]$

value (string | number | boolean | string, required)

The object must be any of the following types:

value (string)