Windspeed Input State Variable Reference

Related documents

• State Variables Overview
• StateVar Reference
• Unit Input SV Type Reference
• Wind Direction Input SV Type Reference

Table of contents

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

Introduction

Windspeed Input (windSpeedInput) state variables represent user inputs for METAR-style windspeed strings (e.g., "10" or "10G15"). It is a type of unitInput that can support multiple windspeed units. Typically, this is kt and mps to match the METAR possibilities.

Like other unitInput state variables MVCS supports a physical or virtual keyboard, a popup keypad, or a thumbwheel input mechanism and selects the desired mechanism by referring to the set_inputType state variable. See Standard Settings Page.

The standard keyboard mechanism will ignore invalid characters and automatically add a 'G' before the third typed number. The popup keypad is specialized so that only valid windspeed characters can be entered. The thumbwheel input is similarly specialized to quickly select valid windspeed strings. Invalid entries (e.g., gust less than wind) are ignored and will revert to the previous valid setting.

Here's a typical example of a page-specific windspeed and windspeed units:

ctl.createPage({
	...,
	stateVarInfo:[
		{id:'page_windSpeed', type:'windSpeedInput',
			unitClass:'page_windSpeed',
			units:{kt:{dflt:'0'}, mps:{dflt:'0'}}
		},
		{id:'page_windSpeedUnit', type:'unitSelector',
			unitClass:'page_windSpeed',
			options: [
				{value:'kt', text:'kt.'},
				{value:'mps', text:'mps.'},
			],
		},
	],
});

A unitSelector with the same unitClass will control which unit is displayed if the parent windSpeedInput is displayed. Here's an example:

ctl.create page({
	...,
	render () {
		return (tml`
			...
			<Cr> <Cl>Wind speed</> <Cv>{{page_windSpeed}} {{page_windSpeedUnit}}</> </Cr>
		`);
	}
});

This will display a windspeed input box and a selector for the units.

Constructor

• Type string: 'windSpeedInput', class: WindSpeedInputSv

Syntax

ctl.createPage({
	...,
	stateVarInfo:[
		{id:'page_windSpeed', type:'windSpeedInput',
			unitClass:'page_windSpeed,
			units:{kt:{dflt:'0'}, mps:{dflt:'0'}}
		},
	],
})

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.
  • 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 input constructor info object.

  The object for each unit has the following keys:

  • dflt (optional)
    The default value for that unit. Only one unit need be specified as the others will be converted.

Instance methods

Inherited methods

• StateVar methods
• ModelValueSv methods
• InputSv methods

Instance properties

Inherited properties

• StateVar properties
• ModelValueSv properties
• InputSv properties

Component attributes

Inherited attributes

• Component attributes

inputType

The inputType attribute establishes a particular user input type that overrides the set_inputType state variable if it exists. The values can be:

• 'keyboard'
  Use the standard physical or virtual keyboard. This is the default if not specified.
• 'keypad'
  Use a popup numeric keypad.
• 'thumbwheel'
  Use a popup thumbwheel selector.

Value

A String.

DOM element properties

• Standard DOM element properties
• For the keyboard inputType, the component will render an <input type="text">.
• The value attribute will be synchronized with the current unit sibling value.
• A <span> element containing the windspeed text string.
• The <span> contents will be synchronized with the state variable value.
• The <input> element will have a className that contains windSpeed and svIo_windSpeedInput.
• For a popup inputType, the component will render a <span>.
• The <span> contents will be synchronized with the state variable value.