reportoptions

Use the reportoptions tag to specify display options which will be loaded every time the tile for that question appears in a Topline report. All of the options which can be selected from the Gear menu on a given tile can be edited via this tag.

For an overview of what these settings are, see the following pages:

• Closed-End Tile Display Options
• Closed-End Two-Axis (Summary) Tile Display Options
• Open-End Numeric Tile Display Options
• Open-End Summary Tile Display Options.

Syntax

To manually build reportoptions syntax, review the settings in the Topline report. 

Reporting GUI	Report Options Equivalent
	reportoptions: Options => {Sort_By => 'Description' }

Basic

Settings are referenced by their names, with strict case-sensitivity, and spaces replaced with underscores. The input is then specified with a "fat arrow" (=>). 

# Radio options are specified within single quotes.
reportoptions: Display_As=> 'Pie_Chart'

# Checkbox inputs are indicated with a '1':
reportoptions: Options => { Sort_Reverse => 1 }

# Open-end numeric inputs are bare:
reportoptions: Options => { Limit => 5 }

# Open-end strings are in single quotes:
reportoptions: Chart_Title => {Custom => {Title => 'Custom Title Here'}}

Advanced

When multiple options are to be picked within a checkbox level, each can be specified individually: Referencing options that are nested on the second or third tier within the menu requires the use of curly braces ({ }), as in the above example where a custom title is specified. The 'Title' dialog is exposed when the Custom option is selected (Gear > Chart Title > Custom), so it needs its own set of curly braces.

# Multiple options per setting
reportoptions: Base => {Select_Subset => { First => 1, Second => 1 } }

# Or
reportoptions: Base => { Select_Subset => [1,2] }


# Multiple settings
reportoptions: Chart_Title => {Custom => {Title => 'Custom Title Here'}}, Limit => 5,  Bars => { Median => 1 }


# Height and Width, specify factor of increase
report options: width => 'x2', height => 'x2'

NPS tile display settings

NPS questions are displayed as closed-end summary tiles, and by default, are displayed as grids. Although these tiles can be manually altered to display as charts, rather than altering each tile's Gear menu display options, Survey Programmers can instead use setclass and report options to establish their own default display options for NPS questions.

The following will ensure that any NPS questions use the Display As option Bar Charts, the Bars option Stacked, and that the response buckets are labeled "nps".

setclass: nps
type: radio
hscale: y
headings: Not at all likely, Extremely likely
0. 0 {desc: 0 - Not at all likely}
series: 1..9
10. 10 {desc: 10 - Extremely likely}
metric: transformed_average {args: 0-6 == -100; 7,8 == 0; 9,10 == 100} {desc: NPS}
reportoptions: <<END
    presets => 1,
    presets_menu => {
        1 => {
        name => 'NPS',
        report_options => {
            displayas => "Chart",
            bars => "Stacked",
            analyze => {
                responsebuckets => 'nps'
            }
        }
    }
}
END

Click on closed end summary tile display options for more information. Please see the information on NPS questions as well.