a!iconIndicator() Function

Note: The rich text icon is a better alternative to icon indicator, with a larger library of options and styles.

Function

a!iconIndicator( icon )

Returns the specified image from a list of standard indicator icons. Indicator icons can be used on interface within a document image.

Parameters

Keyword	Type	Description
`icon`	Text	The key from the table of the icon to be returned.

Returns

Document

Usage consideration

Icon size

The "ICON" size configuration should be used when using these icons within an interface image component.

Available icons

The table below shows each icon.

Name	Key	Name	Key
Add	ADD	Copy	COPY
Document	DOC_GENERIC	Happy Face	FACE_HAPPY
Indifferent Face	FACE_INDIFFERENT	Sad Face	FACE_SAD
Folder	FOLDER	Harvey Ball 0/4	HARVEY_0
Harvey Ball 1/4	HARVEY_25	Harvey Ball 2/4	HARVEY_50
Harvey Ball 3/4	HARVEY_75	Harvey Ball 4/4	HARVEY_100
Move Down	MOVE_DOWN	Move Down (Disabled)	MOVE_DOWN_DISABLED
Move Left	MOVE_LEFT	Move Left (Disabled)	MOVE_LEFT_DISABLED
Move Right	MOVE_RIGHT	Move Right (Disabled)	MOVE_RIGHT_DISABLED
Move Up	MOVE_UP	Move Up (Disabled)	MOVE_UP_DISABLED
Preview	PREVIEW	High Priority	PRIORITY_HIGH
Low Priority	PRIORITY_LOW	Paused	PROGRESS_PAUSED
Running	PROGRESS_RUNNING	Stopped	PROGRESS_STOPPED
Excellent Rating	RATING_EXCELLENT	Fair Rating	RATING_FAIR
Good Rating	RATING_GOOD	Poor Rating	RATING_POOR
Very Good Rating	RATING_VERYGOOD	Remove	REMOVE
Remove (Disabled)	REMOVE_DISABLED	Error	STATUS_ERROR
Not Done	STATUS_NOTDONE	OK	STATUS_OK
Warning	STATUS_WARN	Trend Down (Bad)	TREND_DOWN_BAD
Trend Down (Good)	TREND_DOWN_GOOD	Flat Trend	TREND_FLAT
Trend Up (Bad)	TREND_UP_BAD	Trend Up (Good)	TREND_UP_GOOD
Clock	WAIT_CLOCK

Examples

a!localVariables(
  local!pagingInfo: a!pagingInfo(startIndex: 1, batchSize: 3),
  a!gridField_19r1(
    columns: {
      a!gridTextColumn(
        label: "Task Name",
        data: {"Task 1", "Task 2", "Task 3"}
      ),
      a!gridTextColumn(
        label: "Assignee",
        data: {"John Smith", "Andrew Nelson", "Pamela Sanders"}
      ),
      a!gridImageColumn(
        label: "Status",
        size: "ICON",
        data: apply(
          a!documentImage(document: _, altText: _, caption: _),
          merge(
            apply(a!iconIndicator, {"STATUS_OK", "STATUS_WARN", "STATUS_NOTDONE"}),
            {"Complete", "Overdue", "Not Complete"},
            {"Complete", "Overdue", "Not Complete"}
          )
        )
      )
    },
    totalCount: 3,
    value: local!pagingInfo,
    rowHeader: 1
  )
)

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Partially compatible	Can be used with Appian Portals if it is connected using an integration and web API.
Offline Mobile	Incompatible
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.

Feedback

Was this page helpful?