State Tag

A State Tag is an optional pill-shaped object that can displays the state of the flow to the user. This can be either ‘Locked’ or ‘Read-only’. By default, no state tag is shown.

The application can request a state tag be shown by setting the enableStateTag canvas config field.

When the State Tag is display it will show a tooltip, with an appropriate message, if the mouse cursor is hovered over it. The application can override the default message by implementing the Tip Handler callback.

Note

It is the application’s reponsibility for making the flow read-only. See the Read Only or Locked Flows page for more details.