Skip to main content
Version: 8.1

Vision - 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 Report - Line Shape.

Properties

NameDescriptionProperty TypeScriptingCategory
ColorSet the color of the line. Can be chosen from color wheel, chosen from color palette, or entered as RGB or HSL value. See Color Selector.Color.foregroundAppearance
CursorThe mouse cursor to use when hovering over this component. Options are: Default, Crosshair, Text, Wait, Hand, Move, SW Resize, or SE Resize.int.cursorCodeCommon
Dash PatternEnter 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.strokePatternAppearance
Left ArrowDraw an arrow head on the left/top of the line?boolean.leftArrowAppearance
Left Arrow SizeThe size of the left arrow, if present.int.leftArrowSizeAppearance
Line ModeThe line mode determines where in the rectangle the line is drawn.int.lineModeAppearance
Line StyleThe line style determines how the shape of the line looks. Options are: Plane, Dashed, Sinusoidal, Sinusoidal-Dashed, Loop, and Loop-Dashed.int.lineStyleAppearance
Line WidthSet the width of the line in pixels.int.lineWidthAppearance
Mouseover TextThe text that is displayed in the tooltip which pops up on mouseover of this component.String.toolTipTextCommon
NameThe name of this component.String.nameCommon
QualityThe data quality code for any Tag bindings on this component.QualityCode.qualityData
Right ArrowDraw an arrow head on the right/bottom of the line?boolean.rightArrowAppearance
Right Arrow SizeThe size of the right arrow, if present.int.rightArrowSizeAppearance
Sine HeightSets the amplitude of the sine wave to be drawn.int.sineHeightAppearance
Sine LengthSets the wavelength of the sine wave to be drawn.int.sineLengthAppearance
StylesContains the component's styles.Dataset.stylesAppearance
VisibleIf disabled, the component will be hidden.boolean.visibleCommon

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

Customizers

Examples

Line with Sinusoidal Pattern

PropertySetting
Color0,0,255
Line StyleSinusoidal

Line with Arrow Endpoints

PropertySetting
Color217,0,0
Line StylePlain
Left ArrowTrue
Left Arrow Size25
Line Width4
Right ArrowTrue
Right Arrow Size25