2D Table
xAdd2DTable
Adds a 2D table. i.e. Matrix of user-defined labels.
size_t xAdd2DTable(float fXpos, float fYpos, bool bRelativePos=true)
return
Returns the ID of added 2D table.
Note
It is needed to store this ID for further references.
fXpos, fYpos
X, Y position in screen space of the table to be added.
bRelativePos
Flag for the relative position in screen space.
If True is set X, Y values are used as relative to screen size.
..note::
The range for the relative position is 0 to 1.
xSet2DTableFont
Sets 2D table’s Font for a cell.
return
Returns True, if successful.
iTableID
The ID of the table.
iRow, iCol
Row and column index. If iRow is -1 it applies in all Rows. If iCol
is -1 it applies in all columns.
sFont
Font name that has to set in the given field.
xGet2DTableFont
Gets 2D table’s Font.
return
Returns font name that is set in the given field.
iTableID
The ID of the table.
iRow, iCol
Row and column index of the table, 0 based index.
xSet2DTableFontSize
Sets 2D table’s text size.
return
Returns True, if successful.
iTableID
The ID of the table.
iRow, iCol
Row and column index. If iRow is -1 it applies in all Rows. If iCol
is -1 it applies in all columns.
iFontSize
Font size for the given field.
xGet2DTableFontSize
Gets 2D table’s text size.
return
Returns Font size for the given field. Returns -1 if fails.
iTableID
The ID of the table.
iRow, iCol
Row and column index. 0 based.
xSet2DTableBackground
Sets background color for cell in a 2DTable.
return
Returns True, if successful.
iTableID
2D TableID.
iRow, iCol
Row and column index of the cell in 2DTable. If iRow is -1 it
applies in all Rows. If iCol is -1 it applies in all columns.
r, g, b
New Red, green and blue color values. Valid Range 0 to 255.
pxGet2DTableBackground
Gets beckground color applied in 2DTable cell.
return
Returns an array of size 3 if successful. Else returns empty array.
retArray[0] = red component
retArray[1] = green component
retArray[2] = blue component
iTableID
2D TableID.
iRow, iCol
Row and column index of the cell in 2DTable.
xShow2DTableBackground
Show/Hides background in a 2DTable.
return
Returns True, if successful.
iTableID
2D TableID.
bShow
Set True to show background in the 2DTable.
xIs2DTableBackgroundVisible
Get 2DTable’s background visibility.
return
Returns True, if visible.
iTableID
2D TableID.
xSet2DTablePosition
Sets 2D table’s position in screen space.
return
Returns True if successful.
iTableID
Table ID for which position is to be set.
iXpos, iYpos
X, Y position in screen space of the table.
bRelativePos
Flag for the relative position in screen space.
If True is set X, Y values are used as relative to screen size.
xSet2DTableText
Sets text info in 2D table field.
return
Returns True, if successful.
iTableID
The ID of the 2D table.
iRow, iCol
Row and column index.
Note: It uses a zero-based index. Means index of the first row is 0
and index for the first column is 0.
Note: Table will expand to fit row and column.
sText
Text value to be set for the table field.
xGet2DTableText
Gets text info in 2D table field.
return
Returns Text value of the table field.
iTableID
The ID of the 2D table.
iRow, iCol
Row and column index.
Note: It uses a zero-based index.
sText
Text value to be set for the table field.
xSet2DTableTextColor
Sets 2D table’s text color.
return
Returns True, if successful.
iTableID
The ID of the table.
iRow, iCol
Row and column index. If iRow is -1 it applies in all Rows. If iCol
is -1 it applies in all columns.
iR, iG, iB
RGB color value for the text field.
xGetUser2DTableCount
Gets size of 2D annotation labels count.
return
Returns size of the 2D annotation labels array.
pxGet2DTablePosition
Gets 2D table’s position in screen space.
List<float> pxGet2DTablePosition(size_t iTableID)
return
Returns table position info. In a float array size of 3. Order: iXpos,
iYpos, bRelativePos(True or False)
retArray[0] = iXpos
retArray[1] = iYpos
retArray[2] = bRelativePos
iTableID
The ID of the table.
xGetUser2DTableText
Gets text content of a 2D annotation label.
String xGetUser2DTableText(int iIndex)
xDelete2DTableRow
Deletes a row in 2D table.
return
Returns True, if successful.
iTableID
The ID of the table.
iRow
Row index that has to be deleted. 0 based index.
xDelete2DTableCol
Deletes a coloumn in 2D table.
bool xDelete2DTableCol(size_t iTableID, int iCol)
return
Returns True, if successful.
iTableID
The ID of the table.
iCol
Column index that has to be deleted. 0 based index.
pxGet2DTableTextColor
Gets 2D table’s text color for a given row and column.
return
Returns required field’s text color in an array size of 3. Order : r, g, b
iTableID
The ID of the table.
iRow, iCol
Row and Column index.
xDeleteUser2DTable
Deletes user 2D table by index.
return
Returns True, if successful.
iIndex
Index of the table in the 2D table array. 0 based index.
xDeleteAllUser2DTables
Deletes all 2D annotations.
return
Returns True, if successful.
xAdd2DTableRow
Adds rows to 2D table.
return
Returns True, if successful.
iTableID
2d table ID.
iRow
Number of rows to be added.
xAdd2DTableCol
Adds columns to 2D table.
return
Returns True, if successful.
iTableID
2D table ID.
iCol
Number of columns to be added.
xDeleteUser2DTableEx
Deletes a user 2D table based on ID.
return
Returns True, if successful.
iTabeID
ID of the 2D table to be deleted.
x2DTableShowAll
Shows all 2D Tables.
return
None.
x2DTableHideAll
Hides all 2D Tables.
return
None.
x2DTableDeleteAll
Deletes all 2D Tables.
return
None.
x2DTableInvertShow
Inverts visibilty of 2D tables.
return
None.
xSet2DTableSize
Sets 2D table size/resize.
return
Returns True, if successful.
iTableID
Table ID.
iRows, iCols
New row and column sizes.