Skip to content

Rating

The rating is a component that allows you to enter a numerical value based on the number of ”★”.

Property

NoItemInput ValueDefault ValueAction PropertyTypeAction Default ValueDescription
1IDStringAuto-generatedidstringAuto-generatedThe [id] property cannot be set by actions.
2Label LStringRatinglabelstringRatingComponent label
3WidthNumber222widthnumber222Component width
4HeightNumber40heightnumber40Component height
5XNumberxnumberX coordinate position
6YNumberynumberY coordinate position
7SizeSelection
1. Small
2. Medium
3. Large
4. None
MediumsizestringmediumWhen a value other than None is selected, Font Size is disabled.
Added in v4.2.0.
8Font SizeNumber16fontSizenumber16Font size for label and stars.
Only effective when Size is set to None.
Added in v4.2.0.
9ColorString
Color Picker
colorstringComponent color
10Background ColorString
Color Picker
backgroundColorstringBackground color
11Label ColorString
Color Picker
labelColorstringLabel color
12DisabledBooleanOFFdisabledbooleanfalseDisabled state
13Read OnlyBooleanOFFreadOnlybooleanfalseRead-only state
14VisibilityBooleanONvisibilitybooleantrueComponent show/hide
15Horizontal AlignmentSelection
1. Left
2. Center
3. Right
LefthorizontalAlignmentstringleftHorizontal alignment
16Vertical AlignmentSelection
1. Top
2. Center
3. Bottom
TopverticalAlignmentstringtopVertical alignment
17Show LabelBooleanOFFshowLabelbooleanfalseLabel show/hide
18MaxNumber5maxnumber5Maximum rating value
19PrecisionNumber1precisionnumber1Minimum unit of rating
20Helper TextStringhelperTextstringHelper text
21ValueNumber5valuenumber5Rating value
22ErrorerrorbooleanfalseError state
23Change EventSelection
1. None
2. UI Script
3. Action
4. Detached Action
NoneEvent on value change
Detached Action became selectable in v4.1.0.
UI Script became selectable in v4.2.0.
24Detached ActionSelection
1. [Detached Action ID]
detachedActionstringSet a detached action
Added in v4.1.0.

Event

Event nameDescription
onchangeOccurs when a value change is made.