NumOutput Component Reference

Related documents

• Component Overview
• Component Reference
• Built-in Components
• Template Markup Language (TML) Reference
• NumInput Component Reference
• Numeric Output state variable

Table of Contents

• Introduction
• Attributes
• Instance methods
  • Inherited methods
  • setValue()
• Children
• DOM element properties

Introduction

Syntax

tml`<NumOutput .../>`

The NumOutput component creates renders a numeric output. It is a separate component used by the Numeric Output state variable so that it can be reused by other components.

The NumOutput component has several methods that can be used to allow parent components to dynamically manipulate the state of the rendered elements. See [Instance methods](#instance methods).

Attributes

• Standard properties
  The NumOutput component accepts the standard attributes.
• fmt
  A NumFmt instance that specifies the format and rounding of the number.
• units
  A string containing a unit abbreviation. If present, the units abbreviation is rendered after the numeric input.
• value
  The value of the displayed output.

Instance methods

These methods are intended to be used by parent components to dynamically change the properties of the rendered components without remounting.

Inherited methods

• Component methods

setValue()

Syntax

setValue(value)

Sets the rendered element's value.

Parameters

• value
  A Number.

Children

The NumOutput component ignores all children.

DOM element properties

• NumOuput will render a <span> element containing the value.
• The <span> element will have a numOutput CSS class string.
• If a units attribute is present, the numeric output element and a <span> containing the unit abbreviation are contained in an NbSpan component. The <span> containing the unit abbreviation will have a numUnits CSS class string.