Age Output State Variable Reference

Related documents

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

Table of contents

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

Introduction

Age Output state variables represent age outputs. The state variable value is the age in minutes. If the set value is zero or positive, then the value will be updated every minute. The updates pause while the app is inactive and resume (if the value is still zero or positive) when it becomes active again. The rendered output is in hh:mm format. A negative value (the default is -1) means "no age" and is rendered as '-'; it stops the update timer.

If the limit property is greater than zero, then the age will be rendered in red when strictly greater than the limit value. A limit of zero or less disables the warning.

Constructor

• Type string: 'ageOutput', class: AgeSv (internal, not exported)

Syntax

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

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.
  • dflt (optional)
    The default value in minutes. The default is -1 (no age).
  • limit (optional)
    The initial value of the limit property. The default is -1 (no warning).

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• OutputSv methods

Note: The component() method returns an AgeOutputSvCmp (a subclass of the Time Output component). The value set must be a Number or an Error, otherwise an assertion fails.

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• OutputSv properties

limit

When limit is greater than zero, the age will be rendered with a warning class name when the state variable value is strictly greater than the limit. Otherwise (including when limit is zero or negative), the warning class name is omitted. The warning class typically sets a red font color. The default is -1.

Value

A number.

Component attributes

Inherited attributes

• Component attributes

DOM element

• The ageOutput 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 (the age output shares the Time Output component; there is no svIo_ageOutput class)
• The <span> element will have a className that contains warning if the age is greater than a positive limit.