The dimension ingredient editor

Header

In the ingredient editor header, you can set the icon and label, view the source data table, and access perform various actions from the gear menu.

Icon. This is a FontAwesome icon associated with the dimension ingredient. By default, text dimensions have check-square, time dimensions have calendar, place dimensions have map-marker-alt , and number dimensions and measures have hashtag . The default icon can be changed, or the icon can be removed.

Label. This is the ingredient label. It is the same as the Plural label.

Data table. This displays the name of the source data table.

Gear menu. Provides access to the following actions:

• Duplicate column. Creates a new dimension ingredient with the same definition. This is used to add new ingredients.

• Duplicate as Advanced. Creates a new dimension ingredient with the same definition expressed in yaml. This is used in cases where the UI does not yet support a particular configuration option. In most cases, you should not need to duplicate as Advanced.

• Copy ingredient ID. Copies the underlying ingredient ID for use in complex ingredient field formulas.

• Delete column. Deletes the ingredient.

Basics

The Basics section of the ingredient editor contains the options that are required or used most frequently.

Field formula. This is where the ingredient logic is defined. It could be the name of a single column or it could involve complex logic.

Plural label. This is the label that will be used when the user selects multiple dimension values or no dimension values in the report.

Singular label. This is the label that will be used when the user selects a single dimension value in the report.

Number format. Only for dimensions with a number data type. Select how values should be formatted from the dropdown, or enter a custom number format.

Time format. Only for date or time dimensions. Select how values should be formatted from the dropdown, or enter in a custom time format.

Latitude. Only for place dimensions. Enter the column associated with latitude value.

Longitude. Only for place dimensions. Enter the column associated with the longitude value.

Geometry Field. Only for place dimensions. Enter the column associated with the geojson geometry field.

Styling

Description

Color

Color when negative

Image url

Hide count. By default, filter pills will display the count of distinct dimension values. Enable this option if you want to hide the count.

Advanced

Buckets

A bucketed dimension groups field values into buckets based on conditions in the Buckets box, like so:

- label: Detractor
  condition: score <= 6
- label: Passive
  condition: score <= 8
- label: Promoter
  condition: <= 10

For example, let's say your data includes a score field with customer scores, and you want to use the scores to group customers into different roles: Detractor, Passive, and Promoter. Here's what you would enter in the Buckets box:

Conditions are evaluated in the order they are defined, which makes defining buckets for continuous values convenient:

- label: Under 25k
  condition: <25000
- label: 25k-49k
  condition: <50000
- label: 50k-99k
  condition: <99000

The Buckets default label is the label to display if a value does not meet any of the conditions.

Lookups

If the values in a field are not what you want displayed in your report, you can create lookups to change them by entering a list of values to lookup with their associated value to display in the Lookups box, like so:

value to lookup: value to display
value to lookup: value to display
value to lookup: value to display

For example, let's say the Country field has "United States" values that you want to display as "USA", and it has null values that you want to display as "Unknown". Here's what you would enter in the Lookups box:

If there is a value in the field that is not added to the list of values to lookup, then the original value in your data will be displayed.

Id Field. Specify a custom unique identifier for columns. Especially useful for selections and filtering in unique cases. For example, you could set the field definition to string(" ") to hide the values and the Id Field to last_name .

Order By

Filter

Reverse. By default, higher numbers are deemed "better." To flip this, turn on Reverse.