Class ScaleItem

A question item that allows the respondent to choose one option from a numbered sequence of radio buttons. Items can be accessed or created from a Form.

 // Open a form by ID and add a new scale item.
 var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz');
 var item = form.addScaleItem();
 item.setTitle('Pick a number between 1 and 10')
     .setBounds(1, 10);

Methods

Method	Return type	Brief description
`createResponse(response)`	`ItemResponse`	Creates a new `ItemResponse` for this scale item.
`duplicate()`	`ScaleItem`	Creates a copy of this item and appends it to the end of the form.
`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.
`getLeftLabel()`	`String`	Gets the label for the scale's lower bound, if any.
`getLowerBound()`	`Integer`	Gets the scale's lower bound.
`getRightLabel()`	`String`	Gets the label for the scale's upper bound, if any.
`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`.
`getUpperBound()`	`Integer`	Gets the scale's upper bound.
`isRequired()`	`Boolean`	Determines whether the respondent must answer the question.
`setBounds(lower, upper)`	`ScaleItem`	Sets the scale's lower and upper bounds.
`setHelpText(text)`	`ScaleItem`	Sets the item's help text (sometimes called description text for layout items like `ImageItems`, `PageBreakItems`, and `SectionHeaderItems`).
`setLabels(lower, upper)`	`ScaleItem`	Sets labels for the scale's lower and upper bounds.
`setRequired(enabled)`	`ScaleItem`	Sets whether the respondent must answer the question.
`setTitle(title)`	`ScaleItem`	Sets the item's title (sometimes called header text, in the case of a `SectionHeaderItem`).

Detailed documentation

`createResponse(response)`

Creates a new ItemResponse for this scale item. Throws an exception if the response argument is outside the bounds set for the item.

Parameters

Name	Type	Description
`response`	`Integer`	a value answer for this scale item

Return

ItemResponse — the item response

`duplicate()`

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

Return

ScaleItem — a duplicate of this ScaleItem, for chaining

`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

`getLeftLabel()`

Gets the label for the scale's lower bound, if any.

Return

String — the label for the scale's lower bound

`getLowerBound()`

Gets the scale's lower bound.

Return

Integer — the scale's lower bound

`getRightLabel()`

Gets the label for the scale's upper bound, if any.

Return

String — the label for the scale's upper bound

`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

`getUpperBound()`

Gets the scale's upper bound.

Return

Integer — the scale's upper bound

`isRequired()`

Determines whether the respondent must answer the question.

Return

Boolean — whether the respondent must answer the question

`setBounds(lower, upper)`

Sets the scale's lower and upper bounds. The lower bound must be 0 or 1. The upper bound must be between 3 and 10, inclusive. A new scale defaults to a lower bound of 1 and an upper bound of 5.

Throws a scripting exception if the given values are outside the permitted limits. Decimals are truncated to the preceding integer.

Parameters

Name	Type	Description
`lower`	`Integer`	the new lower bound
`upper`	`Integer`	the new upper bound

Return

ScaleItem — this ScaleItem, 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

ScaleItem — this ScaleItem, for chaining

`setLabels(lower, upper)`

Sets labels for the scale's lower and upper bounds.

Parameters

Name	Type	Description
`lower`	`String`	the new label for the lower bound
`upper`	`String`	the new label for the upper bound

Return

ScaleItem — this ScaleItem, 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

ScaleItem — the current item (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

ScaleItem — this ScaleItem, 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.