Template State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
• Instance properties
  • Inherited properties
• Component attributes
  • Inherited attributes
• DOM element

Introduction

Template state variables are Model Object types and contain a template. The state variable value is a template: A Template object, a string, a number, a DOM node, or an array containing a mix of these types. Template state variables are considered changed after each assignment regardless of value. When rendered, they will display the content template.

Template state variables allow another form of dynamic display. The <When> component provides a similar dynamic display, though it is more useful when the output template depends on a few state variables. Template state variables are more appropriate for more complex computations or server-generated content.

Constructor

• Type string: 'template', class: TemplateSv

Syntax

ctl.createPage({
	...,
	stateVarInfo:[
		{type:'template', ...},
	],
})

Parameters

• info
  An object containing the state variable properties. The info object can contain the following properties, but subclasses of StateVar may have additional properties:
  • StateVar info properties.
  • Model SV type info properties.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods

Note: The component() method returns a TemplateSvCmp.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties

Component attributes

Inherited attributes

• Component attributes

DOM element

• The template Component will render an <span> that contains the contents.
• The <span> content will be synchronized with the state variable value.
• The <span> element will have a className that contains svIo_templateOutput