GO2cam Javascript API
GO2SAnnotation Class Reference

Class for handling annotations. More...

Inherits QObject.

Public Member Functions

 GO2SAnnotation (Number bddId)
 
GO2SEnum::GO2SError Delete ()
 
String GetFontName ()
 
Number GetLayer ()
 
String GetName ()
 
GO2SXYZ GetPosition ()
 
String GetText ()
 
Boolean IsDimension ()
 
Number SetFontName (String fontName)
 \set the font of the annotation. The font must be installed on the system.
 

Detailed Description

Class for handling annotations.

Member Function Documentation

◆ Delete()

GO2SEnum::GO2SError GO2SAnnotation::Delete ( )

Delete the annotation from database

Returns
GO2SError.success (0) if success, see GO2SError otherwise

◆ GetFontName()

String GO2SAnnotation::GetFontName ( )
Returns
the font name of the annotation

◆ GetLayer()

Number GO2SAnnotation::GetLayer ( )
Returns
the layer of the geometric entity (-1 if failed)

◆ GetName()

String GO2SAnnotation::GetName ( )
Returns
the name of the geometric entity ("" if failed or empty name)

◆ GetPosition()

GO2SXYZ GO2SAnnotation::GetPosition ( )
Returns
the position of the annotation

◆ GetText()

String GO2SAnnotation::GetText ( )
Returns
the text of the annotation

◆ IsDimension()

Boolean GO2SAnnotation::IsDimension ( )
Returns
if the annotation is a dimension