API Docs for: 0.0.1
Show:

GrainShape Class

Extends Value
Module: niviz

Constructor

GrainShape

()

Item Index

Methods

Methods

clone

() Value

Inherited from Value: lib/value.js:96

A clone that can be used to set new values

Returns:

convert

(
  • code
)
Object static

Convert Swiss Code F1F2F3 to GrainShape value.

Parameters:

Returns:

Properties

height

Number

Inherited from Value: lib/value.js:48

numeric

Number

Inherited from Value: lib/value.js:67

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

options

Array. static

An array of all grainforms and their most imporant properties

swisscode

Array. static

The index of each type corresponds to the type's swiss code number.

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

Object

Inherited from Value: lib/value.js:42