SetNoteDistance

Sets the note offset distance from the entity center.

Syntax

bestview_handle SetNoteDistance distance

Application

HyperView Tcl Modify

Description

This command sets the note offset distance from the entity center. This distance is not followed during the global, globalregions, globalcomponents, or globalspheres view modes where multiple notes are present and there is a chance of overlap.
Note: To change the format and the contents of the best view note, you should create a note inside the current HyperView window and label the note as “master” and then activate a best view. This can also be done using the poINote Class APIs under poIPost.

When a master note is present, the format and content of the master note will be followed for all best view evaluations.

Inputs

distance
The offset in screen percentage (0.1 would be 10% of the screen height and width).

Example

To set the note offset distance to 20%:
bestview_handle SetNoteDistance 0.2

Errors

Returns success (0) or an error code.