Inline Image

Function

a!richTextImage( image, showWhen )

Displays an image within a rich text component.

To show styled icons within rich text, see Styled Icon.

See also: Rich text style guidance

Parameters

Name Keyword Types Description

Image

image

Image

Required image to display in the node, created with a!documentImage(),a!userImage(), and a!webImage().

Visibility

showWhen

Boolean

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

Examples

Copy and paste an example into the INTERFACE DEFINITION in EXPRESSION MODE to see it displayed.

Inline icons

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
a!richTextDisplayField(
  labelPosition: "COLLAPSED",
  value: {
    "Happy Face ",
    a!richTextImage(
      image: a!documentImage(
        document: a!iconIndicator(
          icon: "FACE_HAPPY"
        )
      )
    ),
    "Indifferent Face ",
    a!richTextImage(
      image: a!documentImage(
        document: a!iconIndicator(
          icon: "FACE_INDIFFERENT"
        )
      )
    ),
    "Sad Face ",
    a!richTextImage(
      image: a!documentImage(
        document: a!iconIndicator(
          icon: "FACE_SAD"
        )
      )
    )
  }
)

Displays the following:

screenshot of icons in embedded in a line of text

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
Process Reports Incompatible

You cannot use this function to configure a process report.

Process Events Incompatible

You cannot use this function to configure a process event node, such as a start event or timer event.

The following patterns include usage of the Inline Image.

Open in Github Built: Wed, Dec 07, 2022 (10:13:16 PM)

On This Page

FEEDBACK