Appearance

You can change the way questions are presented by setting the appearance for each question type. Add an appearance column to your spreadsheet to change the appearance and functionality of your survey questions.

Text

By setting the appearance value to multiline, a text question is presented as a multiline text box. You can set the default height for this text box by setting a defaultHeight parameter in the body::esri:style column. For example, entering defaultHeight=5 in the body::esri:style column will display five lines in a multiline text box when your survey is opened. If this is not set, a multiline text box will display three lines when your survey is opened.

Note:

Controlling the height of questions is not supported in the Survey123 web app.

By setting the appearance value to predictivetext or nopredictivetext, a text question enforces that predictive text is enabled or disabled, respectively, on mobile devices. By default, Android has predictive text disabled for text questions, while it is enabled by default on iOS.

Date

By setting the appearance value to year, a date question is presented as a year-only button, with arrows to increase or decrease the year value.

Year selector

By setting the appearance value to month-year, a date question is presented as a pair of buttons, one for the month and one for the year. Each has arrows to increase or decrease the value.

Month and year selector
Note:

The year and month-year appearance types appear when the survey loads with values for the current month and year. However, they don't already contain these values and will submit a blank value unless manually edited or a default or calculation has been applied.

By setting the appearance value to week-number, a date question is still presented with a calendar picker for choosing the date, but once selected, the result is displayed as the equivalent week number of the year. For example, if you choose April 27, 2016, Week 17 is displayed as the result.

Week number

Select one

By setting the appearance value to minimal, a select one question is presented in a drop-down menu.

Minimal appearance for select one

By setting the appearance value to horizontal, a select one question is presented horizontally in columns of equal width.

Horizontal appearance for select one

In the Survey123 field app, the horizontal and horizontal-compact appearances are identical. In the Survey123 web app, the horizontal-compact appearance fits the choice labels for a select one question side by side in rows, without additional spacing.

By setting the appearance value to likert, a select one question is presented as a Likert scale. A Likert scale is a rating scale that allows respondents to specify their level of agreement on a symmetric agree-disagree scale of a statement.

Likert appearance for select one

By setting the appearance value to autocomplete, a select one question is presented with a text field and a drop-down menu. Entering text into the field limits the drop-down menu to only answers that contain that text. This is ideal for very long choice lists.

Autocomplete appearance for select one

By setting the appearance value to image-map, a select one question is presented as the image referred to in the media::image column, with selectable regions of the image as choices. To function, this appearance type requires an SVG file to be provided in the survey's media folder and the name values of the choice list to match the path IDs for the SVG file's regions. For more information, see Work with SVG files.

Image-map appearance for select one
Note:

The image-map appearance value is not supported in the Survey123 web app.

Select multiple

By setting the appearance value to minimal, a select multiple question is presented in a drop-down menu.

By setting the appearance value to horizontal, a select one question is presented horizontally in columns of equal width.

In the Survey123 field app, the horizontal and horizontal-compact appearances are identical. In the Survey123 web app, the horizontal-compact appearance fits the choice labels for a select one question side by side in rows, without additional spacing.

By setting the appearance value to image-map, a select multiple question is presented as the image referred to in the media::image column, with selectable regions of the image as choices. To function, this appearance type requires an SVG file to be provided in the survey's media folder and the name values of the choice list to match the path IDs for the SVG file's regions. For more information, see Work with SVG files.

Note:

The image-map appearance value is not supported in the Survey123 web app.

Geopoint

By setting the appearance value to hide-input, a geopoint question viewed in the Survey123 web app appears with a read-only coordinates value, as opposed to the default coordinate input box. This appearance value does not apply to the Survey123 field app.

Hide-input appearance for geopoint

Image

By setting the appearance value to signature, an image question is presented as an empty box to capture a signature or other freehand text or drawing.

Signature appearance for image

By setting the appearance value to draw, an image question displays a button to load a canvas on which you can sketch. The canvas used for drawing is the same size as the device's screen resolution. You can use the smart sketching tool to generate shapes and add text annotations to the sketch.

Draw appearance for image

By setting the appearance value to annotate, an image question displays a button to open the device's camera to take a photo that can then be drawn on. The canvas used for annotation is the same size as the device's screen resolution. Unlike the draw appearance above, annotate also provides options to use a screen capture of a map, or an existing image from device storage that can then be rotated and used for sketching. These images are resized to fit the canvas.

To limit the user to only one or two forms of image capture for annotation, set bind::esri:style for that question to method=camera, method=browse, or method=map, or any combination of two of them, for example method=camera,browse. The question disables all other forms of providing an image.

Defaults and calculations behave differently with image questions using draw and annotate. If the file name of an image in the survey's media folder is used as a default value or the result of a calculation, the image is used as an initial background for the canvas. With annotate, this image is replaced by a provided image, and only displays if the user specifically declines to provide an image.

By setting the appearance value to multiline, an image question accepts multiple images in a single image question. This appearance type can be combined with any other image appearance type by setting both appearances separated by a space, such as multiline annotate.

Spike images

Image questions also support appearance types to integrate Survey123 with Spike, a laser measurement solution developed by ikeGPS that allows you to capture the measurements and location of an object from a photo. By setting the appearance value to spike, spike-full-measure, or spike-point-to-point, an image question displays a button to open the Spike mobile app on iOS and Android devices.

Spike appearance for images

A photo taken with the Spike app and laser device allows you to record the coordinates of and distance to the object, and measure the dimensions of objects in the photo through drawing areas and lines. The photo with measurement markup is then attached to your survey, and the metadata from the photo, such as coordinates and measurements, is made available to be recorded. Associated Spike and measurement metadata is recorded in the image file using standard Exchangeable Image File (EXIF) tags. The EXIF information can then be extracted and used to populate other fields.

The difference between the Spike appearance types is the extent of values stored in the image. The spike appearance only measures distance and location, while the spike-full-measure appearance type measures distance, location, area, and length. The spike-point-to-point appearance type captures a series of values exclusive to it, denoted by the property names beginning with P2P.

For more information about these EXIF tags, see Media. For more information about Spike, see the ikeGPS products page.

Integer

By setting the appearance value to distress, an integer question is displayed as a distress scale. A distress scale is a 10-point scale used to measure feelings such as stress, pain, and happiness.

Distress appearance for integer

By setting the appearance value to spinner, an integer question is displayed with buttons to increase or decrease the value by one. Selecting the button repeats the progression until the button is released.

By setting the appearance value to numbers, a highlighted integer question is accompanied by a custom numeric keyboard to enter a value. The keyboard also includes a button to make the value positive or negative.

Numbers appearance for integer

By setting the appearance value to calculator, a highlighted integer question is accompanied by a custom calculator keyboard to enter and modify a value.

Calculator appearance for integer

Decimal

By setting the appearance value to spinner, a decimal question is displayed with buttons to increase or decrease the last digit of the value by one. Selecting a button repeats the progression until the button is released.

Spinner appearance for decimal

Use a default to define the number of decimal places for a question, and the spinner adheres to it. The following are examples of how the spinner handles different decimal values:

  • 1.0 increases to 1.1, 1.2, 1.3, 1.4
  • 3.07 increases to 3.08, 3.09, 3.10, 3.11
  • 2.000000 increases to 2.000001, 2.000002, 2.000003

By setting the appearance value to numbers, a decimal question is accompanied by a custom numeric keyboard to enter a value. The keyboard also includes a button to make the value positive or negative.

By setting the appearance value to calculator, a highlighted decimal question is accompanied by a custom calculator keyboard to enter and modify a value.

By setting the appearance value to thousands-sep, the answer to a decimal question appears with thousands separators. This does not affect the value sent as part of the survey response, only the display in the app. The separators are set by the device's locale and are applied only on opening a survey from Drafts, Outbox, Inbox, or the Sent box or when the response is populated by a default or calculation. Thousands separators do not appear when manually inputting a value.

Thousands-sep appearance for decimal

Range

By setting the appearance value to no-ticks, a range question displays without the lines to show positions on the range slider, or the minimum and maximum values. This doesn't change the behavior of the question, only the display.

Bar code

By setting the appearance value to minimal, a bar code question displays with only a single button to start the scanner. The text box that contains the value for the bar code question is not visible.

Minimal appearance for bar code

Group

By setting the appearance value of a begin group question to compact, a group of questions appears collapsed on startup and can be expanded by the user. This is useful for long surveys that can be difficult for the user to read and navigate. This appearance is defined in the begin group question.

Collapsed group compared to expanded group

The minimal appearance value has no effect on group questions.

By setting the appearance value of a begin group question to table-list, the select_one questions in the group with a common choice list appear in a table format, with the top row displaying the choice list labels and the left column displaying the question labels.

Table list appearance for a group with select_one questions
Note:

The table-list appearance does not support select_multiple questions and does not support media in choice lists.

The table-list appearance value will not function if placed in a theme-grid group.

By setting the style column on the settings sheet to pages and the appearance value of each begin group question to field-list, each group displays on a separate page of the survey. You can browse pages using the back and forward buttons at the bottom of the app. You can long press these buttons to browse to the start or end of the survey. You can also select the page number to convert it to a writable field and type a new page number. This is ideal for breaking down the display of your survey, organizing it, and decreasing load times.

Multiple pages in a single survey

By setting the style column on the settings sheet to theme-grid, groups in your survey can be set to display the contained questions in a grid. Set a group's appearance to w followed by the number of cells used to divide your grid. For example, w8 divides each row of your grid into eight cells. The relative width of each question in this group can be set in the same way; when the stated widths of the questions add up to the number of cells set for the group, the next questions will be on a new line. These widths can be set along with most other appearance types.

A group of questions in a grid
Note:

The theme-grid appearance value is not supported by the Survey123 web app.

A width can't be applied to a repeat. Instead, it must be applied to a group in the repeat.

A nested group will only occupy one of the parent group's cells.

Grid style groups do not support borderColor. Repeats in theme-grid surveys do not support backgroundColor, even if the repeat is outside of any grid style groups. For more information, see Esri custom columns.

The table-list appearance value will not function if placed in a theme-grid group.

File

By setting the appearance value to multiline, a file question accepts multiple files in a single file question.

Repeat

By setting the appearance value of a begin repeat question to minimal, a repeatable collection of questions is not visible on startup. The user must click the add button to see the questions in the repeat. This is useful when repeated questions don't need to be completed in a survey. This appearance is defined in the begin repeat question.

Minimal appearance for repeat

If a repeat is set to minimal and has a repeat count of zero, the repeat controls and their label are invisible.

By setting the appearance value of a begin repeat question to compact, a repeatable collection of questions appears in a collapsed state on startup, which can be expanded by the user. This is useful for large surveys that may be difficult for the user to read and navigate. This appearance is defined in the begin repeat question.

Unlike other appearance types, repeat can use both minimal and compact at the same time by setting the appearance value to minimal compact. This presents the questions in a repeat in both a collapsed (compact) and a hidden (minimal) manner.

By setting the style column on the settings sheet to pages and the appearance value of each begin repeat question to field-list, each repeatable collection of questions displays on a separate page of the survey. This behavior is the same for groups.