PageModel, SurveyJS Library Documentation

The page object. It has elements collection, that contains questions and panels.

Inherited from the following class(es) PanelModelBase

Type to filter the list:

		addElement method
		Add an elememnt into Panel or Page. Type: (element: IElement, index?: number) => void Parameters: element, type: IElement index, type: number , element index in the elements array Implemented in: PanelModelBase
		addNewPanel method
		Creates a new panel and adds it into the end of the elements list. Type: (name?: string) => PanelModel Parameters: name, type: string , a panel name Implemented in: PanelModelBase
		addNewQuestion method
		Creates a new question and adds it into the end of the elements list. Type: (questionType: string, name?: string) => Question Parameters: questionType, type: string , the possible values are: "text", "checkbox", "dropdown", "matrix", "html", "matrixdynamic", "matrixdropdown" and so on. name, type: string , a question name Implemented in: PanelModelBase
		addPanel method
		Add a panel into Panel or Page. Type: (panel: PanelModel, index?: number) => void Parameters: panel, type: PanelModel index, type: number , element index in the elements array Implemented in: PanelModelBase
		addPanelsIntoList method
		Fill list array with the panels. Type: (list: IPanel[], visibleOnly?: boolean, includingDesignTime?: boolean) => void Parameters: list, type: IPanel[] visibleOnly, type: boolean includingDesignTime, type: boolean Implemented in: PanelModelBase
		addQuestion method
		Add a question into Panel or Page. Type: (question: Question, index?: number) => void Parameters: question, type: Question index, type: number , element index in the elements array Implemented in: PanelModelBase
		addQuestionsToList method
		Fill list array with the questions. Type: (list: IQuestion[], visibleOnly?: boolean, includingDesignTime?: boolean) => void Parameters: list, type: IQuestion[] visibleOnly, type: boolean , set it to true to get visible questions only includingDesignTime, type: boolean Implemented in: PanelModelBase
		areQuestionsRandomized property
		The property returns true, if the elements are randomized on the page Type: boolean readonly Implemented in: PageModel See also: hasShown , questionsOrder , SurveyModel.questionsOrder
		clearIncorrectValues method
		Call this function to remove all question values from the current page/panel, 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. Please note, this function doesn't clear values for invisible questions or values that doesn't associated with questions. Type: () => void Implemented in: PanelModelBase See also: Question.clearIncorrectValues
		containsElement method
		Returns true if the current element belongs to the Panel/Page. It looks in nested Panels as well. Type: (element: IElement) => boolean Parameters: element, type: IElement Implemented in: PanelModelBase See also: PanelModel
		description property
		PanelModel or PageModel description property. It renders under title by using smaller font. Unlike the title, description can be empty. Type: string writable Implemented in: PanelModelBase See also: title
		elements property
		Returns the list of the elements in the object, Panel/Page. Elements can be questions or panels. The function doesn't return elements in the nested Panels. Type: IElement[] readonly Implemented in: PanelModelBase
		enableIf property
		An expression that returns true or false. If it returns false the Panel/Page becomes read only and an end-user will not able to answer on qustions inside it. 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: PanelModelBase See also: readOnly , isReadOnly
		focusFirstErrorQuestion method
		Call it to focus the input of the first question that has an error. Type: () => void Implemented in: PageModel
		focusFirstQuestion method
		Call it to focus the input on the first question Type: () => void Implemented in: PageModel
		getComments method
		Returns question comments on the current page Type: () => any Implemented in: PanelModelBase
		getElementByName method
		Retuns the element by its name. It works recursively. Type: (name: string) => IElement Parameters: name, type: string , the element name Implemented in: PanelModelBase
		getPanels method
		Returns the list of all panels in the page Type: (visibleOnly?: boolean, includingDesignTime?: boolean) => IPanel[] Parameters: visibleOnly, type: boolean includingDesignTime, type: boolean Implemented in: PageModel
		getQuestionByName method
		Returns the question by its name Type: (name: string) => Question Parameters: name, type: string , the question name Implemented in: PanelModelBase
		getValue method
		Returns question values on the current page Type: () => any Implemented in: PanelModelBase
		hasErrors method
		Returns true, if there is an error on this Page or inside the current Panel Type: (fireCallback?: boolean, focuseOnFirstError?: boolean) => boolean Parameters: fireCallback, type: boolean , set it to true, to show errors in UI focuseOnFirstError, type: boolean , set it to true to focuse on the first question that doesn't pass the validation Implemented in: PanelModelBase
		id property
		A unique element identificator. It is generated automatically. Type: string writable Implemented in: PanelModelBase
		isActive property
		Returns true if the current object is Page and it is the current page. Type: boolean readonly Implemented in: PanelModelBase
		isPanel property
		Returns true if the current object is Panel. Returns false if the current object is Page (a root Panel). Type: boolean readonly Implemented in: PanelModelBase
		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: PanelModelBase See also: SurveyModel.model , readOnly
		isRequired property
		Set this property to true, to require the answer at least in one question in the panel. Type: boolean writable Implemented in: PanelModelBase
		isStarted property
		Returns true, if the page is started page in the survey. It can be shown on the start only and the end-user could not comeback to it after it passed it. Type: boolean readonly Implemented in: PageModel
		isVisible property
		Returns true if object is visible or survey is in design mode right now. Type: boolean readonly Implemented in: PanelModelBase
		maxTimeToFinish property
		The maximum time in seconds that end-user has to complete the page. If the value is 0 or less, the end-user has unlimited number of time to finish the page. Type: number writable Implemented in: PageModel See also: startTimer , SurveyModel.maxTimeToFinishPage
		navigationButtonsVisibility property
		Set this property to "hide" to make "Prev", "Next" and "Complete" buttons are invisible for this page. Set this property to "show" to make these buttons visible, even if survey showNavigationButtons property is false. Type: string writable Implemented in: PageModel See also: SurveyMode.showNavigationButtons
		parent property
		A parent element. It is always null for the Page object and always not null for the Panel object. Panel object may contain Questions and other Panels. Type: PanelModelBase writable Implemented in: PanelModelBase
		processedTitle property
		Returns rendered title text or html. Type: string readonly Implemented in: PanelModelBase
		questions property
		Returns the list of all questions located in the Panel/Page, including in the nested Panels. Type: Question[] readonly Implemented in: PanelModelBase See also: Question , elements
		questionsOrder property
		Use this property to randomize questions. Set it to 'random' to randomize questions, 'initial' to keep them in the same order or 'default' to use the Survey questionsOrder property Type: string writable Implemented in: PageModel See also: SurveyModel.questionsOrder , areQuestionsRandomized
		questionTitleLocation property
		Set this property different from "default" to set the specific question title location for this panel/page. Type: string writable Implemented in: PanelModelBase See also: SurveyModel.questionTitleLocation
		readOnly property
		Set it to true to make a panel/page readonly. Type: boolean writable Implemented in: PanelModelBase See also: enableIf , isReadOnly
		removeElement method
		Remove an element (Panel or Question) from the elements list. Type: (element: IElement) => boolean Parameters: element, type: IElement Implemented in: PanelModelBase See also: elements
		removeQuestion method
		Remove question from the elements list. Type: (question: Question) => void Parameters: question, type: Question Implemented in: PanelModelBase See also: elements , removeElement
		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: PanelModelBase
		scrollToTop method
		Call it to scroll to the page top. Type: () => void Implemented in: PageModel
		timeSpent property
		Time in seconds end-user spent on this page Type: number writable Implemented in: PageModel
		title property
		PanelModel or PageModel title property. Type: string writable Implemented in: PanelModelBase
		visible property
		Use it to get/set the object visibility. Type: boolean writable Implemented in: PanelModelBase See also: visibleIf
		visibleIf property
		An expression that returns true or false. If it returns true the Panel becomes visible and if it returns false the Panel 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: PanelModelBase See also: visible
		visibleIndex property
		The visible index of the page. It has values from 0 to visible page count - 1. Type: number writable Implemented in: PageModel See also: SurveyModel.visiblePages , SurveyModel.pages
		wasShown property
		The property returns true, if the page has been shown to the end-user. Type: boolean readonly Implemented in: PageModel

Why We Use Cookies