Search

User Manual

GETTING STARTED


MODULES AND PLATFORM


APPENDIX


TUTORIALS & HELPFUL TRICKS


STRATEGIC PARTNER LINKS

Sepasoft - MES Modules
Cirrus Link - MQTT Modules

RESOURCES

Inductive University
Ignition Demo Project
Knowledge Base Articles
Forum
IA Support
SDK Documentation
SDK Examples

ALL USER MANUAL VERSIONS

Ignition 8.1
Ignition 7.9
Ignition 7.8

Deprecated Pages

Employees

Sign In

Skip to end of metadata
Go to start of metadata
General

Component Palette Icon:



IULocgo


Template Repeater

Description
The Template Repeater repeats instances of templates any number of times. It can arrange them vertically, horizontally, or in a "flow" layout, which can either be top-to-bottom or left-to-right. If there are too many to fit, a scrollbar will be shown. This makes it easy to quickly create screens that represent many similar pieces of equipment. It also can be used to create screens that are dynamic, and automatically configure themselves based on configuration stored in a database or tag structure. When first dropped on a window, the template repeater will look like any other empty container. To select the template to repeat, configure the repeater's Template Path property. There are two ways to set how many times the template should repeat:
  • Count - The template will be repeated X times, where X is the value of "Repeat Count". The repeat count starts at zero and increments X amount of times. Each value for X will be inserted into the custom property of the template that will be repeated. Template repeater inserts the value of X into the custom property on the template with the same name as the template repeater's "Index Property Name." For example, if the template has a custom property of "index" and the template repeater's Index Property Name is also "index," then the template will be repeated X many time with the value of X being inserted into the template's custom property called "index."
  • Dataset - The template will be repeated once for each row in the "Template Parameters" dataset. The template's custom properties with the same names as the dataset's column names will assume the values of each row of the dataset.


An Example of configuring the Template Repeater can be found on the Using the Template Repeater page.

Properties
NameDescriptionProperty TypeScriptingCategory
Background ColorThe background color of the component. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.Color.backgroundAppearance
Border

The border surrounding this component. Options are: No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), Button Border, Field Border, Line Border, and Other Border.

The border is unaffected by rotation.

Border.borderCommon
Flow AlignmentAlignment for "Flow" layout style.int.flowAlignmentAppearance
Flow DirectionWhen the layout style is flow, this property controls if the components in the container flow horizontally or vertically.int.flowDirectionAppearance
Horizontal GapThe gap size to use for horizontal gaps.int.horizontalGapAppearance
Index Parameter NameA name of an integer parameter on the template that will be set to an index number.String.indexParamNameBehavior
Layout StyleControls how the repeated template instances are laid out inside the repeater.int.layoutStyleAppearance
Marquee ModeTurn the repeater into a scrolling marquee.boolean.marqueeModeBehavior
NameThe name of this component.String.nameCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Repeat Behavior

"Count" will repeat the template a number of times, assigning each template an index number.

"Dataset" will repeat the template once per row in the template parameter's dataset.

int.repeatBehaviorBehavior
Repeat CountThe template will be repeated this many times, if the repeat behavior is set to "Count."int.repeatCountBehavior
Scroll DelayThe time (in milliseconds) to wait between performing each step in a scroll.int.scrollDelayBehavior
Stay DelayThe time (in milliseconds) to wait between scrolls.int.stayDelayBehavior
Template ParametersThis dataset will be used to control the number of templates and the parameters set on the templates if the repeat behavior is set to "Dataset."Dataset.templateParamsBehavior
Template PathThe path to the template that this container will repeat.String.templatePathBehavior
Vertical GapThe gap size to use for vertical gaps.int.verticalGapAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon
Deprecated Properties
Data QualityThe data quality code for any Tag bindings on this component.int.dataQualityDeprecated
Scripting
Scripting Functions
 getLoadedTemplates()
  • Description

Returns a list of templates loaded into the Template Repeater. Properties on the components within each instance can be references by calling getComponent().

  • Parameters

None

  • Return

List of Templates

Extension Functions

This component does not have extension functions associated with it. 

Event Handlers
 propertyChange
 propertyChange

Fires whenever a bindable property of the source component changes. This works for standard and custom (dynamic) properties.

.sourceThe component that fired this event
.newValueThe new value that this property changed to.
.oldValueThe value that this property was before it changed. Note that not all components include an accurate oldValue in their events.
.propertyName

The name of the property that changed.

Remember to always filter out these events for the property that you are looking for! Components often have many properties that change.

Examples
Code Snippet: getLoadedTemplates()
#This script will call getLoadedTemplates() on a Template Repeater, and 
#then print the text property of a Label component in each instance

#Store a reference to the Template Repeater component in a variable
repeater = event.source.parent.getComponent('Template Repeater')

#Store the list of templates in another variable
templateList = repeater.getLoadedTemplates()

#Iterate through the list 
for template in templateList:
	#find a component named "Label" in the instance, 
	#and print the value of the text property  
	print template.getComponent('Label').text
  • No labels