Add a Preview Image for a Custom Widget

1 minute to read Download PDF Edit

1 Introduction

This how-to will show you how to specify a preview image that will be rendered in the Modeler.

This how-to will teach you how to do the following:

  • Configure a preview image for custom widgets

2 Prerequisites

Before starting with this how-to, make sure you have completed the following prerequisites:

3 Adding a Preview Image to Your Custom Widget Package

You need to put an image file named preview.png next to your custom widget XML configuration file:

After packaging your custom widget, the image provided will be rendered in the Modeler whenever it is used:

Please note that older versions of the Modeler ignore this image and render a grey rectangle as usual.