Skip to content

Commit

Permalink
Merge pull request #7649 from surveyjs/matrixdropdowncolumn
Browse files Browse the repository at this point in the history
Add `MatrixDropdownColumn` to the docs
  • Loading branch information
andrewtelnov authored Jan 10, 2024
2 parents 78ed842 + 6af7473 commit 52bb0da
Show file tree
Hide file tree
Showing 9 changed files with 211 additions and 22 deletions.
4 changes: 4 additions & 0 deletions docs/sidebar.json
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,10 @@
"Name": "questionmatrixdynamicmodel",
"Title": "Matrix Dynamic"
},
{
"Name": "MatrixDropdownColumn",
"title": "MatrixDropdownColumn"
},
{
"Name": "questionmultipletextmodel",
"Title": "Multiple Text"
Expand Down
3 changes: 2 additions & 1 deletion docs/uri.json
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"questionpaneldynamicmodel": "dynamic-panel-model",
"questionmultipletextmodel": "multiple-text-entry-question-model",
"questionmatrixdynamicmodel": "dynamic-matrix-table-question-model",
"questionmatrixdropdownmodel": "matrix-table-with-dropdown-list"
"questionmatrixdropdownmodel": "matrix-table-with-dropdown-list",
"MatrixDropdownColumn": "multi-select-matrix-column-values"
}
}
8 changes: 6 additions & 2 deletions src/martixBase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,13 @@ export class QuestionMatrixBaseModel<TRow, TColumn> extends Question {
/**
* An array of matrix columns.
*
* This array can contain primitive values or objects with the `text` (display value) and `value` (value to be saved in survey results) properties.
* For a Single-Select Matrix, the `columns` array can contain configuration objects with the `text` (display value) and `value` (value to be saved in survey results) properties. Alternatively, the array can contain primitive values that will be used as both the display values and values to be saved in survey results.
*
* [View Demo](https://surveyjs.io/form-library/examples/single-selection-matrix-table-question/ (linkStyle))
* [View "Single-Select Matrix" Demo](https://surveyjs.io/form-library/examples/single-selection-matrix-table-question/ (linkStyle))
*
* For a Multi-Select Matrix or Dynamic Matrix, the `columns` array should contain configuration objects with properties described in the [`MatrixDropdownColumn`](https://surveyjs.io/form-library/documentation/api-reference/multi-select-matrix-column-values) API Reference section.
*
* [View "Multi-Select Matrix" Demo](https://surveyjs.io/form-library/examples/questiontype-matrixdropdown/ (linkStyle))
*/
get columns(): Array<any> {
return this.getPropertyValue("columns");
Expand Down
6 changes: 3 additions & 3 deletions src/panel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ export class PanelModelBase extends SurveyElement<Question>
*
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
*
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
* @see visible
* @see isVisible
*/
Expand Down Expand Up @@ -714,7 +714,7 @@ export class PanelModelBase extends SurveyElement<Question>
*
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
*
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
* @see isRequired
*/
public get requiredIf(): string {
Expand Down Expand Up @@ -1335,7 +1335,7 @@ export class PanelModelBase extends SurveyElement<Question>
*
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
*
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
* @see readOnly
* @see isReadOnly
*/
Expand Down
6 changes: 3 additions & 3 deletions src/question.ts
Original file line number Diff line number Diff line change
Expand Up @@ -417,7 +417,7 @@ export class Question extends SurveyElement<Question>
*
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
*
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
* @see visible
* @see isVisible
*/
Expand Down Expand Up @@ -1257,7 +1257,7 @@ export class Question extends SurveyElement<Question>
*
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
*
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
* @see isRequired
*/
public get requiredIf(): string {
Expand Down Expand Up @@ -1363,7 +1363,7 @@ export class Question extends SurveyElement<Question>
*
* A survey parses and runs all expressions on startup. If any values used in the expression change, the survey re-evaluates it.
*
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility)
* Refer to the following help topic for more information: [Conditional Visibility](https://surveyjs.io/form-library/documentation/design-survey-conditional-logic#conditional-visibility).
* @see readOnly
* @see isReadOnly
*/
Expand Down
4 changes: 2 additions & 2 deletions src/question_baseselect.ts
Original file line number Diff line number Diff line change
Expand Up @@ -843,7 +843,7 @@ export class QuestionSelectBase extends Question {
this.otherPlaceholder = newValue;
}
/**
* Get or sets an error message displayed when users select the "Other" choice item but leave the comment area empty.
* Gets or sets an error message displayed when users select the "Other" choice item but leave the comment area empty.
* @see showOtherItem
*/
public get otherErrorText(): string {
Expand Down Expand Up @@ -1805,7 +1805,7 @@ export class QuestionCheckboxBase extends QuestionSelectBase {
super(name);
}
/**
* Get or sets the number of columns used to arrange choice items.
* Gets or sets the number of columns used to arrange choice items.
*
* Set this property to 0 if you want to display all items in one line. The default value depends on the available width.
* @see separateSpecialChoices
Expand Down
17 changes: 9 additions & 8 deletions src/question_matrixdropdownbase.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1180,14 +1180,15 @@ export class QuestionMatrixDropdownModelBase extends QuestionMatrixBaseModel<Mat
*
* Possible values:
*
* - `"dropdown"`
* - `"checkbox"`
* - `"radiogroup"`
* - `"text"`
* - `"comment"`
* - `"boolean"`
* - `"expression"`
* - `"rating"`
* - [`"dropdown"`](https://surveyjs.io/form-library/documentation/api-reference/dropdown-menu-model)
* - [`"checkbox"`](https://surveyjs.io/form-library/documentation/api-reference/checkbox-question-model)
* - [`"radiogroup"`](https://surveyjs.io/form-library/documentation/api-reference/radio-button-question-model)
* - [`"tagbox"`](https://surveyjs.io/form-library/documentation/api-reference/dropdown-tag-box-model)
* - [`"text"`](https://surveyjs.io/form-library/documentation/api-reference/text-entry-question-model)
* - [`"comment"`](https://surveyjs.io/form-library/documentation/api-reference/comment-field-model)
* - [`"boolean"`](https://surveyjs.io/form-library/documentation/api-reference/boolean-question-model)
* - [`"expression"`](https://surveyjs.io/form-library/documentation/api-reference/expression-model)
* - [`"rating"`](https://surveyjs.io/form-library/documentation/api-reference/rating-scale-question-model)
*
* Default value: `"dropdown"` (inherited from [`settings.matrix.defaultCellType`](https://surveyjs.io/form-library/documentation/settings#matrixDefaultCellType))
*/
Expand Down
Loading

0 comments on commit 52bb0da

Please sign in to comment.