|
Add error into the question error list.
- Type:
-
(error: string | SurveyError) => void
- Parameters:
-
error, type: string | SurveyError
- Implemented in:
-
Question
|
|
- Type:
-
"true" | "false" readonly
- Implemented in:
-
Question
|
|
Get/set question value in 3 modes: indeterminate (value is empty), true (check is set) and false (check is unset).
- Type:
-
any writable
- Implemented in:
-
QuestionBooleanModel
- See also:
-
valueTrue *
, valueFalse
|
|
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
|
|
Gets or sets a value that specifies how invisible question clears the value. By default the behavior is define by Survey "clearInvisibleValues" property.
The following options are available:
default (default) - Survey "clearInvisibleValues" property defines the behavior.
none - do not clear invisible value.
onHidden - clear the question value when it becomes invisible. If a question has value and it was invisible initially then survey clears the value on completing.
onComplete - clear invisible question value on survey complete.
- Type:
-
string writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Default value:
- default
- Accepted values:
-
default
, none
, onComplete
, onHidden
- Implemented in:
-
Question
- See also:
-
SurveyModel.clearInvisibleValues *
, Question.visible *
, onComplete
|
|
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
|
|
Make a clone of the existing object. Create a new object of the same type and load all properties into it.
- Type:
-
() => Base
- Implemented in:
-
Base
|
|
- Type:
-
() => void
- Implemented in:
-
SurveyElement
- See also:
-
state
|
|
Returns true if a question or a container (panel/page) or their chidren have an error.
The value can be out of date. hasErrors function should be called to get the correct value.
- Type:
-
boolean readonly
- Implemented in:
-
SurveyElement
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
Question
- See also:
-
SurveyModel.getCorrectAnswerCount *
, SurveyModel.getInCorrectAnswerCount
|
|
Returns all css classes that used for rendering the question, panel or page.
You can use survey.onUpdateQuestionCssClasses event to override css classes for a question, survey.onUpdatePanelCssClasses event for a panel and survey.onUpdatePageCssClasses for a page.
- Type:
-
any readonly
- Implemented in:
-
SurveyElement
- See also:
-
SurveyModel.updateQuestionCssClasses *
, SurveyModel.updatePanelCssClasses *
, SurveyModel.updatePageCssClasses
|
|
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 state of the check: "indeterminate" - default (value is empty/null), "true" - value equals valueTrue or true, "false" - value equals valueFalse or false.
- Type:
-
any writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
QuestionBooleanModel
|
|
An expression used to calculate the defaultValue.
This expression applies until the question value is specified by an end user or programmatically.
An expression can reference other questions as follows:
{other_question_name}
{panel.other_question_name} (to access questions inside the same dynamic panel)
{row.other_question_name} (to access questions inside the same dynamic matrix or multi-column dropdown)
An expression can also include built-in and custom functions for advanced calculations. For example, if the defaultValue should be today's date, set the defaultValueExpression to "today()" , and the corresponding built-in function will be executed each time the survey is loaded. Refer to the following help topic for more information: Use Functions in Expressions.
- Type:
-
any writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
Question
- See also:
-
defaultValue
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Default value:
- default
- Accepted values:
-
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
Question
- See also:
-
readOnly *
, isReadOnly
|
|
The list of errors. It is created by callig hasErrors functions
- Type:
-
any writable
- Implemented in:
-
SurveyElement
- See also:
-
hasErrors
|
|
expand
method
|
|
- Type:
-
() => void
- Implemented in:
-
SurveyElement
- See also:
-
state
|
|
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
|
|
Load object properties and elements. It doesn't reset properties that was changed before and they are not defined in the json parameter.
- Type:
-
(json: any) => void
- Parameters:
-
json, type: any
, the object JSON definition
- Implemented in:
-
Base
- See also:
-
toJSON
|
|
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:
-
() => any
- 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:
-
SurveyElement
- 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?: any; }) => any
- Parameters:
-
options, type: { includeEmpty?: boolean; includeQuestionTypes?: boolean; calculations?: any; }
- Implemented in:
-
Question
|
|
Returns the serializable property that belongs to this instance by property name. It returns null if the property is not exists.
- Type:
-
(propName: string) => JsonObjectProperty
- Parameters:
-
propName, type: string
, property name
- Implemented in:
-
Base
|
|
Returns the property value by name
- Type:
-
(name: string, defaultValue?: any) => any
- Parameters:
-
name, type: string
, property name
defaultValue, type: any
- Implemented in:
-
Base
|
|
Returns the element template name without prefix. Typically it equals to getType().
- Type:
-
() => string
- Implemented in:
-
Base
- See also:
-
getType
|
|
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
|
|
Question, Panel and Page description. It renders under element title by using smaller font. Unlike the question title, description can be empty.
Please note, this property is hidden for questions without input, for example html question.
- Type:
-
boolean readonly
- Implemented in:
-
SurveyElementCore
- See also:
-
title
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
Question
- See also:
-
visibleIndex *
, titleLocation
|
|
The unique identificator. It is generated automatically.
- Type:
-
string writable
- Implemented in:
-
Question
|
|
The left indent. Set this property to increase the survey element left indent.
- Type:
-
number writable
- Implemented in:
-
SurveyElement
|
|
Returns true if the object is inluded into survey, otherwise returns false.
- Type:
-
boolean readonly
- Implemented in:
-
Base
|
|
Returns true if the question may have a title located on the left
- Type:
-
boolean readonly
- Implemented in:
-
Question
|
|
Returns true if the Element is in the collapsed state
- Type:
-
boolean readonly
- Implemented in:
-
SurveyElement
- See also:
-
state *
, collapse *
, isExpanded
|
|
Use this method to find out if the current instance is of the given typeName or inherited from it.
- Type:
-
(typeName: string) => boolean
- Parameters:
-
typeName, type: string
, One of the values listed in the [getType()](https://surveyjs.io/Documentation/Library?id=surveymodel#getType) description.
- Implemented in:
-
Base
- See also:
-
getType
|
|
Returns true if the question in design mode right now.
- Type:
-
boolean readonly
- Implemented in:
-
Base
|
|
Returns true if the question value is empty
- Type:
-
() => boolean
- Implemented in:
-
Question
|
|
isExpanded
property
|
|
Returns true if the Element is in the expanded state
- Type:
-
boolean readonly
- Implemented in:
-
SurveyElement
- See also:
-
state *
, expand *
, isCollapsed
|
|
Returns true if the question check will be rendered in indeterminate mode. value is empty.
- Type:
-
boolean readonly
- Implemented in:
-
QuestionBooleanModel
|
|
Returns true if the object is loading from Json at the current moment.
- Type:
-
boolean readonly
- Implemented in:
-
Base
|
|
Returns true if it is a page.
- Type:
-
boolean readonly
- Implemented in:
-
SurveyElement
|
|
Returns true if it is a panel.
- Type:
-
boolean readonly
- Implemented in:
-
SurveyElement
|
|
Return true if there is a parent (page or panel) and it is visible
- Type:
-
boolean readonly
- Implemented in:
-
Question
|
|
Returns true if it is a question.
- Type:
-
boolean readonly
- Implemented in:
-
SurveyElement
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
Question
|
|
Returns true if a value undefined, null, empty string or empty array.
- Type:
-
(value: any, trimString?: boolean) => boolean
- Parameters:
-
value, type: any
trimString, type: boolean
, a boolean parameter, default value true. If true then it trims the string and functions returns true for a string that contains white spaces only.
- Implemented in:
-
Base
|
|
Returns true if the question is visible or survey is in design mode right now.
- Type:
-
boolean readonly
- Implemented in:
-
Question
|
|
The checkbox label. If it is empty and showTitle is false then title is rendered
- Type:
-
string writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
QuestionBooleanModel
- See also:
-
showTitle *
, title
|
|
Set this property, if you want to have a different label for state when check is unset.
- Type:
-
any writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
QuestionBooleanModel
|
|
Set this property, if you want to have a different label for state when check is set.
- Type:
-
any writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
QuestionBooleanModel
|
|
Use it to set the specific maxWidth constraint to the survey element like css style (%, px, em etc).
- Type:
-
string writable
- Implemented in:
-
SurveyElement
|
|
Use it to set the specific minWidth constraint to the survey element like css style (%, px, em etc).
- Type:
-
string writable
- Implemented in:
-
SurveyElement
|
|
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
|
|
This is the identifier of a survey element - question or panel.
- Type:
-
string writable
- Implemented in:
-
SurveyElement
- See also:
-
valueName
|
|
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
|
|
Event that raised on changing property of the ItemValue object.
sender - the object that owns the property
options.propertyName - the property name to which ItemValue array is belong. It can be "choices" for dropdown question
options.obj - the instance of ItemValue object which property has been changed
options.name - the property of ItemObject that has been changed
options.oldValue - old value
options.newValue - new value
- Type:
-
Event<(sender: Base, options: any) => any, any>
- Implemented in:
-
Base
|
|
Event that raise on property change of the sender object
sender - the object that owns the property
options.name - the property name that has been changed
options.oldValue - old value. Please note, it equals to options.newValue if property is an array
options.newValue - new value.
- Type:
-
EventBase<Base>
- Implemented in:
-
Base
|
|
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:
-
EventBase<Question>
- Implemented in:
-
Question
|
|
Get/set the page where the question is located.
- Type:
-
IPage writable
This property is stored in the survey JSON definition and can be edited in the Survey 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
|
|
Set it to true to make an element question/panel/page readonly.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
boolean writable
- Implemented in:
-
SurveyElement
- See also:
-
enableIf *
, isReadOnly
|
|
Register a function that will be called on a property value changed from the names list.
- Type:
-
(names: any, func: any, key?: string) => void
- Parameters:
-
names, type: any
, the list of properties names
func, type: any
, the function with no parameters that will be called on property changed.
key, type: string
, an optional parameter. If there is already a registered function for this property with the same key, it will be overwritten.
- Implemented in:
-
Base
|
|
Register a function that will be called on a property value changed.
- Type:
-
(name: string, func: any, key?: string) => void
- Parameters:
-
name, type: string
, the property name
func, type: any
, the function with no parameters that will be called on property changed.
key, type: string
, an optional parameter. If there is already a registered function for this property with the same key, it will be overwritten.
- Implemented in:
-
Base
|
|
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:
-
SurveyElement
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey 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
This property is stored in the survey JSON definition and can be edited in the Survey 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
|
|
The right indent. Set it different from 0 to increase the right padding.
- Type:
-
number writable
- Implemented in:
-
SurveyElement
|
|
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
|
|
- Type:
-
(name: string, val: any) => void
- Parameters:
-
name, type: string
, property name
val, type: any
, new property value
- Implemented in:
-
Base
|
|
Set this property to true to show the question title. It is hidden by default.
- Type:
-
boolean readonly
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
QuestionBooleanModel
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Default value:
- True
- Implemented in:
-
Question
|
|
Set this property to "collapsed" to render only Panel title and expanded button and to "expanded" to render the collapsed button in the Panel caption
- Type:
-
string writable
- Implemented in:
-
SurveyElement
|
|
Returns the survey object.
- Type:
-
ISurvey readonly
- Implemented in:
-
SurveyElement
|
|
Question, Panel, Page and Survey title. If page and panel is empty then they are not rendered.
Question renders question name if the title is empty. Use survey questionTitleTemplate property to change the title question rendering.
- Type:
-
string writable
- Implemented in:
-
SurveyElementCore
- 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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Default value:
- default
- Accepted values:
-
default
, top
, bottom
, left
, hidden
- Implemented in:
-
Question
- See also:
-
SurveyModel.questionTitleLocation
|
|
- Type:
-
() => boolean
- Implemented in:
-
SurveyElement
- See also:
-
state
|
|
Deserialized the current object into JSON
- Type:
-
() => any
- Implemented in:
-
Base
- See also:
-
fromJSON
|
|
Unregister notification on property value changed for all properties in the names list.
- Type:
-
(names: any, key?: string) => void
- Parameters:
-
names, type: any
, the list of properties names
key, type: string
, the key with which you have registered the notification for this property. It can be null.
- Implemented in:
-
Base
|
|
Unregister notification on property value changed
- Type:
-
(name: string, key?: string) => void
- Parameters:
-
name, type: string
, the property name
key, type: string
, the key with which you have registered the notification for this property. It can be null.
- Implemented in:
-
Base
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Default value:
- True
- Implemented in:
-
Question
|
|
The list of question validators.
Please note, this property is hidden for question without input, for example html question.
- Type:
-
any writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
Question
|
|
Get/Set the question value.
- Type:
-
any writable
- Implemented in:
-
Question
- See also:
-
SurveyMode.setValue *
, SurveyMode.getValue
|
|
Set this property, if you want to have a different value from false when check is unset.
- Type:
-
any readonly
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
QuestionBooleanModel
|
|
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
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
Question
- See also:
-
name
|
|
Set this property, if you want to have a different value from true when check is set.
- Type:
-
any readonly
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Implemented in:
-
QuestionBooleanModel
|
|
Use it to get/set the question visibility.
- Type:
-
boolean writable
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
- Default value:
- 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
This property is stored in the survey JSON definition and can be edited in the Survey 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 survey element like css style (%, px, em etc).
- Type:
-
string writable
- Implemented in:
-
SurveyElement
|