Visualizer Templates: Filters
You can perform additional processing before displaying the value by passing the output through one or more filters separated by the pipeline (|).
Math
| Filter | Description | Example |
|---|---|---|
| divided_by | Divides the piped value by the specified integer. Rounds the result. Also see modulo. |
3
|
| minus | Subtracts the specified value from the piped value. Also see plus. |
2
|
| modulo | Returns the modulo (remainder) when the piped value is divided by the specified value. Also see divided_by. |
1
|
| plus | Adds the piped value and the specified value. If the values are numeric strings, the numbers are converted to integers, then added. Also see minus. |
2
|
| times | Multiplies the piped value with the specified value. |
20
|
Strings
| Filter | Description | Example |
|---|---|---|
| append | Appends the specified string to the end of the piped string. Also see prepend. |
the quick brown fox jumped over
|
| capitalize | Capitalizes the first letters of words in the piped string. Also see upcase and downcase. |
The Quick Brown Fox
Jumped Over The Lazy Dog
|
| downcase | Converts the piped string to lowercase. Also see upcase and capitalize. |
the quick brown fox
the quick brown fox
|
| prepend | Prepends a string. Also see append. |
jumped over the lazy dog
|
| remove_first | Removes the first occurrence of the specified string from the piped string. Also see remove and replace. |
ppers
|
| remove | Removes every occurrence of the specified string from the piped string. Also see remove_first and replace. |
prs
|
| replace_first | Replaces the first occurrence of the first specified string with the second specified string. Also see replace and remove_first. |
toppers
|
| replace | Replaces every occurrence of the first specified string with the second specified string. Also see replace_first and remove. |
toptors
|
| size | Returns the size of the piped array or string. |
5
|
| slice | Returns a substring from the piped string, from the specified offset and with the specified number of characters. A negative offset will start counting from the end of the string. |
el
llo
|
| split |
Splits the piped string where the specified pattern is found, not including the search pattern. Also see Arrays.
Note: Arrays are converted to a string for display by simply concatenating the elements. The
join can be used to format the array with a delimiter between each element.
|
ab
a|b
|
| strip_newlines | Removes all newline characters ("\n") from the piped string. |
If myMultiLineField is set to:
Twinkle, twinkle,little star.How I wonderwhat you are.
|
| truncate | Truncates the piped string and appends the optional second parameter, so that the length of the final result is the first parameter. |
superman
sunny
|
| upcase | Converts the piped string to uppercase. |
HELLO
|
HTML and URL Encodings for Strings
The following filters can be used if the field contains a string.
| Filter | Description | Example |
|---|---|---|
| escape_once | Converts special characters in the string into HTML escape characters without affecting characters that are already HTML-escaped. | |
| escape | Converts special characters in the string into HTML escape characters. | |
| newline_to_br | Replaces each newline ("\n") with an HTML break (<br/>). | |
| strip_html | Removes all HTML-encoded characters from the piped string. | |
| url_encode | Converts the piped string to URL encoding. |
Link Creation for URLs
The following filters can be used if the field contains a URL. The examples use the {{ linkedIn }} field placeholder.
| Filter | Description | Example |
|---|---|---|
| (no filter) | Returns the URL as plain text. |
http://www.linkedin.com/in/myexample
|
| link | Creates a link that would load the target page in the same browser tab. |
<a href="http://www.linkedin.com/in/myexample">
http://www.linkedin.com/in/myexample</a>
|
| link_new | Creates a link that would load the target page in a new browser tab. |
<a href="http://www.linkedin.com/in/myexample" target="_blank">
http://www.linkedin.com/in/myexample</a>
|
Arrays
Array indexes are zero-based; i.e., the first element's index is 0, and the last element's index is the number of elements minus 1. Example: If an array contains five elements, the index range is from 0 (for the first element) to 4 (for the last element).
Fields that are of the type Assets (images and documents) contain arrays; therefore, you can also use these filters with those fields.
These examples accept a string with comma-separated values, which is split into an array before the filter is applied. If the result is an array, the join filter combines the elements into a string with the tilde "~" as separator.
join can be used to format the array with a delimiter between each element.
| Filter | Description | Example |
|---|---|---|
| first | Returns the first element of the piped array. Also see last. |
dddd
|
| index_at | Returns the URL of the element at the specified index. If the specified index is outside the valid range (0 to number of elements minus 1), nothing is returned. |
ccc
|
| join | Combines the elements of the piped array with the specified character inserted between each element. |
dddd~bb~ccc~a
|
| last | Returns the last element of the piped array. Also see first. |
a
|
| size | Returns the size of the piped array or string. |
4
|
| sort | Sorts the elements of the array. See reverse. |
a~bb~ccc~dddd
|
Multiple Choice
These filters apply only to fields of the type Multiple Choice.
| Filter | Description | Example |
|---|---|---|
| (no filter) | For single-choice fields, returns the value of the selection. For multiple-selection fields, returns the list of the selections as a comma-separated list. |
Choice 1
Choice 1, Choice 2
|
| list | Returns an unordered list of the user's selections. |
<ul>
<li>Choice 1</li>
<li>Choice 2</li>
</ul>
|
| numberedlist | Returns an ordered list of the user's selections, in the order of the selection. |
<ol>
<li>Choice 1</li>
<li>Choice 2</li>
</ol>
|
Assets (Images and Documents)
These filters apply only to fields of the type Assets.
| Filter | Description | Example |
|---|---|---|
| (no filter) | Returns all images/documents. Images are wrapped in <img/> tags. Documents are wrapped in <a/> tags. |
<img src="https://dnn-centralsupport.zendesk.com/hc/article_attachments/360005751854/my-image-1.png" alt="my image 1" />
<img src="https://dnn-centralsupport.zendesk.com/hc/article_attachments/360005779473/my-image-2.png" alt="my image 2" />
<a target="__blank" href="https://example.com/doc-folder/my-document-1.pdf">Title of My Document 1</a>
<a target="__blank" href="https://example.com/doc-folder/my-document-2.pdf">Title of My Document 2</a>
(Formatted for legibility.) |
| images_url | Returns all the URLs of the images as plain text. |
https://example.com/img-folder/my-image-1.png
https://example.com/img-folder/my-image-2.png
(Formatted for legibility.) |
| images_list | Returns an unordered list containing the images wrapped in <img /> tags. |
<ul>
<li><img src="https://dnn-centralsupport.zendesk.com/hc/article_attachments/360005751854/my-image-1.png" alt="my image 1" /></li>
<li><img src="https://dnn-centralsupport.zendesk.com/hc/article_attachments/360005779473/my-image-2.png" alt="my image 2" /></li>
</ul>
|
| documents_url | Returns all the URLs of the documents as plain text. |
https://example.com/doc-folder/my-document-1.pdf
https://example.com/doc-folder/my-document-2.pdf
(Formatted for legibility.) |
| documents_list | Returns an unordered list containing the document URLs wrapped in <href /> tags. |
<ul>
<li><a target="__blank" href="https://example.com/doc-folder/my-document-1.pdf">Title of My Document 1</a></li>
<li><a target="__blank" href="https://example.com/doc-folder/my-document-2.pdf">Title of My Document 2</a></li>
</ul>
|
Misc
| Filter | Description | Example |
|---|---|---|
| date | Reformats a date. (See Datetime.) |
18:00
|
Priyanka Bhotika
Comments