Lua Scripting Resources

Important Update to Custom Scripting

SurveyGizmo's CustomScript Action now supports the LUA programming language.


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. Read-only scripts will continue to function; you will just be prevented from editing. The exact date on this is to be determined; we will send notifications well ahead of time.


 Go to our Legacy Scripting Documentation.

While SurveyGizmo is one of the most flexible survey tools around, we get requests for customizations that are not available out of the box. This is where JavaScript and Custom Scripting can save the day. If you have scripting chops you can use the JavaScript action or the Custom Scripting action to achieve the survey of your dreams.


New Articles

  1. setcustomtablevalue

    Created On: 08/28/2017 in Survey Setter Functions
    This function allows you to set the value for an individual cell in a custom table question. Parameters* Description Type Required columnID the question ID of the Custom Table integer true rowname the row header text intege...

  2. setpageproperty

    Created On: 08/28/2017 in Survey Setter Functions
    This function allows you to set a specific property for a page with a given page ID for the active response session. Parameters* Description Required pageID the ID of the page true property the property you wish to set true ...

  3. submitsurveycomplete

    Created On: 08/28/2017 in Miscellaneous Functions
    This function submits the data on the current page and records the response as complete. All data collected on previous pages will be stored for reporting. Note: This function will not submit the current page and move to the next. To do that, use...

  4. getsurveyproperty

    Created On: 08/28/2017 in Survey Getter Functions
    This function returns the given property for the current survey. Parameters Description Required property property to get true Available Properties Description Return Values survey_interaction_desktop Desktop survey...

  5. renderquestionhtml

    Created On: 08/28/2017 in Survey Getter Functions
    This function renders the entire question including all the HTML associated with both the question title, description and answer options. Parameters Description Required questionID the ID of the question true Example In the b...

  6. submitsurvey

    Created On: 08/28/2017 in Miscellaneous Functions
    This function submits the data from the current page and records the response as a partial. All data from previous pages will be stored for reporting. Note: this will not submit the current page and move to the next. To do that, use jumptopage ....

  7. translate

    Created On: 08/28/2017 in Miscellaneous Functions
    The translate function creates a translation field for the specified string in the Text & Translation interface for each language version of your survey. The field is then available for each language in the Text & Translations interface to be tran...

  8. gettitle

    Created On: 08/28/2017 in Survey Getter Functions
    This function returns the title of a question. Using the language parameter you can return the title in the given language. The possible values for the language parameter values are the languages available in the translation menu . Languages mu...

  9. getquestionruntimeproperty

    Created On: 08/28/2017 in Survey Getter Functions
    This question returns the specified runtime property for the given question ID. See this function in action in an example survey . Parameters* Description Required questionID the ID of the question true property the property...

  10. responsereset

    Created On: 08/28/2017 in Miscellaneous Functions
    This function clears all data from the current response. See this function in action in an example survey . Example This function can be used to clear the current response (using responsereset) and begin again (using jumptopage). doover = getva...