Annotations

_InsertArrow, _InsertText, AddLabelToVectorObjects, BringVectorObjectsToFront, CopyVectorObjectsToClipboard, DeselectVectorObjects, EnableVectorObjectsTimeChange, ExportSelectedLineCoordinates, InsertArrow, InsertArrowEx, InsertText, InsertTextEx, LockVectorObjects, PasteVectorObjectsFromClipboard, RemoveSelectedVectorObjects, RemoveVectorObjects, SelectVectorObjects, SendVectorObjectsToBack, SetVectorObjectFramesMethod, SetVectorObjectsCurrentMP, SetVectorObjectsInterpolationMethod, SetVectorObjectsTimeVisEnd, SetVectorObjectsTimeVisStart, ShowVectorObjectProperties, ShowVectorObjectVisibilityProperties, ShowVectorObjectVisibilityPropertiesEx, ToggleAnnotations, VectorObjectContextCommand

AddLabelToVectorObjects

Description

 AddLabelToVectorObjects();

Adds label to all selected measurement vector objects. It corresponds to the context menu command Append Label, when you right click on the measurement object without the label.

BringVectorObjectsToFront

This function runs the Bring to Front command.

Description

 BringVectorObjectsToFront();

This function changes the Z order of all vector objects so the selected ones are brought to front.

CopyVectorObjectsToClipboard

This function runs the Copy command.

Description

 CopyVectorObjectsToClipboard();

This function copies all selected vector objects to the clipboard.

DeselectVectorObjects

This function runs the Deselect command.

Description

 DeselectVectorObjects();

This function removes the selection from all the vector objects (arrows, text notes, interactive measurement results) of the current document.

EnableVectorObjectsTimeChange

Description

 EnableVectorObjectsTimeChange(
   int  Frame
);

This function enables change of the visibility of a vector object in time.

Parameters

int Frame

Change of visibility enabled/disabled

ExportSelectedLineCoordinates

Description

 ExportSelectedLineCoordinates(
   char *Filename
);

Exports coordinates of all points of the selected polyline to a text file. It works with any polyline within the annotation layer, but it is meant to be used with the Kymograph line of the tracking module.

Parameters

char *Filename

Full path to the destination txt file. E.g. “C:\export\file1.txt”

InsertArrow

Interactive command to this function: Edit > Insert Arrow

Description

 InsertArrow(
   int  Color,
   int  Orientation,
   int  Length,
   int  PosX,
   int  PosY
);

This function pastes arrow into a current color or gray image. An interactive equivalent is the _InsertArrow function.

All parameters describing the arrow are filled, only PosX and PosY parameters should be specified interactively. When calling this function, hold down primary mouse button - arrow icon appears.

Parameters

int Color

Arrow color.

0	Black
1	White
1	Bordered

int Orientation

Angle from +x axis.

0	0 degrees
1	45 degrees
2	90 degrees
3	135 degrees
4	180 degrees
5	225 degrees
6	270 degrees
7	315 degrees

int Length

Arrow length.

0	Short
1	long

int PosX

X coordinate in [px].

int PosY

Y coordinate of arrow head.

-3	All parameters describing arrow are filled, only PosX and PosY parameters should be specified interactively. When calling this function, hold down primary mouse button - arrow icon appears.

InsertArrowEx

Description

 InsertArrowEx(
   double  ObjectPosX,
   double  ObjectPosY,
   double  Length,
   double  Rotation,
   double  Width,
   int  Color,
   int  Border,
   int  TipShape,
   int  TipSize,
   int  TipAngle
);

Pastes vector arrow into the current image.

Parameters

double ObjectPosX

X coordinate in [px].

double ObjectPosY

Y coordinate in [px].

double Length

Length of the arrow.

double Rotation

Rotation of the arrow in degrees from +x axis.

double Width

Line width [px].

int Color

The RGB color as a 32bit integer. Use the RGB function to get the value.

int Border

Border color as 32bit signed integer (hexadecimal form: 0xffRRGGBB) or 0xffffff for transparent.

int TipShape

Shape of the arrow.

0	Open
1	Semi open
2	Closed
3	Square
4	Round

int TipSize

Size of the arrow tip.

0	Small
1	Middle
2	Big

int TipAngle

Angle of the arrow tip.

0	Small
1	Middle
2	Wide

Note

Unlike the InsertArrow function, this function does not draw to the color image but creates a new object instead.

InsertText

Interactive command to this function: Edit > Insert Text

Description

 InsertText(
   char *ImText,
   int  PosX,
   int  PosY,
   int  TextRed,
   int  TextGreen,
   int  TextBlue,
   int  Font,
   int  FHeight,
   int  FBold,
   int  FStrike,
   int  FItalics,
   int  FUnderline,
   int  Transparent
);

This function pastes text into a current color or gray image.

PosX and PosY parameters specify the coordinates of the upper-left corner of the drawing rectangle. -1 value places the text to the top of the image centered horizontally whereas the -2 value places the text to the bottom of the image, horizontally centered.

Parameters

char *ImText

Text to be displayed.

int PosX

X coordinate in [px].

int PosY

Y coordinate of upper-left corner of drawing rectangle.

-1	Places text to the top of the image, centered horizontally.
-2	Places text to the bottom of the image, centered horizontally.
-3	All parameters describing text and font are filled; only PosX and PosY the position of the text should be specified interactively. When calling this function, text-rectangle cursor with given text appears.

int TextRed

Red component of text color. Values are ranging from 0 to 255

int TextGreen

Green component of text color. Values are ranging from 0 to 255

int TextBlue

Blue component of text color. Values are ranging from 0 to 255

int Font

Font name.

int FHeight

Specifies the requested height for the font in logical units.

int FBold

Specifies the font weight.

0	Regular font style.
1	Bold font style.

int FStrike

Specifies strikeout flag.

0	Turns strikeout flag off.
1	Turns strikeout flag on.

int FItalics

Specifies the italics flag.

0	Turns italic flag off.
1	Turns italic flag on.

int FUnderline

Specifies underline flag.

0	Turns underline flag off.
1	Turns underline flag on.

int Transparent

Text transparency.

0	White Background (Opaque).
1	Transparent.

InsertTextEx

Description

 InsertTextEx(
   double  ObjectPosX,
   double  ObjectPosY,
   double  ObjectWidth,
   double  ObjectHeight,
   char *ObjectText,
   char *ObjectFont,
   double  FontSize,
   int  TextStyle,
   int  TextAlign,
   int  VerticalAlign,
   dword  TextColor,
   dword  FillColor,
   dword  BorderColor,
   double  LineWidth,
   int  WordWrap
);

Inserts a vector text into the current image.

Parameters

double ObjectPosX

X coordinate in [px].

double ObjectPosY

Y coordinate in [px].

double ObjectWidth

Width of the text box. Use -1 to autosize the text box.

double ObjectHeight

Height of the text box. Use -1 to autosize the text box.

char *ObjectText

Text in the text box.

char *ObjectFont

Font name, e.g. “Arial”.

double FontSize

Font size in points.

int TextStyle

Style of the font. Can be any combination of the following values:

1	Bold
2	Italic
4	Underline
8	Strikeout

int TextAlign

Specifies strikeout flag.

0	Left
1	Center
2	Right
3	Full

int VerticalAlign

Vertical alignment of the text in the box. Can be one of the following values:

0	Top
1	Center
2	Bottom

dword TextColor

Text color as 32bit signed integer (hexadecimal form: 0xffRRGGBB) or 0xffffff for transparent.

dword FillColor

Background color as 32bit signed integer (hexadecimal form: 0xffRRGGBB) or 0xffffff for transparent.

dword BorderColor

Border color as 32bit signed integer (hexadecimal form: 0xffRRGGBB) or 0xffffff for transparent.

double LineWidth

Line width in pixels.

int WordWrap

Enable word wrapping

0	Off
1	On

LockVectorObjects

This function runs the Lock command.

Description

 LockVectorObjects(
   int  VectorLock
);

This function locks/unlocks the currently selected vector objects. Locking the objects prevents the user from moving them by mistake.

Parameters

int VectorLock

0	Unlock objects
1	Lock objects

PasteVectorObjectsFromClipboard

This function runs the Paste command.

Description

 PasteVectorObjectsFromClipboard();

This function inserts all vector objects which are currently in the application clipboard into the current image. Some vector objects should have been copied to the clipboard previously.

RemoveSelectedVectorObjects

This function runs the Remove command.

Description

 RemoveSelectedVectorObjects();

This function deletes the currently selected vector object(s) (arrows, text notes, interactive measurement results) from the image.

RemoveVectorObjects

This function runs the Clear Objects command.

Description

 RemoveVectorObjects(
   int  ObjectType
);

This function removes all vector objects of one type.

Parameters

int ObjectType

Type of the object.

0	All objects
1	Interactive measurement objects
2	Automatic measurement objects
4	Non measurement vector objects (arrows and text notes)

SelectVectorObjects

This function runs the Select Vector Objects command.

Description

 SelectVectorObjects(
   int  ObjectType
);

This function selects all vector objects of one type.

Parameters

int ObjectType

Type of the object.

0	All objects
1	Interactive measurement objects
2	Automatic measurement objects
4	Non measurement vector objects (arrows and text notes)

SendVectorObjectsToBack

This function runs the Send to Back command.

Description

 SendVectorObjectsToBack();

This function changes the Z order of all vector objects so the selected ones are sent to back.

SetVectorObjectFramesMethod

Description

 SetVectorObjectFramesMethod(
   int  Method
);

Defines the behaviour of report objects over time and multipoints.

Method parameter sets the frame method (0 = Global, 1 = Changes over Time, 4 = Changes over each Multi Point, 5 = Propagate to each Multi Point).

Parameters

int Method

Selects a method.

SetVectorObjectsCurrentMP

Description

 SetVectorObjectsCurrentMP(
   int  VectorLock
);

This function sets the visibility of all currently selected annotations within a multi-point ND2 image. The selected annotations can be global for all XY positions or locked just to the current position.

Parameters

int VectorLock

0	Display the selected annotations in all XY positions.
1	Display the selected annotations within frames of the current XY position.

SetVectorObjectsInterpolationMethod

Description

 SetVectorObjectsInterpolationMethod(
   int  Method
);

Defines the frame interpolation method of report objects which change over time.

Method parameter sets the frame interpolation method (0 = None, 1 = Linear, 2 = Bezier Cubic).

Parameters

int Method

Selects a method.

SetVectorObjectsTimeVisEnd

Description

 SetVectorObjectsTimeVisEnd(
   int  Frame
);

This function sets the visibility of all currently selected annotations within a time-ND2 image-set. The specified frame is the frame where the annotation(s) will disappear.

Parameters

int Frame

Time position index.

-1	Display selected annotations to the very end.

SetVectorObjectsTimeVisStart

Description

 SetVectorObjectsTimeVisStart(
   int  Frame
);

This function sets visibility of all currently selected(!) annotations within a time-ND2 image-set. The specified frame is the frame where the annotation(s) will appear.

Parameters

int Frame

Time position index.

-1	Display selected annotations from the very start.

ShowVectorObjectProperties

This function runs the Properties command.

Description

 ShowVectorObjectProperties();

This function displays the vector object properties dialog window of the currently selected object(s). When more objects are selected at once, only the shared properties are displayed.

ShowVectorObjectVisibilityProperties

Description

 ShowVectorObjectVisibilityProperties(
   int  SelectedRoiId
);

Opens the Object Visibility dialog window used for setting the visibility of the defined report object in time.

Parameters

int SelectedRoiId

ID of the selected ROI.

ShowVectorObjectVisibilityPropertiesEx

This function runs the Object Visibility command.

Description

 ShowVectorObjectVisibilityPropertiesEx(
   int  SelectedRoiId
);

Opens the Visibility Settings dialog window used for setting the visibility of the defined report object in time.

Parameters

int SelectedRoiId

ID of the selected ROI.

ToggleAnnotations

This function runs the View > Layers > Annotations command.

Description

 ToggleAnnotations();

This function switches the annotation layer from ON to OFF state and vice versa.

VectorObjectContextCommand

This function runs the Edit Points command.

Description

 VectorObjectContextCommand(
   int  VecObjId,
   char *VecObjCommand,
   double  X,
   double  Y
);

This function is reserved for internal purposes, and it has no obvious functionality.

Parameters

int VecObjId

char *VecObjCommand

double X

Double value.

double Y

_InsertArrow

This function runs the Edit > Insert Arrow command.

Description

 _InsertArrow();

This function displays the Insert Arrow dialog box.

See Also
InsertArrow

_InsertText

This function runs the Edit > Insert Text command.

Description

 _InsertText();

This function opens the Insert Text dialog window.

See Also
InsertText

Annotations🔗

Note

Annotations