PopupSurveyModel

Specifies whether to display a button that closes the pop-up window.

Default value: false

If you allow users to close the pop-up window, make sure to implement a UI element that opens it. This element should call the show() method or enable the isShowing property.

Type:

boolean writable

Implemented in:

PopupSurveyModel

See also:

expand * , collapse * , hide

Creates a new object that has the same type and properties as the current SurveyJS object.

Type:

() => Base

Implemented in:

Base

Specifies how many seconds the pop-up window should remain open after users complete the survey.

Default value: 0 (the window is closed immediately)

Set this property to a negative value (for instance, -1) to keep the pop-up window open without a time limit.

Type:

number readonly

Implemented in:

PopupSurveyModel

Collapses the pop-up window, leaving only the survey title visible.

As an alternative to this method, you can set the isExpanded property to false.

Type:

() => void

Implemented in:

PopupSurveyModel

See also:

expand

Expands the pop-up window.

As an alternative to this method, you can set the isExpanded property to true.

Type:

() => void

Implemented in:

PopupSurveyModel

See also:

collapse

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

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

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

Returns the object type as it is used in the JSON schema.

Type:

() => string

Implemented in:

Base

Hides the pop-up survey.

As an alternative to this method, you can set the isShowing property to false.

Type:

() => void

Implemented in:

PopupSurveyModel

See also:

show * , expand * , collapse

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

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.

Return Value:

`true` if the current object is of a given `typeName` or inherited from it.

Implemented in:

Base

See also:

getType

Returns true if the survey is being designed in Survey Creator.

Type:

boolean readonly

Implemented in:

Base

Indicates whether the pop-up window is expanded or collapsed.

You can set this property to true or false to control the expand state of the pop-up survey. Alternatively, you can use the expand() and collapse() methods.

Type:

boolean writable

Implemented in:

PopupSurveyModel

Returns true if the object configuration is being loaded from JSON.

Type:

boolean readonly

Implemented in:

Base

Indicates whether the pop-up survey appears on the page, regardless of its expand state.

You can set this property to true or false to control visibility of the pop-up survey. Alternatively, you can use the show() and hide() methods.

Type:

boolean writable

Implemented in:

PopupSurveyModel

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

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

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

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

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

Shows the pop-up survey. The survey may appear expanded or collapsed.

As an alternative to this method, you can set the isShowing property to true.

Type:

() => void

Implemented in:

PopupSurveyModel

See also:

hide

A SurveyModel instance rendered in the pop-up window.

Type:

SurveyModel readonly

Implemented in:

PopupSurveyModel

A title for the pop-up window. If this property is undefined, the title is taken from SurveyModel's title property.

Type:

string writable

Implemented in:

PopupSurveyModel

Returns a JSON object that corresponds to the current SurveyJS object.

Type:

() => any

Implemented in:

Base

See also:

fromJSON

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