switchState

Changes the state of a layer.

Field Configurations

Key	Type	Description	Default Value
"params" (required)	Object	undefined	null

Parameters

Key	Type	Description	Default Value
"async"	Boolean	Specifies whether the action should perform asynchronously.	null
"layer" (required)	String	Name of the layer which should switch.	null
"states" (required)	Array	List of possible states to switch between.	null

Inherited

From Base Action

Base Action

Field Configurations

Key	Type	Description	Default Value
"dynamicParams"	Object	Dynamic params to retrieve data from a specific context e.g. a userSetting.	null
"leadingDelimiter"	String	The leading mustache delimiter to use.	null
"params"	Object,Array	Object containing the properties of the action.	null
"trailingDelimiter"	String	The trailing mustache delimiter to use.	null
"type"	String	Type name of the action.	null

Examples

Example 1: Switch the state of a layer

Goal: Show or hide a layer.

The state of the layer errorText should switch between hidden and visible.

{
  "type": "switchState",
  "params": {
    "layer": "errorText",
    "states": [
      "visible",
      "hidden"
    ]
  }
}

The actions to be executed are specified in the actions parameter, in this case a switchState action.

Result:

A switchState action has been created.