UIControl
ClassClass in the Lens Scripting API.
- Available on all platforms
Platform details: Snapchat, SPECS, Camera Kit Web, Camera Kit Mobile fully supported.
TypeScript only
Index
Properties
Methods
Constructors
Constructor
new UIControl():
UIControl
Returns
UIControl
Properties
hint
protectedhint:string
label
protectedlabel:string
showIf
protectedshowIf:string
showIfValue
protectedshowIfValue:string|number|boolean
widget
protectedwidget:UIWidget
Methods
addExportRequired()
addExportRequired(
exportRequired):this
Parameters
| Parameter | Type |
|---|---|
exportRequired | boolean |
Returns
this
addHint()
addHint(
hint):this
Parameters
| Parameter | Type |
|---|---|
hint | string |
Returns
this
addLabel()
addLabel(
label):this
Parameters
| Parameter | Type |
|---|---|
label | string |
Returns
this
addShowIf()
addShowIf(
showIf,showIfValue?):this
Parameters
| Parameter | Type |
|---|---|
showIf | string |
showIfValue? | string | number | boolean |
Returns
this
addWidget()
addWidget(
widget):this
Parameters
| Parameter | Type |
|---|---|
widget | UIWidget |
Returns
this
getShowIf()
getShowIf():
string
Returns
string
getShowIfValue()
getShowIfValue():
string|number|boolean
Returns
string | number | boolean
toString()
toString():
string
Returns
string
Nested types
Classes
| Class | Description |
|---|---|
| ColorWidget | - |
| ComboBoxItem | - |
| ComboBoxWidget | - |
| SliderWidget | - |
| SpinBoxWidget | - |
| TextAreaWidget | - |
| UIWidget | - |