Image Widget screen

Shows an image on a custom page.

Figure: Image Widget screen

Image Widget screen

Video: Page Builder Overview

Examples

  • (Example) Image Widget in Page Builder
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Prerequisites

How to Start

  1. Open the Custom Page Design screen.

    For information about how to open this screen, refer to Custom Page Design screen.


    Open Custom Page
  2. Click Add Widget.

    Custom Page Design screen
  3. On the Pick A Widget screen, on the Media tab, click Image.

    Click Image Widget

Fields

Field NameDefinition

Image Source
Description:
Specifies whether to select an image from the image library.
Allowed Values:
  • Web URL - Specifies the absolute URL for an image.
  • Image Library - Uses an image from the image library.

    To use image from image library, click Pick An Image.

Default Value:
Image Library
Limitations:
This field is available in these releases:

Image URL
Description:
Specifies the URL of the image to be shown on your custom page.
To Open this Field:
  1. In the Image Source field, click Web URL.
Allowed Values:
One line of text (a string) in URL format that points to an image file.

The file can be one of these types:

  • .png
  • .jpg
  • .jpeg
  • .gif
  • .bmp
  • .tif
Default Value:
None
Example:
Limitations:

.jpeg and .tif format files are permitted, and .bmp format files are not permitted in these releases:

Pick An Image
Opens this Screen:
Image Picker screen
To Open this Field:
  1. In the Image Source field, click Image Library.
Function of this Screen:
Specifies an image file to show on your page or menu.
Limitations:
This field is available in these releases:

Maintain Aspect Ratio
Description:
Specifies whether to keep the image in its original size.
Allowed Values:
  • On - Keeps the image in its original size.
  • Off - You can change the height or width of an image as necessary to show on the widget.
Default Value:
On

Image Height
Description:
Specifies the height of an image.
To Open this Field:
  1. On the Image screen, turn off the Maintain Aspect Ratio field.
Allowed Values:
An integer.
Default Value:
200
Example:
Refer to:

Unit
Description:
Specifies the unit for the height or width of an image.
To Open this Field:
  1. On the Image screen, turn off the Maintain Aspect Ratio field.
Allowed Values:
  • Pixels (px)
  • Percentage (%)
Default Value:
Pixels (px)

Image Width
Description:
Specifies the width of an image.
To Open this Field:
  1. On the Image screen, turn off the Maintain Aspect Ratio field.
Allowed Values:
An integer.
Default Value:
200
Example:
Refer to:

Add
Description:
Adds the widget to the custom page.