Product Documentation
Virtuoso Studio Design Environment SKILL Reference
Product Version IC23.1, November 2023

geAddHilightPathSeg

geAddHilightPathSeg( 
g_hlSetId 
l_beginPt
l_endPt
n_width
t_beginStyle
t_endStyle
[ l_extValue ] 
=> g_hlObjectId / nil 

Description

Adds a pathSeg to a highlight set.

Arguments

g_hlSetId

Database ID of the highlight set.

l_beginPt

The start point of the path segment.

l_endPt

The end point of the path segment.

n_width

Width of the path.

t_beginStyle

The style for the beginning of the path segment.

t_endStyle

The style for the end of the path segment.

l_extValue

Extension value of a pathSeg. User needs to specify the value set of n_beginExt, n_beginLeftDiagExt, n_beginRightDiagExt, n_beginRightHalfWidth, and/or n_endExt, n_endLeftDiagExt, n_endRightDiagExt, n_endRightHalfWidth in the argument l_extValue.

Value Returned

g_hlObjectId

The pathSeg is added to the set.

nil

The pathSeg is not added to the set.

Examples

cv = geGetEditCellView()
=> db:0x4522df92
hl = geCreateHilightSet(cv list("text" "drawing"))
=> hl:0x110a5018
hl->enable = t
=> t
geAddHilightPathSeg(hl list(0.01 4.975) list(2.005 4.975) 0.12 "extend" "extend") => hl:0x110a4018

Related Topics

Highlight Functions

Return to top
 ⠀
X