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 or relative URL for an image.
    • You can specify the absolute URL to use an image from an external source.
    • You can specify the relative URL to use an image from the image library.
  • 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:
  • These requirements apply to images that use an absolute URL:
    • Images must be stored in a web server or cloud storage location accessible through HTTPS that AgilePoint NX can access.
    • Images cannot be stored on a local file system, such as your local machine or the AgilePoint Server machine.
    • Images must be referenced with an absolute URL.
  • These requirements apply to images that use a relative URL:
    • You must specify the file path for the relative URL in this format:

      /library/images/[file name with the extension]

    • You can use the relative URL only if you know the image file name. If you do not know the file name, you can use the Image Library option on the Image Source field to select an image from the image library.

      For more information, refer to Images screen

      .
    • The image file must exist in the image library in Page Builder. To add an image to the Image Library, refer to Add Image File screen.
    • Support for relative URLs is available in these releases:
  • .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.