Specifies the type of column cells.
Possible values:
"dropdown"
"checkbox"
"radiogroup"
"tagbox"
"text"
"comment"
"boolean"
"expression"
"rating"
"default"
(default) - Inherits the input type from the cellType
property specified for the parent matrix.The input types are based upon standalone question types. Depending on the selected input type, the matrix column can have additional configuration properties inherited from the corresponding question type. For instance, Dropdown, Checkboxes, Radio Button Group, and Tag Box columns can specify the choices
array, similar to the question types upon which they are based. Refer to the API Reference of these question types for a full list of available properties.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
Creates a new object that has the same type and properties as the current SurveyJS object.
Gets or sets the number of columns used to arrange choice options. Applies only to columns of "checkbox"
or "radiogroup"
cellType
.
Default value: -1 (inherits the actual value from the parent matrix's columnColCount
property)
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A value to show in HTML questions and in the dynamic titles and descriptions of survey elements when the cell value is empty.
Default value: ""
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
An expression used to calculate the column's default value. This expression applies to all cells of this column until the cell value is specified by an end user or programmatically.
A Boolean expression. If it evaluates to false
, this column becomes read-only.
Refer to the following help topic for more information: Conditional Visibility.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
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 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.
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.
Marks the column as required. If a respondent skips any cell in a required column, the matrix displays a validation error.
If you want to mark the column as required based on a condition, specify the requiredIf
property.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
Specifies whether a respondent is required to provide a unique response for each question within this column.
Default value: false
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
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.
Gets or sets minimum column width in CSS values. By default, the matrix calculates column widths to optimally fit the content of all columns.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A column ID that is not visible to respondents.
Column IDs must be unique.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
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.
Makes the column read-only.
If you want to switch the column to the read-only state based on a condition, specify the enableIf
property.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
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.
Specifies a custom error message for a required column.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A Boolean expression. If it evaluates to true
, this column becomes required.
Refer to the following help topic for more information: Conditional Visibility.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A Boolean expression. If it evaluates to true
, all cells in this column are set to a value calculated using the defaultValueExpression
.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
Assigns a new value to a specified property.
A property name.
val, type: any ,A new value for the property.
An expression that calculates a value for all cells in this column.
The setValueExpression
is re-evaluated whenever a referenced question's value changes. If you also specify the setValueIf
expression, re-evaluation occurs only when it returns true
.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A Boolean expression. If it evaluates to true
, all cells in this column are set to a value calculated using the setValueExpression
.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
Specifies whether to create an individual column for each choice option. Applies only to columns of "checkbox"
or "radiogroup"
cellType
.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A user-friendly column caption to display. If title
is undefined, name
is displayed instead.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
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.
An alignment for calculated total values.
Possible values:
"left"
"center"
"right"
"auto"
(default) - Applies one of the values above based on the column's cell type.This property is stored in the survey JSON definition and can be edited in the Survey Creator.
Specifies a currency used to display calculated total values. Applies only if totalDisplayStyle
is set to "currency"
.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A format for calculated total values.
Possible values:
"none"
(default)"decimal"
"currency"
"percent"
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
An expression used to calculate total values. Overrides the totalType
property.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A string pattern used to display column totals. To reference a total value within this pattern, use the {0}
placeholder.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
An aggregation method used to calculate the column total.
Possible values:
"none"
(default) - Disables total calculations."sum"
"count"
"min"
"max"
"avg"
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
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.
Gets or sets column visibility.
If you want to display or hide a column based on a condition, specify the visibleIf
property.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
A Boolean expression. If it evaluates to false
, this column becomes hidden.
Refer to the following help topic for more information: Conditional Visibility.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
Gets or sets column width in CSS values. By default, the matrix calculates column widths to optimally fit the content of all columns.
This property is stored in the survey JSON definition and can be edited in the Survey Creator.
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