Sports Lib API - v21.3.0
GitHub
npm
Preparing search index...
API
DataDepthFeet
Class DataDepthFeet
Imperial presentation variant of the canonical meter-based depth stream.
Hierarchy (
View Summary
)
DataDepth
DataDepthFeet
Index
Constructors
constructor
Properties
value
display
Type
type
unit
unit
System
Methods
get
Display
Type
get
Display
Unit
get
Display
Value
get
Type
get
Unit
get
Unit
System
get
Value
is
Value
Type
Valid
set
Value
to
JSON
Constructors
constructor
new
DataDepthFeet
(
value
:
number
)
:
DataDepthFeet
Parameters
value
:
number
Returns
DataDepthFeet
Properties
Protected
value
value
:
number
Static
display
Type
displayType
:
string
= DataDepth.type
Static
type
type
:
string
= 'Depth in feet'
Static
unit
unit
:
string
= 'ft'
Static
unit
System
unitSystem
:
UnitSystem
= UnitSystem.Imperial
Methods
get
Display
Type
getDisplayType
()
:
string
Returns
string
get
Display
Unit
getDisplayUnit
()
:
string
Returns
string
get
Display
Value
getDisplayValue
()
:
string
Returns
string
get
Type
getType
()
:
string
Returns
string
get
Unit
getUnit
()
:
string
Returns
string
get
Unit
System
getUnitSystem
()
:
UnitSystem
Returns
UnitSystem
get
Value
getValue
(
_formatForDataType
?:
string
)
:
number
Parameters
Optional
_formatForDataType
:
string
Returns
number
is
Value
Type
Valid
isValueTypeValid
(
value
:
any
)
:
boolean
Parameters
value
:
any
Returns
boolean
set
Value
setValue
(
value
:
number
)
:
this
Parameters
value
:
number
Returns
this
to
JSON
toJSON
()
:
DataJSONInterface
Returns
DataJSONInterface
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
value
display
Type
type
unit
unit
System
Methods
get
Display
Type
get
Display
Unit
get
Display
Value
get
Type
get
Unit
get
Unit
System
get
Value
is
Value
Type
Valid
set
Value
to
JSON
GitHub
npm
Sports Lib API - v21.3.0
Loading...
Imperial presentation variant of the canonical meter-based depth stream.