sgapiHideOption(%%questionID,%%reportingvalue, true/false)

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language. Visit our NEW Lua Scripting Resources!

Legacy Custom Scripting Language Deprecation Plans 

  1. New accounts (created after October 29, 2018) will only have the option to use Lua in scripts.
  2. As of October 29, 2018 Custom Scripting Actions will default to Lua as the scripting type in the Custom Scripting Action for accounts created before this date. You will be able to switch to the Legacy Custom Scripting; though we highly encourage using Lua.
  3. In the long term, Legacy Custom Scripting Actions will be switched to read-only. The exact date on this is to be determined; we will send notifications well ahead of time.

This function hides an answer option by reporting value. The true/false parameter can be used to support changes in answer options when respondents use the back button.

For grid questions the answer fields in column associated with that reporting value for all rows will be hidden. Note: this will not hide the column header itself.


Here, we use the function sgapiHideOption to hide an option from question 2 based on the answer to question 1. If the back button is used and the answer option is changed the else condition with the false paramenter will unhide the hidden option.

For the example script below, the survey is set up as follows:

Page 1: Source question (Question ID #2)

Page 2: Custom Script and Target question (Question ID#3)

Your custom script should be at the top of the page with the target question.

Check it out in an Example Survey

%%q1 = 2; //Question ID for question 1
%%q2 = 3; //Question ID for question 2
%%q2value_1='1'; //Reporting value for option 1
%%q2value_2='2'; //Reporting value for option 2

if (%%q1value == '1')
  sgapiHideOption(%%q2, %%q2value_1, true);

  sgapiHideOption(%%q2, %%q2value_1, false);

if (%%q1value == '2')
  sgapiHideOption(%%q2, %%q2value_2, true);

  sgapiHideOption(%%q2, %%q2value_2, false);