FormIt Plugin API  v23.0.0 (2023.0.0)
FormIt.StringConversion API

Description

Functions

json FormIt.StringConversion.LinearValueToString (val, forceFeetOrMeter)
 
json FormIt.StringConversion.StringToLinearValue (val, forceFeetOrMeter)
 StringToLinearValue converts a string to a double Parameters: In: val In: forceFeetOrMeter Out: { success: result: }. More...
 
json FormIt.StringConversion.AreaValueToString (val, forceFeetOrMeter)
 AreaValueToString converts an area value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }. More...
 
json FormIt.StringConversion.StringToAreaValue (val, forceFeetOrMeter)
 StringToAreaValue converts a string to an area value Parameters: In: val In: forceFeetOrMeter Out: { success: result: }. More...
 
json FormIt.StringConversion.VolumeValueToString (val, forceFeetOrMeter)
 VolumeValueToString converts a volume value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }. More...
 
json FormIt.StringConversion.StringToVolumeValue (val, forceFeetOrMeter)
 StringToVolumeValue converts a string to a volume value Parameters: In: val In: forceFeetOrMeter Out: { success: result: }. More...
 

Function Documentation

json FormIt.StringConversion.AreaValueToString ( val  ,
forceFeetOrMeter   
)

AreaValueToString converts an area value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }.

Parameters
[in]valdouble
[in]forceFeetOrMeter(OPTIONAL, default = false) bool
Returns
unitValue
json FormIt.StringConversion.LinearValueToString ( val  ,
forceFeetOrMeter   
)
json FormIt.StringConversion.StringToAreaValue ( val  ,
forceFeetOrMeter   
)

StringToAreaValue converts a string to an area value Parameters: In: val In: forceFeetOrMeter Out: { success: result: }.

Parameters
[in]valString
[in]forceFeetOrMeter(OPTIONAL, default = false) bool
Returns
{...}
json FormIt.StringConversion.StringToLinearValue ( val  ,
forceFeetOrMeter   
)

StringToLinearValue converts a string to a double Parameters: In: val In: forceFeetOrMeter Out: { success: result: }.

Parameters
[in]valString
[in]forceFeetOrMeter(OPTIONAL, default = false) bool
Returns
{...}
json FormIt.StringConversion.StringToVolumeValue ( val  ,
forceFeetOrMeter   
)

StringToVolumeValue converts a string to a volume value Parameters: In: val In: forceFeetOrMeter Out: { success: result: }.

Parameters
[in]valString
[in]forceFeetOrMeter(OPTIONAL, default = false) bool
Returns
{...}
json FormIt.StringConversion.VolumeValueToString ( val  ,
forceFeetOrMeter   
)

VolumeValueToString converts a volume value to a string Parameters: In: val In: forceFeetOrMeter Out: { unitValue }.

Parameters
[in]valdouble
[in]forceFeetOrMeter(OPTIONAL, default = false) bool
Returns
unitValue