Skip to main content

Templating

Text Expressions

In Evidence, curly braces like these {...} evaluate javascript. In most cases, you will want to pass data into a component such as <Value/> or <LineChart/>, but text expressions can be very handy. You don't need to be an expert in javascript to use text expressions, and the possibilities are nearly endless.

Examples

  • Doing math: {5+5} will show up as "10" in your report.
  • Dynamically getting the number of records from a query result: {example_query.length} will display the number of rows returned by example_query.
  • Using a conditional to create a colloquial explanation of what's going on:
We are {revenue_growth[0].projected_vs_target >= 0 ? "on track for " : "behind"} our revenue growth target.

Will resolve to "We are on track for our revenue growth target." or "We are behind our revenue growth target." depending on the results of the revenue_growth query.

Conditionals

Conditionals are critical tool for managing information overload, and ensuring that your reporting is consistently showing actionable information.

Conditionals allow you to show a section of your document if a condition is met. You can optionally include {:else} and {:else if} blocks inside of your {#if}...{/if} blocks.

{#if condition}

Display this content.

{:else if another condition}

A different piece of content.

{:else }

Finally, this last piece of content.

{/if}

Example

Imagine you wanted to encourage your sales leaders "up-sell" low margin customers, but only when there were enough low-margin customers to do that work in-bulk. You could use a conditional to do something like this:

{#if low_margin_customers.length > 15}

The following customers are generating low margins.

Consider re-allocating an account management call block to up-sell these customers.

<Table data={low_margin_customers}/>

{:else }

There are fewer than fifteen low margin customers, which is not enough to fill a call block.

{/if}

Loops

Loops enable you to iterate over the rows in a query result, and reference the row using an alias of your choosing.

{#each query_name as alias}

{alias.column_name}

{/each}

If you have more content than you would like to loop over on a single page, consider using a parameterized page.

Example

Imagine you were creating a report on the performance of your organization's locations. You could use a loop to generate a section of your report for each location. When a new location appears in your query results, a new section will appear in your report.

The following table is being returned by the query location_summary

idnamesales_usdgross_margin_pct
1New York90000.60
2Los Angeles50000.45
3Toronto40000.70

By using an {#each} block, we can iterate over each of the rows in location_summary, and reference the current row with the alias location. Here we'll create a header, and a paragraph for each of the three locations.

Daily sales:

{#each location_summary as location}

## {location.name}

<Value data={location.sales_usd}/> in sales at a <Value data={location.gross_margin_pct}/> gross margin.

{/each}

Which would result in the following output

Daily sales:

New York

$9,000 in sales at a 60% gross margin.

Los Angeles

$5,000 in sales at a 45% gross margin.

Toronto

$4,000 in sales at a 70% gross margin.