Skip to content

Switch

The switch is a component that accepts a boolean value (true/false).

Property

NoItemInput ValueDefault ValueAction PropertyTypeAction Default ValueDescription
1IDStringAuto-generatedidstringAuto-generatedThe [id] property cannot be set by actions.
2Label LStringSwitchlabelstringSwitchComponent label
3WidthString222widthstring222Component width
4HeightString40heightstring40Component height
5XStringxstringX coordinate position
6YStringystringY coordinate position
7LockBooleanOFFlockbooleanfalseWhen ON, the component stays fixed even when the screen is scrolled.
When OFF, the component moves along with the screen scroll.
Added in v4.1.0.
8ColorString
Color Picker
colorstringComponent color
9Background ColorString
Color Picker
backgroundColorstringBackground color
10Label ColorString
Color Picker
labelColorstringLabel color
11DisabledBooleanOFFdisabledbooleanfalseDisabled state
12Read OnlyBooleanOFFreadOnlybooleanfalseRead-only state
13VisibilityBooleanONvisibilitybooleantrueComponent show/hide
14Horizontal AlignmentSelection
1. Left
2. Center
3. Right
LefthorizontalAlignmentstringleftHorizontal alignment
15Vertical AlignmentSelection
1. Top
2. Center
3. Bottom
TopverticalAlignmentstringtopVertical alignment
16Helper TextStringhelperTextstringHelper text
17ValueSelection
1.OFF
2.ON
ONvaluebooleantrueSwitch value
18ErrorerrorbooleanfalseError state
19Change EventSelection
1. None
2. Action
3. Detached Action
NoneEvent on value change
Detached Action became selectable in v4.1.0.
20Detached ActionSelection
1. [Detached Action ID]
detachedActionstringSet a detached action
Added in v4.1.0.

Event

Event nameDescription
onchangeOccurs when a value change is made.