SurveyElement, SurveyJS Library Documentation

Base class of SurveyJS Elements.

Inherited from the following class(es):

Type to filter the list:

	clone method
	Make a clone of the existing object. Create a new object of the same type and load all properties into it. Type: () => Base Implemented in: Base
	collapse method
	Collapse the Element Type: () => void Implemented in: SurveyElement See also: state
	containsErrors property
	Returns true if a question or a container (panel/page) or their chidren have an error. The value can be out of date. hasErrors function should be called to get the correct value. Type: boolean readonly Implemented in: SurveyElement
	cssClasses property
	Returns all css classes that used for rendering the question, panel or page. You can use survey.onUpdateQuestionCssClasses event to override css classes for a question, survey.onUpdatePanelCssClasses event for a panel and survey.onUpdatePageCssClasses for a page. Type: any readonly Implemented in: SurveyElement See also: SurveyModel.updateQuestionCssClasses * , SurveyModel.updatePanelCssClasses * , SurveyModel.updatePageCssClasses
	description property
	Question, Panel and Page description. It renders under element title by using smaller font. Unlike the question title, description can be empty. Please note, this property is hidden for questions without input, for example html question. Type: string writable Implemented in: SurveyElementCore See also: title
	errors property
	The list of errors. It is created by callig hasErrors functions Type: SurveyError[] writable Implemented in: SurveyElement See also: hasErrors
	expand method
	Expand the Element Type: () => void Implemented in: SurveyElement See also: state
	fromJSON method
	Load object properties and elements. It doesn't reset properties that was changed before and they are not defined in the json parameter. Type: (json: any) => void Parameters: json, type: any , the object JSON definition Implemented in: Base See also: toJSON
	getLocale method
	Returns the current survey locale Type: () => string Implemented in: SurveyElement See also: SurveyModel.locale
	getPropertyByName method
	Returns the serializable property that belongs to this instance by property name. It returns null if the property is not exists. Type: (propName: string) => JsonObjectProperty Parameters: propName, type: string , property name Implemented in: Base
	getPropertyValue method
	Returns the property value by name Type: (name: string, defaultValue?: any) => any Parameters: name, type: string , property name defaultValue, type: any Implemented in: Base
	getTemplate method
	Returns the element template name without prefix. Typically it equals to getType(). Type: () => string Implemented in: Base See also: getType
	getType method
	Returns the type of the object as a string as it represents in the json. It should be in lowcase. Type: () => string Implemented in: Base
	inSurvey property
	Returns true if the object is inluded into survey, otherwise returns false. Type: boolean readonly Implemented in: Base
	isCollapsed property
	Returns true if the Element is in the collapsed state Type: boolean readonly Implemented in: SurveyElement See also: state * , collapse * , isExpanded
	isDesignMode property
	Returns true if the question in design mode right now. Type: boolean readonly Implemented in: SurveyElement
	isExpanded property
	Returns true if the Element is in the expanded state Type: boolean readonly Implemented in: SurveyElement See also: state * , expand * , isCollapsed
	isLoadingFromJson property
	Returns true if the object is loading from Json at the current moment. Type: boolean readonly Implemented in: Base
	isPage property
	Returns true if it is a page. Type: boolean readonly Implemented in: SurveyElement
	isPanel property
	Returns true if it is a panel. Type: boolean readonly Implemented in: SurveyElement
	isQuestion property
	Returns true if it is a question. Type: boolean readonly Implemented in: SurveyElement
	isValueEmpty method
	Returns true if a value undefined, null, empty string or empty array. Type: (value: any, trimString?: boolean) => boolean Parameters: value, type: any trimString, type: boolean , a boolean parameter, default value true. If true then it trims the string and functions returns true for a string that contains white spaces only. Implemented in: Base
	name property
	This is the identifier of a survey element - question or panel. Type: string writable Implemented in: SurveyElement See also: valueName
	onItemValuePropertyChanged event
	Event that raised on changing property of the ItemValue object. sender - the object that owns the property options.propertyName - the property name to which ItemValue array is belong. It can be "choices" for dropdown question options.obj - the instance of ItemValue object which property has been changed options.name - the property of ItemObject that has been changed options.oldValue - old value options.newValue - new value Type: Event<(sender: Base, options: any) => any, any> Implemented in: Base
	onPropertyChanged event
	Event that raise on property change of the sender object sender - the object that owns the property options.name - the property name that has been changed options.oldValue - old value. Please note, it equals to options.newValue if property is an array options.newValue - new value. Type: EventBase<Base> Implemented in: Base
	readOnly property
	Set it to true to make an element question/panel/page readonly. Please note, this property is hidden for question without input, for example html question. Type: boolean writable Implemented in: SurveyElement See also: enableIf * , isReadOnly
	registerFunctionOnPropertiesValueChanged method
	Register a function that will be called on a property value changed from the names list. Type: (names: string[], func: any, key?: string) => void Parameters: names, type: string[] , the list of properties names func, type: any , the function with no parameters that will be called on property changed. key, type: string , an optional parameter. If there is already a registered function for this property with the same key, it will be overwritten. Implemented in: Base
	registerFunctionOnPropertyValueChanged method
	Register a function that will be called on a property value changed. Type: (name: string, func: any, key?: string) => void Parameters: name, type: string , the property name func, type: any , the function with no parameters that will be called on property changed. key, type: string , an optional parameter. If there is already a registered function for this property with the same key, it will be overwritten. Implemented in: Base
	setPropertyValue method
	set property value Type: (name: string, val: any) => void Parameters: name, type: string , property name val, type: any , new property value Implemented in: Base
	state property
	Set this property to "collapsed" to render only Panel title and expanded button and to "expanded" to render the collapsed button in the Panel caption Type: string writable Implemented in: SurveyElement
	survey property
	Returns the survey object. Type: ISurvey readonly Implemented in: SurveyElement
	title property
	Question, Panel, Page and Survey title. If page and panel is empty then they are not rendered. Question renders question name if the title is empty. Use survey questionTitleTemplate property to change the title question rendering. Type: string writable Implemented in: SurveyElementCore See also: SurveyModel.questionTitleTemplate
	toggleState method
	Toggle element's state Type: () => boolean Implemented in: SurveyElement See also: state
	toJSON method
	Deserialized the current object into JSON Type: () => any Implemented in: Base See also: fromJSON
	unRegisterFunctionOnPropertiesValueChanged method
	Unregister notification on property value changed for all properties in the names list. Type: (names: string[], key?: string) => void Parameters: names, type: string[] , the list of properties names key, type: string , the key with which you have registered the notification for this property. It can be null. Implemented in: Base
	unRegisterFunctionOnPropertyValueChanged method
	Unregister notification on property value changed Type: (name: string, key?: string) => void Parameters: name, type: string , the property name key, type: string , the key with which you have registered the notification for this property. It can be null. Implemented in: Base

SurveyElement

Why We Use Cookies