Time Output State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables
• Output SV Type Reference

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
  • fmtVal()
  • fmtUnit()
• Instance properties
  • Inherited properties
• Component attributes
  • Inherited attributes
• DOM element

Introduction

Time Output state variables represent time interval outputs. The state variable value is the time in minutes. The value is rounded to whole minutes when assigned (non-finite values such as Errors are stored as is). The rendered output is in h:mm format.

Constructor

• Type string: 'timeOutput', class: TimeOutputSv

Syntax

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

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.
  • Output SV type info properties.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• OutputSv methods

Note: The component() method returns a TimeOutputSvCmp.

fmtVal()

Returns the value formatted as h:mm (using fmtTime), or the Error text if the value is an Error.

fmtUnit()

Returns 'h:m'.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• OutputSv properties

Component attributes

Inherited attributes

• Component attributes

DOM element

• The timeOutput 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_timeOutput