Skip to content

Content ​

Page Flow Blocks reference.

Blocks ​

Collapsible Area Action in Data Design ​

Block name: template_collapsecontrol

Expands, collapses, or toggles a collapsible area element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
actionchoiceThe collapsible area action to perform.
elementelementThe collapsible area element inside the selected Data Design template to control. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and applies the selected collapsible area action.

Calls: $io.dom.dataDesignElementSel, $io.ui.controlCollapsibleArea

Content from Data Design ​

Block name: content_from_template_with_object

Generates an HTML content string using a Data Design template and a data object.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template to use. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
IDstringThe primary identifier used for the generated template content. This is typically provided by a text block.text
ID2stringAn optional secondary identifier used for the generated template content. This is typically provided by a text block.text
dataobjectThe data object used to fill the Data Design template.

Output ​

This block produces an output value of type String.

Behavior ​

Generates client-side code that builds content from the selected Data Design template and the provided identifiers and data object.

Calls: $io.content.fromDataDesign

Enable/Disable Element in Data Design ​

Block name: template_enabledisableelement

Enables or disables an element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe element inside the selected Data Design template whose enabled state should be updated. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
statebooleanThe enabled state to assign to the selected element. Use true to enable the element and false to disable it. This is typically provided by a boolean block.logic_boolean

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and sets its disabled property. The boolean input is inverted so true enables the element and false disables it.

Calls: $io.dom.dataDesignElementSel, $io.dom.setProp

Event Action in Data Design ​

Block name: template_eventhandler

Runs the nested logic when the specified event occurs for an element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
eventstringThe event name to listen for. This is typically provided by a text block.text
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe element inside the selected Data Design template to monitor for the specified event. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
tasksstatementsThe blocks to run when the specified event occurs. Use the Action/Event Info block inside these statements to access event details such as id, id2, and name for the current Data Design element. Nested blocks run inside the generated callback for this block. customcode and customcodeexpr blocks inside this area can directly access the documented callback-scope variables.

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and registers an event listener using $io.dom.setEventListener. The nested blocks are emitted inside function(tvEventInfo) { ... }, so customcode and customcodeexpr blocks inside the handler can access tvEventInfo directly. The mkbevinfo block returns that same object.

Calls: $io.dom.dataDesignElementSel, $io.dom.setEventListener

Get Element Attribute in Data Design ​

Block name: template_attributevalue

Gets the value of an HTML attribute from an element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
attributestringThe HTML attribute name to read. This is typically provided by a text block.text
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe element inside the selected Data Design template whose attribute value should be read. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text

Output ​

This block produces an output value of type String.

Behavior ​

Generates client-side code that resolves the target Data Design element and reads the requested HTML attribute value.

Calls: $io.dom.dataDesignElementSel, $io.dom.getAttr

Get Input Value in Data Design ​

Block name: template_getinputvalue

Gets the current value of an input, dropdown, or multi-line element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe input, dropdown, or multi-line element inside the selected Data Design template whose value should be read. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text

Output ​

This block produces an output value of type String.

Behavior ​

Generates client-side code that resolves the target Data Design element and reads its current value.

Calls: $io.dom.dataDesignElementSel, $io.dom.getVal

Get Toggle Switch State in Data Design ​

Block name: template_checkboxstate

Gets the current checked state of a checkbox or toggle switch element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe checkbox or toggle switch element inside the selected Data Design template whose state should be read. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text

Output ​

This block produces an output value of type Boolean.

Behavior ​

Generates client-side code that resolves the target Data Design element and reads its checked property.

Calls: $io.dom.dataDesignElementSel, $io.dom.getProp

Initialize Toggle Switch in Data Design ​

Block name: template_initcheckbox

Initializes a checkbox or toggle switch element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe checkbox or toggle switch element inside the selected Data Design template to initialize. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that initializes the selected checkbox or toggle switch in a Data Design template instance.

Calls: $io.dom.initDataDesignCheckbox

Set CSS in Data Design ​

Block name: template_setcssclass

Adds and or removes CSS classes from an element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe element inside the selected Data Design template whose CSS classes should be updated. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
add classesstringSpace-separated CSS classes to add to the element. This is typically provided by a text block.text
remove classesstringSpace-separated CSS classes to remove from the element. This is typically provided by a text block.text

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and adds or removes CSS class names on it.

Calls: $io.dom.dataDesignElementSel, $io.dom.modClasses

Set Element Attribute in Data Design ​

Block name: template_setattributevalue

Sets the value of an HTML attribute on an element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
attributestringThe HTML attribute name to set. This is typically provided by a text block.text
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe element inside the selected Data Design template whose attribute value should be updated. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
valuestringThe value to assign to the selected attribute. This is typically provided by a text block.text

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and sets the requested HTML attribute value.

Calls: $io.dom.dataDesignElementSel, $io.dom.setAttr

Set Input Feedback in Data Design ​

Block name: template_setinputfeedback

Sets the validation feedback state for an input, dropdown, multi-line, checkbox, or toggle switch element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe element inside the selected Data Design template whose feedback state should be updated. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
feedbackchoiceThe feedback state to apply to the selected element.

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and updates its validation feedback CSS classes.

Calls: $io.dom.dataDesignElementSel, $io.dom.modClasses

Set Input Value in Data Design ​

Block name: template_setinputvalue

Sets the value of an input, dropdown, or multi-line element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe input, dropdown, or multi-line element inside the selected Data Design template whose value should be updated. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
valuestringThe value to assign to the selected element. This is typically provided by a text block.text

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and sets its current value.

Calls: $io.dom.dataDesignElementSel, $io.dom.setVal

Set Style in Data Design ​

Block name: template_setstyle

Sets a CSS property on an element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
propertystringThe CSS property name to set. This is typically provided by a text block.text
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe element inside the selected Data Design template whose style should be updated. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
valuestringThe value to assign to the CSS property. This is typically provided by a text block.text

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and sets a CSS property value on it.

Calls: $io.dom.dataDesignElementSel, $io.dom.setCss

Set Toggle Switch State in Data Design ​

Block name: template_setcheckboxstate

Sets the checked state of a checkbox or toggle switch element generated from a Data Design template.

Inputs ​

InputTypeDescriptionAccepts
data designtemplateThe Data Design template that produced the target element. You can type the template name directly or click the lookup button to select from valid Data Design templates available in the current context.
elementelementThe checkbox or toggle switch element inside the selected Data Design template whose state should be updated. You can type the element name directly or click the lookup button to select from valid template elements available in the current context.
IDstringThe primary identifier for the generated template instance. This is typically provided by a text block.text
ID2stringAn optional secondary identifier for the generated template instance. This is typically provided by a text block.text
valuebooleanThe state to assign to the selected element. Use true to check the element and false to clear it. This is typically provided by a boolean block.logic_boolean

Output ​

This block does not produce an output value.

Behavior ​

Generates client-side code that resolves the target Data Design element and sets its checked property.

Calls: $io.dom.dataDesignElementSel, $io.dom.setProp