bajaScript

Class: Float

baja. Float

new Float()

Represents a baja:Float in BajaScript.

Boxes JavaScript Number to represent a baja:Float.

When creating a Simple, always use the make() method instead of
creating a new Object.

Extends

Members

<static> DEFAULT :baja.Float

Default Float instance.

Type:

<static> MAX_VALUE :baja.Float

Float Max Value.

Type:

<static> MIN_VALUE :baja.Float

Float Min Value.

Type:

<static> NaN :baja.Float

Float Not A Number.

Type:

<static> NEGATIVE_INFINITY :baja.Float

Float Negative Infinity.

Type:

<static> POSITIVE_INFINITY :baja.Float

Float Positive Infinity.

Type:

Methods

<static> make(val)

Make a Float.

Parameters:
Name Type Description
val Number

the number value.
Returns:
Type
baja.Float

decodeAsync(str [, batch])

The string encoding of certain Simples may include Type information, or
other data that may be require asynchronous operations to decode. BOX is
designed to handle these situations when decoding data from the station,
but when user code needs to decode string-encoded Simples directly, prefer
this method as it gives the individual Simple a chance to import Types,
etc. to ensure that the decoded Simple is fully correct.

The default implementation just returns decodeFromString directly.

Parameters:
Name Type Argument Description
str string
batch baja.comm.Batch <optional>

optional batch to use
Inherited From:
Returns:

may return the Simple instance
directly, or a Promise resolving to same - so wrap in Promise.resolve()
if unsure.

Type
baja.Simple | Promise.<baja.Simple>

decodeFromString(str)

Decode a Float from a String.

Parameters:
Name Type Description
str String

an encoded Float.
Overrides:
Returns:
Type
baja.Float

encodeToString()

Encode the Float (itself) to a String.

Overrides:
Returns:
Type
String

equals(obj)

Equality test.

Parameters:
Name Type Description
obj
Overrides:
Returns:
Type
Boolean

equivalent(obj)

Equivalence test.

equivalent() is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.

Parameters:
Name Type Description
obj
Inherited From:
Returns:
Type
Boolean

getAgents( [is] [, batch])

Returns a promise that resolves to the agent list for this Object.

Parameters:
Name Type Argument Description
is Array.<String> <optional>

An optional array of filters to add to the
agent query.
batch baja.comm.Batch <optional>

An optional object used to batch network
calls together.
Inherited From:
See:
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getDataTypeSymbol()

Return the data type symbol.

Used for encoding this data type (primarily for facets).

Returns:
Type
String

getIcon()

Return the Object's Icon.

Inherited From:
Returns:
Type
baja.Icon

getType()

Get the type of this instance.

Inherited From:
Returns:
Type
Type

getTypeDisplayName( [cx])

Gets the friendly type display name for this object.

Parameters:
Name Type Argument Description
cx Object <optional>

a context to be passed down to Type
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Returns:

If no context is provided, the type
display name is returned synchronously as a string. If context provided,
the type display name is resolved via a promise as a string.

Type
Promise.<string> | string

make(val)

Make a Float.

Parameters:
Name Type Description
val Number

the number value.
Overrides:
Returns:
Type
baja.Float

newCopy( [exact])

Every value may be cloned using the newCopy method.

Please note that Simples are immutable so they don't
allocate a new instance.

Parameters:
Name Type Argument Description
exact Boolean <optional>

true if an exact copy of the value should be
made (only valid in the Component architecture).
Inherited From:
See:
Returns:

a copy of the value (or the same instance if the value is a
Simple).

toString( [cx])

Return the String representation of the Float (itself).

Parameters:
Name Type Argument Description
cx baja.Facets | Object <optional>

used to specify formatting facets. The
argument can also be an Object Literal.

Properties
Name Type Argument Description
forceSign Boolean <optional>

specifying 'true' will concatenate a '+'
to the beginning of the number if positive.
precision Number <optional>

the number of decimal places to show in
the return string. Specifying '0' will also remove the decimal. If a context
is provided without precision, this value will default to 2. If no context
is provided, there will be no precision applied.
showSeparators Boolean <optional>

include separators.
units baja.Unit <optional>

the baja Unit to apply to the return
string.
unitConversion baja.Enum | Number | String <optional>

the
baja:UnitConversion enum, an ordinal, or tag.
zeroPad Number <optional>

the minimum number of the whole-number
digits to be displayed, filling in zeroes when necessary.
trimTrailingZeros boolean <optional>

set to true if trailing zeros
should not be included in the string. If the only digits after the decimal
point are zeros, the decimal point will be removed as well.
Overrides:
Returns:

returns a Promise if a cx is passed in.

Type
String | Promise.<String>

valueOf()

Return the Number encapsulated in the Float (itself).

Overrides:
Returns:
Type
Number