Format Number

The goal of formatting numbers is to help display numbers in a human-readable form.

There are two ways of formatting numbers in Mprove:

• SSF
• D3-format (recommended)

SSF

SSF can be used in Field-Level Formatting & Rendering Tags of Malloy Sources.

D3-format

D3-format can be used in Project Config, Store Fields, Report Rows and Malloy Sources.

To use D3-format in Mprove there are 3 parameters:

• format_number
• currency_prefix
• currency_suffix

Example of D3-format usage in Malloy Sources:

#(mprove) model
source: c1_order_items is c1_order_items_tx extend {

  -- 1057.1258 >> $1,057.13
  #(mprove) format_number='$,.2f' currency_prefix='$' currency_suffix=''
  measure: total_profit is total_sale_price - inventory_items.total_actual_cost

  -- 0.25 >> 25%
  #(mprove) format_number='.2p'
  measure: profit_margin is total_profit / total_sale_price
}

Example of D3-format usage in Store Fields:

fields: # store's fields section- dimension: price  result: number  format_number: "$,.2f" # 1057.1258 >> $1,057.13  currency_prefix: $  currency_suffix: ""- measure: orders_count  format_number: "," # 2143 >> 2,143

Syntax

Fields with result: number (implicitly or explicitly set) can accept format_number using special syntax of D3-format:

[[fill]align][sign][symbol][0][width][,][.precision][type]

If options are specified, they must preserve its order.

Fill, Align, Width

The align can be:

• < - left alignment
• ^ - center alignment
• > - right alignment (default)

The fill can be any character. Fill can be specified only if align specified. It fills empty characters if value requires less characters than width. The width defines the minimum field width in characters. If not specified, then the width will be determined by the content.

[[fill]align][sign][symbol][0][width][,][.precision][type]

Sign

The sign can be:

• - - nothing for zero or positive and a minus sign for negative (default)
• + - a plus sign for zero or positive and a minus sign for negative
• ( - nothing for zero or positive and parentheses for negative

[[fill]align][sign][symbol][0][width][,][.precision][type]

Symbol

The symbol can be:

• $ - apply currency_prefix and currency_suffix
• # - for binary, octal, or hexadecimal types, prefix by 0b, 0o, or 0x, respectively.

[[fill]align][sign][symbol][0][width][,][.precision][type]

Zero

The zero 0 option enables zero-padding; this implicitly sets fill to 0.

[[fill]align][sign][symbol][0][width][,][.precision][type]

Comma

The comma , option enables the use of a group separator for thousands.

[[fill]align][sign][symbol][0][width][,][.precision][type]

Precision and Type

The available type values are:

• e - exponent notation
• d - decimal notation, rounded to integer
• % - multiply by 100, and then decimal notation with a percent sign
• p - multiply by 100, round to significant digits, and then decimal notation with a percent sign
• s - decimal notation with an SI prefix, rounded to significant digits
• b - binary notation, rounded to integer
• o - octal notation, rounded to integer
• x - hexadecimal notation, using lower-case letters, rounded to integer
• X - hexadecimal notation, using upper-case letters, rounded to integer
• c - (not yet supported) converts the integer to the corresponding unicode character before printing
• g - either decimal or exponent notation, rounded to significant digits
• - (none) like g, but trim insignificant trailing zeros
• f - fixed point notation
• r - decimal notation, rounded to significant digits
• n - shorthand for ,g

For the g, n and (none) types, decimal notation is used if the resulting string would have precision or fewer digits; otherwise, exponent notation is used. Depending on the type, the precision either indicates the number of digits that follow the decimal point (types f and %), or the number of significant digits (types (none), e, g, r, s and p). If the precision is not specified, it defaults to 6 for all types except (none), which defaults to 12. Precision is ignored for integer formats (types b, o, d, x, X and c).

[[fill]align][sign][symbol][0][width][,][.precision][type]

Exponential

Integer

Percentage

Scientific

Binary

Octal

Hexadecimal

General

None

Fixed

Rounded