Rating Question Schema Properties
A rating scale question (stars, smileys, or numeric scale).
Element type: rating
Key properties: 15
Generation Hints
Section titled “Generation Hints”- Aliases: star rating, satisfaction score, scale rating.
- Use when: collecting a bounded score or satisfaction rating.
- Recommended properties:
type,name,title,rateMin,rateMax,minRateDescription,maxRateDescription.
{ "type": "rating", "name": "satisfaction", "title": "How satisfied are you?", "rateMin": 1, "rateMax": 5 }Key Properties
Section titled “Key Properties”rateMin
Section titled “rateMin”- Type:
number - Default:
1
Specifies the first rate value in the generated sequence of rate values. Applies if the rateValues array is empty.
rateMax
Section titled “rateMax”- Type:
number - Default:
5
Specifies the last rate value in the generated sequence of rate values. Applies if the rateValues array is empty.
rateStep
Section titled “rateStep”- Type:
number - Default:
1
Specifies a step with which to generate rate values. Applies if the rateValues array is empty.
rateCount
Section titled “rateCount”- Type:
number - Default:
5
Specifies the number of rate values you want to generate. Applies if the rateValues array is empty.
rateValues
Section titled “rateValues”- Type:
ratingitem[] - Default:
[]
A list of rate values.
rateType
Section titled “rateType”- Type:
string - Default:
"labels" - Allowed values:
labels,stars,smileys
Specifies the visual representation of rate values.
displayMode
Section titled “displayMode”- Type:
string - Default:
"auto" - Allowed values:
auto,buttons,dropdown
Specifies whether to display rate values as buttons or items in a drop-down list.
autoGenerate
Section titled “autoGenerate”- Type:
string - Default:
true - Allowed values:
true,false
minRateDescription
Section titled “minRateDescription”- Type:
string - Default:
— - Localizable: Yes
Specifies a description for the minimum (first) rate value.
maxRateDescription
Section titled “maxRateDescription”- Type:
string - Default:
— - Localizable: Yes
Specifies a description for the maximum (last) rate value.
rateDescriptionLocation
Section titled “rateDescriptionLocation”- Type:
string - Default:
"leftRight" - Allowed values:
leftRight,top,bottom,topBottom
Specifies the alignment of minRateDescription and maxRateDescription texts.
displayRateDescriptionsAsExtremeItems
Section titled “displayRateDescriptionsAsExtremeItems”- Type:
boolean - Default:
false
Specifies whether to display minRateDescription and maxRateDescription values as captions for buttons that correspond to the extreme (first and last) rate values.
rateColorMode
Section titled “rateColorMode”- Type:
string - Default:
"scale" - Allowed values:
default,scale
Specifies how to colorize the selected emoji. Applies only if rateType is “smileys”.
scaleColorMode
Section titled “scaleColorMode”- Type:
string - Default:
"monochrome" - Allowed values:
monochrome,colored
Specifies how to colorize the smiley face rating scale. Applies only if rateType is “smileys”.
showCommentArea
Section titled “showCommentArea”- Type:
switch - Default:
—
Specifies whether to display a comment area.
Shared Properties
Section titled “Shared Properties”This page lists only properties that are specific to this element type or especially important for generation.
- Use Shared Question Properties for common fields such as
name,title,description,isRequired,requiredIf,visibleIf,enableIf,readOnly,defaultValue,validators,width, and layout options.