QuestionPanelDynamicModel, SurveyJS Library Documentation

A Model for a panel dymanic question. You setup the template panel, but adding elements (any question or a panel) and assign a text to it's title, and this panel will be used as a template on creating dynamic panels. The number of panels is defined by panelCount property. An end-user may dynamically add/remove panels, unless you forbidden this.

Inherited from the following class(es) Question

Type to filter the list:

		addError method
		Add error into the question error list. Type: (error: SurveyError) => void Parameters: error, type: SurveyError Implemented in: Question
		addPanel method
		Add a new dynamic panel based on the template Panel. Type: () => PanelModel Implemented in: QuestionPanelDynamicModel See also: template , panelCount , panels
		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 Implemented in: QuestionPanelDynamicModel See also: template , panelCount , panels , canAddPanel
		allowAddPanel property
		Set this property to false to hide the 'Add New' button Type: boolean writable Implemented in: QuestionPanelDynamicModel See also: allowRemovePanel
		allowRemovePanel property
		Set this property to false to hide the 'Remove' button Type: boolean writable Implemented in: QuestionPanelDynamicModel See also: allowAddPanel
		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 Implemented in: QuestionPanelDynamicModel See also: isReadOnly , panelCount , maxPanelCount
		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 Implemented in: QuestionPanelDynamicModel See also: isReadOnly , panelCount , minPanelCount
		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 Implemented in: Question
		comment property
		The question comment value. Type: string writable Implemented in: Question
		commentText property
		Use it to get or set the comment value. Type: string writable Implemented in: Question
		confirmDelete property
		Set it to true, to show a confirmation dialog on removing a panel Type: boolean writable Implemented in: QuestionPanelDynamicModel See also: ConfirmDeleteText
		confirmDeleteText property
		Use this property to change the default text showing in the confirmation delete dialog on removing a panel. Type: string writable Implemented in: QuestionPanelDynamicModel
		correctAnswer property
		The correct answer on the question. Set this value if you are doing a quiz. Type: any writable Implemented in: Question See also: SurveyModel.correctAnswers , SurveyModel.inCorrectAnswers
		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 Implemented in: Question See also: SurveyModel.updateQuestionCssClasses
		currentErrorCount property
		Returns the validation errors count. Type: number readonly Implemented in: Question
		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 Implemented in: QuestionPanelDynamicModel See also: currentPanel , panels , panelCount , renderMode
		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 Implemented in: QuestionPanelDynamicModel See also: currenIndex , panels , panelCount , renderMode
		customWidget property
		The link to the custom widget. Type: QuestionCustomWidget readonly Implemented in: Question
		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 Implemented in: QuestionPanelDynamicModel See also: defaultValue , defaultValueFromLastRow
		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 Implemented in: Question
		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 Implemented in: QuestionPanelDynamicModel See also: defaultValue , defaultPanelValue
		description property
		Question description. It renders under question title by using smaller font. Unlike the title, description can be empty. Type: string writable Implemented in: Question See also: title
		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 Implemented in: Question See also: readOnly , isReadOnly
		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. Implemented in: Question
		fullTitle property
		Returns the title after processing the question template. Type: string readonly Implemented in: Question See also: SurveyModel.questionTitleTemplate
		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[] Implemented in: Question
		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) => any Parameters: keysAsText, type: boolean , Set this value to true, to return key (in matrices questions) as display text as well. Implemented in: Question
		getLocale method
		Returns the current survey locale Type: () => string Implemented in: Question See also: SurveyModel.locale
		getTitleLocation method
		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
		getType method
		Returns the type of the object as a string as it represents in the json. Type: () => string Implemented in: Question
		hasComment property
		Set it to true, to add a comment for the question. Type: boolean writable Implemented in: Question
		hasErrors method
		Returns true if there is a validation error(s) in the question. Type: (fireCallback?: boolean) => boolean Parameters: fireCallback, type: boolean , set it to true to show an error in UI. Implemented in: Question
		hasInput property
		Returns false if the question doesn't have an input element, for example: QuestionHtmlModel Type: boolean readonly Implemented in: Question
		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 Implemented in: Question See also: titleLocation
		id property
		The unique identificator. It is generated automatically. Type: string writable Implemented in: Question
		indent property
		Set it different from 0 to increase the left padding. Type: number writable Implemented in: Question
		isAllowTitleLeft property
		Returns true if the question may have a title located on the left Type: boolean readonly Implemented in: Question
		isEmpty method
		Returns true if the question value is empty Type: () => boolean Implemented in: Question
		isNextButtonShowing property
		Returns true when currentIndex is more than or equal 0 and less then panelCount - 1. Type: boolean readonly Implemented in: QuestionPanelDynamicModel See also: currenIndex , currenPanel , panelCount
		isPanel property
		Always returns false. Type: boolean readonly Implemented in: Question
		isPrevButtonShowing property
		Returns true when currentIndex is more than 0. Type: boolean readonly Implemented in: QuestionPanelDynamicModel See also: currenIndex , currenPanel
		isProgressBottomShowing property
		Returns true when the renderMode equals to "progressBottom" or "progressTopBottom" Type: boolean readonly Implemented in: QuestionPanelDynamicModel
		isProgressTopShowing property
		Returns true when the renderMode equals to "progressTop" or "progressTopBottom" Type: boolean readonly Implemented in: QuestionPanelDynamicModel
		isRangeShowing property
		Returns true when showRangeInProgress equals to true, renderMode doesn't equal to "list" and panelCount is >= 2. Type: boolean readonly Implemented in: QuestionPanelDynamicModel
		isReadOnly property
		Retuns 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
		isRenderModeList property
		Returns true when renderMode equals to "list". Type: boolean readonly Implemented in: QuestionPanelDynamicModel See also: renderMode
		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 Implemented in: Question
		isVisible property
		Returns true if the question is visible or survey is in design mode right now. Type: boolean readonly Implemented in: Question
		keyDuplicationError property
		The duplication value error text. Set it to show the text different from the default. Type: string writable Implemented in: QuestionPanelDynamicModel See also: keyName
		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 Implemented in: QuestionPanelDynamicModel See also: keyDuplicationError
		maxPanelCount property
		The maximum panel count. A user could not add a panel if the panelCount equals to maxPanelCount Type: number writable Implemented in: QuestionPanelDynamicModel See also: panelCount , minPanelCount
		minPanelCount property
		The minimum panel count. A user could not delete a panel if the panelCount equals to minPanelCount Type: number writable Implemented in: QuestionPanelDynamicModel See also: panelCount , maxPanelCount
		page property
		Get/set the page where the question is located. Type: IPage writable Implemented in: Question
		panelAddText property
		Use this property to change the default value of add panel button text. Type: string writable Implemented in: QuestionPanelDynamicModel
		panelCount property
		Use this property to get/set the number of dynamic panels. Type: number writable Implemented in: QuestionPanelDynamicModel See also: template , minPanelCount , maxPanelCount , addPanel , removePanel , removePanelUI
		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 Implemented in: QuestionPanelDynamicModel See also: currentPanel , currentIndex , renderMode
		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 Implemented in: QuestionPanelDynamicModel See also: currentPanel , currentIndex , renderMode
		panelRemoveText property
		Use this property to change the default value of remove panel button text. Type: string writable Implemented in: QuestionPanelDynamicModel
		panels property
		The array of dynamic panels created based on panel template Type: PanelModel[] readonly Implemented in: QuestionPanelDynamicModel See also: template , panelCount
		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 Implemented in: QuestionPanelDynamicModel See also: renderMode , templateTitle
		parent property
		A parent element. It can be panel or page. Type: IPanel writable Implemented in: Question
		processedTitle property
		Returns the rendred question title. Type: string readonly Implemented in: Question
		readOnly property
		Set it to true to make a question readonly. Type: boolean writable Implemented in: Question See also: enableIf , isReadOnly
		removePanel method
		Removes a dynamic panel from the panels array. Type: (value: any) => void Parameters: value, type: any , a panel or panel index Implemented in: QuestionPanelDynamicModel See also: panels , template
		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 Implemented in: QuestionPanelDynamicModel See also: removePanel , confirmDelete , confirmDeleteText , canRemovePanel
		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 Implemented in: QuestionPanelDynamicModel
		renderWidth property
		The rendered width of the question. Type: string writable Implemented in: Question
		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 Implemented in: Question
		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 Implemented in: Question See also: isRequired
		requiredText property
		Returns the char/string for a required question. Type: string readonly Implemented in: Question See also: SurveyModel.requiredText
		rightIndent property
		Set it different from 0 to increase the right padding. Type: number writable Implemented in: Question
		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> Implemented in: Question See also: visible , visibleIf , readOnly , enableIf
		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 Implemented in: QuestionPanelDynamicModel
		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 Implemented in: QuestionPanelDynamicModel See also: panelCount , renderMode
		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 Implemented in: Question
		template property
		The template Panel. This panel is used as a template on creatign dynamic panels Type: PanelModel readonly Implemented in: QuestionPanelDynamicModel See also: templateElements , templateTitle , panelCount
		templateDescription property
		The template Panel description property. Type: string writable Implemented in: QuestionPanelDynamicModel See also: templateElements , template , panelCount , templateTitle
		templateElements property
		The template Panel elements, questions and panels. Type: IElement[] readonly Implemented in: QuestionPanelDynamicModel See also: templateElements , template , panelCount
		templateTitle property
		The template Panel title property. Type: string writable Implemented in: QuestionPanelDynamicModel See also: templateElements , template , panelCount
		templateTitleLocation property
		Set this property different from "default" to set the specific question title location for the template questions. Type: string writable Implemented in: QuestionPanelDynamicModel See also: SurveyModel.questionTitleLocation , PanelModelBase.questionTitleLocation
		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 Implemented in: Question See also: SurveyModel.questionTitleTemplate
		titleLocation property
		Set this property different from "default" to set the specific question title location for this panel/page. Type: string writable Implemented in: Question See also: SurveyModel.questionTitleLocation
		useDisplayValuesInTitle property
		Use it to choose how other question values will be rendered in title if referenced in {}. Type: boolean writable Implemented in: Question
		validators property
		The list of question validators. Type: SurveyValidator[] writable Implemented in: Question
		value property
		Get/Set the question value. Type: any writable Implemented in: Question See also: SurveyMode.setValue , SurveyMode.getValue
		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 Implemented in: Question
		visible property
		Use it to get/set the question visibility. Type: boolean writable Implemented in: Question See also: visibleIf
		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 Implemented in: Question See also: visible Show More
		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 Implemented in: Question
		width property
		Use it to set the specific width to the question. Type: string writable Implemented in: Question

Why We Use Cookies