API Reference: Pop-up Survey Model | Form Builder Libraries

A Model for a survey running in the Popup Window.

Inherited from the following class(es):

Type to filter the list:

	clone method
	Creates a new object that has the same type and properties as the current SurveyJS object. Type: () => Base Implemented in: Base
	closeOnCompleteTimeout property
	Set this value to negative value, for example -1, to avoid closing the popup window on completing the survey. Leave it equals to 0 (default value) to close the popup window immediately, or set it to 3, 5, 10, ... to close the popup window in 3, 5, 10 seconds. Type: number readonly Implemented in: PopupSurveyModel
	collapse method
	Collapse the popup window and show survey title only. Type: () => void Implemented in: PopupSurveyModel
	expand method
	Expand the popup window to show the survey. Type: () => void Implemented in: PopupSurveyModel
	fromJSON method
	Assigns a new configuration to the current SurveyJS object. This configuration is taken from a passed JSON object. The JSON object should contain only serializable properties of this SurveyJS object. Event handlers and properties that do not belong to the SurveyJS object are ignored. Type: (json: any) => void Parameters: json, type: any , A JSON object with properties that you want to apply to the current SurveyJS object. Implemented in: Base See also: toJSON
	getPropertyByName method
	Returns a `JsonObjectProperty` object with metadata about a serializable property that belongs to the current SurveyJS object. If the property is not found, this method returns `null`. Type: (propName: string) => JsonObjectProperty Parameters: propName, type: string , A property name. Implemented in: Base
	getPropertyValue method
	Returns the value of a property with a specified name. If the property is not found or does not have a value, this method returns either `undefined`, `defaultValue` specified in the property configuration, or a value passed as the `defaultValue` parameter. Type: (name: string, defaultValue?: any) => any Parameters: name, type: string , A property name. defaultValue, type: any , (Optional) A value to return if the property is not found or does not have a value. Implemented in: Base
	getType method
	Returns the object type as it is used in the JSON schema. Type: () => string Implemented in: Base
	hide method
	Hide the popup window Type: () => void Implemented in: PopupSurveyModel See also: show * , isShowing
	inSurvey property
	Returns `true` if the object is included in a survey. This property may return `false`, for example, when you create a survey model dynamically. Type: boolean readonly Implemented in: Base
	isDescendantOf method
	Use this method to find out if the current object is of a given `typeName` or inherited from it. Type: (typeName: string) => boolean Parameters: typeName, type: string , One of the values listed in the getType() description. Implemented in: Base See also: getType
	isDesignMode property
	Returns `true` if the survey is being designed in Survey Creator. Type: boolean readonly Implemented in: Base
	isExpanded property
	Returns true if the popup window is expanded. Set it to true to expand the popup window or false to collapse it. Type: boolean writable Implemented in: PopupSurveyModel See also: expand * , collapse
	isLoadingFromJson property
	Returns `true` if the object configuration is being loaded from JSON. Type: boolean readonly Implemented in: Base
	isShowing property
	Returns true if the popup window is currently showing. Set it to true to show the popup window and false to hide it. Type: boolean writable Implemented in: PopupSurveyModel See also: show * , hide
	isValueEmpty method
	Returns `true` if a passed `value` is an empty string, array, or object or if it equals to `undefined` or `null`. Type: (value: any, trimString?: boolean) => boolean Parameters: value, type: any , A value to be checked. trimString, type: boolean , (Optional) When this parameter is `true`, the method ignores whitespace characters at the beginning and end of a string value. Pass `false` to disable this functionality. Implemented in: Base
	onItemValuePropertyChanged event
	An event that is raised when an `ItemValue` property is changed. Parameters: `sender`: `this` A SurveyJS object whose property contains an array of `ItemValue` objects. `options.obj`: `ItemValue` An `ItemValue` object. `options.propertyName`: `String` The name of the property to which an array of `ItemValue` objects is assigned (for example, `"choices"` or `"rows"`). `options.name`: `"text"` \| `"value"` The name of the changed property. `options.newValue`: `any` A new value for the property. Type: Event<(sender: Base, options: any) => any, Base, any> Implemented in: Base
	onPropertyChanged event
	An event that is raised when a property of this SurveyJS object has changed. Parameters: `sender`: `this` A SurveyJS object whose property has changed. `options.name`: `String` The name of the changed property. `options.newValue`: `any` A new value for the property. `options.oldValue`: `any` An old value of the property. If the property is an array, `oldValue` contains the same array as `newValue` does. Type: EventBase<Base, any> Implemented in: Base
	registerPropertyChangedHandlers method
	Registers a function to call when a property value changes. Type: (propertyNames: string[], handler: any, key?: string) => void Parameters: propertyNames, type: string[] , An array of one or multiple property names. handler, type: any , A function to call when one of the listed properties change. key, type: string , (Optional) A key that identifies the current registration. If a function for one of the properties is already registered with the same key, the function will be overwritten. You can also use the key to subsequently unregister handlers. Implemented in: Base See also: unregisterPropertyChangedHandlers
	setPropertyValue method
	Assigns a new value to a specified property. Type: (name: string, val: any) => void Parameters: name, type: string , A property name. val, type: any , A new value for the property. Implemented in: Base
	show method
	Show the popup window Type: () => void Implemented in: PopupSurveyModel See also: hide * , isShowing
	survey property
	A survey object. Type: SurveyModel readonly Implemented in: PopupSurveyModel See also: SurveyModel
	title property
	The popup window and survey title. Type: string writable Implemented in: PopupSurveyModel
	toJSON method
	Returns a JSON object that corresponds to the current SurveyJS object. Type: () => any Implemented in: Base See also: fromJSON
	unregisterPropertyChangedHandlers method
	Unregisters value change event handlers for the specified properties. Type: (propertyNames: string[], key?: string) => void Parameters: propertyNames, type: string[] , An array of one or multiple property names. key, type: string , (Optional) A key of the registration that you want to cancel. Implemented in: Base See also: registerPropertyChangedHandlers

PopupSurveyModel

Why we use cookies.

Your renewal subscription expires soon.

Your renewal subscription has expired.