API Docs for: 0.0.1
Show:

Hardness Class

Extends Value
Defined in: lib/values/hardness.js:36
Module: niviz

Stores a Hand Hardness Index (HHI) value.

Constructor

Hardness

(
  • [top]
  • [value]
  • [bottom]
)

Defined in lib/values/hardness.js:36

Parameters:

Methods

clone

() Value

Inherited from Value: lib/value.js:96

A clone that can be used to set new values

Returns:

Value:

parse

(
  • value
)
Number static

Defined in lib/values/hardness.js:150

Converts a value to HHI index. If the value is a string, it is interpreted as an HHI code; if it is a number it is interpreted as ram resistance in Newton.

Parameters:

  • value Number, String

Returns:

Number:

Properties

caamlcode

String

Defined in lib/values/hardness.js:218

HHI CAAML code string.

code

String

Defined in lib/values/hardness.js:189

HHI code string.

codes

Array.

Defined in lib/values/hardness.js:121

height

Number

Inherited from Value: lib/value.js:48

index

Object

Defined in lib/values/hardness.js:89

HHI code to numeric index mapping.

newton

Number

Defined in lib/values/hardness.js:252

Ram Resistance in Newton.

numeric

Number

Inherited from Value: lib/value.js:67

The numeric value (defaults to .value) used for comparisons.

options

Array.

Defined in lib/values/hardness.js:129

text

String

Inherited from Value: lib/value.js:57

A string represantation of this value.

thickness

Number

Inherited from Value: lib/value.js:77

The thickness value only makes sense with top and bottom defined

top

Number

Inherited from Value: lib/value.js:36

value

Number

Inherited from Value but overwritten in lib/values/hardness.js:52

The HHI value between .666 and 6.0.