Matrix Component

Overview

The Matrix (Centauri v1.0) component enables Creators to create a series of questions that have the same responses. For example, creating a survey where end-users answer several questions on a scale of 1 to 5.

The Matrix component displays data in one of two ways as shown below:

Table

Displays data in a table of radio buttons. Here's how the table option for displaying the Matrix component looks in Express View:

Inline

Displays data inline with the rest of your module. Here's how the inline option looks in Express View:

For logic-based configurations, you can also assign numeric values to your response options. For example, Strongly Agree = 5, Agree = 4, and so on.

You'll find the Matrix component in the Display & Layout group to the left of the Module Builder.

About the Configuration Window

To learn more about general component settings, view our General Component Settings article.×

Display Settings

Default State Options

Setting	Description
Hide Label	Setting Hide Label to (ON) hides Label Text from displaying in Express View. Your Label Text still displays in the Module Builder. By default, this setting is set to (OFF).
Hide Field	Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder. By default, Hide Field is set to (OFF).

Setting

Description

Hide Label

Setting Hide Label to (ON) hides Label Text from displaying in Express View. Your Label Text still displays in the Module Builder.

By default, this setting is set to (OFF).

Hide Field

Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder.

By default, Hide Field is set to (OFF).

Formatting

Setting	Description
Display Type	You can choose to display the Matrix component either as a Table or Inline. Table: Table display is the standard matrix layout. It's a grid with columns and rows. Inline: Inline display shows each collection one after the other, in a list-like layout. Each collection shows all options, displayed as a series of radio buttons.
Table	When using Table display, you can add a text field column to your Matrix component. Doing so lets the end-user enter values, and the text field column triggers when the end-user selects the triggering value. For example, if an end-user selects an option called Other/Not, the selection triggers a text field where the end-user can enter a specific value. Selecting Table displays the following settings: Header for Optional Text Field Column: Displays a label or header for the rightmost text field column. Display Text Fields When Triggered By: Select which value triggers the text field column. Until the end-user selects this value, the text field column is disabled.
Inline	When you select Inline, the following setting displays: Tooltip: A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.

Setting

Description

Display Type

You can choose to display the Matrix component either as a Table or Inline.

Table: Table display is the standard matrix layout. It's a grid with columns and rows.
Inline: Inline display shows each collection one after the other, in a list-like layout. Each collection shows all options, displayed as a series of radio buttons.

Table

When using Table display, you can add a text field column to your Matrix component. Doing so lets the end-user enter values, and the text field column triggers when the end-user selects the triggering value. For example, if an end-user selects an option called Other/Not, the selection triggers a text field where the end-user can enter a specific value.

Selecting Table displays the following settings:

Header for Optional Text Field Column: Displays a label or header for the rightmost text field column.
Display Text Fields When Triggered By: Select which value triggers the text field column. Until the end-user selects this value, the text field column is disabled.

Inline

When you select Inline, the following setting displays:

Tooltip: A short hint that displays when an end-user positions their cursor over the Questionmark Icon (Tooltip) icon. Tooltips can display across more than one line.

Input Behavior

Setting	Description
Input Behavior	Controls how end-users interact with the component. Choose from the following options: Enable User Input: Allow end-users to view and enter data in this field. Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol. Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

Setting

Description

Input Behavior

Controls how end-users interact with the component. Choose from the following options:

Enable User Input: Allow end-users to view and enter data in this field.
Disable User Input: Prevents end-users from entering data in the field, but lets them view it. In the Module Builder, the field’s background displays as gray. In Express View, when end-users hover over the field, their cursor displays with a prohibited symbol.
Read Only - Legacy: Prevents end-users from entering data and replaces the field with the component’s data value. If no value is provided, the component displays None.

Setting	Description
Store Data in Database	The Store Data in Database setting affects how data persists through your application. When set to (ON), Unqork stores values entered into the field to the database (server-side submission). This occurs in three scenarios: Navigating between Panels in a Navigation component. On navigation between pages (Panels), the component’s value saves to the database. Triggering a module save event using a Button component with an Action Type of Save. Navigating between screens of a workflow. On navigation between screens, the component’s value saves to the database. By default, workflows persist data from all fields in the client-side submission when navigating between screens. However, only values from fields with Store Data in Database enabled store in the server-side submission.× Set the toggle to (OFF) when you don’t want to store the values from this field in the database. When using a Plug-In to remote execute a module, ensure data moving between modules is persistent. You can optionally enable Store Data in Database for components in the source module. But any components in the API module whose values are included in an API response must have Store Data in Database enabled. When a component’s data is not persistent, the data isn't included in an API call's response. So, Plug-Ins or external services requesting data from the API module can't receive non-persistent data in the response.× Store Data in Database also affects what data is tracked using Unqork’s built-in tracker. When the Enable Tracker and Track Value toggles are set to (ON) in Module Settings, only values from fields with Store Data in Database enabled are tracked.× By default, the Store Data in Database toggle is set to ON.

Setting	Description
Required	When set to (ON), the end-user must enter a value in the component's visible fields. When set to (OFF), the input is optional. By default, Required is set to (OFF).
Error Message	A custom error message that displays below a required field. The error message displays when the end-user tries to save or submit the module without completing the required field.

Setting	Description
Custom CSS Class	Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name.

Adding a Matrix Component

In this scenario, you'll create a car insurance questionnaire using the default Table display option. These instructions assume that you have an open module saved with a title.

In the Module Builder drag and drop a Matrix component onto your canvas.

In the Property ID field, enter surveyInsurance .

In the Canvas Label Text field, enter Car Insurance Questionnaire .

In the Rows/Collections table, enter the following:

	Label	Value
1	My car insurance is priced fairly.	myCarInsuranceIsPricedFairly
2	My car insurance does not provide enough coverage.	myCarInsuranceDoesNotProvideEnoughCoverage
3	My car is not worth insuring.	myCarIsNotWorthInsuring
4	Car insurance should not be required by law.	carInsuranceShouldNotBeRequiredByLaw

The Label column sets the row labels for your table.

In the Columns/Properties table, enter the following:

	Label	Value
1	Strongly Agree	stronglyAgree
2	Agree	agree
3	Undecided	undecided
4	Disagree	disagree
5	Strongly Disagree	stronglyDisagree

The Label column sets the column headers for your table.

Click Save Component.

Save your module.

Preview your module in Express View. Note how the data displays in the Matrix table:

Matrix Component

Overview

Table

Inline

About the Configuration Window

Display Settings

Default State Options

Formatting

Input Behavior

Data Settings

Data Storage

Validation Settings

User Input

Advanced Settings

Additional Styling

Adding a Matrix Component

Overview

About the Configuration Window

Display Panel

Data Panel

Validation Panel

Adding a Matrix Component

Resources

Feedback

Setting	Description
Label Text	Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. User-friendly labels make your module more accessible. Keep labels short and descriptive (a word or two) using title case. For longer entries, use sentence case.
Rows/Collections	Use this table to set the row labels. Label: The label text that appears on the left side of each row. Value: Each option requires an associated value for storage with the data submitted. By default, the value is a camel case version of the label. You can also assign a numeric value to each option for use in logic-based configurations.
Columns/Properties	Use this table to set the column headers. Label: The label text for each column header. Value: Each option requires an associated value for storage with the data submitted. By default, the value is a camel case version of the label. You can also assign a numeric value to each option for use in logic-based configurations.
Display Type	You can choose to display the Matrix component either as a Table or Inline. Table: Table display is the standard matrix layout. It's a grid with columns and rows. Inline: Inline display shows each collection one after the other, in a list-like layout. Each collection shows all options, displayed as a series of radio buttons.
Table	When using Table display, you can add a text field column to your Matrix component. Doing so lets the end-user enter values, and the text field column triggers when the end-user selects the triggering value. For example, if an end-user selects an option called Other/Not, the selection triggers a text field where the end-user can enter a specific value. Selecting Table displays the following settings: Header for Optional Text Field Column: Displays a label or header for the rightmost text field column. Display Text Fields When Triggered By: Select which value triggers the text field column. Until the end-user selects this value, the text field column is disabled.
Inline	When you select Inline, the following setting displays: Tooltip: A short hint that displays when an end-user positions their cursor over the (Tooltip) icon. Tooltips can display across more than one line.
Hide Label	Setting Hide Label to (ON) hides Label Text from displaying in Express View. Your Label Text still displays in the Module Builder. By default, this setting is set to (OFF).
Disable User Input	When set to (ON), end-users cannot interact with or edit the Express View's input field or element. When end-users hover over the field, their cursor changes to alert them to the status change. By default, Disable User Input is set to (OFF).
Read Only View	When set to (ON), the component is display-only. If another component sends content to the field, the end-user can view that content. Otherwise, end-users see the word None. By default, the Read Only View toggle is set to (OFF).
Hide Field	Displays or hides the component from view. Setting Hide Field to (ON) hides the component in Express View. Setting it to (OFF) displays the component. The component is always visible in the Module Builder. By default, Hide Field is set to (OFF).
Custom CSS Class	Enter a Custom CSS Class to apply to your component. Custom CSS lets you maintain a consistent look and feel when the field or element is part of a template or multiple modules. Updated CSS styling applies to all components that reference this custom class name.