Creates a new object that has the same type and properties as the current SurveyJS object.
Specifies how many columns this survey element spans in the grid layout. Applies only if you set the SurveyModel
's gridLayoutEnabled
property to true
and define the gridLayoutColumns
array for the parent page or panel.
Default value: 1
Returns true
if the survey element or its child elements have validation errors.
This property contains the result of the most recent validation. This result may be outdated. Call the validate
method to get an up-to-date value.
Validation errors. Call the validate()
method to validate survey element data.
Assigns a new JSON schema to the current survey element.
The JSON schema should contain only serializable properties of this survey element. Event handlers and properties that do not belong to the survey element are ignored.
A JSON schema that you want to apply to the current survey element.
options, type: ILoadFromJSONOptions ,An object with configuration options.
options.validatePropertyValues, type: boolean ,Pass true
if you want to validate property values. Use the jsonErrors
array to access validation errors.
Returns the survey's locale.
If a default locale is used, this method returns an empty string. To get the applied locale in this case, use the following code:
import { surveyLocalization } from 'survey-core';
const defaultLocale = surveyLocalization.defaultLocale;
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
.
A property name.
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.
A property name.
defaultValue, type: any ,(Optional) A value to return if the property is not found or does not have a value.
calcFunc, type: () => any
Returns the object type as it is used in the JSON schema.
Increases or decreases an indent of survey element content from the left edge. Accepts positive integer values and 0.
Use this method to find out if the current object is of a given typeName
or inherited from it.
One of the values listed in the getType() description.
true
if the current object is of a given typeName
or inherited from it.
Returns true
if the survey is being designed in Survey Creator.
Returns true
if the object configuration is being loaded from JSON.
Returns true
if the survey element is a page.
This property returns false
for PageModel
objects in the following cases:
SurveyModel
's questionsOnPageMode
is set to "singlePage"
.In those cases, the survey creates an internal PageModel
object to show all questions on one page, and all regular pages become panels.
Returns true
if the survey element is a panel or acts as one.
This property returns true
for PageModel
objects in the following cases:
SurveyModel
's questionsOnPageMode
is set to "singlePage"
.In those cases, the survey creates an internal PageModel
object to show all questions on one page, and all regular pages become panels.
Returns true
if the survey element is a question.
Returns true
if the survey element or its parent element is read-only.
If you want to switch a survey element to the read-only state based on a condition, specify the enableIf
property. Refer to the following help topic for information: Conditional Visibility.
Returns true
if the element is a survey.
Returns true
if a passed value
is an empty string, array, or object or if it equals to undefined
or null
.
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.
A survey element identifier.
Question names must be unique.
An event that is raised when an ItemValue
property is changed.
Parameters:
sender
: this
ItemValue
objects.options.obj
: ItemValue
ItemValue
object.options.propertyName
: string
ItemValue
objects is assigned (for example, "choices"
or "rows"
).options.name
: "text"
| "value"
options.newValue
: any
An event that is raised when a property of this SurveyJS object has changed.
Parameters:
sender
: this
options.name
: string
options.newValue
: any
options.oldValue
: any
oldValue
contains the same array as newValue
does.If you need to add and remove property change event handlers dynamically, use the registerPropertyChangedHandlers
and unregisterPropertyChangedHandlers
methods instead.
A Dynamic Panel, Dynamic Matrix, or Dropdown Matrix that includes the current question.
This property is null
for standalone questions.
Makes the survey element read-only.
If you want to switch a survey element to the read-only state based on a condition, specify the enableIf
property. Refer to the following help topic for information: Conditional Visibility.
Registers a single value change handler for one or multiple properties.
The registerPropertyChangedHandlers
and unregisterPropertyChangedHandlers
methods allow you to manage property change event handlers dynamically. If you only need to attach an event handler without removing it afterwards, you can use the onPropertyChanged
event instead.
An array of one or multiple property names.
handler, type: any ,A function to call when one of the listed properties change. Accepts a new property value as an argument.
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.
Assigns a new value to a specified property.
A property name.
val, type: any ,A new value for the property.
Gets and sets the survey element's expand state.
Possible values:
"default"
(default) - The survey element is displayed in full and cannot be collapsed in the UI."expanded"
- The survey element is displayed in full and can be collapsed in the UI."collapsed"
- The survey element displays only title
and description
and can be expanded in the UI.Returns the survey object.
A title for the survey element. If title
is undefined, the name
property value is displayed instead.
Empty pages and panels do not display their titles or names.
Returns a JSON schema that corresponds to the current survey element.
An object with configuration options.
options.storeDefaults, type: boolean ,Pass true
if the JSON schema should include properties with default values.
A JSON schema of the survey element.
Unregisters value change event handlers for the specified properties.
An array of one or multiple property names.
key, type: string ,(Optional) A key of the registration that you want to cancel.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4