ncvue.ncvmap

Map panel of ncvue.

The panel allows plotting contour or mesh maps of georeferenced data. Maps can be animated along the time axis.

This module was written by Matthias Cuntz while at Institut National de Recherche pour l’Agriculture, l’Alimentation et l’Environnement (INRAE), Nancy, France.

copyright:

Copyright 2020-2021 Matthias Cuntz - mc (at) macu (dot) de

license:

MIT License, see LICENSE for details.

The following classes are provided:

ncvMap(master, **kwargs)

Panel for maps.

History

• Written Dec 2020-Jan 2021 by Matthias Cuntz (mc (at) macu (dot) de)

• Open new netcdf file, communicate via top widget, Jan 2021, Matthias Cuntz

• Write coordinates and value on bottom of plotting canvas, May 2021, Matthias Cuntz

• Larger pad for colorbar, Jun 2021, Matthias Cuntz

• Work with files without an unlimited (time) dimension (set_tstep), Oct 2021, Matthias Cuntz

• Address fi.variables[name] directly by fi[name], Jan 2024, Matthias Cuntz

• Allow groups in netcdf files, Jan 2024, Matthias Cuntz

• Allow multiple netcdf files, Jan 2024, Matthias Cuntz

• Move images/ directory from src/ncvue/ to src/ directory, Jan 2024, Matthias Cuntz

• Added borders, rivers, and lakes checkbuttons, Feb 2024, Matthias Cuntz

• Move themes/ and images/ back to src/ncvue/, Feb 2024, Matthias Cuntz

• Use matplotlib.colormaps[name] instead of matplotlib.colormaps.get_cmap(name), Jul 2024, Matthias Cuntz

• Use draw_idle instead of draw in update method for faster animation, Jul 2024, Matthias Cuntz

class ncvMap(master, **kwargs)

Bases: Frame

Panel for maps.

Sets up the layout with the figure canvas, variable selectors, dimension spinboxes, and options in __init__.

Contains various commands that manage what will be drawn or redrawn if something is selected, changed, checked, etc.

Methods

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.
anchor([anchor])	The anchor value controls how to place the grid within the master when no row/column has any weight.
bbox([column, row, col2, row2])	Return a tuple of integer coordinates for the bounding box of this widget controlled by the geometry manager grid.
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.
cget(key)	Return the resource value for a KEY given as string.
checked()	Command called if any checkbutton was checked or unchecked.
checked_all()	Command called if any checkbutton 'all' for vmin/vmax was checked or unchecked.
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.
columnconfigure(index[, cnf])	Configure column INDEX of a grid.
config([cnf])	Configure resources of a widget.
configure([cnf])	Configure resources of a widget.
delay_t(delay)	Command called if delay scale was changed.
deletecommand(name)	Internal function.
destroy()	Destroy this and all descendants widgets.
entered_clon(event)	Command called if values central longitude was entered.
entered_v(event)	Command called if values for vmin/vmax were entered.
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.
first_t()	Command called if first frame button was pressed.
focus()	Direct input focus to this widget.
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.
getboolean(s)	Return a boolean value for Tcl boolean values true and false given as parameter.
getvar([name])	Return value of Tcl variable NAME.
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.
identify(x, y)	Returns the name of the element at position x, y, or the empty string if the point does not lie within any element.
image_names()	Return a list of all existing image names.
image_types()	Return a list of all available image types (e.g. photo bitmap).
info()	Return information about the packing options for this widget.
info_patchlevel()	Returns the exact version of the Tcl library.
instate(statespec[, callback])	Test the widget's state.
keys()	Return a list of all resource names of this widget.
last_t()	Command called if last frame button was pressed.
lift([aboveThis])	Raise this widget in the stacking order.
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([belowThis])	Lower this widget in the stacking order.
mainloop([n])	Call the mainloop of Tk.
nametowidget(name)	Return the Tkinter instance of a widget identified by its Tcl name NAME.
newnetcdf()	Open a new netcdf file and connect it to top.
next_t()	Command called if next frame button was pressed.
next_v()	Command called if next button for the plotting variable was pressed.
nrun_t()	Command called if forward run button was pressed.
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.
pause_t()	Command called if pause button was pressed.
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.
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.
prev_t()	Command called if previous frame button was pressed.
prev_v()	Command called if previous button for the plotting variable was pressed.
propagate([flag])	Set or get the status for propagation of geometry information.
prun_t()	Command called if run backwards button was pressed.
quit()	Quit the Tcl interpreter.
redraw()	Redraws the plot.
register(func[, subst, needcleanup])	Return a newly created Tcl function.
reinit()	Reinitialise the panel from top.
repeat_t(event)	Command called if repeat option was chosen with combobox.
rowconfigure(index[, cnf])	Configure row INDEX of a grid.
selected_cmap(value)	Command called if cmap was chosen from menu.
selected_lat(event)	Command called if latitude-variable was selected with combobox.
selected_lon(event)	Command called if x-variable was selected with combobox.
selected_proj(value)	Command called if projection was chosen from menu.
selected_v(event)	Command called if plotting variable was selected with combobox.
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.
set_tstep(it)	Make all steps when changing time step.
set_unlim(v)	Set index and length of unlimited dimension of variable v.
setvar([name, value])	Set Tcl variable NAME to VALUE.
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.
spinned_lat([event])	Command called if spinbox of latitude-dimensions was changed.
spinned_lon([event])	Command called if spinbox of x-dimensions was changed.
spinned_v([event])	Command called if spinbox of variable-dimensions was changed.
state([statespec])	Modify or inquire widget state.
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([aboveThis])	Raise this widget in the stacking order.
tstep_t(step)	Command called if tstep was changed.
unbind(sequence[, funcid])	Unbind for this widget the event SEQUENCE.
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.
update(frame[, isframe])	Updates data of the current plot.
update_idletasks()	Enter event loop until all idle callbacks have been called.
wait_variable([name])	Wait until the variable is modified.
wait_visibility([window])	Wait until the visibility of a WIDGET changes (e.g. it appears).
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. "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])	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.

get_vminmax
getdouble
getint

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.

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.

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.

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).

cget(key)

Return the resource value for a KEY given as string.

checked()

Command called if any checkbutton was checked or unchecked.

Redraws plot.

checked_all()

Command called if any checkbutton ‘all’ for vmin/vmax was checked or unchecked.

Resets vmin/vmax, redraws plot.

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)

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.

delay_t(delay)

Command called if delay scale was changed.

delay is the chosen value on the scale slider.

deletecommand(name)

Internal function.

Delete the Tcl command provided in NAME.

destroy()

Destroy this and all descendants widgets.

entered_clon(event)

Command called if values central longitude was entered.

Triggering event was bound to entry.

Redraws plot.

entered_v(event)

Command called if values for vmin/vmax were entered.

Triggering event was bound to entry.

Redraws plot.

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.

first_t()

Command called if first frame button was pressed.

focus()

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.

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.

get_vminmax()

getboolean(s)

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

getdouble(s)

getint(s)

getvar(name='PY_VAR')

Return value of Tcl variable NAME.

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.

identify(x, y)

Returns the name of the element at position x, y, or the empty string if the point does not lie within any element.

x and y are pixel coordinates relative to the widget.

image_names()

Return a list of all existing image names.

image_types()

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

info()

Return information about the packing options for this widget.

info_patchlevel()

Returns the exact version of the Tcl library.

instate(statespec, callback=None, *args, **kw)

Test the widget’s state.

If callback is not specified, returns True if the widget state matches statespec and False otherwise. If callback is specified, then it will be invoked with *args, **kw if the widget state matches statespec. statespec is expected to be a sequence.

keys()

Return a list of all resource names of this widget.

last_t()

Command called if last frame button was pressed.

lift(aboveThis=None)

Raise this widget in the stacking order.

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(belowThis=None)

Lower this widget in the stacking order.

mainloop(n=0)

Call the mainloop of Tk.

nametowidget(name)

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

newnetcdf()

Open a new netcdf file and connect it to top.

next_t()

Command called if next frame button was pressed.

next_v()

Command called if next button for the plotting variable was pressed.

Resets vmin/vmax and variable-dimensions. Redraws plot.

nrun_t()

Command called if forward run button was pressed.

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.

pause_t()

Command called if pause button was pressed.

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

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.

prev_t()

Command called if previous frame button was pressed.

prev_v()

Command called if previous button for the plotting variable was pressed.

Resets vmin/vmax and v-dimensions. Redraws plot.

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.

prun_t()

Command called if run backwards button was pressed.

quit()

Quit the Tcl interpreter. All widgets will be destroyed.

redraw()

Redraws the plot.

Reads lon, lat, variable names, the current settings of their dimension spinboxes, as well as all other plotting options. Then redraws the plot.

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.

reinit()

Reinitialise the panel from top.

repeat_t(event)

Command called if repeat option was chosen with combobox.

Triggering event was bound to the combobox.

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).

selected_cmap(value)

Command called if cmap was chosen from menu.

value is the chosen colormap.

Sets text and image on the menubutton.

selected_lat(event)

Command called if latitude-variable was selected with combobox.

Triggering event was bound to the combobox.

Resets lat options and dimensions. Redraws plot.

selected_lon(event)

Command called if x-variable was selected with combobox.

Triggering event was bound to the combobox.

Resets x options and dimensions. Redraws plot.

selected_proj(value)

Command called if projection was chosen from menu.

value is the chosen projection.

Sets text on the menubutton.

selected_v(event)

Command called if plotting variable was selected with combobox.

Triggering event was bound to the combobox.

Resets vmin/vmax and variable-dimensions. Redraws plot.

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.

set_tstep(it)

Make all steps when changing time step.

it (int) is the time step.

Sets the time dimension spinbox, sets the time step scale, write the time on top.

set_unlim(v)

Set index and length of unlimited dimension of variable v.

v (str) is the variable name as in the selection comboboxes, i.e. gvar, var = vardim2var(self.fi[v)].

Sets self.nunlim to the length of the unlimited dimension and self.iunlim to the index in variable.dimensions if self.dunlim ~= ‘’ and self.dunlim in var.dimensions.

Takes self.iunlim=0 and self.nunlim=variable.shape[0] if self.dunlim == ‘’` or self.dunlim not in var.dimensions.

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

Set Tcl variable NAME to VALUE.

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.

spinned_lat(event=None)

Command called if spinbox of latitude-dimensions was changed.

Triggering event was bound to the spinbox.

Redraws plot.

spinned_lon(event=None)

Command called if spinbox of x-dimensions was changed.

Triggering event was bound to the spinbox.

Redraws plot.

spinned_v(event=None)

Command called if spinbox of variable-dimensions was changed.

Triggering event was bound to the spinbox.

Redraws plot.

state(statespec=None)

Modify or inquire widget state.

Widget state is returned if statespec is None, otherwise it is set according to the statespec flags and then a new state spec is returned indicating which flags were changed. statespec is expected to be a sequence.

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(aboveThis=None)

Raise this widget in the stacking order.

tstep_t(step)

Command called if tstep was changed.

step is the chosen value on the scale slider.

unbind(sequence, funcid=None)

Unbind for this widget the event SEQUENCE.

If FUNCID is given, only unbind the function identified with FUNCID and also delete the corresponding Tcl command.

Otherwise destroy the current binding for SEQUENCE, leaving SEQUENCE unbound.

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.

update(frame, isframe=False)

Updates data of the current plot.

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.

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.