Inline Image

SAIL Design System guidance available for Rich Text

Enhance readability and comprehension on your interface by using rich text styles to visually differentiate text.

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

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 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 Inline Image.

Refresh Until Asynchronous Action Completes (Auto-Refresh): Use a refresh interval to display the results of an asynchronous action automatically.

Feedback

Was this page helpful?