Unit Output State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Built-in State Variables
• Output 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
  • fmt
  • className
  • unitSiblings
• 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 output 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 output 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 and unitOutput 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)
    A NumFmt format string (fmtStr). A NumFmt instance is not accepted. If no fmt is provided, a format string of '8' is assumed. Any min or max for a unit is ignored.
  • dflt (optional)
    The default value for this unit. The default is INVALID_NONE.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• OutputSv methods

Note: The component() method is inherited from OutputSv and wraps render(). The parent's render() returns a <When> that renders a <StateVar> for the current unit sibling, and re-renders it when the unitSelector value changes. The component that is ultimately displayed is the current sibling's NumOutputSvCmp, so the numericOutput component attributes apply.

The following methods operate on the current unit sibling (curSv):

• val([value]), isValid(...), setDflt(), fmtVal(), fmtUnit(), and userChange(value).
• getUnitSv(unit)
  Returns the sibling state variable for unit. Asserts if there is none.
• siblings()
  Returns an array of all the unit sibling state variables.
• unitSiblingId(unit)
  Returns the ID of the sibling for unit (<id>_<unit>).

Setting the value of any sibling converts and sets the value of all the other siblings.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• OutputSv properties

isNumber

Not set on the unitOutput parent. It is true for each unit sibling numericOutput.

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.

fmt

Getter that returns the current unit sibling's fmt. There are no min or max properties on a numericOutput.

className

Gets/sets the className of the current sibling; setting applies to all siblings.

unitSiblings

A Map from unit to sibling state variable.

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_numOutput' (the current sibling's class; there is no svIo_unitOutput class).