Using Annotation Components

Last Updated: 12/03/2015 Introduced in Verision: 2.0

Annotation components identify and label parts of the flow, but have no other function. They display in the workspace only and not in the Debugger.

Use annotations to add design notes, to list components and paths yet to be added to a flow, or to clarify functionality when working with a complex flow.

To add an annotation to a flow, in the Toolbox panel, in the Annotations category, drag an Arrow component and a Rich Text component to the workspace.

Example

Our example flow asks a user to input a piece of text. To help other users understand how the form is composed, we will annotate the step with a descriptive label.
 flow
 

In the Toolbox panel, in the Annotations category, drag an Arrow component to the workspace below the form to annotate. Move the arrow and adjust its size.

Next, we’ll drag our label to the workspace. The Rich Text component can also be found in the Annotations category. 

Rich text, unlike plain text, can be styled in much the same manner as any document editor. In the Properties panel, under the section Display > Text > Rich Text,  click the Rich Text selector to open the Rich Text Input editor.

richTextProperties

 

In the Rich Text Input editor, input the desired message and click OK.  

Our flow annotation is completed. Anchors along the edges of our annotation make it easy to move and resize it, or delete it.

 

 

Additional Resources