|
Add error into the question error list.
- Type:
-
(error: string | SurveyError) => void
- Parameters:
-
error, type: string | SurveyError
- Implemented in:
-
Question
|
|
Get is question ready to use
- Type:
-
() => void
- Implemented in:
-
Question
|
|
Call this function to clear all errors in the question
- Type:
-
() => void
- Implemented in:
-
Question
|
|
Call this function to remove values from the current question, that end-user will not be able to enter.
For example the value that doesn't exists in a radigroup/dropdown/checkbox choices or matrix rows/columns.
- Type:
-
() => void
- Implemented in:
-
Question
|
|
Clear the question value. It clears the question comment as well.
- Type:
-
() => void
- Implemented in:
-
Question
|
|
The correct answer on the question. Set this value if you are doing a quiz.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
any writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
- See also:
-
SurveyModel.correctAnswers
, SurveyModel.inCorrectAnswers
|
|
Returns all css classes that used for rendering the question. You may use survey.updateQuestionCssClasses event to override css classes for a question.
- Type:
-
any readonly
- Implemented in:
-
Question
- See also:
-
SurveyModel.updateQuestionCssClasses
|
|
Returns the validation errors count.
- Type:
-
number readonly
- Implemented in:
-
Question
|
|
The link to the custom widget.
- Type:
-
QuestionCustomWidget readonly
- Implemented in:
-
Question
|
|
Set the default value to the question. It will be assign to the question on loading the survey from JSON or adding a question to the survey or on setting this property of the value is empty.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
any writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
|
|
Question description location. By default, value is "default" and it depends on survey questionDescriptionLocation property
You may change it to "underInput" to render it under question input or "underTitle" to rendered it under title.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- default
- You may set the following values into this property:
-
default
, underInput
, underTitle
- Implemented in:
-
Question
- See also:
-
description
, Survey.questionDescriptionLocation
|
|
An expression that returns true or false. If it returns false the Question becomes read only and an end-user will not able to answer on the qustion. The library runs the expression on survey start and on changing a question value. If the property is empty then readOnly property is used.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
- See also:
-
readOnly
, isReadOnly
|
|
Move the focus to the input of this question.
- Type:
-
(onError?: boolean) => void
- Parameters:
-
onError, type: boolean
, set this parameter to true, to focus the input with the first error, other wise the first input will be focused.
- Implemented in:
-
Question
|
|
Returns the title after processing the question template.
- Type:
-
string readonly
- Implemented in:
-
Question
- See also:
-
SurveyModel.questionTitleTemplate
|
|
Returns a copy of question errors survey. For some questions like matrix and panel dynamic it includes the errors of nested questions.
- Type:
-
() => SurveyError[]
- Implemented in:
-
Question
|
|
Return the question value as a display text. For example, for dropdown, it would return the item text instead of item value.
- Type:
-
(keysAsText: boolean, value?: any) => any
- Parameters:
-
keysAsText, type: boolean
, Set this value to true, to return key (in matrices questions) as display text as well.
value, type: any
, use this parameter, if you want to get display value for this value and not question.value. It is undefined by default.
- Implemented in:
-
Question
|
|
Returns the current survey locale
- Type:
-
() => string
- Implemented in:
-
Question
- See also:
-
SurveyModel.locale
|
|
Returns question answer data as a plain object: with question title, name, value and displayValue.
For complex questions (like matrix, etc.) isNode flag is set to true and data contains array of nested objects (rows)
set options.includeEmpty to false if you want to skip empty answers
- Type:
-
(options?: { includeEmpty?: boolean; includeQuestionTypes?: boolean; calculations?: { propertyNam...
- Parameters:
-
options, type: { includeEmpty?: boolean; includeQuestionTypes?: boolean; calculations?: { propertyName: string; ...
- Implemented in:
-
Question
|
|
Return the title location based on question titleLocation property and QuestionTitleLocation of it's parents
- Type:
-
() => string
- Implemented in:
-
Question
- See also:
-
titleLocation
, PanelModelBase.QuestionTitleLocation
, SurveyModel.QuestionTitleLocation
|
|
Returns the type of the object as a string as it represents in the json.
- Type:
-
() => string
- Implemented in:
-
Question
|
|
Returns true if there is a validation error(s) in the question.
- Type:
-
(fireCallback?: boolean, rec?: any) => boolean
- Parameters:
-
fireCallback, type: boolean
, set it to true to show an error in UI.
rec, type: any
- Implemented in:
-
Question
|
|
Returns false if the question doesn't have an input element, for example: QuestionHtmlModel
- Type:
-
boolean readonly
- Implemented in:
-
Question
- See also:
-
hasSingleInput
|
|
Returns false if the question doesn't have an input element or have multiple inputs: matrices or panel dynamic
- Type:
-
boolean readonly
- Implemented in:
-
Question
- See also:
-
hasInput
|
|
Returns false if the question doesn't have a title property, for example: QuestionHtmlModel, or titleLocation property equals to "hidden"
- Type:
-
boolean readonly
- Implemented in:
-
Question
- See also:
-
titleLocation
|
|
Set hideNumber to true to stop showing the number for this question. The question will not be counter
- Type:
-
boolean writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
- See also:
-
visibleIndex
, titleLocation
|
|
The unique identificator. It is generated automatically.
- Type:
-
string writable
- Implemented in:
-
Question
|
|
Set it different from 0 to increase the left padding.
- Type:
-
number writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- You may set the following values into this property:
-
0
, 1
, 2
, 3
- Implemented in:
-
Question
|
|
Returns true if the question may have a title located on the left
- Type:
-
boolean readonly
- Implemented in:
-
Question
|
|
Returns true if the question value is empty
- Type:
-
() => boolean
- Implemented in:
-
Question
|
|
Returns true if readOnly property is true or survey is in display mode or parent panel/page is readOnly.
- Type:
-
boolean readonly
- Implemented in:
-
Question
- See also:
-
SurveyModel.model
, readOnly
|
|
Set this property to true, to make the question a required. If a user doesn't answer the question then a validation error will be generated.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
boolean writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
|
|
Returns true if the question is visible or survey is in design mode right now.
- Type:
-
boolean readonly
- Implemented in:
-
Question
|
|
The description of maximum (last) item.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
QuestionRatingModel
|
|
Use it to set the specific maxWidth constraint to the question like css style (%, px, em etc).
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- initial
- Implemented in:
-
Question
|
|
The description of minimum (first) item.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
QuestionRatingModel
|
|
Use it to set the specific minWidth constraint to the question like css style (%, px, em etc).
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- 300px
- Implemented in:
-
Question
|
|
Move question to a new container Page/Panel. Add as a last element if insertBefore parameter is not used or inserted into the given index,
if insert parameter is number, or before the given element, if the insertBefore parameter is a question or panel
- Type:
-
(container: IPanel, insertBefore?: any) => boolean
- Parameters:
-
container, type: IPanel
, Page or Panel to where a question is relocated.
insertBefore, type: any
, Use it if you want to set the question to a specific position. You may use a number (use 0 to insert int the beginning) or element, if you want to insert before this element.
- Implemented in:
-
Question
|
|
The property returns the question number. If question is invisible then it returns empty string.
If visibleIndex is 1, then no is 2, or 'B' if survey.questionStartIndex is 'A'.
- Type:
-
string readonly
- Implemented in:
-
Question
- See also:
-
SurveyModel.questionStartIndex
|
|
The event is fired when isReady property of question is changed.
options.question - the question
options.isReady - current value of isReady
options.oldIsReady - old value of isReady
- Type:
-
Event<(sender: Question, options: any) => any, any>
- Implemented in:
-
Question
|
|
Get/set the page where the question is located.
- Type:
-
IPage writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
|
|
A parent element. It can be panel or page.
- Type:
-
IPanel writable
- Implemented in:
-
Question
|
|
A parent question. It can be a dynamic panel or dynamic/dropdown matrices. If the value is a matrix, it means that question is a cell question.
This property is null for a stand alone question.
- Type:
-
Question readonly
- Implemented in:
-
Question
|
|
Returns the rendred question title.
- Type:
-
string readonly
- Implemented in:
-
Question
|
|
Returns questions count: 1 for the non-matrix questions and all inner visible questions that has input(s) widgets for question of matrix types.
- Type:
-
number readonly
- Implemented in:
-
Question
- See also:
-
getQuizQuestions
|
|
This property is used to generate rate values if rateValues array is empty. It is the last value in the rating. The default value is 5.
- Type:
-
number writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- 5
- Implemented in:
-
QuestionRatingModel
- See also:
-
rateValues
, rateMin
, rateStep
|
|
This property is used to generate rate values if rateValues array is empty. It is the first value in the rating. The default value is 1.
- Type:
-
number writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- 1
- Implemented in:
-
QuestionRatingModel
- See also:
-
rateValues
, rateMax
, rateStep
|
|
This property is used to generate rate values if rateValues array is empty. It is the step value. The number of rate values are (rateMax - rateMin) / rateStep. The default value is 1.
- Type:
-
number writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- 1
- Implemented in:
-
QuestionRatingModel
- See also:
-
rateValues
, rateMin
, rateMax
|
|
The list of rate items. Every item has value and text. If text is empty, the value is rendered. The item text supports markdown. If it is empty the array is generated by using rateMin, rateMax and rateStep properties.
- Type:
-
any[] writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- []
- Implemented in:
-
QuestionRatingModel
- See also:
-
rateMin
, rateMax
, rateStep
|
|
Remove a particular error from the question error list.
- Type:
-
(error: SurveyError) => void
- Parameters:
-
error, type: SurveyError
- Implemented in:
-
Question
|
|
The rendered width of the question.
- Type:
-
string writable
- Implemented in:
-
Question
|
|
The custom text that will be shown on required error. Use this property, if you do not want to show the default text.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
|
|
An expression that returns true or false. If it returns true the Question becomes required and an end-user has to answer it.
If it returns false the Question then an end-user may not answer it the Question maybe empty.
The library runs the expression on survey start and on changing a question value. If the property is empty then isRequired property is used.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
- See also:
-
isRequired
|
|
Returns the char/string for a required question.
- Type:
-
string readonly
- Implemented in:
-
Question
- See also:
-
SurveyModel.requiredText
|
|
Set it different from 0 to increase the right padding.
- Type:
-
number writable
- Implemented in:
-
Question
|
|
Run visibleIf and enableIf expressions. If visibleIf or/and enabledIf are not empty, then the results of performing the expression (true or false) set to the visible/readOnly properties.
- Type:
-
(values: HashTable<any>, properties: HashTable<any>) => void
- Parameters:
-
values, type: HashTable<any>
, Typically survey results
properties, type: HashTable<any>
- Implemented in:
-
Question
- See also:
-
visible
, visibleIf
, readOnly
, enableIf
|
|
The Question renders on the new line if the property is true. If the property is false, the question tries to render on the same line/row with a previous question/panel.
- Type:
-
boolean writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- True
- Implemented in:
-
Question
|
|
Question title. Use survey questionTitleTemplate property to change the title question is rendered. If it is empty, then question name property is used.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
- See also:
-
SurveyModel.questionTitleTemplate
|
|
Set this property different from "default" to set the specific question title location for this panel/page.
Please note, this property is hidden for questions without input, for example html question.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- default
- You may set the following values into this property:
-
default
, top
, bottom
, left
, hidden
- Implemented in:
-
Question
- See also:
-
SurveyModel.questionTitleLocation
|
|
Use it to choose how other question values will be rendered in title if referenced in .
Please note, this property is hidden for question without input, for example html question.
- Type:
-
boolean writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- True
- Implemented in:
-
Question
|
|
The list of question validators.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
SurveyValidator[] writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
|
|
Get/Set the question value.
- Type:
-
any writable
- Implemented in:
-
Question
- See also:
-
SurveyMode.setValue
, SurveyMode.getValue
|
|
Use this property if you want to store the question result in the name different from the question name.
Question name should be unique in the survey and valueName could be not unique. It allows to share data between several questions with the same valueName.
The library set the value automatically if the question.name property is not valid. For example, if it contains the period '.' symbol.
In this case if you set the question.name property to 'x.y' then the valueName becomes 'x y'.
Please note, this property is hidden for questions without input, for example html question.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
- See also:
-
name
|
|
Use it to get/set the question visibility.
- Type:
-
boolean writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- The default value is:
- True
- Implemented in:
-
Question
- See also:
-
visibleIf
|
|
An expression that returns true or false. If it returns true the Question becomes visible and if it returns false the Question becomes invisible. The library runs the expression on survey start and on changing a question value. If the property is empty then visible property is used.
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
- See also:
-
visible
|
|
Returns the visible index of the question in the survey. It can be from 0 to all visible questions count - 1
The visibleIndex is -1 if the title is 'hidden' or hideNumber is true
- Type:
-
number readonly
- Implemented in:
-
Question
- See also:
-
titleLocation
, hideNumber
|
|
Use it to set the specific width to the question like css style (%, px, em etc).
- Type:
-
string writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
- Implemented in:
-
Question
|