Line
Component Palette Icon:
Description
The Line component displays a straight line. It can run north-south, east-west, or diagonally. You can add arrows to either side. The line can be dashed using any pattern you want. You can even draw the line like a sinusoidal wave.
Reporting Line Component
If you are looking for the Line component used in Reporting, refer to Reporting Line.
Properties
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Anti Alias | Draw with antialias on? Makes text smoother. | boolean | .antiAlias | Appearance |
| Color | Set the color of the line. | Color | .foreground | Appearance |
| Cursor | The mouse cursor to use when hovering over this component. | int | .cursorCode | Common |
| Dash Pattern | Enter a string of comma-delimited numbers which indicate the stroke pattern for a dashed line. For instance, "3,5" means three pixels on, five pixels off. | String | .strokePattern | Appearance |
| Data Quality | The data quality code for any tag bindings on this component. | int | .dataQuality | Data |
| Left Arrow | Draw an arrow head on the left/top of the line? | boolean | .leftArrow | Appearance |
| Left Arrow Size | The size of the left arrow, if present. | int | .leftArrowSize | Appearance |
| Line Mode | The line mode determines where in the rectangle the line is drawn. | int | .lineMode | Appearance |
| Line Style | The line style determines how the shape of the line looks. | int | .lineStyle | Appearance |
| Line Width | Set the width of the line in pixels. | int | .lineWidth | 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 |
| Right Arrow | Draw an arrow head on the right/bottom of the line? | boolean | .rightArrow | Appearance |
| Right Arrow Size | The size of the right arrow, if present. | int | .rightArrowSize | Appearance |
| Sine Height | Sets the 'amplitude' of the sine wave to be drawn. | int | .sineHeight | Appearance |
| Sine Length | Sets the 'wavelength' of the sine wave to be drawn. | int | .sineLength | 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