Matrix

Type key: matrix. Renders a grid with one row per entry of select_options_matrix_rows and one column per entry of select_options_data. Respondents pick one column per row. In the editor this is the Matrix block.

A question: the question rules apply, but it cannot sit in a layout row column.

Meta fields

The meta fields of this node type are listed in the request body of Replace the draft document, under pages › nodes, in the matrix tab.

Example

A minimal Matrix node

{
  "public_id": "nMtx",
  "sort_order": 1,
  "type": "matrix",
  "meta": {
    "question": "<span>Rate each session</span>",
    "select_options_data": [
      {
        "value": "poor",
        "label": "Poor"
      },
      {
        "value": "good",
        "label": "Good"
      },
      {
        "value": "great",
        "label": "Great"
      }
    ],
    "select_options_matrix_rows": [
      {
        "value": "keynote",
        "label": "Keynote"
      },
      {
        "value": "workshop",
        "label": "Workshop"
      }
    ],
    "validation": {
      "required": false
    }
  }
}

Defaults and rules

• select_options_data (the columns) accepts up to 30 entries and select_options_matrix_rows up to 50. Both default to an empty list, and publishing needs at least one of each (FORM_PUBLISH_MISSING_OPTIONS, FORM_PUBLISH_MISSING_MATRIX_ROWS).
• Rows and columns use the option shape: a stable value, a label, and an optional label_formatted. Answers are keyed by both value lists, so keep them stable once the form collects responses.
• The node has no default_value.