You are here: Tools > All Tools > Image

Image Tool

The Image Tool adds graphics to reports.

Configuration Properties:

The Image Tool allows for a static image to be stored in the workflow or for an image to be retrieved from disk at run time. The image tool accepts.png,.jpg or gif formats.

Image Handling: There are two options when including images in reports that tell Alteryx where to retrieve the images and whether or not to store the image with the workflow.

- Store Static Image in Workflow: The image is saved with the workflow. This setting allows users to share the workflow without having to maintain separate files. This setting also impacts the size of the workflow, as the image file size is added to the workflow file size.
- 1. Browse to the image in.png, jpg or.gif format. Once the image is chosen the tool displays the image information including Width and Height, Format, Size and a thumbnail of the image.
- Retrieve image from disk at run time: Alteryx will retrieve this image from the specified path when the workflow is run. Either a single image may be chosen or Alteryx will read the contents of a field containing the file path of the image to return an image for each incoming record.
- 1. Populate the Filename box with the intended image's directory path. Browse to the image in.png, jpg or.gif format.
- If multiple images are to be returned, this box can be populated with any part of the file's directory structure relative to the content of the incoming data. See the options in Step 2 below.
Modify Filename for each record: This is an optional setting to be used when the file path (or file names) of the images to be included in the report are contained within the input data stream. When checked, the filename can be edited based on other field data. File name/path editing choices include:
- Appending Field to Filename: Appends the value of the selected filename to the end of the specified Field.
- 1. The Filename box may be populated to include a relative path: .\data\images\image.jpg The highlighted part will be replaced to include ImageFile Name+Image Name:

Image Name	Image File Name	Appended File Name
Pineapple	image.jpg	imagePineapple.jpg
Banana	image.jpg	imageBanana.jpg
Apple	image.jpg	imageApple.jpg

- Prepending Field To Filename: Prepends the value of the selected filename to the beginning of the specified Field.
- 1. The Filename box may be populated to include a relative path: .\data\images\image.jpg The highlighted part will be replaced to include Image Name+Image File Name:

Image Name	Image File Name	Prepended File Name
Pineapple	image.jpg	Pineappleimage.jpg
Banana	image.jpg	Bananaimage.jpg
Apple	image.jpg	Appleimage.jpg

- Replacing Filename With Field: Changes the filename to the value of the selected Field.
- 1. The Filename box may be populated to include relative folder path: .\data\images\
  2. Notice in the path above a file name is not specified. The intention here is for the field Image File Name to complete the specified folder path.

Image Name	Image File Name	Replaced File Name
Pineapple	Pineappleimage.jpg	.\data\images\Pineappleimage.jpg
Banana	Bananaimage.jpg	.\data\images\Bananaimage.jpg
Apple	Appleimage.jpg	.\data\images\Appleimage.jpg

- Replacing Entire Path With Field: Changes the entire path to the value of the selected Field.
- 1. The Filename box may be left Blank because the entire file path is included in the Image File Name field. Alteryx will use this data to retrieve the images.

Image Name	Image File Name
Pineapple	.\data\images\Pineappleimage.jpg
Banana	.\data\images\Bananaimage.jpg
Apple	.\data\images\Bananaimage.jpg

Stop with error if file not found: When checked, processing will stop and an error will be reported that the specified image could not be found.

When using a static image, the tool will provide a red warning message if the image is over 100KB letting the user know it will be taking up that much space in the saved workflow.

Image Settings

Opening the Image Style Editor allows adjustment to the following Image Style properties:

- Use Fixed Width: Specify if a fixed width should be used. If choosing to use a fix width the image is restrained to the width chosen in the menu below.
- Image Width: Specify the image width in pixels. Aspect ratio will be preserved.
- Show Border: Specify if a border is desired around the image.
- Border Width: Specify the border width in pixels.
- Border Color: Specify the border color.