Skip to main content

Object: ImagePool

The ImagePool object contains a table with image ID assignments.

For more information, see: Using an Image Pool

ID

ID of the image

You reference this ID, for example in the visualization of the image.

File name

File path of the image file

When you click the _cds_icon_three_dots.png button for more settings, the Select Image dialog opens.

Image

Show a thumbnail of the image

Link Type

Opens the Select Image dialog

In the dialog, you define the type of link.

Dialog: Select Image

Image file

Name and directory of the image file (example: "C:\Program Files\images\logo.bmp")

In CODESYS, the following image formats are supported: BMP, EMF, GIF, ICO, JPG, PNG, SVG, and TIFF. Note that a controller might not support all formats.

Whether or not you can use images formatted as scalable vector graphics (*.svg) depends on the operating system. Any necessary information is located in the device description of the hardware vendor.

Hint: It is recommended to use only images in SVG format where the aspect ratio of width to height corresponds to the aspect ratio of the view box value. Otherwise an unexpected display might result.

Table 1. File Handling

Remember the link

Only the link is saved. This automatically updates a change to the image file in the image pool.

You need to make sure that the path of the image file does not change.

When saving the project as a project archive, the image file is embedded into the project archive.

Remember the link and embed into project

The image in the image pool is copied, but the link information is retained.

This makes it possible to detect changes to the image file so that, if necessary, an update of the image can be made in the image pool.

The behavior is controlled with the options in the next table.

Note: Embedded image files increase the memory requirement of the project.

Embed into project

The image is added to the image pool.

If the image file is changed again afterwards, then it is not updated in the project. For libraries, you need to embed the image into the project.

Note: Embedded image files increase the memory requirement of the project.



Table 2. Change Tracking

These options are available only if you have selected the Remember the link and embed into project option as described above.

Reload the file automatically

The image file is automatically updated in the project without any prompts.

Prompt whether to reload the file

If the image file has changed, then you may be prompted whether or not the image file should be updated.

Do nothing

The image file in the image pool is not updated.