Vision - Pipe Segment
Component Palette Icon:
Description​
The pipe segment component displays a quasi-3D pipe. In its basic form it looks very much like a rectangle with a round gradient. The difference comes in its advanced rendering of its edges and endcaps. You can configure each pipe segment's end to mate perfectly with another pipe segment butted up against it perpendicularly. The result looks like a pipe welded together in a 90° corner.
The control of the pipe's ends are done using 6 booleans - three per 'end'. End 1 is the top/left end, and End 2 is the bottom/right end. You turn off each boolean if there will be another pipe butted up against that side. The following diagram illustrates the naming conventions:
Properties​
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Border | The border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border. Note: The border is unaffected by rotation. Changed in 8.1.21 As of 8.1.21, the "Button Border" and "Other Border" options are removed. | Border | .border | Common |
| Center Fill | The center of the fill gradient. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector. | Color | .mainColor | Appearance |
| Cursor | The mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize. | int | .cursorCode | Common |
| Edge Fill | The edge of the fill gradient. See Color Selector. | Color | .secondaryColor | Appearance |
| End 1 Bottom? | Draw the border at end #1's bottom? | boolean | .end1Bottom | Appearance |
| End 1 Cap? | Draw the border at end #1's cap? | boolean | .end1Cap | Appearance |
| End 1 Top? | Draw the border at end #1's top? | boolean | .end1Top | Appearance |
| End 2 Bottom? | Draw the border at end #2's bottom? | boolean | .end2Bottom | Appearance |
| End 2 Cap? | Draw the border at end #2's cap? | boolean | .end2Cap | Appearance |
| End 2 Top? | Draw the border at end #2's top? | boolean | .end2Top | Appearance |
| Mouseover Text | The text that is displayed in the tooltip which pops up on mouseover of this component. | String | .toolTipText | Common |
| Name | The name of this component. | String | .name | Common |
| Outline Color | The color of the outline border. See Color Selector. | Color | .outlineColor | Appearance |
| Quality | The data quality code for any Tag bindings on this component. | QualityCode | .quality | Data |
| Styles | Contains the component's styles. | Dataset | .styles | Appearance |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
Scripting​
Component Functions​
This component does not have component functions associated with it.
Extension Functions​
This component does not have extension functions associated with it.
Event Handlers​
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page