schHiCreateNoteShape

schHiCreateNoteShape( 
[ ?shape t_shape ]
[ ?style t_style ]
[ ?width n_width ] 
)
=> t

Description

Creates a shape to annotate the design for documentation purposes. These shapes do not affect connectivity. Usable when editing schematics or symbols.

Options forms are seeded with the argument values. If the style argument is omitted for any shape, the options form is displayed prompting you to specify the missing values. This also occurs if you omit the width argument when creating a line shape.

Arguments

?shape t_shape

Shape to create; must be enclosed in quotation marks.
Valid Values: line, rectangle, polygon, circle, ellipse, arc

?style t_style

Line style of the shape; must be enclosed in quotation marks.
Valid Values: solid, dashed

?width n_width

The width of the line, if t_shape is set to line.

If the width is zero, this command creates narrow lines using the minimum possible width. If the width is set to anything other than zero, this command creates wide lines with a configurable width.

You can modify the way that all narrow note lines are displayed by editing the Data Registry File preferences for the (text, drawing) LPP.

Value Returned

Always returns t.

Examples

Starts creating a rectangle using a solid line in the current window.

schHiCreateNoteShape( ?shape "rectangle" ?style "solid" )

Starts creating a solid line with a width of 0.0625 in the current window.

schHiCreateNoteShape( ?shape "line" ?style "solid" ?width "0.0625" )

Return to top

Virtuoso Schematic Editor SKILL Functions ReferenceProduct Version IC23.1, November 2023