Output Options


The simplest way to display an Image+ TV on your page is to use the TV Output type. This will automatically format the output anywhere you use the TV tag.

If you want to use different renders for the same TV accross your site, you can alternatively use the Output Filter.

TV Output type


The Image+ TV Output Type offers several different method of rendering an image onto a page. The default, and simplest of these is URL, which will output a simple url onto the page pointing to you image. Other options are available for more advanced and dynamic usage of the TV.

To use the TV Output Type, select Image+ as the Output Type on the TV.

URL


The URL output type simple outputs the URL of your image onto the page. This can be used to populate and image tag or background-image css property on the page.

Example

<img src="[[*myTV]]" />

Chunk


The Chunk output type allows you to select a chunk to use for rendering the TV's output. Select the chunk you want to use from the dropdown menu, and it will be called whenever you use your TV on a page. Several placeholders are passed to the chunk to allow you to customize the output.

Available Placeholders

[[+uid]]      Unique identifier for this image
[[+url]]      Url of the image
[[+width]]    Width of the image
[[+height]]   Height of the image
[[+alt]]      Alt text
[[+original]] Url of the original (uncropped) image
[[+mtime]]    Timestamp the image was generated

Snippet


The Snippet output type allows you use a snippet for rendering the TV's output. Select the snippet you want to use from the dropdown menu, and it will be called whenever you use your TV on a page. Several variables are passed to the snippet to allow you to customize the output.

Available variables

<?php
/**
 * @param int     $uid       Unique identifier for the Image+ instance
 * @param string  $url       Absolute URL of the cropped image
 * @param int     $width     Image width
 * @param int     $height    Image height
 * @param int     $mtime     Timestamp when cached image was generated
 * @param string  $original  Absolute URL to the original (source) image
 */

Data URI


If for whatever reason you can't load your image in the normal way, you can also output the image as a Data URI. This will mean it is available as soon as the DOM loads, but may slow down your page load time as the amount of data it outputs can be very large.

Output Filter


Image+ also comes with a snippet to use an an output filter in your templates. This means that you can use the same TV, and output it in many different formats accross the site.

To use the output filter, it is important that you set the TV Output Type as 'default', or MODX will get into a right mess.

The Output Filter snippet has the same rendering options as the TV Output Type (above), and can be used as follows:

URL

<img src="[[*myTV:image]]" />
- or -
<img src="[[*myTV:image=`url`]]" />

Chunk

[[*myTv:image=`chunk:myChunkName`]]

Snippet

[[*myTv:image=`snippet:mySnippetName`]]

Data URI

<img src="[[*myTv:image=`datauri`]]" />