|
|
addError
method
|
|
Add error into the question error list.
Type:
(error: SurveyError) => void
Parameters:
error, type: SurveyError
|
|
|
|
addPanel
method
|
|
Add a new dynamic panel based on the template Panel.
Type:
() => PanelModel
|
|
|
|
addPanelUI
method
|
|
Add a new dynamic panel based on the template Panel. It checks if canAddPanel returns true and then calls addPanel method.
Type:
() => PanelModel
|
|
|
allowAddPanel
property
|
|
Set this property to false to hide the 'Add New' button
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
|
|
|
|
allowRemovePanel
property
|
|
Set this property to false to hide the 'Remove' button
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
|
|
|
|
canAddPanel
property
|
|
Returns true when an end user may add a new panel. The question is not read only and panelCount less than maxPanelCount
Type:
boolean
readonly
|
|
|
|
canRemovePanel
property
|
|
Returns true when an end user may remove a panel. The question is not read only and panelCount is more than minPanelCount
Type:
boolean
readonly
|
|
|
|
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
|
|
|
|
confirmDelete
property
|
|
Set it to true, to show a confirmation dialog on removing a panel
Type:
boolean
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
confirmDeleteText
property
|
|
Use this property to change the default text showing in the confirmation delete dialog on removing a panel.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
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
|
|
|
|
currentIndex
property
|
|
The index of current active dynamical panel when the renderMode is not "list". If there is no dymamic panel (panelCount = 0) or renderMode equals "list" it returns -1, otherwise it returns a value from 0 to panelCount - 1.
Type:
number
writable
|
|
|
|
currentPanel
property
|
|
The current active dynamical panel when the renderMode is not "list". If there is no dymamic panel (panelCount = 0) or renderMode equals "list" it returns null.
Type:
PanelModel
readonly
|
|
|
|
customWidget
property
|
|
The link to the custom widget.
Type:
QuestionCustomWidget
readonly
|
|
|
|
defaultPanelValue
property
|
|
If it is not empty, then this value is set to every new panel, including panels created initially, unless the defaultValue is not empty
Type:
any
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
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.
|
|
|
|
defaultValueFromLastPanel
property
|
|
Set it to true to copy the value into new added panel from the last panel. If defaultPanelValue is set and this property equals to true,
then the value for new added panel is merging.
Type:
boolean
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
|
|
|
|
goToNextPanel
method
|
|
Goes to the next panel in the PanelDynamic
Type:
() => void
|
|
|
|
goToPrevPanel
method
|
|
Goes to the previous panel in the PanelDynamic
Type:
() => void
|
|
|
|
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
|
|
|
|
isNextButtonShowing
property
|
|
Returns true when currentIndex is more than or equal 0 and less then panelCount - 1.
Type:
boolean
readonly
|
|
|
|
isPanel
property
|
|
Always returns false.
Type:
boolean
readonly
|
|
|
|
isPrevButtonShowing
property
|
|
Returns true when currentIndex is more than 0.
Type:
boolean
readonly
|
|
|
|
isProgressBottomShowing
property
|
|
Returns true when the renderMode equals to "progressBottom" or "progressTopBottom"
Type:
boolean
readonly
|
|
|
|
isProgressTopShowing
property
|
|
Returns true when the renderMode equals to "progressTop" or "progressTopBottom"
Type:
boolean
readonly
|
|
|
|
isRangeShowing
property
|
|
Returns true when showRangeInProgress equals to true, renderMode doesn't equal to "list" and panelCount is >= 2.
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
|
|
|
|
isRenderModeList
property
|
|
Returns true when renderMode equals to "list".
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
|
|
|
|
keyDuplicationError
property
|
|
The duplication value error text. Set it to show the text different from the default.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
keyName
property
|
|
Set it to a question name used in the template panel and the library shows duplication error, if there are same values in different panels of this question.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
maxPanelCount
property
|
|
The maximum panel count. A user could not add a panel if the panelCount equals to maxPanelCount
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:
100
|
|
|
|
minPanelCount
property
|
|
The minimum panel count. A user could not delete a panel if the panelCount equals to minPanelCount
Type:
number
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
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.
|
|
|
|
panelAddText
property
|
|
Use this property to change the default value of add panel button text.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
panelCount
property
|
|
Use this property to get/set the number of dynamic panels.
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
, 4
, 5
, 6
, 7
, 8
, 9
, 10
|
|
|
|
panelNextText
property
|
|
Use this property to change the default next button text. Next button shows the next panel, change the currentPanel, when the renderMode doesn't equal to "list".
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
panelPrevText
property
|
|
Use this property to change the default previous button text. Previous button shows the previous panel, change the currentPanel, when the renderMode doesn't equal to "list".
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
panelRemoveText
property
|
|
Use this property to change the default value of remove panel button text.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
panels
property
|
|
The array of dynamic panels created based on panel template
Type:
PanelModel[]
readonly
|
|
|
|
panelsState
property
|
|
Use this property to allow the end-user to collapse/expand the panels. It works only if the renderMode property equals to "list" and templateTitle property is not empty. The following values are available:
default - the default value. User can't collpase/expand panels
expanded - User can collpase/expand panels and all panels are expanded by default
collapsed - User can collpase/expand panels and all panels are collapsed by default
firstExpanded - User can collpase/expand panels. The first panel is expanded and others are collapsed
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
, collapsed
, expanded
, firstExpanded
|
|
|
|
parent
property
|
|
A parent element. It can be panel or page.
Type:
IPanel
writable
|
|
|
|
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
|
|
|
|
removePanel
method
|
|
Removes a dynamic panel from the panels array.
Type:
(value: any) => void
Parameters:
value, type: any
, a panel or panel index
|
|
|
|
removePanelUI
method
|
|
Call removePanel function. Do nothing is canRemovePanel returns false. If confirmDelete set to true, it shows the confirmation dialog first.
Type:
(value: any) => void
Parameters:
value, type: any
, a panel or panel index
|
|
|
|
renderMode
property
|
|
By default the property equals to "list" and all dynamic panels are rendered one by one on the page. You may change it to: "progressTop", "progressBottom" or "progressTopBottom" to render only one dynamic panel at once. The progress and navigation elements can be rendred on top, bottom or both.
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:
list
You may set the following values into this property:
list
, progressTop
, progressBottom
, progressTopBottom
|
|
|
|
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
|
|
|
|
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>
|
|
|
|
showQuestionNumbers
property
|
|
Use this property to show/hide the numbers in titles in questions inside a dynamic panel.
By default the value is "off". You may set it to "onPanel" and the first question inside a dynamic panel will start with 1 or "onSurvey" to include nested questions in dymamic panels into global survey question numbering.
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:
off
You may set the following values into this property:
off
, onPanel
, onSurvey
|
|
|
|
showRangeInProgress
property
|
|
Shows the range from 1 to panelCount when renderMode doesn't equal to "list". Set to false to hide this element.
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
|
|
|
|
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
|
|
|
|
template
property
|
|
The template Panel. This panel is used as a template on creatign dynamic panels
Type:
PanelModel
readonly
|
|
|
|
templateDescription
property
|
|
The template Panel description property.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
templateElements
property
|
|
The template Panel elements, questions and panels.
Type:
IElement[]
readonly
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
templateTitle
property
|
|
The template Panel title property.
Type:
string
writable
The property is serializable. It is stored in survey json and you can edit it in the SurveyJS Creator.
|
|
|
|
templateTitleLocation
property
|
|
Set this property different from "default" to set the specific question title location for the template questions.
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
|
|
|
|
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.
|
