format

The format parameter sets the default display format for a ‘s values. s can use one of Omni’s named formats, an Excel-style string, a Mustache template, or a conditional format that selects a format dynamically. Formats can also be set on a per-query basis from visualization configuration, using the same format types. See Formatting values for more information on format types and examples.

Formats are applied after the SQL runs, so they do not impact grouping. To handle grouping with truncation, use ROUND() or FLOOR().

Syntax

format accepts either a string or a conditional object:

String
Conditional

<dimension_or_measure_name>:
  format: <format_string>

<dimension_or_measure_name>:
  format:
    depends_on:
      field: <field_name>
      conditions:
        - condition:
            <filter_expression>
          value: <format_string>
    else: <fallback_format_string>

Properties

Use the tabs to view the properties for string values and conditional objects.

String
Conditional

format

string

required

The format definition. This can be any valid format type:

A named format (e.g., currency_2, percent_1)
An Excel-style string (e.g., '#,##0.00 "kg"')
A reference to a model-level custom format

See Formatting values for the full reference on all format types, including named formats, Excel-style strings, conditional formats, model constants, locale settings, and more.

depends_on

object

required

Defines the source value to evaluate conditions against. Set exactly one of field, user_attribute, or filter.These options resolve as follows:

Source	Resolution timing	Behavior
`field`	At display time (per row)	Evaluated against each row’s value after query results are returned. Each row can resolve to a different format.
`user_attribute`	At query preparation time	The user attribute value is evaluated once. The entire field uses the single resolved format.
`filter`	At query preparation time	The filter value is evaluated once. The entire field uses the single resolved format.

Hide depends_on properties

field

string

The name of a field in the same view.

user_attribute

string

The reference of a user attribute.

filter

string

The name of a filter applied to the query.

conditions

object[]

required

An ordered list of condition entries. Each entry contains a condition using Omni filter syntax and a value specifying the format string to apply when the condition matches.

Hide conditions properties

condition

object

required

An Omni filter expression. Supported condition types:

Condition	Description	Example
`is`	Exact match	`is: "USD"`
`not`	Not equal	`not: "USD"`
`greater_than`	Greater than	`greater_than: "1000"`
`greater_than_or_equal_to`	Greater than or equal to	`greater_than_or_equal_to: "1000"`
`less_than`	Less than	`less_than: "0"`
`less_than_or_equal_to`	Less than or equal to	`less_than_or_equal_to: "100"`
`between`	Between two values (inclusive)	`between: [10, 100]`
`not_between`	Outside a range	`not_between: [10, 100]`
`starts_with`	String starts with	`starts_with: "US"`
`ends_with`	String ends with	`ends_with: "Corp"`
`contains`	String contains	`contains: "special"`
`not_starts_with`	String does not start with	`not_starts_with: "US"`
`not_ends_with`	String does not end with	`not_ends_with: "Corp"`
`not_contains`	String does not contain	`not_contains: "special"`

Additional conditions follow the same structure as filters.

value

string

required

The format string to apply when the condition matches. Can be a named format or an Excel-style string.

else

string

Fallback format string used when no condition matches.

Examples

Currency format

sale_price:
  format: currency_2

Big number format

revenue:
  format: big_2

Custom Excel-style format with units

avg_weight:
  sql: '"weight"'
  aggregate_type: avg
  format: '#,##0.00 "kg"'

Custom format reference

avg_margin:
  sql: '"margin"'
  aggregate_type: avg
  format: margin_bps

Conditional format

revenue:
  format:
    depends_on:
      field: orders.currency_code
      conditions:
        - condition:
            equals: USD
          value: usdcurrency_2
        - condition:
            equals: EUR
          value: eurcurrency_2
      else: currency_2

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

Syntax

Properties

Examples

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

Documentation Index

​Syntax

​Properties

​Examples

Syntax

Properties

Examples