|
|
addError
method
|
|
Add error into the question error list.
Type:
(error: SurveyError) => void
Parameters:
error, type: SurveyError
|
|
|
|
choicesLoaded
method
|
|
Get is question ready to use
Type:
() => void
|
|
|
|
clearErrors
method
|
|
Call this function to clear all errors in the question
Type:
() => void
|
|
|
|
clearIncorrectValues
method
|
|
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
|
|
|
cols
property
|
|
The html cols attribute.
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:
50
|
|
|
|
correctAnswer
property
|
|
The correct answer on the question. Set this value if you are doing a quiz.
Type:
any
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
cssClasses
property
|
|
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
|
|
|
|
currentErrorCount
property
|
|
Returns the validation errors count.
Type:
number
readonly
|
|
|
|
customWidget
property
|
|
The link to the custom widget.
Type:
QuestionCustomWidget
readonly
|
|
|
|
defaultValue
property
|
|
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.
Type:
any
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
description
property
|
|
Question description. It renders under question title by using smaller font. Unlike the title, description can be empty.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
descriptionLocation
property
|
|
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
|
|
|
|
enableIf
property
|
|
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.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
focus
method
|
|
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.
|
|
|
|
fullTitle
property
|
|
Returns the title after processing the question template.
Type:
string
readonly
|
|
|
|
getAllErrors
method
|
|
Returns a copy of question errors survey. For some questions like matrix and panel dynamic it includes the errors of nested questions.
Type:
() => SurveyError[]
|
|
|
|
getDisplayValue
method
|
|
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.
|
|
|
|
getLocale
method
|
|
Returns the current survey locale
Type:
() => string
|
|
|
|
getPlainData
method
|
|
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; calculations?: { propertyName: string; }[]; }) => any
Parameters:
options, type: { includeEmpty?: boolean; calculations?: { propertyName: string; }[]; }
|
|
|
|
getTitleLocation
method
|
|
Return the title location based on question titleLocation property and QuestionTitleLocation of it's parents
Type:
() => string
|
|
|
|
getType
method
|
|
Returns the type of the object as a string as it represents in the json.
Type:
() => string
|
|
|
|
hasErrors
method
|
|
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
|
|
|
|
hasInput
property
|
|
Returns false if the question doesn't have an input element, for example: QuestionHtmlModel
Type:
boolean
readonly
|
|
|
|
hasTitle
property
|
|
Returns false if the question doesn't have a title property, for example: QuestionHtmlModel, or titleLocation property equals to "hidden"
Type:
boolean
readonly
|
|
|
|
id
property
|
|
The unique identificator. It is generated automatically.
Type:
string
writable
|
|
|
|
indent
property
|
|
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
|
|
|
|
isAllowTitleLeft
property
|
|
Returns true if the question may have a title located on the left
Type:
boolean
readonly
|
|
|
|
isEmpty
method
|
|
Returns true if the question value is empty
Type:
() => boolean
|
|
|
|
isPanel
property
|
|
Always returns false.
Type:
boolean
readonly
|
|
|
|
isReadOnly
property
|
|
Retuns true if readOnly property is true or survey is in display mode or parent panel/page is readOnly.
Type:
boolean
readonly
|
|
|
|
isRequired
property
|
|
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.
Type:
boolean
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
isVisible
property
|
|
Returns true if the question is visible or survey is in design mode right now.
Type:
boolean
readonly
|
|
|
|
maxLength
property
|
|
The maximim text length. If it is -1, defaul value, then the survey maxTextLength property will be used.
If it is 0, then the value is unlimited
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
|
|
|
|
moveTo
method
|
|
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.
|
|
|
|
no
property
|
|
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
|
|
|
onReadyChanged
event
|
|
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>
|
|
|
|
page
property
|
|
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.
|
|
|
|
parent
property
|
|
A parent element. It can be panel or page.
Type:
IPanel
writable
|
|
|
|
placeHolder
property
|
|
Use this property to set the input place holder.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
processedTitle
property
|
|
Returns the rendred question title.
Type:
string
readonly
|
|
|
|
removeError
method
|
|
Remove a particular error from the question error list.
Type:
(error: SurveyError) => void
Parameters:
error, type: SurveyError
|
|
|
|
renderWidth
property
|
|
The rendered width of the question.
Type:
string
writable
|
|
|
|
requiredErrorText
property
|
|
The custom text that will be shown on required error. Use this property, if you do not want to show the default text.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
requiredIf
property
|
|
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.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
requiredText
property
|
|
Returns the char/string for a required question.
Type:
string
readonly
|
|
|
|
rightIndent
property
|
|
Set it different from 0 to increase the right padding.
Type:
number
writable
|
|
|
|
rows
property
|
|
The html rows attribute.
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:
4
|
|
|
|
runCondition
method
|
|
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>
|
|
|
|
startWithNewLine
property
|
|
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
|
|
|
|
title
property
|
|
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.
|
|
|
|
titleLocation
property
|
|
Set this property different from "default" to set the specific question title location for this panel/page.
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
|
|
|
|
useDisplayValuesInTitle
property
|
|
Use it to choose how other question values will be rendered in title if referenced in {}.
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
|
|
|
|
validators
property
|
|
The list of question validators.
Type:
SurveyValidator[]
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
value
property
|
|
Get/Set the question value.
Type:
any
writable
|
|
|
|
valueName
property
|
|
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'.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
visible
property
|
|
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
|
|
|
|
visibleIf
property
|
|
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.
|
|
|
|
visibleIndex
property
|
|
Returns the visible index of the question in the survey. It can be from 0 to all visible questions count - 1
Type:
number
readonly
|
|
|
|
width
property
|
|
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.
|
Please help us to improve our product