navigate Logo

Getting Started

  • Quick Start Guide
  • Software Installation
  • I Want To…

User Guide

  • Supported Hardware
  • Supported File Formats
  • User Interface Walkthrough
  • Setting Up A Microscope
  • Acquiring Data
  • Case Studies

Development

  • Contributing Guidelines
  • Developer Install
  • Software Architecture
  • Feature Container
  • REST-API
  • Plugin Architecture

Troubleshooting & Known Issues

  • Troubleshooting
  • Known Issues

Plugins

  • navigate Plugin Template
  • navigate Confocal Projection
  • navigate at Scale
  • navigate Constant Velocity Acquisition
  • navigate MMCore
  • navigate ilastik Server
  • navigate Photoactivation

Reference

  • Implemented Microscopes
  • Software API
navigate
  • navigate.view.main_window_content.multiposition_tab.MultiPositionTable
  • View page source

navigate.view.main_window_content.multiposition_tab.MultiPositionTable

class navigate.view.main_window_content.multiposition_tab.MultiPositionTable(parent=None, **kwargs)

Bases: Table

MultiPositionTable is a class that inherits from Table. It is used to customize the table for the multipoint table.

__init__(parent=None, **kwargs)

Initialize the MultiPositionTable

Parameters:
  • parent (tk.Frame) – The frame that contains the settings tab.

  • **kwargs (dict) – Arbitrary keyword arguments.

Methods

__init__([parent])

Initialize the MultiPositionTable

addColumn([newname])

Add a new column

addRow()

Insert a new row

addRows([num])

Add new rows

addtag(*args)

Internal function.

addtag_above(newtag, tagOrId)

Add tag NEWTAG to all items above TAGORID.

addtag_all(newtag)

Add tag NEWTAG to all items.

addtag_below(newtag, tagOrId)

Add tag NEWTAG to all items below TAGORID.

addtag_closest(newtag, x, y[, halo, start])

Add tag NEWTAG to item which is closest to pixel at X, Y.

addtag_enclosed(newtag, x1, y1, x2, y2)

Add tag NEWTAG to all items in the rectangle defined by X1,Y1,X2,Y2.

addtag_overlapping(newtag, x1, y1, x2, y2)

Add tag NEWTAG to all items which overlap the rectangle defined by X1,Y1,X2,Y2.

addtag_withtag(newtag, tagOrId)

Add tag NEWTAG to all items with TAGORID.

adjustColumnWidths([limit])

Optimally adjust col widths to accomodate the longest entry in each column - usually only called on first redraw.

after(ms[, func])

Call function once after given time.

after_cancel(id)

Cancel scheduling of function identified with ID.

after_idle(func, *args)

Call FUNC once if the Tcl main loop has no event to process.

aggregate()

Show aggregate dialog

anchor([anchor])

The anchor value controls how to place the grid within the master when no row/column has any weight.

applyColumnFunction([evt])

Apply column wise functions, applies a calculation per row and ceates a new column.

applyStringMethod()

Apply string operation to column(s)

applyTransformFunction([evt])

Apply resampling and transform functions on a single column.

autoAddColumns([numcols])

Automatically add x number of cols

autoResizeColumns()

Automatically set nice column widths and draw

bbox(*args)

Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle which encloses all items with tags specified as arguments.

bell([displayof])

Ring a display's bell.

bind([sequence, func, add])

Bind to this widget at event SEQUENCE a call to function FUNC.

bind_all([sequence, func, add])

Bind to all widgets at an event SEQUENCE a call to function FUNC.

bind_class(className[, sequence, func, add])

Bind to widgets with bindtag CLASSNAME at event SEQUENCE a call of function FUNC.

bindtags([tagList])

Set or get the list of bindtags for this widget.

canvasx(screenx[, gridspacing])

Return the canvas x coordinate of pixel position SCREENX rounded to nearest multiple of GRIDSPACING units.

canvasy(screeny[, gridspacing])

Return the canvas y coordinate of pixel position SCREENY rounded to nearest multiple of GRIDSPACING units.

cget(key)

Return the resource value for a KEY given as string.

checkDataEntry([event])

do validation checks on data entry in a widget

cleanData()

Deal with missing data

clearData([evt])

Delete cells from gui event

clearFormatting()

clearSelected()

Clear selections

clearTable()

Make an empty table

clipboard_append(string, **kw)

Append STRING to the Tk clipboard.

clipboard_clear(**kw)

Clear the data in the Tk clipboard.

clipboard_get(**kw)

Retrieve data from the clipboard on window's display.

close([evt])

closeChildTable()

Close the child table

colorColumns([cols, color])

Color visible columns

colorRows()

Color individual cells in column(s).

columnconfigure(index[, cnf])

Configure column INDEX of a grid.

config([cnf])

Configure resources of a widget.

configure([cnf])

Configure resources of a widget.

contractColumns([factor])

Reduce column widths

convertColumnNames([s])

Convert col names so we can use numexpr

convertDates()

Convert single or multiple columns into datetime

convertNumeric()

Convert cols to numeric if possible

coords(*args)

Return a list of coordinates for the item given in ARGS.

copy(rows[, cols])

Copy cell contents to clipboard

copyColumn()

Copy a column

copyIndex()

Copy index to a column

copyTable([event])

Copy from the clipboard

corrMatrix()

Correlation matrix

createCategorical()

Get a categorical column from selected

createChildTable(df[, title, index, out])

Add the child table

create_arc(*args, **kw)

Create arc shaped region with coordinates x1,y1,x2,y2.

create_bitmap(*args, **kw)

Create bitmap with coordinates x1,y1.

create_image(*args, **kw)

Create image item with coordinates x1,y1.

create_line(*args, **kw)

Create line with coordinates x1,y1,...,xn,yn.

create_oval(*args, **kw)

Create oval with coordinates x1,y1,x2,y2.

create_polygon(*args, **kw)

Create polygon with coordinates x1,y1,...,xn,yn.

create_rectangle(*args, **kw)

Create rectangle with coordinates x1,y1,x2,y2.

create_text(*args, **kw)

Create text with coordinates x1,y1.

create_window(*args, **kw)

Create window with coordinates x1,y1,x2,y2.

crosstab()

Cross tabulation

dchars(*args)

Delete characters of text items identified by tag or id in ARGS (possibly several times) from FIRST to LAST character (including).

delete(*args)

Delete items identified by all tag or ids contained in ARGS.

deleteCells(rows, cols[, answer])

Clear the cell contents

deleteColumn()

Delete currently selected column(s)

deleteRow()

Delete a row

deletecommand(name)

Internal function.

describe()

Create table summary

destroy()

Destroy this and all descendants widgets.

doBindings()

Bind keys and mouse clicks, this can be overriden

doCombine()

Do combine/merge operation

doExport([filename])

Do a simple export of the cell contents to csv

drawCellEntry(row, col[, text])

When the user single/double clicks on a text/number cell, bring up entry window and allow edits.

drawGrid(startrow, endrow)

Draw the table grid lines

drawHighlighted()

Color an arbitrary selection of cells.

drawMultipleCells()

Draw an outline box for multiple cell selection

drawMultipleCols()

Draw multiple column selections

drawMultipleRows(rowlist)

Draw more than one row selection

drawRect(row, col[, color, tag, delete])

Cell is colored

drawRowHeader()

User has clicked to select a cell

drawSelectedCol([col, delete, color, tag])

Draw a highlight rect for the current column selection

drawSelectedRect(row, col[, color, fillcolor])

User has clicked to select a cell

drawSelectedRow()

Draw a highlight rect for the currently selected rows

drawText(row, col, celltxt[, align])

Draw the text inside a cell area

dtag(*args)

Delete tag or id given as last arguments in ARGS from items identified by first argument in ARGS.

duplicateRows()

Make copy of rows

evalBar([evt])

Use pd.eval to apply a function colwise or preset funcs.

evalFunction([evt])

Apply a function to create new columns

event_add(virtual, *sequences)

Bind a virtual event VIRTUAL (of the form <<Name>>) to an event SEQUENCE such that the virtual event is triggered whenever SEQUENCE occurs.

event_delete(virtual, *sequences)

Unbind a virtual event VIRTUAL from SEQUENCE.

event_generate(sequence, **kw)

Generate an event SEQUENCE.

event_info([virtual])

Return a list of all virtual events or the information about the SEQUENCE bound to the virtual event VIRTUAL.

expandColumns([factor])

Reduce column widths

fillAcross(collist, rowlist)

Fill across a row, or multiple rows

fillColumn()

Fill a column with a data range

fillDown(rowlist, collist)

Fill down a column, or multiple columns

find(*args)

Internal function.

findDuplicates()

Find duplicate rows

findText([evt])

Simple text search in whole table

find_above(tagOrId)

Return items above TAGORID.

find_all()

Return all items.

find_below(tagOrId)

Return all items below TAGORID.

find_closest(x, y[, halo, start])

Return item which is closest to pixel at X, Y.

find_enclosed(x1, y1, x2, y2)

Return all items in rectangle defined by X1,Y1,X2,Y2.

find_overlapping(x1, y1, x2, y2)

Return all items which overlap the rectangle defined by X1,Y1,X2,Y2.

find_withtag(tagOrId)

Return all items with TAGORID.

flattenIndex()

Flatten multiindex

focus(*args)

Set focus to the first item specified in ARGS.

focus_displayof()

Return the widget which has currently the focus on the display where this widget is located.

focus_force()

Direct input focus to this widget even if the application does not have the focus.

focus_get()

Return the widget which has currently the focus in the application.

focus_lastfor()

Return the widget which would have the focus if top level for this widget gets the focus from the window manager.

focus_set()

Direct input focus to this widget.

forget()

Unmap this widget and do not use it for the packing order.

functionsBar([evt])

Apply python functions from a pre-defined set, this is for stuff that can't be done with eval strings

getCanvasPos(row, col)

Get the cell x-y coords as a fraction of canvas size

getCellCoords(row, col)

Get x-y coordinates to drawing a cell in a given row/col

getColPosition(x)

Get column position at coord

getFonts()

getGeometry(frame)

Get frame geometry

getPlotData()

Plot data from selection

getRowPosition(y)

Set row position

getRowsFromIndex([idx])

Get row positions from index values

getRowsFromMask(mask)

getScale()

getSelectedColumn()

Get currently selected column

getSelectedDataFrame()

Return a sub-dataframe of the selected cells

getSelectedRow()

Get currently selected row

getSelectedRows()

Return a sub-dataframe of the selected rows

getSelectionValues()

Get values for current multiple cell selection

getVisibleCols(x1, x2)

Get the visible column range

getVisibleRegion()

Get visible region of canvas

getVisibleRows(y1, y2)

Get the visible row range

get_col_clicked(event)

Get column where event on the canvas occurs

get_memory()

memory usage of current table

get_row_clicked(event)

Get row where event on canvas occurs

getboolean(s)

Return a boolean value for Tcl boolean values true and false given as parameter.

getdouble(s)

getint(s)

gettags(*args)

Return tags associated with the first item specified in ARGS.

getvar([name])

Return value of Tcl variable NAME.

gotonextCell()

Move highlighted cell to next cell in row or a new col

gotonextRow()

Programmatically set next row - eg.

gotoprevRow()

Programmatically set previous row - eg.

grab_current()

Return widget which has currently the grab in this application or None.

grab_release()

Release grab for this widget if currently set.

grab_set()

Set grab for this widget.

grab_set_global()

Set global grab for this widget.

grab_status()

Return None, "local" or "global" if this widget has no, a local or a global grab.

grid([cnf])

Position a widget in the parent widget in a grid. Use as options: column=number - use cell identified with given column (starting with 0) columnspan=number - this widget will span several columns in=master - use master to contain this widget in_=master - see 'in' option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction row=number - use cell identified with given row (starting with 0) rowspan=number - this widget will span several rows sticky=NSEW - if cell is larger on which sides will this widget stick to the cell boundary.

grid_anchor([anchor])

The anchor value controls how to place the grid within the master when no row/column has any weight.

grid_bbox([column, row, col2, row2])

Return a tuple of integer coordinates for the bounding box of this widget controlled by the geometry manager grid.

grid_columnconfigure(index[, cnf])

Configure column INDEX of a grid.

grid_configure([cnf])

Position a widget in the parent widget in a grid. Use as options: column=number - use cell identified with given column (starting with 0) columnspan=number - this widget will span several columns in=master - use master to contain this widget in_=master - see 'in' option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction row=number - use cell identified with given row (starting with 0) rowspan=number - this widget will span several rows sticky=NSEW - if cell is larger on which sides will this widget stick to the cell boundary.

grid_forget()

Unmap this widget.

grid_info()

Return information about the options for positioning this widget in a grid.

grid_location(x, y)

Return a tuple of column and row which identify the cell at which the pixel at position X and Y inside the master widget is located.

grid_propagate([flag])

Set or get the status for propagation of geometry information.

grid_remove()

Unmap this widget but remember the grid options.

grid_rowconfigure(index[, cnf])

Configure row INDEX of a grid.

grid_size()

Return a tuple of the number of column and rows in the grid.

grid_slaves([row, column])

Return a list of all slaves of this widget in its packing order.

groupby(colindex)

Group by

handleCellEntry(row, col)

Callback for cell entry

handleEntryMenu(*args)

Callback for option menu in categorical columns entry

handle_arrow_keys(event)

Handle arrow keys press

handle_double_click(event)

Do double click stuff.

handle_left_click(event)

Respond to a single press

handle_left_ctrl_click(event)

Handle ctrl clicks for multiple row selections

handle_left_release(event)

Handle left mouse button release event

handle_left_shift_click(event)

Handle shift click, for selecting multiple rows

handle_mouse_drag(event)

Handle mouse moved with button held down, multiple selections

handle_right_click(event)

respond to a right click

hidePlot()

Hide plot frame

icursor(*args)

Set cursor at position POS in the item identified by TAGORID.

image_names()

Return a list of all existing image names.

image_types()

Return a list of all available image types (e.g.

importCSV([filename, dialog])

Import from csv file

index(*args)

Return position of cursor as integer in item specified in ARGS.

info()

Return information about the packing options for this widget.

insert(*args)

Insert TEXT in item TAGORID at position POS.

isInsideTable(x, y)

Returns true if x-y coord is inside table bounds

itemcget(tagOrId, option)

Return the resource value for an OPTION for item TAGORID.

itemconfig(tagOrId[, cnf])

Configure resources of an item TAGORID.

itemconfigure(tagOrId[, cnf])

Configure resources of an item TAGORID.

keys()

Return a list of all resource names of this widget.

lift(*args)

Raise an item TAGORID given in ARGS (optional above another item).

load([filename])

load from a file

loadExcel([filename])

Load excel file

loadPrefs([prefs])

Load preferences from defaults

location(x, y)

Return a tuple of column and row which identify the cell at which the pixel at position X and Y inside the master widget is located.

lower(*args)

Lower an item TAGORID given in ARGS (optional below another item).

mainloop([n])

Call the mainloop of Tk.

melt()

Melt table

merge(table)

Merge with another table.

mouse_wheel(event)

Handle mouse wheel scroll for windows

move(*args)

Move an item TAGORID given in ARGS.

moveColumns([names, pos])

Move column(s) to start/end, used for large tables

moveto(tagOrId[, x, y])

Move the items given by TAGORID in the canvas coordinate space so that the first coordinate pair of the bottommost item with tag TAGORID is located at position (X,Y).

movetoSelection([row, col, idx, offset])

Move to a specific row/col, updating table

nametowidget(name)

Return the Tkinter instance of a widget identified by its Tcl name NAME.

new()

Clears all the data and makes a new table

option_add(pattern, value[, priority])

Set a VALUE (second parameter) for an option PATTERN (first parameter).

option_clear()

Clear the option database.

option_get(name, className)

Return the value for an option NAME for this widget with CLASSNAME.

option_readfile(fileName[, priority])

Read file FILENAME into the option database.

pack([cnf])

Pack a widget in the parent widget. Use as options: after=widget - pack it after you have packed widget anchor=NSEW (or subset) - position widget according to given direction before=widget - pack it before you will pack widget expand=bool - expand widget if parent size grows fill=NONE or X or Y or BOTH - fill widget if widget grows in=master - use master to contain this widget in_=master - see 'in' option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.

pack_configure([cnf])

Pack a widget in the parent widget. Use as options: after=widget - pack it after you have packed widget anchor=NSEW (or subset) - position widget according to given direction before=widget - pack it before you will pack widget expand=bool - expand widget if parent size grows fill=NONE or X or Y or BOTH - fill widget if widget grows in=master - use master to contain this widget in_=master - see 'in' option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.

pack_forget()

Unmap this widget and do not use it for the packing order.

pack_info()

Return information about the packing options for this widget.

pack_propagate([flag])

Set or get the status for propagation of geometry information.

pack_slaves()

Return a list of all slaves of this widget in its packing order.

paste([event])

Paste selections - not implemented

pasteTable([event])

Paste a new table from the clipboard

pivot()

Pivot table

place([cnf])

Place a widget in the parent widget. Use as options: in=master - master relative to which the widget is placed in_=master - see 'in' option description x=amount - locate anchor of this widget at position x of master y=amount - locate anchor of this widget at position y of master relx=amount - locate anchor of this widget between 0.0 and 1.0 relative to width of master (1.0 is right edge) rely=amount - locate anchor of this widget between 0.0 and 1.0 relative to height of master (1.0 is bottom edge) anchor=NSEW (or subset) - position anchor according to given direction width=amount - width of this widget in pixel height=amount - height of this widget in pixel relwidth=amount - width of this widget between 0.0 and 1.0 relative to width of master (1.0 is the same width as the master) relheight=amount - height of this widget between 0.0 and 1.0 relative to height of master (1.0 is the same height as the master) bordermode="inside" or "outside" - whether to take border width of master widget into account.

placeColumn(col1, col2)

Move col1 next to col2, useful for placing a new column made from the first one next to it so user can see it easily

place_configure([cnf])

Place a widget in the parent widget. Use as options: in=master - master relative to which the widget is placed in_=master - see 'in' option description x=amount - locate anchor of this widget at position x of master y=amount - locate anchor of this widget at position y of master relx=amount - locate anchor of this widget between 0.0 and 1.0 relative to width of master (1.0 is right edge) rely=amount - locate anchor of this widget between 0.0 and 1.0 relative to height of master (1.0 is bottom edge) anchor=NSEW (or subset) - position anchor according to given direction width=amount - width of this widget in pixel height=amount - height of this widget in pixel relwidth=amount - width of this widget between 0.0 and 1.0 relative to width of master (1.0 is the same width as the master) relheight=amount - height of this widget between 0.0 and 1.0 relative to height of master (1.0 is the same height as the master) bordermode="inside" or "outside" - whether to take border width of master widget into account.

place_forget()

Unmap this widget.

place_info()

Return information about the placing options for this widget.

place_slaves()

Return a list of all slaves of this widget in its packing order.

plot3D()

plotSelected()

Plot the selected data in the associated plotviewer

popupMenu(event[, rows, cols, outside])

Add right click behaviour for table

postscript([cnf])

Print the contents of the canvas to a postscript file.

propagate([flag])

Set or get the status for propagation of geometry information.

query([evt])

Do query

queryBar([evt])

Query/filtering dialog

quit()

Quit the Tcl interpreter.

recalculateFunctions([omit])

Re evaluate any columns that were derived from functions and dependent on other columns (except self derived?)

redraw([event, callback])

Redraw table

redrawCell([row, col, recname, colname])

Redraw a specific cell only

redrawVisible([event, callback])

Redraw the visible portion of the canvas.

register(func[, subst, needcleanup])

Return a newly created Tcl function.

remove()

Close table frame

renameIndex()

Rename the row index

resample()

Table time series resampling dialog.

resetColors()

resetIndex([ask])

Reset index and redraw row header

resizeColumn(col, width)

Resize a column by dragging

resized(event)

Check if size changed when event triggered to avoid unnecessary redraws

rowconfigure(index[, cnf])

Configure row INDEX of a grid.

save()

Save current file

saveAs([filename])

Save dataframe to file

scale(*args)

Scale item TAGORID with XORIGIN, YORIGIN, XSCALE, YSCALE.

scan_dragto(x, y[, gain])

Adjust the view of the canvas to GAIN times the difference between X and Y and the coordinates given in scan_mark.

scan_mark(x, y)

Remember the current X, Y coordinates.

selectAll([evt])

Select all rows and cells

selectNone()

Deselect current, called when table is redrawn with completely new cols and rows e.g.

select_adjust(tagOrId, index)

Adjust the end of the selection near the cursor of an item TAGORID to index.

select_clear()

Clear the selection if it is in this widget.

select_from(tagOrId, index)

Set the fixed end of a selection in item TAGORID to INDEX.

select_item()

Return the item which has the selection.

select_to(tagOrId, index)

Set the variable end of a selection in item TAGORID to INDEX.

selection_clear(**kw)

Clear the current X selection.

selection_get(**kw)

Return the contents of the current X selection.

selection_handle(command, **kw)

Specify a function COMMAND to call if the X selection owned by this widget is queried by another application.

selection_own(**kw)

Become owner of X selection.

selection_own_get(**kw)

Return owner of X selection.

send(interp, cmd, *args)

Send Tcl command CMD to different interpreter INTERP to be executed.

setAlignment([colnames])

Set column alignments, overrides global value

setColPositions()

Determine current column grid positions

setColorByMask(col, mask, clr)

Color individual cells in a column using a mask.

setColorbyValue()

Set row colors in a column by values

setColumnColors([cols, clr])

Set a column color and store it

setColumnType()

Change the column dtype

setFont()

Set font tuple

setRowColors([rows, clr, cols])

Set rows color from menu.

setRowHeight(h)

Set the row height

setSelectedCells(startrow, endrow, startcol, ...)

Set a block of cells selected

setSelectedCol(col)

Set currently selected column

setSelectedRow(row)

Set currently selected row and reset multiple row list

setTheme([name])

Set theme

setWrap()

Toogle column header wrap

set_defaults()

Set default settings

set_rowcolors_index()

set_xviews(*args)

Set the xview of table and col header

set_yviews(*args)

Set the xview of table and row header

setcellbackgr()

setgrid_color()

setindex()

Set indexes

setrowselectedcolor()

Set selected row color

setvar([name, value])

Set Tcl variable NAME to VALUE.

show([callback])

Show the table

showAll()

Re-show unfiltered

showIndex()

Show the row index

showInfo()

Show dataframe info

showPlot()

showPlotViewer([parent, layout])

Create plot frame

showPreferences()

Preferences dialog

show_progress_window([message])

Show progress bar window for loading of data

showasText()

Get table as formatted text - for printing

size()

Return a tuple of the number of column and rows in the grid.

slaves()

Return a list of all slaves of this widget in its packing order.

sortColumnIndex()

Sort the column header by the current rows values

sortTable([columnIndex, ascending, index])

Sort rows based on currently selected columns

statsViewer()

Show model fitting dialog

storeCurrent()

Store current version of the table before a major change is made

tableChanged()

Callback to be used when dataframe changes so that other widgets and data can be updated

tableFromSelection()

Create a new table from the selected cells

tag_bind(tagOrId[, sequence, func, add])

Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.

tag_lower(*args)

Lower an item TAGORID given in ARGS (optional below another item).

tag_raise(*args)

Raise an item TAGORID given in ARGS (optional above another item).

tag_unbind(tagOrId, sequence[, funcid])

Unbind for all items with TAGORID for event SEQUENCE the function identified with FUNCID.

tk_bisque()

Change the color scheme to light brown as used in Tk 3.6 and before.

tk_focusFollowsMouse()

The widget under mouse will get automatically focus.

tk_focusNext()

Return the next widget in the focus order which follows widget which has currently the focus.

tk_focusPrev()

Return previous widget in the focus order.

tk_setPalette(*args, **kw)

Set a new color scheme for all widget elements.

tk_strictMotif([boolean])

Set Tcl internal variable, whether the look and feel should adhere to Motif.

tkraise(*args)

Raise an item TAGORID given in ARGS (optional above another item).

transform()

Apply element-wise transform

transpose()

Transpose table

type(tagOrId)

Return the type of the item TAGORID.

unbind(sequence[, funcid])

Unbind for this widget for event SEQUENCE the function identified with FUNCID.

unbind_all(sequence)

Unbind for all widgets for event SEQUENCE all functions.

unbind_class(className, sequence)

Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE all functions.

undo()

Undo last major table change

update()

Enter event loop until all pending events have been processed by Tcl.

updateFunctions()

Remove functions if a column has been deleted

updateModel([model])

Should call this method when a new table model is loaded.

updateWidgets()

Update some dialogs when table changed

update_idletasks()

Enter event loop until all idle callbacks have been called.

update_rowcolors()

Update row colors if present so that it syncs with current dataframe.

valueCounts()

Value counts for column(s)

values_to_colors(x[, cmap, alpha])

Convert columnn values to colors

wait_variable([name])

Wait until the variable is modified.

wait_visibility([window])

Wait until the visibility of a WIDGET changes (e.g.

wait_window([window])

Wait until a WIDGET is destroyed.

waitvar([name])

Wait until the variable is modified.

winfo_atom(name[, displayof])

Return integer which represents atom NAME.

winfo_atomname(id[, displayof])

Return name of atom with identifier ID.

winfo_cells()

Return number of cells in the colormap for this widget.

winfo_children()

Return a list of all widgets which are children of this widget.

winfo_class()

Return window class name of this widget.

winfo_colormapfull()

Return True if at the last color request the colormap was full.

winfo_containing(rootX, rootY[, displayof])

Return the widget which is at the root coordinates ROOTX, ROOTY.

winfo_depth()

Return the number of bits per pixel.

winfo_exists()

Return true if this widget exists.

winfo_fpixels(number)

Return the number of pixels for the given distance NUMBER (e.g.

winfo_geometry()

Return geometry string for this widget in the form "widthxheight+X+Y".

winfo_height()

Return height of this widget.

winfo_id()

Return identifier ID for this widget.

winfo_interps([displayof])

Return the name of all Tcl interpreters for this display.

winfo_ismapped()

Return true if this widget is mapped.

winfo_manager()

Return the window manager name for this widget.

winfo_name()

Return the name of this widget.

winfo_parent()

Return the name of the parent of this widget.

winfo_pathname(id[, displayof])

Return the pathname of the widget given by ID.

winfo_pixels(number)

Rounded integer value of winfo_fpixels.

winfo_pointerx()

Return the x coordinate of the pointer on the root window.

winfo_pointerxy()

Return a tuple of x and y coordinates of the pointer on the root window.

winfo_pointery()

Return the y coordinate of the pointer on the root window.

winfo_reqheight()

Return requested height of this widget.

winfo_reqwidth()

Return requested width of this widget.

winfo_rgb(color)

Return a tuple of integer RGB values in range(65536) for color in this widget.

winfo_rootx()

Return x coordinate of upper left corner of this widget on the root window.

winfo_rooty()

Return y coordinate of upper left corner of this widget on the root window.

winfo_screen()

Return the screen name of this widget.

winfo_screencells()

Return the number of the cells in the colormap of the screen of this widget.

winfo_screendepth()

Return the number of bits per pixel of the root window of the screen of this widget.

winfo_screenheight()

Return the number of pixels of the height of the screen of this widget in pixel.

winfo_screenmmheight()

Return the number of pixels of the height of the screen of this widget in mm.

winfo_screenmmwidth()

Return the number of pixels of the width of the screen of this widget in mm.

winfo_screenvisual()

Return one of the strings directcolor, grayscale, pseudocolor, staticcolor, staticgray, or truecolor for the default colormodel of this screen.

winfo_screenwidth()

Return the number of pixels of the width of the screen of this widget in pixel.

winfo_server()

Return information of the X-Server of the screen of this widget in the form "XmajorRminor vendor vendorVersion".

winfo_toplevel()

Return the toplevel widget of this widget.

winfo_viewable()

Return true if the widget and all its higher ancestors are mapped.

winfo_visual()

Return one of the strings directcolor, grayscale, pseudocolor, staticcolor, staticgray, or truecolor for the colormodel of this widget.

winfo_visualid()

Return the X identifier for the visual for this widget.

winfo_visualsavailable([includeids])

Return a list of all visuals available for the screen of this widget.

winfo_vrootheight()

Return the height of the virtual root window associated with this widget in pixels.

winfo_vrootwidth()

Return the width of the virtual root window associated with this widget in pixel.

winfo_vrootx()

Return the x offset of the virtual root relative to the root window of the screen of this widget.

winfo_vrooty()

Return the y offset of the virtual root relative to the root window of the screen of this widget.

winfo_width()

Return the width of this widget.

winfo_x()

Return the x coordinate of the upper left corner of this widget in the parent.

winfo_y()

Return the y coordinate of the upper left corner of this widget in the parent.

xview(*args)

Query and change the horizontal position of the view.

xview_moveto(fraction)

Adjusts the view in the window so that FRACTION of the total width of the canvas is off-screen to the left.

xview_scroll(number, what)

Shift the x-view according to NUMBER which is measured in "units" or "pages" (WHAT).

yview(*args)

Query and change the vertical position of the view.

yview_moveto(fraction)

Adjusts the view in the window so that FRACTION of the total height of the canvas is off-screen to the top.

yview_scroll(number, what)

Shift the y-view according to NUMBER which is measured in "units" or "pages" (WHAT).

zoomIn()

Zoom in, increases font and row heights.

zoomOut()

Zoom out, decreases font and row heights.

addColumn(newname=None)

Add a new column

addRow()

Insert a new row

addRows(num=None)

Add new rows

addtag(*args)

Internal function.

addtag_above(newtag, tagOrId)

Add tag NEWTAG to all items above TAGORID.

addtag_all(newtag)

Add tag NEWTAG to all items.

addtag_below(newtag, tagOrId)

Add tag NEWTAG to all items below TAGORID.

addtag_closest(newtag, x, y, halo=None, start=None)

Add tag NEWTAG to item which is closest to pixel at X, Y. If several match take the top-most. All items closer than HALO are considered overlapping (all are closest). If START is specified the next below this tag is taken.

addtag_enclosed(newtag, x1, y1, x2, y2)

Add tag NEWTAG to all items in the rectangle defined by X1,Y1,X2,Y2.

addtag_overlapping(newtag, x1, y1, x2, y2)

Add tag NEWTAG to all items which overlap the rectangle defined by X1,Y1,X2,Y2.

addtag_withtag(newtag, tagOrId)

Add tag NEWTAG to all items with TAGORID.

adjustColumnWidths(limit=30)

Optimally adjust col widths to accomodate the longest entry in each column - usually only called on first redraw. :param limit: max number of columns to resize

after(ms, func=None, *args)

Call function once after given time.

MS specifies the time in milliseconds. FUNC gives the function which shall be called. Additional parameters are given as parameters to the function call. Return identifier to cancel scheduling with after_cancel.

after_cancel(id)

Cancel scheduling of function identified with ID.

Identifier returned by after or after_idle must be given as first parameter.

after_idle(func, *args)

Call FUNC once if the Tcl main loop has no event to process.

Return an identifier to cancel the scheduling with after_cancel.

aggregate()

Show aggregate dialog

anchor(anchor=None)

The anchor value controls how to place the grid within the master when no row/column has any weight.

The default anchor is nw.

applyColumnFunction(evt=None)

Apply column wise functions, applies a calculation per row and ceates a new column.

applyStringMethod()

Apply string operation to column(s)

applyTransformFunction(evt=None)

Apply resampling and transform functions on a single column.

autoAddColumns(numcols=None)

Automatically add x number of cols

autoResizeColumns()

Automatically set nice column widths and draw

bbox(*args)

Return a tuple of X1,Y1,X2,Y2 coordinates for a rectangle which encloses all items with tags specified as arguments.

bell(displayof=0)

Ring a display’s bell.

bind(sequence=None, func=None, add=None)

Bind to this widget at event SEQUENCE a call to function FUNC.

SEQUENCE is a string of concatenated event patterns. An event pattern is of the form <MODIFIER-MODIFIER-TYPE-DETAIL> where MODIFIER is one of Control, Mod2, M2, Shift, Mod3, M3, Lock, Mod4, M4, Button1, B1, Mod5, M5 Button2, B2, Meta, M, Button3, B3, Alt, Button4, B4, Double, Button5, B5 Triple, Mod1, M1. TYPE is one of Activate, Enter, Map, ButtonPress, Button, Expose, Motion, ButtonRelease FocusIn, MouseWheel, Circulate, FocusOut, Property, Colormap, Gravity Reparent, Configure, KeyPress, Key, Unmap, Deactivate, KeyRelease Visibility, Destroy, Leave and DETAIL is the button number for ButtonPress, ButtonRelease and DETAIL is the Keysym for KeyPress and KeyRelease. Examples are <Control-Button-1> for pressing Control and mouse button 1 or <Alt-A> for pressing A and the Alt key (KeyPress can be omitted). An event pattern can also be a virtual event of the form <<AString>> where AString can be arbitrary. This event can be generated by event_generate. If events are concatenated they must appear shortly after each other.

FUNC will be called if the event sequence occurs with an instance of Event as argument. If the return value of FUNC is “break” no further bound function is invoked.

An additional boolean parameter ADD specifies whether FUNC will be called additionally to the other bound function or whether it will replace the previous function.

Bind will return an identifier to allow deletion of the bound function with unbind without memory leak.

If FUNC or SEQUENCE is omitted the bound function or list of bound events are returned.

bind_all(sequence=None, func=None, add=None)

Bind to all widgets at an event SEQUENCE a call to function FUNC. An additional boolean parameter ADD specifies whether FUNC will be called additionally to the other bound function or whether it will replace the previous function. See bind for the return value.

bind_class(className, sequence=None, func=None, add=None)

Bind to widgets with bindtag CLASSNAME at event SEQUENCE a call of function FUNC. An additional boolean parameter ADD specifies whether FUNC will be called additionally to the other bound function or whether it will replace the previous function. See bind for the return value.

bindtags(tagList=None)

Set or get the list of bindtags for this widget.

With no argument return the list of all bindtags associated with this widget. With a list of strings as argument the bindtags are set to this list. The bindtags determine in which order events are processed (see bind).

canvasx(screenx, gridspacing=None)

Return the canvas x coordinate of pixel position SCREENX rounded to nearest multiple of GRIDSPACING units.

canvasy(screeny, gridspacing=None)

Return the canvas y coordinate of pixel position SCREENY rounded to nearest multiple of GRIDSPACING units.

cget(key)

Return the resource value for a KEY given as string.

checkDataEntry(event=None)

do validation checks on data entry in a widget

cleanData()

Deal with missing data

clearData(evt=None)

Delete cells from gui event

clearSelected()

Clear selections

clearTable()

Make an empty table

clipboard_append(string, **kw)

Append STRING to the Tk clipboard.

A widget specified at the optional displayof keyword argument specifies the target display. The clipboard can be retrieved with selection_get.

clipboard_clear(**kw)

Clear the data in the Tk clipboard.

A widget specified for the optional displayof keyword argument specifies the target display.

clipboard_get(**kw)

Retrieve data from the clipboard on window’s display.

The window keyword defaults to the root window of the Tkinter application.

The type keyword specifies the form in which the data is to be returned and should be an atom name such as STRING or FILE_NAME. Type defaults to STRING, except on X11, where the default is to try UTF8_STRING and fall back to STRING.

This command is equivalent to:

selection_get(CLIPBOARD)

closeChildTable()

Close the child table

colorColumns(cols=None, color='gray')

Color visible columns

colorRows()

Color individual cells in column(s). Requires that the rowcolors dataframe has been set. This needs to be updated if the index is reset

columnconfigure(index, cnf={}, **kw)

Configure column INDEX of a grid.

Valid resources are minsize (minimum size of the column), weight (how much does additional space propagate to this column) and pad (how much space to let additionally).

config(cnf=None, **kw)

Configure resources of a widget.

The values for resources are specified as keyword arguments. To get an overview about the allowed keyword arguments call the method keys.

configure(cnf=None, **kw)

Configure resources of a widget.

The values for resources are specified as keyword arguments. To get an overview about the allowed keyword arguments call the method keys.

contractColumns(factor=10)

Reduce column widths

convertColumnNames(s='_')

Convert col names so we can use numexpr

convertDates()

Convert single or multiple columns into datetime

convertNumeric()

Convert cols to numeric if possible

coords(*args)

Return a list of coordinates for the item given in ARGS.

copy(rows, cols=None)

Copy cell contents to clipboard

copyColumn()

Copy a column

copyIndex()

Copy index to a column

copyTable(event=None)

Copy from the clipboard

corrMatrix()

Correlation matrix

createCategorical()

Get a categorical column from selected

createChildTable(df, title=None, index=False, out=False)

Add the child table

create_arc(*args, **kw)

Create arc shaped region with coordinates x1,y1,x2,y2.

create_bitmap(*args, **kw)

Create bitmap with coordinates x1,y1.

create_image(*args, **kw)

Create image item with coordinates x1,y1.

create_line(*args, **kw)

Create line with coordinates x1,y1,…,xn,yn.

create_oval(*args, **kw)

Create oval with coordinates x1,y1,x2,y2.

create_polygon(*args, **kw)

Create polygon with coordinates x1,y1,…,xn,yn.

create_rectangle(*args, **kw)

Create rectangle with coordinates x1,y1,x2,y2.

create_text(*args, **kw)

Create text with coordinates x1,y1.

create_window(*args, **kw)

Create window with coordinates x1,y1,x2,y2.

crosstab()

Cross tabulation

dchars(*args)

Delete characters of text items identified by tag or id in ARGS (possibly several times) from FIRST to LAST character (including).

delete(*args)

Delete items identified by all tag or ids contained in ARGS.

deleteCells(rows, cols, answer=None)

Clear the cell contents

deleteColumn()

Delete currently selected column(s)

deleteRow()

Delete a row

deletecommand(name)

Internal function.

Delete the Tcl command provided in NAME.

describe()

Create table summary

destroy()

Destroy this and all descendants widgets.

doBindings()

Bind keys and mouse clicks, this can be overriden

doCombine()

Do combine/merge operation

doExport(filename=None)

Do a simple export of the cell contents to csv

drawCellEntry(row, col, text=None)

When the user single/double clicks on a text/number cell, bring up entry window and allow edits.

drawGrid(startrow, endrow)

Draw the table grid lines

drawHighlighted()

Color an arbitrary selection of cells. Set the ‘highlighted’ attribute which is a masked dataframe of the table.

drawMultipleCells()

Draw an outline box for multiple cell selection

drawMultipleCols()

Draw multiple column selections

drawMultipleRows(rowlist)

Draw more than one row selection

drawRect(row, col, color=None, tag=None, delete=1)

Cell is colored

drawRowHeader()

User has clicked to select a cell

drawSelectedCol(col=None, delete=1, color=None, tag='colrect')

Draw a highlight rect for the current column selection

drawSelectedRect(row, col, color=None, fillcolor=None)

User has clicked to select a cell

drawSelectedRow()

Draw a highlight rect for the currently selected rows

drawText(row, col, celltxt, align=None)

Draw the text inside a cell area

dtag(*args)

Delete tag or id given as last arguments in ARGS from items identified by first argument in ARGS.

duplicateRows()

Make copy of rows

evalBar(evt=None)

Use pd.eval to apply a function colwise or preset funcs.

evalFunction(evt=None)

Apply a function to create new columns

event_add(virtual, *sequences)

Bind a virtual event VIRTUAL (of the form <<Name>>) to an event SEQUENCE such that the virtual event is triggered whenever SEQUENCE occurs.

event_delete(virtual, *sequences)

Unbind a virtual event VIRTUAL from SEQUENCE.

event_generate(sequence, **kw)

Generate an event SEQUENCE. Additional keyword arguments specify parameter of the event (e.g. x, y, rootx, rooty).

event_info(virtual=None)

Return a list of all virtual events or the information about the SEQUENCE bound to the virtual event VIRTUAL.

expandColumns(factor=10)

Reduce column widths

fillAcross(collist, rowlist)

Fill across a row, or multiple rows

fillColumn()

Fill a column with a data range

fillDown(rowlist, collist)

Fill down a column, or multiple columns

find(*args)

Internal function.

findDuplicates()

Find duplicate rows

findText(evt=None)

Simple text search in whole table

find_above(tagOrId)

Return items above TAGORID.

find_all()

Return all items.

find_below(tagOrId)

Return all items below TAGORID.

find_closest(x, y, halo=None, start=None)

Return item which is closest to pixel at X, Y. If several match take the top-most. All items closer than HALO are considered overlapping (all are closest). If START is specified the next below this tag is taken.

find_enclosed(x1, y1, x2, y2)

Return all items in rectangle defined by X1,Y1,X2,Y2.

find_overlapping(x1, y1, x2, y2)

Return all items which overlap the rectangle defined by X1,Y1,X2,Y2.

find_withtag(tagOrId)

Return all items with TAGORID.

flattenIndex()

Flatten multiindex

focus(*args)

Set focus to the first item specified in ARGS.

focus_displayof()

Return the widget which has currently the focus on the display where this widget is located.

Return None if the application does not have the focus.

focus_force()

Direct input focus to this widget even if the application does not have the focus. Use with caution!

focus_get()

Return the widget which has currently the focus in the application.

Use focus_displayof to allow working with several displays. Return None if application does not have the focus.

focus_lastfor()

Return the widget which would have the focus if top level for this widget gets the focus from the window manager.

focus_set()

Direct input focus to this widget.

If the application currently does not have the focus this widget will get the focus if the application gets the focus through the window manager.

forget()

Unmap this widget and do not use it for the packing order.

functionsBar(evt=None)

Apply python functions from a pre-defined set, this is for stuff that can’t be done with eval strings

getCanvasPos(row, col)

Get the cell x-y coords as a fraction of canvas size

getCellCoords(row, col)

Get x-y coordinates to drawing a cell in a given row/col

getColPosition(x)

Get column position at coord

getGeometry(frame)

Get frame geometry

getPlotData()

Plot data from selection

getRowPosition(y)

Set row position

getRowsFromIndex(idx=None)

Get row positions from index values

getSelectedColumn()

Get currently selected column

getSelectedDataFrame()

Return a sub-dataframe of the selected cells

getSelectedRow()

Get currently selected row

getSelectedRows()

Return a sub-dataframe of the selected rows

getSelectionValues()

Get values for current multiple cell selection

getVisibleCols(x1, x2)

Get the visible column range

getVisibleRegion()

Get visible region of canvas

getVisibleRows(y1, y2)

Get the visible row range

get_col_clicked(event)

Get column where event on the canvas occurs

get_memory()

memory usage of current table

get_row_clicked(event)

Get row where event on canvas occurs

getboolean(s)

Return a boolean value for Tcl boolean values true and false given as parameter.

gettags(*args)

Return tags associated with the first item specified in ARGS.

getvar(name='PY_VAR')

Return value of Tcl variable NAME.

gotonextCell()

Move highlighted cell to next cell in row or a new col

gotonextRow()

Programmatically set next row - eg. for button events

gotoprevRow()

Programmatically set previous row - eg. for button events

grab_current()

Return widget which has currently the grab in this application or None.

grab_release()

Release grab for this widget if currently set.

grab_set()

Set grab for this widget.

A grab directs all events to this and descendant widgets in the application.

grab_set_global()

Set global grab for this widget.

A global grab directs all events to this and descendant widgets on the display. Use with caution - other applications do not get events anymore.

grab_status()

Return None, “local” or “global” if this widget has no, a local or a global grab.

grid(cnf={}, **kw)

Position a widget in the parent widget in a grid. Use as options: column=number - use cell identified with given column (starting with 0) columnspan=number - this widget will span several columns in=master - use master to contain this widget in_=master - see ‘in’ option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction row=number - use cell identified with given row (starting with 0) rowspan=number - this widget will span several rows sticky=NSEW - if cell is larger on which sides will this

widget stick to the cell boundary

grid_anchor(anchor=None)

The anchor value controls how to place the grid within the master when no row/column has any weight.

The default anchor is nw.

grid_bbox(column=None, row=None, col2=None, row2=None)

Return a tuple of integer coordinates for the bounding box of this widget controlled by the geometry manager grid.

If COLUMN, ROW is given the bounding box applies from the cell with row and column 0 to the specified cell. If COL2 and ROW2 are given the bounding box starts at that cell.

The returned integers specify the offset of the upper left corner in the master widget and the width and height.

grid_columnconfigure(index, cnf={}, **kw)

Configure column INDEX of a grid.

Valid resources are minsize (minimum size of the column), weight (how much does additional space propagate to this column) and pad (how much space to let additionally).

grid_configure(cnf={}, **kw)

Position a widget in the parent widget in a grid. Use as options: column=number - use cell identified with given column (starting with 0) columnspan=number - this widget will span several columns in=master - use master to contain this widget in_=master - see ‘in’ option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction row=number - use cell identified with given row (starting with 0) rowspan=number - this widget will span several rows sticky=NSEW - if cell is larger on which sides will this

widget stick to the cell boundary

grid_forget()

Unmap this widget.

grid_info()

Return information about the options for positioning this widget in a grid.

grid_location(x, y)

Return a tuple of column and row which identify the cell at which the pixel at position X and Y inside the master widget is located.

grid_propagate(flag=['_noarg_'])

Set or get the status for propagation of geometry information.

A boolean argument specifies whether the geometry information of the slaves will determine the size of this widget. If no argument is given, the current setting will be returned.

grid_remove()

Unmap this widget but remember the grid options.

grid_rowconfigure(index, cnf={}, **kw)

Configure row INDEX of a grid.

Valid resources are minsize (minimum size of the row), weight (how much does additional space propagate to this row) and pad (how much space to let additionally).

grid_size()

Return a tuple of the number of column and rows in the grid.

grid_slaves(row=None, column=None)

Return a list of all slaves of this widget in its packing order.

groupby(colindex)

Group by

handleCellEntry(row, col)

Callback for cell entry

handleEntryMenu(*args)

Callback for option menu in categorical columns entry

handle_arrow_keys(event)

Handle arrow keys press

handle_double_click(event)

Do double click stuff. Selected row/cols will already have been set with single click binding

handle_left_click(event)

Respond to a single press

handle_left_ctrl_click(event)

Handle ctrl clicks for multiple row selections

handle_left_release(event)

Handle left mouse button release event

handle_left_shift_click(event)

Handle shift click, for selecting multiple rows

handle_mouse_drag(event)

Handle mouse moved with button held down, multiple selections

handle_right_click(event)

respond to a right click

hidePlot()

Hide plot frame

icursor(*args)

Set cursor at position POS in the item identified by TAGORID. In ARGS TAGORID must be first.

image_names()

Return a list of all existing image names.

image_types()

Return a list of all available image types (e.g. photo bitmap).

importCSV(filename=None, dialog=False, **kwargs)

Import from csv file

index(*args)

Return position of cursor as integer in item specified in ARGS.

info()

Return information about the packing options for this widget.

insert(*args)

Insert TEXT in item TAGORID at position POS. ARGS must be TAGORID POS TEXT.

isInsideTable(x, y)

Returns true if x-y coord is inside table bounds

itemcget(tagOrId, option)

Return the resource value for an OPTION for item TAGORID.

itemconfig(tagOrId, cnf=None, **kw)

Configure resources of an item TAGORID.

The values for resources are specified as keyword arguments. To get an overview about the allowed keyword arguments call the method without arguments.

itemconfigure(tagOrId, cnf=None, **kw)

Configure resources of an item TAGORID.

The values for resources are specified as keyword arguments. To get an overview about the allowed keyword arguments call the method without arguments.

keys()

Return a list of all resource names of this widget.

lift(*args)

Raise an item TAGORID given in ARGS (optional above another item).

load(filename=None)

load from a file

loadExcel(filename=None)

Load excel file

loadPrefs(prefs=None)

Load preferences from defaults

location(x, y)

Return a tuple of column and row which identify the cell at which the pixel at position X and Y inside the master widget is located.

lower(*args)

Lower an item TAGORID given in ARGS (optional below another item).

mainloop(n=0)

Call the mainloop of Tk.

melt()

Melt table

merge(table)

Merge with another table.

mouse_wheel(event)

Handle mouse wheel scroll for windows

move(*args)

Move an item TAGORID given in ARGS.

moveColumns(names=None, pos='start')

Move column(s) to start/end, used for large tables

moveto(tagOrId, x='', y='')

Move the items given by TAGORID in the canvas coordinate space so that the first coordinate pair of the bottommost item with tag TAGORID is located at position (X,Y). X and Y may be the empty string, in which case the corresponding coordinate will be unchanged. All items matching TAGORID remain in the same positions relative to each other.

movetoSelection(row=None, col=0, idx=None, offset=0)

Move to a specific row/col, updating table

nametowidget(name)

Return the Tkinter instance of a widget identified by its Tcl name NAME.

new()

Clears all the data and makes a new table

option_add(pattern, value, priority=None)

Set a VALUE (second parameter) for an option PATTERN (first parameter).

An optional third parameter gives the numeric priority (defaults to 80).

option_clear()

Clear the option database.

It will be reloaded if option_add is called.

option_get(name, className)

Return the value for an option NAME for this widget with CLASSNAME.

Values with higher priority override lower values.

option_readfile(fileName, priority=None)

Read file FILENAME into the option database.

An optional second parameter gives the numeric priority.

pack(cnf={}, **kw)

Pack a widget in the parent widget. Use as options: after=widget - pack it after you have packed widget anchor=NSEW (or subset) - position widget according to

given direction

before=widget - pack it before you will pack widget expand=bool - expand widget if parent size grows fill=NONE or X or Y or BOTH - fill widget if widget grows in=master - use master to contain this widget in_=master - see ‘in’ option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.

pack_configure(cnf={}, **kw)

Pack a widget in the parent widget. Use as options: after=widget - pack it after you have packed widget anchor=NSEW (or subset) - position widget according to

given direction

before=widget - pack it before you will pack widget expand=bool - expand widget if parent size grows fill=NONE or X or Y or BOTH - fill widget if widget grows in=master - use master to contain this widget in_=master - see ‘in’ option description ipadx=amount - add internal padding in x direction ipady=amount - add internal padding in y direction padx=amount - add padding in x direction pady=amount - add padding in y direction side=TOP or BOTTOM or LEFT or RIGHT - where to add this widget.

pack_forget()

Unmap this widget and do not use it for the packing order.

pack_info()

Return information about the packing options for this widget.

pack_propagate(flag=['_noarg_'])

Set or get the status for propagation of geometry information.

A boolean argument specifies whether the geometry information of the slaves will determine the size of this widget. If no argument is given the current setting will be returned.

pack_slaves()

Return a list of all slaves of this widget in its packing order.

paste(event=None)

Paste selections - not implemented

pasteTable(event=None)

Paste a new table from the clipboard

pivot()

Pivot table

place(cnf={}, **kw)

Place a widget in the parent widget. Use as options: in=master - master relative to which the widget is placed in_=master - see ‘in’ option description x=amount - locate anchor of this widget at position x of master y=amount - locate anchor of this widget at position y of master relx=amount - locate anchor of this widget between 0.0 and 1.0

relative to width of master (1.0 is right edge)

rely=amount - locate anchor of this widget between 0.0 and 1.0

relative to height of master (1.0 is bottom edge)

anchor=NSEW (or subset) - position anchor according to given direction width=amount - width of this widget in pixel height=amount - height of this widget in pixel relwidth=amount - width of this widget between 0.0 and 1.0

relative to width of master (1.0 is the same width as the master)

relheight=amount - height of this widget between 0.0 and 1.0

relative to height of master (1.0 is the same height as the master)

bordermode=”inside” or “outside” - whether to take border width of

master widget into account

placeColumn(col1, col2)

Move col1 next to col2, useful for placing a new column made from the first one next to it so user can see it easily

place_configure(cnf={}, **kw)

Place a widget in the parent widget. Use as options: in=master - master relative to which the widget is placed in_=master - see ‘in’ option description x=amount - locate anchor of this widget at position x of master y=amount - locate anchor of this widget at position y of master relx=amount - locate anchor of this widget between 0.0 and 1.0

relative to width of master (1.0 is right edge)

rely=amount - locate anchor of this widget between 0.0 and 1.0

relative to height of master (1.0 is bottom edge)

anchor=NSEW (or subset) - position anchor according to given direction width=amount - width of this widget in pixel height=amount - height of this widget in pixel relwidth=amount - width of this widget between 0.0 and 1.0

relative to width of master (1.0 is the same width as the master)

relheight=amount - height of this widget between 0.0 and 1.0

relative to height of master (1.0 is the same height as the master)

bordermode=”inside” or “outside” - whether to take border width of

master widget into account

place_forget()

Unmap this widget.

place_info()

Return information about the placing options for this widget.

place_slaves()

Return a list of all slaves of this widget in its packing order.

plotSelected()

Plot the selected data in the associated plotviewer

popupMenu(event, rows=None, cols=None, outside=None)

Add right click behaviour for table

Parameters:
  • event (tk.Event) – The event that triggers the popup menu.

  • rows (list) – The list of rows that are selected.

  • cols (list) – The list of columns that are selected.

  • outside (bool) – Whether the popup menu is triggered outside the table.

Returns:

popupmenu – The popup menu.

Return type:

tk.Menu

postscript(cnf={}, **kw)

Print the contents of the canvas to a postscript file. Valid options: colormap, colormode, file, fontmap, height, pageanchor, pageheight, pagewidth, pagex, pagey, rotate, width, x, y.

propagate(flag=['_noarg_'])

Set or get the status for propagation of geometry information.

A boolean argument specifies whether the geometry information of the slaves will determine the size of this widget. If no argument is given the current setting will be returned.

query(evt=None)

Do query

queryBar(evt=None)

Query/filtering dialog

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

recalculateFunctions(omit=None)

Re evaluate any columns that were derived from functions and dependent on other columns (except self derived?)

redraw(event=None, callback=None)

Redraw table

redrawCell(row=None, col=None, recname=None, colname=None)

Redraw a specific cell only

redrawVisible(event=None, callback=None)

Redraw the visible portion of the canvas. This is the core redraw method. Refreshes all table elements. Called by redraw() method as shorthand.

Parameters:
  • event – tkinter event to trigger method, default None

  • callback – function to be called after redraw, default None

register(func, subst=None, needcleanup=1)

Return a newly created Tcl function. If this function is called, the Python function FUNC will be executed. An optional function SUBST can be given which will be executed before FUNC.

remove()

Close table frame

renameIndex()

Rename the row index

resample()

Table time series resampling dialog. Should set a datetime index first.

resetIndex(ask=True)

Reset index and redraw row header

resizeColumn(col, width)

Resize a column by dragging

resized(event)

Check if size changed when event triggered to avoid unnecessary redraws

rowconfigure(index, cnf={}, **kw)

Configure row INDEX of a grid.

Valid resources are minsize (minimum size of the row), weight (how much does additional space propagate to this row) and pad (how much space to let additionally).

save()

Save current file

saveAs(filename=None)

Save dataframe to file

scale(*args)

Scale item TAGORID with XORIGIN, YORIGIN, XSCALE, YSCALE.

scan_dragto(x, y, gain=10)

Adjust the view of the canvas to GAIN times the difference between X and Y and the coordinates given in scan_mark.

scan_mark(x, y)

Remember the current X, Y coordinates.

selectAll(evt=None)

Select all rows and cells

selectNone()

Deselect current, called when table is redrawn with completely new cols and rows e.g. after model is updated.

select_adjust(tagOrId, index)

Adjust the end of the selection near the cursor of an item TAGORID to index.

select_clear()

Clear the selection if it is in this widget.

select_from(tagOrId, index)

Set the fixed end of a selection in item TAGORID to INDEX.

select_item()

Return the item which has the selection.

select_to(tagOrId, index)

Set the variable end of a selection in item TAGORID to INDEX.

selection_clear(**kw)

Clear the current X selection.

selection_get(**kw)

Return the contents of the current X selection.

A keyword parameter selection specifies the name of the selection and defaults to PRIMARY. A keyword parameter displayof specifies a widget on the display to use. A keyword parameter type specifies the form of data to be fetched, defaulting to STRING except on X11, where UTF8_STRING is tried before STRING.

selection_handle(command, **kw)

Specify a function COMMAND to call if the X selection owned by this widget is queried by another application.

This function must return the contents of the selection. The function will be called with the arguments OFFSET and LENGTH which allows the chunking of very long selections. The following keyword parameters can be provided: selection - name of the selection (default PRIMARY), type - type of the selection (e.g. STRING, FILE_NAME).

selection_own(**kw)

Become owner of X selection.

A keyword parameter selection specifies the name of the selection (default PRIMARY).

selection_own_get(**kw)

Return owner of X selection.

The following keyword parameter can be provided: selection - name of the selection (default PRIMARY), type - type of the selection (e.g. STRING, FILE_NAME).

send(interp, cmd, *args)

Send Tcl command CMD to different interpreter INTERP to be executed.

setAlignment(colnames=None)

Set column alignments, overrides global value

setColPositions()

Determine current column grid positions

setColorByMask(col, mask, clr)

Color individual cells in a column using a mask.

setColorbyValue()

Set row colors in a column by values

setColumnColors(cols=None, clr=None)

Set a column color and store it

setColumnType()

Change the column dtype

setFont()

Set font tuple

setRowColors(rows=None, clr=None, cols=None)

Set rows color from menu. :param rows: row numbers to be colored :param clr: color in hex :param cols: column numbers, can also use ‘all’

setRowHeight(h)

Set the row height

setSelectedCells(startrow, endrow, startcol, endcol)

Set a block of cells selected

setSelectedCol(col)

Set currently selected column

setSelectedRow(row)

Set currently selected row and reset multiple row list

setTheme(name='light')

Set theme

setWrap()

Toogle column header wrap

set_defaults()

Set default settings

set_xviews(*args)

Set the xview of table and col header

set_yviews(*args)

Set the xview of table and row header

setindex()

Set indexes

setrowselectedcolor()

Set selected row color

setvar(name='PY_VAR', value='1')

Set Tcl variable NAME to VALUE.

show(callback=None)

Show the table

Parameters:

callback (function) – The function that is called when the table is shown.

showAll()

Re-show unfiltered

showIndex()

Show the row index

showInfo()

Show dataframe info

showPlotViewer(parent=None, layout='horizontal')

Create plot frame

showPreferences()

Preferences dialog

show_progress_window(message=None)

Show progress bar window for loading of data

showasText()

Get table as formatted text - for printing

size()

Return a tuple of the number of column and rows in the grid.

slaves()

Return a list of all slaves of this widget in its packing order.

sortColumnIndex()

Sort the column header by the current rows values

sortTable(columnIndex=None, ascending=1, index=False)

Sort rows based on currently selected columns

statsViewer()

Show model fitting dialog

storeCurrent()

Store current version of the table before a major change is made

tableChanged()

Callback to be used when dataframe changes so that other widgets and data can be updated

tableFromSelection()

Create a new table from the selected cells

tag_bind(tagOrId, sequence=None, func=None, add=None)

Bind to all items with TAGORID at event SEQUENCE a call to function FUNC.

An additional boolean parameter ADD specifies whether FUNC will be called additionally to the other bound function or whether it will replace the previous function. See bind for the return value.

tag_lower(*args)

Lower an item TAGORID given in ARGS (optional below another item).

tag_raise(*args)

Raise an item TAGORID given in ARGS (optional above another item).

tag_unbind(tagOrId, sequence, funcid=None)

Unbind for all items with TAGORID for event SEQUENCE the function identified with FUNCID.

tk_bisque()

Change the color scheme to light brown as used in Tk 3.6 and before.

tk_focusFollowsMouse()

The widget under mouse will get automatically focus. Can not be disabled easily.

tk_focusNext()

Return the next widget in the focus order which follows widget which has currently the focus.

The focus order first goes to the next child, then to the children of the child recursively and then to the next sibling which is higher in the stacking order. A widget is omitted if it has the takefocus resource set to 0.

tk_focusPrev()

Return previous widget in the focus order. See tk_focusNext for details.

tk_setPalette(*args, **kw)

Set a new color scheme for all widget elements.

A single color as argument will cause that all colors of Tk widget elements are derived from this. Alternatively several keyword parameters and its associated colors can be given. The following keywords are valid: activeBackground, foreground, selectColor, activeForeground, highlightBackground, selectBackground, background, highlightColor, selectForeground, disabledForeground, insertBackground, troughColor.

tk_strictMotif(boolean=None)

Set Tcl internal variable, whether the look and feel should adhere to Motif.

A parameter of 1 means adhere to Motif (e.g. no color change if mouse passes over slider). Returns the set value.

tkraise(*args)

Raise an item TAGORID given in ARGS (optional above another item).

transform()

Apply element-wise transform

transpose()

Transpose table

type(tagOrId)

Return the type of the item TAGORID.

unbind(sequence, funcid=None)

Unbind for this widget for event SEQUENCE the function identified with FUNCID.

unbind_all(sequence)

Unbind for all widgets for event SEQUENCE all functions.

unbind_class(className, sequence)

Unbind for all widgets with bindtag CLASSNAME for event SEQUENCE all functions.

undo()

Undo last major table change

update()

Enter event loop until all pending events have been processed by Tcl.

updateFunctions()

Remove functions if a column has been deleted

updateModel(model=None)

Should call this method when a new table model is loaded. Recreates widgets and redraws the table.

updateWidgets()

Update some dialogs when table changed

update_idletasks()

Enter event loop until all idle callbacks have been called. This will update the display of windows but not process events caused by the user.

update_rowcolors()

Update row colors if present so that it syncs with current dataframe.

valueCounts()

Value counts for column(s)

values_to_colors(x, cmap='jet', alpha=1)

Convert columnn values to colors

wait_variable(name='PY_VAR')

Wait until the variable is modified.

A parameter of type IntVar, StringVar, DoubleVar or BooleanVar must be given.

wait_visibility(window=None)

Wait until the visibility of a WIDGET changes (e.g. it appears).

If no parameter is given self is used.

wait_window(window=None)

Wait until a WIDGET is destroyed.

If no parameter is given self is used.

waitvar(name='PY_VAR')

Wait until the variable is modified.

A parameter of type IntVar, StringVar, DoubleVar or BooleanVar must be given.

winfo_atom(name, displayof=0)

Return integer which represents atom NAME.

winfo_atomname(id, displayof=0)

Return name of atom with identifier ID.

winfo_cells()

Return number of cells in the colormap for this widget.

winfo_children()

Return a list of all widgets which are children of this widget.

winfo_class()

Return window class name of this widget.

winfo_colormapfull()

Return True if at the last color request the colormap was full.

winfo_containing(rootX, rootY, displayof=0)

Return the widget which is at the root coordinates ROOTX, ROOTY.

winfo_depth()

Return the number of bits per pixel.

winfo_exists()

Return true if this widget exists.

winfo_fpixels(number)

Return the number of pixels for the given distance NUMBER (e.g. “3c”) as float.

winfo_geometry()

Return geometry string for this widget in the form “widthxheight+X+Y”.

winfo_height()

Return height of this widget.

winfo_id()

Return identifier ID for this widget.

winfo_interps(displayof=0)

Return the name of all Tcl interpreters for this display.

winfo_ismapped()

Return true if this widget is mapped.

winfo_manager()

Return the window manager name for this widget.

winfo_name()

Return the name of this widget.

winfo_parent()

Return the name of the parent of this widget.

winfo_pathname(id, displayof=0)

Return the pathname of the widget given by ID.

winfo_pixels(number)

Rounded integer value of winfo_fpixels.

winfo_pointerx()

Return the x coordinate of the pointer on the root window.

winfo_pointerxy()

Return a tuple of x and y coordinates of the pointer on the root window.

winfo_pointery()

Return the y coordinate of the pointer on the root window.

winfo_reqheight()

Return requested height of this widget.

winfo_reqwidth()

Return requested width of this widget.

winfo_rgb(color)

Return a tuple of integer RGB values in range(65536) for color in this widget.

winfo_rootx()

Return x coordinate of upper left corner of this widget on the root window.

winfo_rooty()

Return y coordinate of upper left corner of this widget on the root window.

winfo_screen()

Return the screen name of this widget.

winfo_screencells()

Return the number of the cells in the colormap of the screen of this widget.

winfo_screendepth()

Return the number of bits per pixel of the root window of the screen of this widget.

winfo_screenheight()

Return the number of pixels of the height of the screen of this widget in pixel.

winfo_screenmmheight()

Return the number of pixels of the height of the screen of this widget in mm.

winfo_screenmmwidth()

Return the number of pixels of the width of the screen of this widget in mm.

winfo_screenvisual()

Return one of the strings directcolor, grayscale, pseudocolor, staticcolor, staticgray, or truecolor for the default colormodel of this screen.

winfo_screenwidth()

Return the number of pixels of the width of the screen of this widget in pixel.

winfo_server()

Return information of the X-Server of the screen of this widget in the form “XmajorRminor vendor vendorVersion”.

winfo_toplevel()

Return the toplevel widget of this widget.

winfo_viewable()

Return true if the widget and all its higher ancestors are mapped.

winfo_visual()

Return one of the strings directcolor, grayscale, pseudocolor, staticcolor, staticgray, or truecolor for the colormodel of this widget.

winfo_visualid()

Return the X identifier for the visual for this widget.

winfo_visualsavailable(includeids=False)

Return a list of all visuals available for the screen of this widget.

Each item in the list consists of a visual name (see winfo_visual), a depth and if includeids is true is given also the X identifier.

winfo_vrootheight()

Return the height of the virtual root window associated with this widget in pixels. If there is no virtual root window return the height of the screen.

winfo_vrootwidth()

Return the width of the virtual root window associated with this widget in pixel. If there is no virtual root window return the width of the screen.

winfo_vrootx()

Return the x offset of the virtual root relative to the root window of the screen of this widget.

winfo_vrooty()

Return the y offset of the virtual root relative to the root window of the screen of this widget.

winfo_width()

Return the width of this widget.

winfo_x()

Return the x coordinate of the upper left corner of this widget in the parent.

winfo_y()

Return the y coordinate of the upper left corner of this widget in the parent.

xview(*args)

Query and change the horizontal position of the view.

xview_moveto(fraction)

Adjusts the view in the window so that FRACTION of the total width of the canvas is off-screen to the left.

xview_scroll(number, what)

Shift the x-view according to NUMBER which is measured in “units” or “pages” (WHAT).

yview(*args)

Query and change the vertical position of the view.

yview_moveto(fraction)

Adjusts the view in the window so that FRACTION of the total height of the canvas is off-screen to the top.

yview_scroll(number, what)

Shift the y-view according to NUMBER which is measured in “units” or “pages” (WHAT).

zoomIn()

Zoom in, increases font and row heights.

zoomOut()

Zoom out, decreases font and row heights.


© Copyright 2025, Dean Lab, UT Southwestern Medical Center.