Functions

Documint uses an enhanced version of Handlebars as its templating engine. This means all valid Handlebars syntax is valid Documint syntax. Below is a list of custom functions that can be used in your Documint templates.

Combining Functions

You can combine functions by wrapping the inner function in parenthesis.

//Example
{{$multiply ($add amount_1 amount_2) ($add amount_3 amount_4)}}

Here we're using the $add function to sum two sets of values then multiplying them together. Functions in parenthesis will be evaluated first and returned to its parent function.

General

$calc (beta)

The $calc function is a powerful expression evaluator that enables complex calculations, string manipulations, array operations, and provides a secure sandbox environment within your templates.

$var

Creates a custom variable in your template which you can access from other parts of your template

Signature

{{$var name value}}

Arguments

Returns

This function does not have a return value.

Example #1 - Basic

{{$var "custom_var" "Custom value"}}
...
{{custom_var}} // Used somewhere else in the template after the above declaration

Example #2 - Advanced

Template

Data

Result

Create a custom variable and set the value to the results of the filter function where we filter items that have a quantity of 10 or more.

Repeat the section for each item in the custom variable

Copy

{
  "items":[
    {
      "name": "Item #1",
      "qty": 5
    },
    {
      "name": "Item #2",
      "qty": 10
    },
    {
      "name": "Item #3",
      "qty": 15
    },
    {
      "name": "Item #4",
      "qty": 20
    }
  ]
}

Math

$add

Add two numbers together

Signature

{{$add number1 number2 [format]}}

Arguments

Returns

Returns the total.

Example

{{$add subtotal tax}}

{
    "subtotal":100,
    "tax": 7.50
}

$subtract

Subtracts the second number from the first number.

Signature

{{$subtract number1 number2 [format]}}

Arguments

Returns

Returns the total.

Example

{{$subtract subtotal discount}}

{
    "subtotal":100,
    "discount": 21.5
}

$multiply

Multiplies two numbers together.

Signature

{{$multiply number1 number2 [format]}}

Arguments

Returns

Returns the product.

Example

{{$multiply subtotal .075}}

{
    "subtotal": 150
}

$divide

Divides the first number by the second number.

Signature

{{$divide dividend divisor [format]}}

Arguments

Returns

Returns the total.

Example

{{$divide wins total_games}}

{
    "wins": 3,
    "total_games": 15
}

$sum

Computes the sum of the values.

{{$sum hours_worked}}

{
    "hours_worked": [3, 6, 4, 12]
}

{{$sum subtotal discount tax}}

{
    "subtotal": 150,
    "discount": -20,
    "tax": 6.50
}

{{$sum items "price"}}

{
    "items": [
        { "name":"Rocket Skates", "price":160.3 },
        { "name":"Acme Glue", "price":15.6 },
        { "name":"Wing Suit", "price":699.99 },
    ]
}

$min

Computes the minimum number in an array.

Signature

{{$min array [format]}}

Arguments

Returns

Returns the minimum value.

Example

{{$min scores}}

{
    "scores": [ 3, 22, 9, 15 ]
}

$max

Computes the maximum number in an array.

Signature

{{$max array [format]}}

Arguments

Returns

Returns the maiximum value.

Example

{{$max scores}}

{
    "scores": [ 3, 22, 9, 15 ]
}

$mean

Computes the average of all values in an array.

Signature

{{$mean array [format]}}

Arguments

Returns

Returns the average value.

Example

{{$mean scores}}

{
    "scores": [ 3, 22, 9, 15 ]
}

$round

Computes number rounded to precision.

Signature

{{$round number [precision=0] [format]}}

Arguments

Returns

Returns the rounded value.

Example

{{$round avg_age}}

{
    "avg_age": 39.486
}

$floor

Computes number rounded down to precision.

Signature

{{$floor number [precision=0] [format]}}

Arguments

Returns

Returns the rounded down value.

Example

{{$floor avg_age}}

{
    "avg_age": 39.682
}

$ceil

Computes number rounded up to precision.

Signature

{{$ceil number [precision=0] [format]}}

Arguments

Returns

Returns the rounded-up value.

Example

{{$ceil avg_age}}

{
    "avg_age": 39.182
}

List/Arrays

#each

Loops over an array (list) of items. This is different than the other functions because it has an opening ({{#each}}) and closing ({{/each}}) tag and uses an # instead of a $ to prefix the function name. The content within the opening and closing tags is set to the context of the current item in the loop. This means that any variables used within the opening and closing tags are relative to the current item in the loop. If the list of items being looped over is a list of objects, then variable names will represent properties on that object. See example below.

Signature

{{#each array }}{{this}}{{/each}}

Arguments

Returns

Content within the opening and closing tags, for each item in the given array/list.

Example - Array of Objects

In this example we're looping over an array/list of Objects. We can access the properties of the current object in the loop simply by using the name of the property. In the case below, we're displaying the name property of each object using the {{name}} token. This works because the within the opening and closing tags of the #each function, the context is set to the current item in the loop.

{{#each characters}}{{name}}, {{/each}}

{
    "characters": [
        { "name": "Wile E. Coyote", "email":"[email protected]" },
        { "name": "Road Runer",     "email":"[email protected]" }
    ]
}

Example - Array of Strings

In this example, we're looping over an array/list of Strings. We use the this keyword to reference the current item in the loop. this always represents the current item in the loop, even when looping over data types other than Strings.

{{#each characters}}{{this}}, {{/each}}

{
    "characters": [ "Wile E. Coyote", "Road Runer" ]
}

$filter

Filters an array/list of items.

Signature

{{$filter array pathoperator [value]}}

Arguments

Example - Array of Objects

{{$filter products "category" "isIn" "Disguise,Explosive"}}

{
  "products": [
    { "name":"Batman Costume", "category":"Disguise" }, 
    { "name":"TNT", "category":"Explosive" },
    { "name":"Jet-Propelled Unicycle", "category":"Transportation" }
  ]
}

[
  { "name":"Batman Costume", "category":"Disguise" }, 
  { "name":"TNT", "category":"Explosive" }
]

Video walk-through of the filter process

$group

Group items together and create a loop of those items

Video walk-through of the group process

$join

Concatenates an array (list) of items into a string.

Signature

{{$join array [path] [separator] [final] }}

Arguments

Example #1 - Array of strings

{{$join categories ", " " & "}}

{
  "categories": ["Disguise", "Explosive", "Transportation"]
}

Example #2- Collection (array of objects)

{{$join items "name" ", " " & "}}

{
  "items": [
    { "name": "Glue V1", "price": 9.99 },
    { "name": "Artificial Rock", "price": 26.99 },
    { "name": "Bat-Man's Outfit", "price": 159.99 }
  ]
}

Example #3 - Path to array

{{$join "company.employees" "name" ", " " & "}}

{
  "company": {
    "name": "Acme Co.",
    "employees": [
      {
        "name": "Bernadine Burton",
        "role": "Decoy"
      },
      {
        "name": "Good Battle",
        "role": "Field Agent"
      },
      {
        "name": "Dennis Miles",
        "role": "Field Agent"
      }
    ]
  }
}

Helpers

$extname

Returns the extension name of a filename.

Signature

{{$extname filename }}

Arguments

Example

{{$extname filename}}

{
  "filename": "https://acmec.co/assets/image.jpg"
}

$inspect

Displays the raw merge data used to create the document. Useful for debugging your template when merging documents.

Signature

{{$inspect [expandDepth=1]}}

Arguments

Example

Template

Data

Result

Copy

{{$inspect 2}}

Copy

{
    "name":"Order 2321",
    "account":[
        {
            "name":"Acme Co.",
            "address":{
                "street": "123 Main St.",
                "city": "New York",
                "state": "New York"
            }
        }
    ],
    "items":[
        { "name":"Widget 1", "price":123, "qty": 1, "amount": 123 },
        { "name":"Widget 2", "price":321, "qty": 1, "amount": 321 },
        { "name":"Widget 3", "price": 456, "qty": 1, "amount": 456 },
    ]
}

Content

$iframe

Documentation coming soon!

$link

Creates a link to a given URL

Signature

{{$link url [text]}}

Arguments

Returns

Link to the given URL.

Example

{{$link company.website}}
{{$link company.website company.name}}

{
    "company":{
        "name":"Acme Co.",
        "website":"https://www.acme.co"
    }
}

$md

Renders markdown content

Signature

{{$md content}}

Arguments

Example

Template

Data

Result

Copy

{{$md notes}}

Copy

{
    "notes":"Before moving forward you need to complete the following items:\n[ ] Checklist item one\n[x] Checklist item two\n[ ] Checklist item three\n"
}