Legend Button Workflow Usage
The Triggers, Commands, and Properties available for the Legend Button within Workflows are listed below.
Triggers
| Trigger | Description |
|---|---|
| OnClick | The Legend Button has been clicked. |
Commands
| Command | Parameters | Description |
|---|---|---|
| Set Position | X Coordinate — The coordinate on the x-axis to move the item to. Y Coordinate — The coordinate on the y-axis to move the item to. |
Moves the position of the item to a specific set of coordinates on the canvas. |
| Set Size | Width — The width of the item in pixels. Height — The height of the item in pixels. |
Changed the size of the item to a specific Height and Width. |
| Set Visibility | Value — If the item is visible (True) or not (False). | Change whether an item is visible in Runtime. |
| Set Fill Color | Color — The Fill Color of the item. | Set a new Fill Color for the item. |
| Set Image | Image — The image file to use. | Sets a specified background image for this button. |
Properties
| Property | Description |
|---|---|
| Item ID | The unique identifier for this item. |
| Item Type | The Type of item this is. |
| Button Image | The Background Image set for the Legend Button. |
| Caption | A label for the asset. |
| Display Text Color | The Color of the Text on the button. |
| Display Text Font | The Font for the Text on the button. |
| Display Panel ID | The ID of the Display Layout the Legend displays on. |
| Legend Window Opacity | The Opacity of the Legend Window. The lower the value, the more transparent it appears. The higher the value, the more opaque it is. |
| On Click Color | The Background Color of the button when clicked. |
| Fill Color | The color currently set to fill the item background. |
| Corner Radius | This determines how rounded or sharp the corners of the item are. The higher the value, the more rounded they are. |
| Border Thickness | How thick in pixels the border is. If required, contained content is clipped to fit within the defined border. |
| Border Color | The color of the border on the item. |
| Item Name | The unique ID for this item. This property is deprecated and it is recommended to use the Item ID property instead. |
| Name | The value for this property is the Description configured via the property grid when the item is selected in Designer. |
| Width | The horizontal length of the item in pixels. |
| Height | The vertical height of the item in pixels. |
| Opacity | How visible the item is. The higher the value, the more opaque it is. The lower the value, the more translucent it is. |
| Top | The value for where on the y-axis the top of the item is located in relation to the canvas. |
| Left | The value for where on the x-axis the left side of the item is located in relation to the canvas. |
| Z Index | The position of the item when overlapped with other items. The item with the higher index value appears on top. |
| Is Visible | Whether the item is visible (True) or not (False). |