Class: Toybox.Lang.Number

Inherits:
Toybox.Lang.Object show all

Overview

Number represents a 32-bit signed integer.

Since:

API Level 1.0.0

Instance Method Summary collapse

Instance Method Details

abs() as Lang.Number

Get the absolute value of a Number.

Returns:

Since:

API Level 1.0.0

format(format as Lang.String) as Lang.String

Format a Number using a formatting String.

The formatting string is similar to that available in printf from the C stdio library, though the length option is not available:

    "%[flags][width][.precision]specifier"
specifiers
  • d or i - signed decimal integer

  • e - scientific notation (mantissa/exponent) using 'e' character

  • E - scientific notation (mantissa/exponent) using 'E' character

  • f - decimal floating point

  • o - signed octal

  • u - unsigned decimal integer

  • x - unsigned hexadecimal integer

  • X - unsigned hexadecimal integer (capital letters)

flags
  • + - Prepends the result with a plus or minus sign ('+' or '-'), including positive numbers. By default, only negative numbers are preceded with a '-' sign.

  • 0 - Left-pads the number with zeros (0) instead of spaces, where padding is specified (see width sub-specifier).

width

supports only numbers (* is not supported)

.precision

supports only numbers (* is not supported)

Example:

Formatting time with leading zeros

// Format the time to display "08:03:15"
using Toybox.Lang;
var hours = 8;
var minutes = 3;
var seconds = 15;
var myTime = Lang.format(
    "$1$:$2$:$3$",
    [hours.format("%02d"), minutes.format("%02d"), seconds.format("%02d")]
);

Returns:

See Also:

Since:

API Level 1.0.0

toChar() as Lang.Char

Convert a Number to a Char.

Returns:

  • Lang.Char

    A Char representation of the Number

Since:

API Level 1.3.0

toDouble() as Lang.Double

Convert a Number to a Double.

Returns:

  • Lang.Double

    A Double representation of the Number

Since:

API Level 1.0.0

toFloat() as Lang.Float

Convert a Number to a Float.

Returns:

  • Lang.Float

    A Float representation of the Number

Since:

API Level 1.0.0

toLong() as Lang.Long

Convert a Number to a Long.

Returns:

  • Lang.Long

    A Long representation of the Number

Since:

API Level 1.0.0

toNumber() as Lang.Number

Convert a Number to a Number.

Returns:

  • Lang.Number

    A Number representation of the Number

Since:

API Level 1.0.0


Generated Jul 7, 2021 10:36:25 AM