Class GridItem

A question item, presented as a grid of columns and rows, that allows the respondent to select one choice per row from a sequence of radio buttons. Items can be accessed or created from a Form.

 // Open a form by ID and add a new grid item.
 var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
 var item = form.addGridItem();
 item.setTitle('Rate your interests')
     .setRows(['Cars', 'Computers', 'Celebrities'])
     .setColumns(['Boring', 'So-so', 'Interesting']);

Methods

Method	Return type	Brief description
`createResponse(responses)`	`ItemResponse`	Creates a new `ItemResponse` for this grid item.
`duplicate()`	`GridItem`	Creates a copy of this item and appends it to the end of the form.
`getColumns()`	`String[]`	Gets the values for every column in the grid.
`getHelpText()`	`String`	Gets the item's help text (sometimes called description text for layout items like `ImageItems`, `PageBreakItems`, and `SectionHeaderItems`).
`getId()`	`Integer`	Gets the item's unique identifier.
`getIndex()`	`Integer`	Gets the index of the item among all the items in the form.
`getRows()`	`String[]`	Gets the values for every row in the grid.
`getTitle()`	`String`	Gets the item's title (sometimes called header text, in the case of a `SectionHeaderItem`).
`getType()`	`ItemType`	Gets the item's type, represented as an `ItemType`.
`isRequired()`	`Boolean`	Determines whether the respondent must answer the question.
`setColumns(columns)`	`GridItem`	Sets the columns of the grid based on an array of values.
`setHelpText(text)`	`GridItem`	Sets the item's help text (sometimes called description text for layout items like `ImageItems`, `PageBreakItems`, and `SectionHeaderItems`).
`setRequired(enabled)`	`GridItem`	Sets whether the respondent must answer the question.
`setRows(rows)`	`GridItem`	Sets the rows of the grid based on an array of values.
`setTitle(title)`	`GridItem`	Sets the item's title (sometimes called header text, in the case of a `SectionHeaderItem`).

Detailed documentation

`createResponse(responses)`

Creates a new ItemResponse for this grid item. The argument responses must be a String[] array containing as many values as the number of rows in the grid. A null element for a non-required grid question indicates no response to that row. Throws an exception if any of the values does not match a valid choice.

Parameters

Name	Type	Description
`responses`	`String[]`	an array of valid answers for this grid item

Return

ItemResponse — the item response

`duplicate()`

Creates a copy of this item and appends it to the end of the form.

Return

GridItem — a duplicate of this GridItem, for chaining

`getColumns()`

Gets the values for every column in the grid.

Return

String[] — an array of column values, which respondents see as labels when viewing the form

`getHelpText()`

Gets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Return

String — the item's help text or description text

`getId()`

Gets the item's unique identifier.

Return

Integer — the item's ID

`getIndex()`

Gets the index of the item among all the items in the form.

Return

Integer — the index of the item

`getRows()`

Gets the values for every row in the grid.

Return

String[] — an array of row values, which respondents see as labels when viewing the form

`getTitle()`

Gets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Return

String — the item's title or header text

`getType()`

Gets the item's type, represented as an ItemType.

Return

ItemType — the item's type

`isRequired()`

Determines whether the respondent must answer the question.

Return

Boolean — whether the respondent must answer the question

`setColumns(columns)`

Sets the columns of the grid based on an array of values. Throws an exception if the given array is empty.

Parameters

Name	Type	Description
`columns`	`String[]`	an array of column values, which respondents see as labels when viewing the form

Return

GridItem — this GridItem, for chaining

`setHelpText(text)`

Sets the item's help text (sometimes called description text for layout items like ImageItems, PageBreakItems, and SectionHeaderItems).

Parameters

Name	Type	Description
`text`	`String`	the new help text

Return

GridItem — this GridItem, for chaining

`setRequired(enabled)`

Sets whether the respondent must answer the question.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether the respondent must answer the question

Return

GridItem — the current item (for chaining)

`setRows(rows)`

Sets the rows of the grid based on an array of values. Throws an exception if the given array is empty.

Parameters

Name	Type	Description
`rows`	`String[]`	an array of row values, which respondents see as labels when viewing the form

Return

GridItem — this GridItem, for chaining

`setTitle(title)`

Sets the item's title (sometimes called header text, in the case of a SectionHeaderItem).

Parameters

Name	Type	Description
`title`	`String`	the new title or header text

Return

GridItem — this GridItem, for chaining

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.