Alchemer Lua Scripting

https://luascript.alchemer.com/help

Provides documentation and resources for using Lua scripting to customize and extend the...

Tokens:61,165

Snippets:666

Trust Score:9.7

Update:2 months ago

Show doc for...

Tokens:

Tokens:

### Custom Table Output Example

Source: https://luascript.alchemer.com/help/getvalue

Example of the multidimensional array structure returned by a Custom Table question.

```text
Array ( [3] => Array ( [TableRow-0] => Oil change,Tire repair [TableRow-1] => Tire repair,Brakes ) [4] => Array ( [TableRow-0] => Javier [TableRow-1] => John ) )
```

--------------------------------

### MaxDiff Output Example

Source: https://luascript.alchemer.com/help/getvalue

Example of the multidimensional array structure returned by a MaxDiff question.

```text
Array(
	[1] => Array(
		[attributes] => Array(
			[1] => Strawberry
			[2] => Starfruit
			[3] => Apples
			[4] => Papaya
		) 
		[best] => Papaya
		[worst] => Strawberry
	) [2] => Array(
		[attributes] => Array(
			[1] => Kiwi
			[2] => Banana
			[3] => Mango
			[4] => Peach
		) 
		[best] => Banana
		[worst] => Mango
	)
)
```

--------------------------------

### Radio Button Grid Output Example

Source: https://luascript.alchemer.com/help/getvalue

Example of the multidimensional array structure returned by a Radio Button Grid question.

```text
Array ( [37] => Array ( [10128] => Never ) [39] => Array ( [10130] => Sometimes ) [38] => Array ( [10129] => Rarely ) [40] => Array ( [10131] => Often ) )
```

--------------------------------

### Conjoint Output Example

Source: https://luascript.alchemer.com/help/getvalue

Example of the multidimensional array structure returned by a Conjoint question.

```text
Array(
	[1] => Array(
		[1] => Array(
			[attributes] => Array(
				[Price] => $300
				[Color] => Green
			)
			[score] => 100
		) [2] => Array(
			[attributes] => Array(
				[Price] => $250
				[Color] => Yellow
			)
			[score] => 0
		) [3] => Array(
			[attributes] => Array(
				[Price] => $399
				[Color] => Blue
			),
			[score] => 0
		) [4] => Array(
			[attributes] => Array() 
			[score] => 0
			[none] => 1
		)
	) [2] => Array(
		[1] => Array(
			[attributes] => Array(
				[Price] => $200
				[Color] => Green
			)
			[score] => 0
		) [2] => Array(
			[attributes] => Array() 
			[score] => 100
			[none] => 1
		) [3] => Array(
			[attributes] => Array(
				[Price] => $399
				[Color] => Yellow
			)
			[score] => 0
		) [4] => Array(
			[attributes] => Array(
				[Price] => $200
				[Color] => Blue
			) 
			[score] => 0
		)
	)
)
```

--------------------------------

### Calculate volume using question IDs

Source: https://luascript.alchemer.com/help/custom-scripting-with-question-aliases

Example of a volume calculation script using numeric question IDs.

```Lua
volume = getvalue(2) *  getvalue(3) *  getvalue(4)
```

--------------------------------

### Calculate volume using question aliases

Source: https://luascript.alchemer.com/help/custom-scripting-with-question-aliases

Example of a volume calculation script using descriptive aliases instead of numeric IDs.

```Lua
volume = getvalue("width") *  getvalue("height") *  getvalue("depth")
```

--------------------------------

### Set Question Runtime Properties Example

Source: https://luascript.alchemer.com/help/setquestionruntimeproperty

Demonstrates how to conditionally update question properties based on the value of another question.

```lua
flag = getvalue(2)

if flag == 'Required' then
  setquestionruntimeproperty(3,'Required',true)

elseif flag == 'Soft required' then

  setquestionruntimeproperty(3,'Soft-Required',true)

elseif (flag == 'Disabled') then

  setquestionruntimeproperty(3,'Disabled',true)

elseif (flag == 'Number') then

  setquestionruntimeproperty(3,'Number',"12.")

end
```

--------------------------------

### Example HTML for a Textbox Question

Source: https://luascript.alchemer.com/help/using-css-classes-in-javascript

The structure of a standard textbox question element in an Alchemer survey.

```html
<div id="sgE-2081629-1-3-box" class="sg-question sg-type-textbox first">
        <input type="hidden" id="sgE-2081629-1-3-meta" name="sgE-2081629-1-3-meta" value="hidden=false&amp;required=false">
        <input type="hidden" id="sgE-2081629-1-3-time" name="sgE-2081629-1-3-time" value="">
            <div class="sg-question-title">
                <label for="sgE-2081629-1-3-element">
                <span class="sg-question-number">2.</span> Most important philosopher</label>
                </div>
            <div class="sg-question-options">   
        <div class="sg-control-text sg-control-text">

            <input type="text" id="sgE-2081629-1-3-element" name="sgE-2081629-1-3" title="Most important philosopher" class="sg-input sg-input-text " value="">    </div>
                <!-- /sg-question-options -->
            </div>
            <!-- /sge-box -->
    </div>
```

--------------------------------

### Set Page Property Example

Source: https://luascript.alchemer.com/help/setpageproperty

Demonstrates how to update the status_change property to complete for a specific page ID.

```lua
pageID = 1
propertyname = 'status_change'
value = 'complete'

setpageproperty(pageID, propertyname, value)
```

--------------------------------

### Retrieve Multi-Answer Question Values

Source: https://luascript.alchemer.com/help/getvalue

Examples for accessing data from questions that return an array of values, such as checkboxes or ranking grids.

```Lua
print(getvalue(questionID))
```

```Lua
print('The answers to '..(gettitle(questionID))..(' are: ')..(implode(',',getvalue(questionID))))
```

```Lua
questionID = 2
optiontitles = getquestionoptions(questionID)
if isanswered(questionID) then
	for optionID,reportingvalue in pairs(getvalue(questionID)) do
        print('The answer to question: ')
 		print(gettitle(questionID) .. ' ' ..optiontitles[optionID] .. ' is ' .. reportingvalue)
	end
end
```

```Lua
optiontitles = getquestionoptions(8)
for optionID,rank in pairs(getvalue(8)) do
 if rank then
	print('In question '..gettitle(8))
	print(', option '..optiontitles[optionID]..' is ranked '..rank..'<br>')
 end
end
```

```Lua
question = getvalue(questionID)
option = question[optionID]
```

--------------------------------

### Hide Option Logic Example

Source: https://luascript.alchemer.com/help/hideoption

Demonstrates using hideoption to conditionally show or hide options in a target question based on the value selected in a source question.

```lua
q1 = 2 -- Question ID for question 1 (source question)
q2 = 3 --Question ID for question 2 (target question)
q2value_1='1' --Reporting value for option 1
q2value_2='2' --Reporting value for option 2

q1value=getvalue(q1)
 
if (q1value == '1') then

  hideoption(q2, q2value_1, true)

else
  
  hideoption(q2, q2value_1, false)
  
end

if (q1value == '2') then

  hideoption(q2, q2value_2, true)

else

  hideoption(q2, q2value_2, false)
  
end
```

--------------------------------

### Retrieve Single-Answer Question Values

Source: https://luascript.alchemer.com/help/getvalue

Examples for accessing data from questions that return a single value, such as radio buttons or textboxes.

```Lua
print(getvalue(questionID))
```

```Lua
print('The answer to question ' .. gettitle(questionID) .. ' is ' .. getvalue(questionID))
```

--------------------------------

### Pipe rows into a Custom Table

Source: https://luascript.alchemer.com/help/pipematrixrows

This example demonstrates how to collect values from various question types and pipe them into a Custom Table using the pipematrixrows function.

```lua
staticvalue = 'Static Value' --Static Value
radiobutton = getvalue(10) --Answer from Radio Button
rbgrow1 = getvalue(12) --Answer for Radio Button Grid Row 1
rbgrow2 = getvalue(13) --Answer for Radio Button Grid Row 2

pipematrixrows(6, {staticvalue, radiobutton, rbgrow1, rbgrow2}) --set values for row
```

--------------------------------

### Merge code using question alias

Source: https://luascript.alchemer.com/help/custom-scripting-with-question-aliases

Example of a merge code referencing a question by its alias.

```text
[question("value"), id="depth"]
```

--------------------------------

### Remove Option Example

Source: https://luascript.alchemer.com/help/removeoption

Demonstrates removing an option from a second question based on the selected value of a first question.

```lua
q1 = 2
q2 = 3
 
value1 = getvalue(q1)
 
removeoption(q2,value1)
```

--------------------------------

### Create and Attach a PDF with Custom Styling

Source: https://luascript.alchemer.com/help/setcolorpdf

Demonstrates initializing a PDF, setting font and color properties, adding images and tables, and attaching the final output to an email action.

```lua
pdf = "Example PDF"
text = "Text to include in PDF"
size = 14
options = {['spacing'] = 1.5}
table = {row1={1,2,3,4}, row2={5,6,7,8}, row3={9,10,11,12}}
columns = {'Column A','Column B','Column C','Column D'}

newpdf(pdf,'letter','portrait')
setfontpdf(pdf,'courier')
setcolorpdf(pdf,0,1,1)
imagepdf(pdf,'https://alchmerlibrary.s3.amazonaws.com/library/160589/surveysoftwareapi.png') 
textpdf(pdf,text,size,options)
tablepdf(pdf,table,columns,'Table Title')

formattedpdf = pdfoutput(pdf)

attachment = {}

attachment['example.pdf'] = formattedpdf

--Attach to existing send email action (ID 30)
setquestionproperty(30,"email_attachments",attachment)
```

--------------------------------

### Create and Attach a PDF with an Image

Source: https://luascript.alchemer.com/help/imagepdf

Demonstrates initializing a PDF, adding an image using imagepdf, and attaching the resulting file to an email action.

```lua
pdf = "Example PDF"
text = "Text to include in PDF"
size = 14
options = {['spacing'] = 1.5}
table = {row1={1,2,3,4}, row2={5,6,7,8}, row3={9,10,11,12}}
columns = {'Column A','Column B','Column C','Column D'}

newpdf(pdf,'letter','portrait')
setfontpdf(pdf,'courier')
setcolorpdf(pdf,0,1,1)
imagepdf(pdf,'https://alchemerlibrary.s3.amazonaws.com/library/160589/surveysoftwareapi.png') 
textpdf(pdf,text,size,options)
tablepdf(pdf,table,columns,'Table Title')

formattedpdf = pdfoutput(pdf)

attachment = {}

attachment['example.pdf'] = formattedpdf

--Attach to existing send email action (ID 30)
setquestionproperty(30,"email_attachments",attachment)
```

--------------------------------

### Create and Attach a PDF with setfontpdf

Source: https://luascript.alchemer.com/help/setfontpdf

This script demonstrates the full workflow of initializing a PDF, setting its font, adding content, and attaching it to an email action.

```lua
pdf = "Example PDF"
text = "Text to include in PDF"
size = 14
options = {['spacing'] = 1.5}
table = {row1={1,2,3,4}, row2={5,6,7,8}, row3={9,10,11,12}}
columns = {'Column A','Column B','Column C','Column D'}

newpdf(pdf,'letter','portrait')
setfontpdf(pdf,'courier')
setcolorpdf(pdf,0,1,1)
imagepdf(pdf,'https://allchemerlibrary.s3.amazonaws.com/library/160589/surveysoftwareapi.png') 
textpdf(pdf,text,size,options)
tablepdf(pdf,table,columns,'Table Title')

formattedpdf = pdfoutput(pdf)

attachment = {}

attachment['example.pdf'] = formattedpdf

--Attach to existing send email action (ID 30)
setquestionproperty(30,"email_attachments",attachment)
```

--------------------------------

### Retrieve Question Options with getquestionoptions

Source: https://luascript.alchemer.com/help/getquestionoptions

Demonstrates how to output both answer option titles and reporting values for a specific question ID.

```lua
question = 2
title = "Title"
value = "Reporting"

print (getquestionoptions(question,title))
print (getquestionoptions(question,value))
```

--------------------------------

### Get response count for a question

Source: https://luascript.alchemer.com/help/getquestionresponsecount

Displays the total response count for a specific question ID.

```Lua
print(getquestionresponseCount(2))
```

--------------------------------

### Get Total Checked Checkboxes

Source: https://luascript.alchemer.com/help/checkboxtotalchecked

Outputs the count of selected checkboxes for a specified question ID to the page.

```lua
print(checkboxtotalchecked(2))
```

--------------------------------

### Post Survey Response with listadd

Source: https://luascript.alchemer.com/help/listadd

Demonstrates how to populate textbox, radio button, and checkbox responses before submitting them using the listadd function.

```lua
surveyID = 1524919
questions = {}

--textbox question, id = 2
question[2] = 'test'

--radio question, id = 3, selecting option with reporting value b
question[3] = 'b'

--checkbox question, id = 4, selecting options with reporting values a and c
question[4] = array('a','c')

listadd(surveyID, questions)
```

--------------------------------

### Get response count for a question option

Source: https://luascript.alchemer.com/help/getquestionresponsecount

Displays the response count for a specific answer option within a question.

```Lua
option=10001
print(getquestionresponsecount(2,option))
```

--------------------------------

### Render a question using renderquestionhtml

Source: https://luascript.alchemer.com/help/renderquestionhtml

Prints the full HTML representation of a question identified by its ID.

```lua
print(renderquestionhtml(2))
```

--------------------------------

### Create a new PDF page

Source: https://luascript.alchemer.com/help/newpagepdf

Use this function to initialize a new page within a PDF object.

```lua
newpagepdf(pdf)
```

--------------------------------

### Set Page Starting Number

Source: https://luascript.alchemer.com/help/setpagestartingnumber

Use this function at the beginning of a survey page to reset the question numbering to a specific value.

```lua
setpagestartingnumber(1)
```

--------------------------------

### setpagestartingnumber(questionnumber)

Source: https://luascript.alchemer.com/help/setpagestartingnumber

Sets the starting number for the first question on a survey page. This function can be used on each page to reset or customize question numbering.

```APIDOC
## setpagestartingnumber(questionnumber)

### Description
Sets the number of the first question of the page (default is 1). You can use this script on each page to restart the question numbering on each page.

### Parameters
- **questionnumber** (integer) - Optional - Question number to start at.

### Example
```lua
setpagestartingnumber(1)
```
```

--------------------------------

### New Lua Functions

Source: https://luascript.alchemer.com/help/lua-function-changes

List of standard Lua functions and libraries now available for use in Custom Scripting Actions.

```lua
print
pairs
next
pcall
tonumber
tostring
type
unpack
string.byte
string.char
string.find
string.format
string.gmatch
string.gsub
string.len
string.lower
string.match
string.rep
string.reverse
string.sub
string.upper
table.insert
table.maxn
table.remove
table.sort
math.abs
math.acos
math.asin
math.atan
math.atan2
math.ceil
math.cos
math.cosh
math.deg
math.exp
math.floor
math.fmod
math.frexp
math.huge
math.ldexp
math.log
math.log10
math.max
math.min
math.modf
math.pi
math.pow
math.rad
math.random
math.sin
math.sinh
math.sqrt
math.tan
math.tanh
os.difftime
os.time
os.clock
```

--------------------------------

### Retrieve Table Question SKUs

Source: https://luascript.alchemer.com/help/gettablequestionskus

Outputs the array of SKUs for a table question with the specified ID to the page.

```Lua
print (gettablequestionskus(51))
```

--------------------------------

### Get response count for a specified response status

Source: https://luascript.alchemer.com/help/getquestionresponsecount

Retrieves the response count for a question filtered by a specific status, using an empty string for the optionID parameter.

```Lua
questionID = 2
optionID = ''
status = "Complete"

getquestionresponsecount(questionID,optionID,status)
```

--------------------------------

### Retrieve and print answer counts for various question types

Source: https://luascript.alchemer.com/help/questionsansweredonpage

Demonstrates how to count answered questions for different question types across various pages and output the results.

```lua
cascadingdd = questionsansweredonpage(1,'CASCADING_DROPDOWN')
checkbox = questionsansweredonpage(1,'CHECKBOX')
conjoint = questionsansweredonpage(2,"CONJOINT_NEW")
contsum = questionsansweredonpage(1,'CONT_SUM') 
essay = questionsansweredonpage(1,'ESSAY')
file = questionsansweredonpage(1,'FILE')
group = questionsansweredonpage(1,'GROUP')
heatmap = questionsansweredonpage(1,'HEATMAP')
imageselect = questionsansweredonpage(1,'IMAGE_SELECT')
matrix = questionsansweredonpage(1,'MATRIX')
maxdiff = questionsansweredonpage(3,'MAXDIFF')
menu = questionsansweredonpage(1,'MENU')
multislider = questionsansweredonpage(1,'MULTI_SLIDER')
multitext = questionsansweredonpage(1,'MULTI_TEXTBOX')
nps = questionsansweredonpage(1,'NPS')
radio = questionsansweredonpage(1,'RADIO')
rank = questionsansweredonpage(1,'RANK')
reaction = questionsansweredonpage(1,'REACTION')
signature = questionsansweredonpage(1,'SIGNATURE')
slider = questionsansweredonpage(1,'SLIDER')
table = questionsansweredonpage(1,'TABLE')
textbox = questionsansweredonpage(1,'TEXTBOX')
texthighlighter = questionsansweredonpage(1,'TEXTHIGHLIGHTER')


print(cascadingdd)
print(checkbox)
print(conjoint)
print(contsum)
print(essay)
print(file)
print(group)
print(heatmap)
print(imageselect)
print(matrix)
print(maxdiff)
print(menu)
print(multislider)
print(multitext)
print(nps)
print(radio)
print(rank)
print(reaction)
print(signature)
print(slider)
print(table)
print(textbox)
print(texthighlighter)
```

--------------------------------

### Output the survey referrer

Source: https://luascript.alchemer.com/help/referrer

Prints the URL of the webpage that linked to the survey for the current respondent.

```lua
print(referrer())
```

--------------------------------

### Generate and Email PDF from Survey Content

Source: https://luascript.alchemer.com/help/htmltopdf

Creates a PDF from a survey question's value and attaches it to an existing email action.

```lua
contents = getvalue(2)
pdf = htmltopdf(contents)

attachment['filename.pdf'] = pdf

--Attach to existing send email action (ID 3)
setquestionproperty(3,"email_attachments",attachment)
```

--------------------------------

### Submit Survey as Partial

Source: https://luascript.alchemer.com/help/submit-survey

Executes a partial submission of the current survey page when the action is triggered.

```lua
submitsurvey()
```

--------------------------------

### Retrieve a question property

Source: https://luascript.alchemer.com/help/getquestionproperty

Use this function to look up specific settings like 'required' status for a question by providing its ID and the property name.

```lua
questionID = 2
property = 'required'

getquestionproperty(questionID, property)
```

--------------------------------

### Shuffle a Lua Table

Source: https://luascript.alchemer.com/help/tableshuffle

Demonstrates how to use the tableshuffle function to create a randomized version of an existing array.

```lua
arr = {8,9,11,12,13,14,15,16,17,18}

print(arr)

shuffledarr = tableshuffle(arr)
print(shuffledarr)
```

--------------------------------

### Retrieve Table Question Titles

Source: https://luascript.alchemer.com/help/gettablequestiontitles

Outputs an array of table question titles and IDs for a given question ID.

```Lua
print (gettablequestiontitles(51))
```

--------------------------------

### Attach Files to Existing Email Action via setquestionproperty

Source: https://luascript.alchemer.com/help/attaching-files-to-email

Attaches a generated file to a pre-existing email action by updating the email_attachments property.

```lua
pdf = "Example PDF"
text = "Text to include in PDF"
size = 14
options = {}
options['spacing'] = 1.5
table = { {1,2,3,4}, {5,6,7,8}, {9,10,11,12} }
columns = {'Column A','Column B','Column C','Column D'}

newpdf(pdf,'letter','portrait')
setfontpdf(pdf,'courier')
setcolorpdf(pdf,0,0,0)
textpdf(pdf,text,size,options)
tablepdf(pdf,table,columns,'Table Title')

formattedpdf = pdfoutput(pdf)

attachment = {}
attachment['example.pdf'] = formattedpdf

--Attach to existing send email action (ID 5)
setquestionproperty(5,"email_attachments",attachment)
```

--------------------------------

### Mark Survey as Complete

Source: https://luascript.alchemer.com/help/submitsurveycomplete

Executes the completion function when the Custom Script action is triggered on page load.

```lua
submitsurveycomplete()
```

--------------------------------

### Hide and Show Pages Conditionally

Source: https://luascript.alchemer.com/help/hidepage

Hides specific pages by default and reveals them based on user input from a previous question.

```lua
hidepage(3,true)
hidepage(4,true)

jediorsith = getvalue(2)

if (jediorsith == 'jedi') then
  pageid = '3'
else 
  pageid = '4'
end
   
hidepage(pageid,false)
```

--------------------------------

### Calculate Total Amount Due

Source: https://luascript.alchemer.com/help/performing-basic-math-using-scripting-add-subtract-multiply-and-divide

Multiplies a value retrieved from a textbox by a fixed price and stores the result in another question.

```Lua
numberofshirts = getvalue(5) --Get value of first textbox
shirtprice = 15 --Replace 15 with amount of shirt

totalamountdue = (numberofshirts * shirtprice) --Multiply the first textbox times the shirt amount
  
setvalue(6,totalamountdue) --Change 6 to ID of Hidden Value or Textbox
```

--------------------------------

### Iterate Textbox and Ranking Grid Answers

Source: https://luascript.alchemer.com/help/getvalue

Iterates through grid question results including column titles to print detailed response information.

```lua
local questionId = 6 -- Change this to the corresponding question id
local columnTitles = getquestionoptions(questionId)

for rowId, row in pairs(getvalue(questionId)) do  
  for optionId, userResponse in pairs(row) do    
    print('Question: '.. gettitle(questionId))    
    print('Row: '     .. gettitle(rowId))   
    print('Column: '  .. columnTitles[optionId])    
    print('Answer: '  .. userResponse .. '<br>')  
  end
end
```

--------------------------------

### renderquestionhtml(questionID)

Source: https://luascript.alchemer.com/help/renderquestionhtml

Renders the entire question including all the HTML associated with the question title, description, and answer options.

```APIDOC
## renderquestionhtml(questionID)

### Description
This function renders the entire question including all the HTML associated with both the question title, description and answer options.

### Parameters
- **questionID** (integer) - Required - The ID of the question to render.

### Example
```lua
print(renderquestionhtml(2))
```
```

--------------------------------

### newpdf(pdf, paper, orientation)

Source: https://luascript.alchemer.com/help/newpdf

Creates a new PDF object that can be built, output, and sent via email.

```APIDOC
## newpdf(pdf, paper, orientation)

### Description
Creates a PDF object that you can store, build, output, and send via the emailsend function.

### Parameters
- **pdf** (string) - Required - The title of the PDF you are creating.
- **paper** (string) - Optional - The paper size, e.g. 'letter', 'legal', 'a4'. Defaults to 'letter'.
- **orientation** (string) - Optional - The orientation of the PDF, e.g. 'portrait'. Defaults to 'portrait'.

### Example
```lua
pdf = "Example PDF"
newpdf(pdf, 'letter', 'portrait')
```
```

--------------------------------

### Retrieve Piped SKUs with getpipeskus

Source: https://luascript.alchemer.com/help/getpipeskus

Use this function to output the SKUs and their associated values for a specific question ID.

```lua
print(getpipeskus(3))
```

--------------------------------

### Execute Action with runaction

Source: https://luascript.alchemer.com/help/runaction

Triggers the action associated with the specified question ID.

```lua
runaction(27)
```

--------------------------------

### Aggregate Continuous Sums with Lua

Source: https://luascript.alchemer.com/help/add-two-continuous-sums-into-a-third

This script retrieves values from two continuous sum questions, strips currency symbols, calculates the totals, and stores them in hidden values before jumping to the next page.

```lua
contsum1 = 7 --Question ID for first Continuous Sum
contsum2 = 8 --Question ID for second Continuous Sum
sum1 = 5 -- ID of hidden value for first sum
sum2 = 6 -- ID of hidden value for second sum
next_pageID = 3 --ID of page to jump to so page with script does not show.

array = getvalue(contsum1) 
chars = {'%','$','₠','₡','₢','₣','₤','₥','₦','₧','₨','₩','₪','₫','€','₭','₮','₯','₱','₲','₳','₴','₵','₶','₷','₸','₹'}

finalval=0

for key,value in pairs (array) do

  val = str_replace(chars, '', value) 
  val = tonumber(val)
  finalval = finalval+val

end

setvalue(sum1,finalval)


array2 = getvalue(contsum2) 

finalval2 = 0

for key2,value2 in pairs (array2) do

  val2 = str_replace(chars, '', value2);  
  val2 = tonumber(val2)
  finalval2 = finalval2+val2

end

setvalue(sum2,finalval2)

jumptopage(next_pageID) 
```

--------------------------------

### Send Email with Attachments via emailsend

Source: https://luascript.alchemer.com/help/attaching-files-to-email

Uses the emailsend function to define all email parameters and include attachments directly within the script execution.

```lua
pdf = "Example PDF"
text = "Text to include in PDF"
size = 14
options = {}
options['spacing'] = 1.5
table = { {1,2,3,4}, {5,6,7,8}, {9,10,11,12} }
columns = {'Column A','Column B','Column C','Column D'}

newpdf(pdf,'letter','portrait')
setfontpdf(pdf,'courier')
setcolorpdf(pdf,0,0,0)
textpdf(pdf,text,size,options)
tablepdf(pdf,table,columns,'Table Title')

formattedpdf = pdfoutput(pdf)

attachment = {}
attachment['example.pdf'] = formattedpdf

to = getvalue(3)
toname = getvalue(2)
textBody = ''
bcc = ''
htmlBody = "Thank you for completing the survey. Your response is appreciated
We will be in touch shortly!.

 Thanks,
Your Company"

emailsend(to, toname, "your.company@company.com", "Your Company", "Your Assessment Results", textBody, htmlBody, bcc, to, "html", attachment)
```

--------------------------------

### Set Drag & Drop Ranking Values

Source: https://luascript.alchemer.com/help/setvalue

Sets ranking values for a Drag & Drop question using option SKUs as keys in an array.

```lua
setvalue(2,{[10001] = 4, [10002] = 3, [10003] = 2, [10004] = 1})
```

--------------------------------

### Iterate Checkbox Grid Answers

Source: https://luascript.alchemer.com/help/getvalue

Prints all selected answers for each row of a checkbox grid question using implode.

```lua
for rowid,rowarray in pairs(getvalue(questionID)) do 
 print('Question '.. gettitle(questionID)..': The answers to row '..gettitle(rowid)..' are '..implode(',',rowarray)..'
')
```

--------------------------------

### Style Placeholder Text with CSS

Source: https://luascript.alchemer.com/help/add-placeholder

Applies custom styling to the placeholder text, such as changing the font color to light gray. Add this to the Custom CSS tab in the HTML/CSS Editor.

```css
.placeholder {color: #a9a9a9 !important;}
```

--------------------------------

### Randomly display and record Text/Instruction fields

Source: https://luascript.alchemer.com/help/show-a-random-set-of-textinstruction-fields

This script hides unselected fields and records the identifiers of the shown fields into a hidden Textbox question. Requires assigning unique CSS classes to text elements and a hidden textbox with the class 'shown'.

```javascript
$(document).ready(function() {
	var numToShow = 2; //Change this number to how many fields we need to show
  
  /*-----Don't touch anything below this line-----*/
	var textEls = $('.sg-type-instruction');
	var randIndices = [];
  var shownArr = [];
  var shownStr;
	
	for (var i = 0; i < numToShow; i++) {
		var randIndex = Math.floor(Math.random() * textEls.length);
		do {
			randIndex = Math.floor(Math.random() * textEls.length);
		} while (randIndices.indexOf(randIndex) !== -1);
		
		randIndices.push(randIndex);
	}
	//console.log(randIndices);
	textEls.each(function(i, el) {
		if (randIndices.indexOf(i) === -1) {
			$(this).remove();
			//console.log('set for removal: #' + i);
		} else {
			var classArr = $(this).attr('class').split(' ');
			//Fix for Preview
			if (classArr.indexOf('sg-cc-hook') !== -1) classArr.splice(classArr.indexOf('sg-cc-hook'), 1);
			var shownClass = classArr[classArr.length - 1];
			shownArr.push(shownClass);
		}
	});
  	shownStr = shownArr.join(',');
  	$('.shown').find('input[type="text"]').val(shownStr);
});
```

--------------------------------

### Retrieve Current Page SKU

Source: https://luascript.alchemer.com/help/currentpagesku

Outputs the current page SKU to the survey page using the currentpagesku function.

```lua
print(currentpagesku())
```

--------------------------------

### Calculate and Store Continuous Sum Total

Source: https://luascript.alchemer.com/help/using-continuous-sum-total-in-a-merge-code

This script iterates through Continuous Sum data, strips currency symbols, calculates the total, and saves it to a specified hidden value question.

```lua
contsum = 2 --Continuous Sum QuestionID
hiddenvalue = 5 --QuestionID of hidden value that will store total


contsum_data = getvalue(contsum) 
finalval=0


for key,value in pairs(contsum_data) do

  chars = {',','%','$','₠','₡','₢','₣','₤','₥','₦','₧','₨','₩','₪','₫','€','₭','₮','₯','₱','₲','₳','₴','₵','₶','₷','₸','₹'}

  val = str_replace(chars, '', value)  
  
  finalval = finalval + val
end


setvalue(hiddenvalue,finalval)
```

--------------------------------

### Attach Custom PDF to Email Action

Source: https://luascript.alchemer.com/help/setquestionproperty

Generates a PDF and attaches it to a send email action using the email_attachments property.

```lua
pdf = "Example PDF"
text = "Hello World!"
size = 14
options = {['spacing'] = 1.5}
table = {row1={1,2,3,4}, row2={5,6,7,8}, row3={9,10,11,12}}
columns = {'Column A','Column B','Column C','Column D'}

newpdf(pdf,'letter','portrait')
setfontpdf(pdf,'courier','Bold')
setcolorpdf(pdf,0,0,0)
imagepdf(pdf,'https://alchmerlibrary.s3.amazonaws.com/library/160589/communitylogo.png')
textpdf(pdf,text,size,options)
tablepdf(pdf,table,columns,'Table Title')

formattedpdf = pdfoutput(pdf)

attachment = {}

attachment['example.pdf'] = formattedpdf

setquestionproperty(3,"email_attachments",attachment)
```

--------------------------------

### getquestionoptions(questionID, type)

Source: https://luascript.alchemer.com/help/getquestionoptions

Retrieves an array of options for a given question ID.

```APIDOC
## getquestionoptions(questionID, type)

### Description
This function returns an array of options for the given question. It can return either the option title or the reporting value based on the provided type parameter.

### Parameters
- **questionID** (integer) - Required - The ID of the question.
- **type** (string) - Optional - The value type to retrieve. Possible values: "Reporting", "Title". Defaults to "Title".

### Usage Example
```lua
question = 2
title = "Title"
value = "Reporting"

print (getquestionoptions(question,title))
print (getquestionoptions(question,value))
```
```

--------------------------------

### Send Email via emailsend

Source: https://luascript.alchemer.com/help/emailsend

Sends a confirmation email to a respondent using values retrieved from the survey. Ensure all required parameters are provided in the correct order.

```lua
to = getvalue(7)
toname = getvalue(1)
textbody = ''
bcc = ''
htmlbody = "Thank you for completing the survey. Your response is appreciated<br />We will be in touch shortly!.<br /><br /> Thanks,<br />Your Company"

emailsend(to, toname, "your.company@company.com", "Your Company", "Your Assessment Results", textbody, htmlbody, bcc, to, "html")
```

--------------------------------

### imagepdf(pdf, image, pad, width, resize, just, border)

Source: https://luascript.alchemer.com/help/imagepdf

Adds an image to a specified PDF object. Parameters must be provided in the exact order specified.

```APIDOC
## imagepdf(pdf, image, pad, width, resize, just, border)

### Description
Adds an image to the given PDF object.

### Parameters
- **pdf** (string) - Required - The title of the PDF you are creating.
- **image** (string) - Required - The image URL.
- **pad** (number) - Optional - Image padding by page unit. Defaults to 5.
- **width** (number) - Optional - The width of the image on the page. Defaults to 0.
- **resize** (string) - Optional - Can be 'full', 'width', or 'none'.
- **just** (string) - Optional - The horizontal position of the image.
- **border** (array) - Optional - An array of possible border options.

### Example
```lua
imagepdf(pdf,'https://alchemerlibrary.s3.amazonaws.com/library/160589/surveysoftwareapi.png')
```
```

--------------------------------

### Retrieve a Question Title in Spanish

Source: https://luascript.alchemer.com/help/gettitle

Demonstrates how to fetch a question title for a specific ID in a non-English language.

```lua
question = 2
language = "Spanish"

print(gettitle(question, language))
```

--------------------------------

### Pipe Question Values with setpipevalues

Source: https://luascript.alchemer.com/help/setpipevalues

Use this function to pipe an array of values from a source question to a target question.

```lua
valuestopipe = getvalue(4)
pipetarget = 5

setpipevalues(pipetarget, valuestopipe)
```

--------------------------------

### Set Multi-Answer Question Value

Source: https://luascript.alchemer.com/help/setvalue

Sets multiple options for a checkbox question by passing an array of reporting values.

```lua
options = {"Cats","Dogs"}
setvalue(2,options)
```

--------------------------------

### Synchronize Table Row Order

Source: https://luascript.alchemer.com/help/settableorderbytable

Use this script to order the rows of a target table based on the randomization order of a reference table. Both tables must share identical row headers.

```lua
table = 12
reftable = 3

settableorderbytable(table,reftable)
```

--------------------------------

### Hide and Show Questions with hidequestion

Source: https://luascript.alchemer.com/help/hidequestion

Use this function to toggle question visibility by passing the question ID and a boolean value. Setting the second parameter to true hides the question, while false displays it.

```lua
hidequestion(3, true)

question1 = getvalue(2)

if (question1 == "yes") then
    hidequestion(3,false)
end
```

--------------------------------

### Display Signature Image via Lua Script

Source: https://luascript.alchemer.com/help/use-signature-question-later-in-survey

This script retrieves the signature data from a specified question ID, decodes the base64 string, and outputs an HTML image tag.

```lua
signatureID = 2

data = getquestionruntimeproperty(signatureID,'Data')
dataAtoms = data['atoms']
signature = dataAtoms[0]['raw_value']['signature']
base64d = base64decode(signature)
signature = '<img src="' .. base64d .. '">'
print(signature)
```

--------------------------------

### Set Single-Answer Question Value

Source: https://luascript.alchemer.com/help/setvalue

Sets the value of a single-answer question to a specific string.

```lua
setvalue(2,"Yes")
```