Classes
class MarkList-
MarkList (EbvListSection)
Class for handling Marks in current Mark Table.
Examples
# Make a mark at 100, 100. mark = pynebv.mark.add((100, 100), "Test Mark") # Make the mark color in blue. mark.color = 'blue' # Delete the mark. mark.delete()Ancestors
Methods
def add(point, /, name='', shape='Dot')-
Add a mark.
Args
point:tuple[float, float]-
Specify coordinate.
name:str-
Specify name.
shape:str-
type detail: str: 'Dot', 'Cross', 'X' or 'Square'
Specify shape.
Returns
EbvItem- Return a created mark.
def clear()-
Delete all marks.
Returns
none- Always none.
def load(filePath, /, append=False, firstLineIsHeader=True, formulas={}, actionWhenLineLimit='Deny')-
Create marks from file.
Args
filePath:str-
Specify file path.
append:bool-
Specify whether to append.
firstLineIsHeader:bool-
Specify whether to tread the first line as header.
formulas:dict[str, str]-
Specify formula which indicate how the value is to be handled.
actionWhenLineLimit:str-
type detail: str: 'Deny', 'Read until Limit' or 'Ignore and Read All'
Specify the behavior when the file read limit is exceeded.
Returns
EbvItemList- Return created marks.
def save(filePath, /, saveColumnDisplay=False)-
Save marks.
Args
filePath:str-
Specify file path.
saveColumnDisplay:bool-
Specify whether to save column display status.
Returns
none- Always none.
def sort_by_column(column, sortAscending)-
Sort by column.
Args
column:int-
Specify an index number of column.
sortAscending:bool-
Specify whether to sort in ascending order.
Returns
none- Always none.
Inherited members
class MarkTableList-
MarkTableList (EbvListSection)
Class for handling Mark Tables.
Examples
# Create a mark table. mark_table = pynebv.mark_table.add() # Add a mark to the mark table. pynebv.mark.add((100, 100), "Test Mark") # Close the mark table. mark_table.close()Ancestors
Methods
def add()
Inherited members
class MarkListItem-
MarkListItem (EbvItem)
Ancestors
Subclasses
Inherited members
class MarkTable-
MarkTable (MarkListItem)
Class representing Mark Table.
Ancestors
Instance variables
var filter : str-
Formula for Filter.
var formula_color : str-
Formula for $Color.
var formula_f_angle : str-
Formula for $FAngle.
var formula_f_height : str-
Formula for $FHeight.
var formula_f_width : str-
Formula for $FWidth.
var formula_group : str-
Formula for $Group.
var formula_label : str-
Formula for $Label.
var formula_name : str-
Formula for $Name.
var formula_shape : str-
Formula for $Shape.
var formula_size : str-
Formula for $Size.
var formula_x : str-
Formula for $X.
var formula_y : str-
Formula for $Y.
var name : str-
Name of item.
var thumbnail_size : str-
Thumbnail image size.
Methods
def close()-
Close a mark table.
Returns
none- Always none.
def set_current()-
Specify the target mark table.
Returns
none- Always none.
Inherited members
class Mark-
Mark (MarkListItem)
Class representing Mark.
Ancestors
Instance variables
var cells : dict[str, str]-
Mark cell values.
var is_filter_hit : bool-
Returns whether the mark hits the filter criteria.
var name : str-
Name of item.
var pos : tuple[float, float]-
Position of item.
var thumbnail_image_size : str-
Thumbnail image size.
Methods
def delete()-
Delete an item.
Returns
none- Always none.
def group()def relocate(destinationItem, /, insertAfter=True)-
Move position in list.
Args
destinationItem:EbvItem-
Specify destination item.
insertAfter:bool-
Specify whether to insert after destination.
Returns
none- Always none.
def represent(represent)-
Show mark as represent instead of mark group in list.
Args
represent:bool-
Specify whether to display as represent.
Returns
none- Always none.
def to_the_origin()-
Move the mark so that its coordinates are (0, 0). The file and mark will move accordingly.
Returns
none- Always none.
Inherited members
class MarkGroup-
MarkGroup (MarkListItem)
Class representing Mark Group.
Ancestors
Instance variables
var name : str-
Name of item.
Methods
def delete()-
Delete an item.
Returns
none- Always none.
def group()def relocate(destinationItem, /, insertAfter=True)-
Move position in list.
Args
destinationItem:EbvItem-
Specify destination item.
insertAfter:bool-
Specify whether to insert after destination.
Returns
none- Always none.
def ungroup()-
Ungroup.
Returns
none- Always none.
Inherited members