Unit Output State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables
• Input SV Type Reference
• Unit Input State Variable Reference

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
• Instance properties
  • Inherited properties
  • isNumber
  • isUnit
  • isUnitParent
  • unitClass
• Component attributes
  • Inherited attributes
• DOM element properties

Introduction

A unit output (unitOutput) state variable represents a numeric value with multiple possible units. The app may provide the user a choice of their desired units for the number. The app can also choose which units it wants to compute with independent of the user's choice. Each rendered component will display according to the format and limits specified for the chosen unit in the state variable.

The unit input contains several child numericOutput state variables, one for each unit is supports. Each child state variable is published with a subName corresponding to its unit (e.g., 'myPage_mySv_kg' and 'myPage_mySv_lb'). When one child state variable changes, the others are updated with the new value converted to their respective units.

Each unit input has an associated unitClass string. Each unitClass is associated with a unitSelector state variable. The unitSelector state variable controls which unit each rendered component will be displayed to the user. Many unitInput state variables can have the same unitClass, and, therefore will be controlled by the same unitSelector.

The unitOutput state variable's component instance will display the currently selected unit sibling. If the showUnits attribute or the '{{...@}}' template syntax is used, the component will also display the appropriate unit abbreviations for the currently selected unit.

The app code or a component template may also refer to a specific child numericOutput state variable. Any modification to that child will also update its siblings with converted values.

Constructor

• Type string: unitOutput', class: UnitOutputSv

Syntax

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

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.
  • unitClass
    The unitClass string for the unitSelector that controls which unit sibling is current for this state variable.
  • units
    An object with one or more keys. Each key is a subName for a child state variable. The key value is a numeric output constructor info object.

  The object for each unit has the following keys:

  • fmt (optional)
    The fmt parameter can be one of the following:

    • A NumFmt instance specifying the desired numeric format and limits.
    • A NumFmt format string (fmtStr). If a format string is used, then a NumFmt instance will be created using this string along with any info.min and info.amx parameters.

    If no fmt is provided, a format string of '8' is assumed.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• OutputSv methods

Note: The component() method returns a NumOutputSvCmp.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• InputSv properties

isNumber

Always true for unitOutput.

Value

A Boolean.

isUnit

Always true for unitOutput.

Value

A Boolean.

isUnitParent

Always true for unitOutput.

Value

A Boolean.

unitClass

The unitClass string for the unitSelector that controls which unit sibling is current for this state variable.

Value

A String.

Component attributes

Inherited attributes

• Component attributes

DOM element properties

• Standard DOM element properties
• Component will render an <span> with the value attribute set according to the current unit sibling value.
• The <span> contents will be synchronized with the current unit sibling value.
• The <span> element will have a className that contains 'svIo_unitOutput'.