Numeric Output State Variable Reference

Related documents

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

Table of contents

• Introduction
• Constructor
• Instance methods
  • Inherited methods
• Instance properties
  • Inherited properties
  • fmt
  • max
  • min
  • isNumber
  • isUnit
  • unit
• Component attributes
  • Inherited attributes
• DOM element properties

Introduction

Numeric output state variables represent user number inputs. Each rendered component will display according to the format specified in the state variable.

Constructor

• Type string: 'numericOutput', class: NumOutputSv

Syntax

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

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.

  • Input SV type info properties.

  • 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.

  • min (optional)
    The minimum valid value. This is ignored if a NumFmt instance is provided in the fmt parameter.

  • max (optional)
    The maximum valid value. This is ignored if a NumFmt instance is provided in the fmt parameter.

Note: If the info.id contains a subName (e.g., 'myPage_mySv_kg'), it will be considered a unit specifier. If the Component has the showUnits attribute, the unit abbreviation for the unit subName will be displayed after the number.

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
• OutputSv properties

fmt

A NumFmt instance specifies the desired numeric format and limits.

Value

A NumFmt instance.

max

The maximum valid value. Sets/gets fmt.max.

Value

A Number.

min

The minimum valid value. Sets/gets fmt.min.

Value

A Number.

isNumber

Always true for numericInput.

Value

A Boolean.

isUnit

True if the state variable has a unit subName.

Value

A Boolean.

unit

The first subName. For example, 'kg' if the state variable ID is 'myPage_mySv_kg'.

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 state variable value.
• The <span> contents will be synchronized with the state variable value.
• The <span> element will have a className that contains 'svIo_numOutput'.