Free cookie consent management tool by TermsFeed Document Image (a!documentImage)
Document Image
SAIL Design System guidance available for Images

A picture is worth a thousand words. Learn how to use images in your interface designs to say more than words ever could.

Function

a!documentImage( document, altText, caption, link, showWhen )

Displays an image from document management for use in an image, rich text display, tree browser, billboard layout component, or in a grid column component in a Read-Only Grid.

Parameters

Name Keyword Types Description

Document

document

Document

The image to display. Supported document types:

  • JPG
  • JPEG
  • PNG
  • GIF
  • SVG
  • BMP

Alternate Text

altText

Text

Alternate text of the image used for the image's alt attribute and read by screen readers; see accessibility considerations for more information.

Caption

caption

Text

Optional text to display in the mouseover text for the image and when the images is viewed in slideshow mode.

Link

link

Link

Link that determines the behavior of an image when clicked. Create links with:

Visibility

showWhen

Boolean

Determines whether the image is displayed in the component. When set to false, the image is hidden and is not evaluated. Default: true.

Examples

To experiment with examples, copy and paste the expression into an interface object.

Displaying a document image using a constant

To test this example, replace cons!MY_PNG with a constant that points to a document in your environment.

Note that this uses the document() function to access the name of the document to display in the interface.

1
2
3
4
5
6
7
8
9
10
11
12
a!imageField(
  label: document(
    documentId: cons!MY_PNG,
    property: "name"
  ),
  labelPosition: "ABOVE",
  images: {
    a!documentImage(
      document: cons!MY_PNG
    )
  }
)

Feature compatibility

The table below lists this SAIL component's compatibility with various features in Appian.
Feature Compatibility Note
Portals Compatible
Offline Mobile Compatible
Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Incompatible

Cannot be used to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Document Image.

Open in Github Built: Tue, Jun 11, 2024 (05:25:17 PM)

Document Image

FEEDBACK