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 can be a bit confusing to a new user. It is done via 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 should make the naming conventions more clear:
Properties
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Border | The border surrounding this component. NOTE that the border is unaffected by rotation. | Border | .border | Common |
| Center Fill | The center of the fill gradient. | Color | .mainColor | Appearance |
| Cursor | The mouse cursor to use when hovering over this component. | int | .cursorCode | Common |
| Data Quality | The data quality code for any tag bindings on this component. | int | .dataQuality | Data |
| Edge Fill | The edge of the fill gradient. | 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. | Color | .outlineColor | Appearance |
| Styles | Contains the component's styles. | Dataset | .styles | Appearance |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
Scripting
Scripting Functions
This component does not have scripting 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