visidata 2.11.1__py3-none-any.whl → 3.0.1__py3-none-any.whl

visidata/metasheets.py

@@ -2,7 +2,7 @@ import collections
 
 from visidata import globalCommand, BaseSheet, Column, options, vd, anytype, ENTER, asyncthread, Sheet, IndexSheet
 from visidata import CellColorizer, RowColorizer, JsonLinesSheet, AttrDict
-from visidata import ColumnAttr, ColumnItem
+from visidata import ColumnAttr, ItemColumn
 from visidata import TsvSheet, Path, Option
 from visidata import undoAttrFunc, VisiData, vlen
 
@@ -11,20 +11,30 @@ vd.option('visibility', 0, 'visibility level (0=low, 1=high)')
 vd_system_sep = '\t'
 
 
-@BaseSheet.lazy_property
-def optionsSheet(sheet):
-    return OptionsSheet(sheet.name+"_options", source=sheet)
-
-@VisiData.lazy_property
-def globalOptionsSheet(vd):
-    return OptionsSheet('global_options', source='global')
-
-
 class ColumnsSheet(Sheet):
     rowtype = 'columns'
     _rowtype = Column
     _coltype = ColumnAttr
     precious = False
+    guide = '''# Columns Sheet
+This is a list of {sheet.nSourceCols} columns on {sheet.displaySource}.
+Edit values on this sheet to change the appearance of the source sheet.
+For example, edit the _{sheet.cursorCol.name}_ column to **{sheet.cursorCol.formatted_help}**.
+
+Some new commands on this sheet operate on all selected columns on the source sheet:
+
+- {help.commands.hide_selected}
+- {help.commands.key_selected}
+- {help.commands.key_off_selected}
+- {help.commands.type_int_selected}
+- or `g` with any standard type to set type of selected source columns to that type
+
+## As usual
+
+- {help.commands.setcol_input}
+{sheet.help_columns}
+'''
+
     class ValueColumn(Column):
         'passthrough to the value on the source cursorRow'
         def calcValue(self, srcCol):
@@ -34,17 +44,18 @@ class ColumnsSheet(Sheet):
 
     columns = [
             ColumnAttr('sheet', type=str),
-            ColumnAttr('name'),
+            ColumnAttr('name', help='rename the column on the source sheet'),
             ColumnAttr('keycol', type=int, width=0),
-            ColumnAttr('width', type=int),
-            ColumnAttr('height', type=int),
+            ColumnAttr('width', type=int, help='set the column width (`0` to hide completely)'),
+            ColumnAttr('height', type=int, max_help=1, help='set a maximum height for the row, if this column will fill it'),
             ColumnAttr('hoffset', type=int, width=0),
             ColumnAttr('voffset', type=int, width=0),
-            ColumnAttr('type', 'typestr'),
-            ColumnAttr('fmtstr'),
-            ColumnAttr('formatter'),
-            ValueColumn('value'),
-            ColumnAttr('expr'),
+            ColumnAttr('type', 'typestr', help='convert all values to a specific type'),
+            ColumnAttr('fmtstr', help='use a custom format string, either C-style (`%0.4f`) or Python-style (`{{:0.4f}}`)'),
+            ColumnAttr('formatter', max_help=1, help='use a custom format function (**{col.help_formatters}**)'),
+            ColumnAttr('displayer', max_help=1, help='use a custom display function (**{col.help_displayers}**)'),
+            ValueColumn('value', help='change the value of this cell on the source sheet'),
+            ColumnAttr('expr', max_help=1, help='change the main column parameter'),
             ColumnAttr('ncalcs', type=int, width=0, cache=False),
             ColumnAttr('maxtime', type=float, width=0, cache=False),
             ColumnAttr('totaltime', type=float, width=0, cache=False),
@@ -54,13 +65,18 @@ class ColumnsSheet(Sheet):
         RowColorizer(7, 'color_key_col', lambda s,c,r,v: r and r.keycol),
         RowColorizer(8, 'color_hidden_col', lambda s,c,r,v: r and r.hidden),
     ]
-    def reload(self):
+
+    @property
+    def nSourceCols(self):
+        return sum(vs.nCols for vs in self.source)
+
+    def loader(self):
         if len(self.source) == 1:
             self.rows = self.source[0].columns
             self.cursorRowIndex = self.source[0].cursorColIndex
             self.columns[0].hide()  # hide 'sheet' column if only one sheet
         else:
-            self.rows = [col for vs in self.source for col in vs.visibleCols if vs is not self]
+            self.rows = [col for vs in self.source for col in vs.visibleCols if isinstance(vs, Sheet) and vs is not self]
 
     def newRow(self):
         c = type(self.source[0])._coltype()
@@ -81,110 +97,14 @@ VisiDataMetaSheet.options.row_delimiter = '\n'
 VisiDataMetaSheet.options.encoding = 'utf-8'
 
 
-class OptionsSheet(Sheet):
-    _rowtype = Option  # rowdef: Option
-    rowtype = 'options'
-    precious = False
-    columns = (
-        Column('option', getter=lambda col,row: row.name),
-        Column('value',
-            getter=lambda col,row: col.sheet.diffOption(row.name),
-            setter=lambda col,row,val: options.set(row.name, val, col.sheet.source),
-            ),
-        Column('default', getter=lambda col,row: options.getdefault(row.name)),
-        Column('description', width=40, getter=lambda col,row: options._get(row.name, 'default').helpstr),
-        ColumnAttr('replayable'),
-    )
-    colorizers = [
-        CellColorizer(3, None, lambda s,c,r,v: v.value if r and c in s.columns[1:3] and r.name.startswith('color_') else None),
-    ]
-    nKeys = 1
-
-    def diffOption(self, optname):
-        return options.getonly(optname, self.source, '')
-
-    def editOption(self, row):
-        currentValue = options.getobj(row.name, self.source)
-        vd.addUndo(options.set, row.name, currentValue, self.source)
-        if isinstance(row.value, bool):
-            options.set(row.name, not currentValue, self.source)
-        else:
-            options.set(row.name, self.editCell(1, value=currentValue), self.source)
-
-    def reload(self):
-        self.rows = []
-        for k in options.keys():
-            opt = options._get(k)
-            self.addRow(opt)
-        self.columns[1].name = 'global_value' if self.source == 'global' else 'sheet_value'
-
-
-vd._lastInputs = collections.defaultdict(dict)  # [input_type] -> {'input': anything}
-
-class LastInputsSheet(JsonLinesSheet):
-    columns = [
-        ColumnItem('type'),
-        ColumnItem('input'),
-    ]
-    def __init__(self, *args, **kwargs):
-        super().__init__(*args, **kwargs)
-        self.colnames = {col.name:col for col in self.columns}
-
-    def addRow(self, row, **kwargs):
-        'Update lastInputs before adding row.'
-        row = AttrDict(row)
-        if row.input in vd._lastInputs[row.type]:
-            del vd._lastInputs[row.type][row.input]  # so will be added as last entry
-        vd._lastInputs[row.type][row.input] = 1
-        return super().addRow(row, **kwargs)
-
-    def appendRow(self, row):
-        'Append *row* (AttrDict with *type* and *input*) directly to source.'
-        hist = self.history(row.type)
-        if hist and hist[-1] == row.input:
-            return
-
-        self.addRow(row)
-
-        if self.source:
-            with self.source.open_text(mode='a', encoding=self.options.encoding) as fp:
-                import json
-                fp.write(json.dumps(row) + '\n')
-
-    def history(self, t):
-        'Return list of inputs in category *t*, with last element being the most recently added.'
-        return list(vd._lastInputs[t].keys())
-
-
-@VisiData.lazy_property
-def lastInputsSheet(vd):
-    name = options.input_history
-
-    if not name:
-        return LastInputsSheet('last_inputs', source=None, rows=[])
-
-    p = Path(name)
-    if not p.is_absolute():
-        p = Path(options.visidata_dir)/f'{name}.jsonl'
-
-    vs = LastInputsSheet(name, source=p)
-    try:
-        vs.reload.__wrapped__(vs)
-    except FileNotFoundError:
-        pass
-    except Exception as e:
-        vd.exceptionCaught(e)
-
-    return vs
-
-
 @VisiData.property
 def allColumnsSheet(vd):
     return ColumnsSheet("all_columns", source=vd.stackedSheets)
 
+
 @VisiData.api
 def save_visidatarc(vd, p, vs):
-    with p.open_text(mode='w') as fp:
+    with p.open(mode='w') as fp:
         for opt in vs.rows:
             rval = repr(opt.value)
             defopt = vd.options._get(opt.name, 'default')
@@ -192,7 +112,9 @@ def save_visidatarc(vd, p, vs):
             fp.write(f'{leading}options.{opt.name:25s} = {rval:10s}  # {defopt.helpstr}\n')
 
 
-@ColumnsSheet.command('&', 'join-cols', 'add column from concatenating selected source columns')
+ColumnsSheet.addCommand('', 'join-cols', 'sheet.join_cols()', 'add column from concatenating selected source columns')
+
+@ColumnsSheet.api
 def join_cols(sheet):
     cols = sheet.onlySelectedRows
     destSheet = cols[0].sheet
@@ -209,40 +131,36 @@ def join_cols(sheet):
 
 # copy vd.sheets so that ColumnsSheet itself isn't included (for recalc in addRow)
 globalCommand('gC', 'columns-all', 'vd.push(vd.allColumnsSheet)', 'open Columns Sheet: edit column properties for all visible columns from all sheets on the sheets stack')
-globalCommand('O', 'options-global', 'vd.push(vd.globalOptionsSheet)', 'open Options Sheet: edit global options (apply to all sheets)')
-
-BaseSheet.addCommand('zO', 'options-sheet', 'vd.push(sheet.optionsSheet)', 'open Options Sheet: edit sheet options (apply to current sheet only)')
-BaseSheet.addCommand(None, 'open-inputs', 'vd.push(lastInputsSheet)', '')
 
 Sheet.addCommand('C', 'columns-sheet', 'vd.push(ColumnsSheet(name+"_columns", source=[sheet]))', 'open Columns Sheet: edit column properties for current sheet')
 
 # used ColumnsSheet, affecting the 'row' (source column)
-ColumnsSheet.addCommand('g!', 'key-selected', 'for c in onlySelectedRows: c.sheet.setKeys([c])', 'toggle selected rows as key columns on source sheet')
-ColumnsSheet.addCommand('gz!', 'key-off-selected', 'for c in onlySelectedRows: c.sheet.unsetKeys([c])', 'unset selected rows as key columns on source sheet')
+ColumnsSheet.addCommand('g!', 'key-selected', 'for c in onlySelectedRows: c.sheet.setKeys([c])', 'toggle selected source columns as key columns')
+ColumnsSheet.addCommand('gz!', 'key-off-selected', 'for c in onlySelectedRows: c.sheet.unsetKeys([c])', 'unset selected source columns as key columns')
 
-ColumnsSheet.addCommand('g-', 'hide-selected', 'onlySelectedRows.hide()', 'hide selected columns on source sheet')
+ColumnsSheet.addCommand('g-', 'hide-selected', 'onlySelectedRows.hide()', 'hide selected source columns')
 ColumnsSheet.addCommand(None, 'resize-source-rows-max', 'for c in selectedRows or [cursorRow]: c.setWidth(c.getMaxWidth(c.sheet.visibleRows))', 'adjust widths of selected source columns')
 
-ColumnsSheet.addCommand('g%', 'type-float-selected', 'onlySelectedRows.type=float', 'set type of selected columns to float')
-ColumnsSheet.addCommand('g#', 'type-int-selected', 'onlySelectedRows.type=int', 'set type of selected columns to int')
-ColumnsSheet.addCommand('gz#', 'type-len-selected', 'onlySelectedRows.type=vlen', 'set type of selected columns to len')
-ColumnsSheet.addCommand('g@', 'type-date-selected', 'onlySelectedRows.type=date', 'set type of selected columns to date')
-ColumnsSheet.addCommand('g$', 'type-currency-selected', 'onlySelectedRows.type=currency', 'set type of selected columns to currency')
-ColumnsSheet.addCommand('g~', 'type-string-selected', 'onlySelectedRows.type=str', 'set type of selected columns to str')
-ColumnsSheet.addCommand('gz~', 'type-any-selected', 'onlySelectedRows.type=anytype', 'set type of selected columns to anytype')
-ColumnsSheet.addCommand('gz%', 'type-floatsi-selected', 'onlySelectedRows.type=floatsi', 'set type of selected columns to floatsi')
-ColumnsSheet.addCommand('', 'type-floatlocale-selected', 'onlySelectedRows.type=floatlocale', 'set type of selected columns to float using system locale')
-
-OptionsSheet.addCommand('d', 'unset-option', 'options.unset(cursorRow.name, str(source))', 'remove option override for this context')
-OptionsSheet.addCommand(None, 'edit-option', 'editOption(cursorRow)', 'edit option at current row')
-OptionsSheet.bindkey('e', 'edit-option')
-OptionsSheet.bindkey(ENTER, 'edit-option')
+ColumnsSheet.addCommand('g%', 'type-float-selected', 'onlySelectedRows.type=float', 'set type of selected source columns to float')
+ColumnsSheet.addCommand('g#', 'type-int-selected', 'onlySelectedRows.type=int', 'set type of selected source columns to int')
+ColumnsSheet.addCommand('gz#', 'type-len-selected', 'onlySelectedRows.type=vlen', 'set type of selected source columns to len')
+ColumnsSheet.addCommand('g@', 'type-date-selected', 'onlySelectedRows.type=date', 'set type of selected source columns to date')
+ColumnsSheet.addCommand('g$', 'type-currency-selected', 'onlySelectedRows.type=currency', 'set type of selected source columns to currency')
+ColumnsSheet.addCommand('g~', 'type-string-selected', 'onlySelectedRows.type=str', 'set type of selected source columns to str')
+ColumnsSheet.addCommand('gz~', 'type-any-selected', 'onlySelectedRows.type=anytype', 'set type of selected source columns to anytype')
+ColumnsSheet.addCommand('gz%', 'type-floatsi-selected', 'onlySelectedRows.type=floatsi', 'set type of selected source columns to floatsi')
+ColumnsSheet.addCommand('', 'type-floatlocale-selected', 'onlySelectedRows.type=floatlocale', 'set type of selected source columns to float using system locale')
+
 MetaSheet.options.header = 0
 
 
 vd.addGlobals({
     'ColumnsSheet': ColumnsSheet,
     'MetaSheet': MetaSheet,
-    'OptionsSheet': OptionsSheet,
     'VisiDataMetaSheet': VisiDataMetaSheet,
 })
+
+vd.addMenuItems('''
+    View > Columns > this sheet > columns-sheet
+    View > Columns > all sheets > columns-all
+''')

visidata/modify.py

@@ -1,9 +1,37 @@
 from copy import copy
-from visidata import *
 
-vd.option('color_add_pending', 'green', 'color for rows pending add')
-vd.option('color_change_pending', 'reverse yellow', 'color for cells pending modification')
-vd.option('color_delete_pending', 'red', 'color for rows pending delete')
+from visidata import vd, VisiData, asyncthread
+from visidata import Sheet, RowColorizer, CellColorizer, Column, BaseSheet, Progress
+
+vd.theme_option('color_add_pending', 'green', 'color for rows pending add')
+vd.theme_option('color_change_pending', 'reverse yellow', 'color for cells pending modification')
+vd.theme_option('color_delete_pending', 'red', 'color for rows pending delete')
+vd.option('overwrite', 'c', 'overwrite existing files {y=yes|c=confirm|n=no}')
+
+vd.optalias('readonly', 'overwrite', 'n')
+vd.optalias('ro', 'overwrite', 'n')
+vd.optalias('y', 'overwrite', 'y')
+
+
+@VisiData.api
+def couldOverwrite(vd) -> bool:
+    'Return True if overwrite might be allowed.'
+    return vd.options.overwrite.startswith(('y','c'))
+
+
+@VisiData.api
+def confirmOverwrite(vd, path, msg:str=''):
+    'Fail if file exists and overwrite not allowed.'
+    if path is None or path.exists():
+        msg = msg or f'{path.given} exists. overwrite? '
+        ow = vd.options.overwrite
+        if ow.startswith('c'):  # confirm
+            vd.confirm(msg)
+        elif ow.startswith('y'):  # yes/always
+            pass
+        else: #1805  empty/no/never/readonly
+            vd.fail('overwrite disabled')
+    return True
 
 # deferred cached
 @Sheet.lazy_property
@@ -20,7 +48,7 @@ def _deferredDels(sheet):
 
 Sheet.colorizers += [
         RowColorizer(9, 'color_add_pending', lambda s,c,r,v: s.rowid(r) in s._deferredAdds),
-        CellColorizer(8, 'color_change_pending', lambda s,c,r,v: s.isChanged(c, r)),
+        CellColorizer(8, 'color_change_pending', lambda s,c,r,v: c and (r is not None) and s.isChanged(c, r)),
         RowColorizer(9, 'color_delete_pending', lambda s,c,r,v: s.isDeleted(r)),
         ]
 
@@ -89,9 +117,9 @@ def addRows(sheet, rows, index=None, undo=True):
     'Add *rows* after row at *index*.'
     addedRows = {}
     if index is None: index=len(sheet.rows)
-    for row in Progress(rows, gerund='adding'):
+    for i, row in enumerate(Progress(rows, gerund='adding')):
         addedRows[sheet.rowid(row)] = row
-        sheet.addRow(row, index=index+1)
+        sheet.addRow(row, index=index+i+1)
 
         if sheet.defer:
             sheet.rowAdded(row)
@@ -137,8 +165,11 @@ def deleteBy(sheet, func, commit=False, undo=True):
             if r is newCursorRow:
                 sheet.cursorRowIndex = len(sheet.rows)-1
         else:
-            sheet.deleteSourceRow(r)
-            ndeleted += 1
+            try:
+                sheet.commitDeleteRow(r)
+                ndeleted += 1
+            except Exception as e:
+                vd.exceptionCaught(e)
 
     if undo:
         vd.addUndo(setattr, sheet, 'rows', oldrows)
@@ -177,17 +208,30 @@ def getSourceValue(col, row):
 @Sheet.api
 def commitAdds(self):
     'Return the number of rows that have been marked for deferred add-row. Clear the marking.'
-    nadded = len(self._deferredAdds.values())
-    if nadded:
-        vd.status('added %s %s' % (nadded, self.rowtype))
+    nadded = 0
+    nerrors = 0
+    for row in self._deferredAdds.values():
+        try:
+            self.commitAddRow(row)
+            nadded += 1
+        except Exception as e:
+            vd.exceptionCaught(e)
+            nerrors += 1
+
+    if nadded or nerrors:
+        vd.status(f'added {nadded} {self.rowtype} ({nerrors} errors)')
+
     self._deferredAdds.clear()
     return nadded
 
+
 @Sheet.api
-def commitMods(self):
-    'Return the number of modifications (that are not deferred deletes or adds) that been marked for defer mod. Change value to mod for row in col. Clear the marking.'
+def commitMods(sheet):
+    'Commit all deferred modifications (that are not from rows added or deleted in this commit.  Return number of cells changed.'
+    _, deferredmods, _ = sheet.getDeferredChanges()
+
     nmods = 0
-    for row, rowmods in self._deferredMods.values():
+    for row, rowmods in deferredmods.values():
         for col, val in rowmods.items():
             try:
                 col.putValue(row, val)
@@ -195,7 +239,7 @@ def commitMods(self):
             except Exception as e:
                 vd.exceptionCaught(e)
 
-    self._deferredMods.clear()
+    sheet._deferredMods.clear()
     return nmods
 
 @Sheet.api
@@ -207,9 +251,16 @@ def commitDeletes(self):
         vd.status('deleted %s %s' % (ndeleted, self.rowtype))
     return ndeleted
 
+
+@Sheet.api
+def commitAddRow(self, row):
+    'To commit an added row.  Override per sheet type.'
+
+
 @Sheet.api
-def deleteSourceRow(sheet, row):
-    pass
+def commitDeleteRow(self, row):
+    'To commit a deleted row.  Override per sheet type.'
+
 
 @asyncthread
 @Sheet.api
@@ -219,8 +270,6 @@ def putChanges(sheet):
     sheet.commitMods()
     sheet.commitDeletes()
 
-    vd.saveSheets(Path(sheet.source), sheet, confirm_overwrite=False)
-
     # clear after save, to ensure cstr (in commit()) is aware of deletes
     sheet._deferredDels.clear()
 
@@ -269,10 +318,8 @@ def commit(sheet, *rows):
 
     adds, mods, deletes = sheet.getDeferredChanges()
     cstr = sheet.changestr(adds, mods, deletes)
-    path = sheet.source
 
-    if sheet.options.confirm_overwrite:
-        vd.confirm('really %s? ' % cstr)
+    vd.confirmOverwrite(sheet.rootSheet().source, 'really ' + cstr + '? ')
 
     sheet.putChanges()
     sheet.hasBeenModified = False
@@ -288,3 +335,11 @@ Sheet.addCommand('za', 'addcol-new', 'addColumnAtCursor(SettableColumn(input("co
 Sheet.addCommand('gza', 'addcol-bulk', 'addColumnAtCursor(*(SettableColumn() for c in range(int(input("add columns: ")))))', 'append N empty columns')
 
 Sheet.addCommand('z^S', 'commit-sheet', 'commit()', 'commit changes back to source.  not undoable!')
+
+vd.addMenuItems('''
+    File > Save > changes to source > commit-sheet
+    Row > Add > one row
+    Row > Add > multiple rows
+    Column > Add column > empty > one column > addcol-new
+    Column > Add column > empty > multiple columns > addcol-bulk
+''')

visidata/motd.py

@@ -5,7 +5,7 @@ a motd file from a url.  The file may be text or unheaded TSV, with one message
 
 Any Exception ends the thread silently.
 
-options.motd_url may be set to another URL, or empty to disable entirely.
+options.motd_url may be set to another URL, or empty string to disable entirely.
 '''
 
 import random
@@ -15,7 +15,7 @@ from visidata import options, asyncsingle, vd, VisiData
 vd.option('motd_url', 'https://visidata.org/motd-'+vd.version, 'source of randomized startup messages', sheettype=None)
 
 
-vd.motd = ''
+vd.motd = 'Support VisiData: https://github.com/sponsors/saulpw'
 
 @VisiData.api
 @asyncsingle
@@ -25,6 +25,6 @@ def domotd(vd):
             p = vd.urlcache(options.motd_url, days=1)
             line = random.choice(list(p))
             vd.motd = line.split('\t')[0]
-            vd.status(vd.motd, priority=-1)
     except Exception:
         pass
+    vd.status(vd.motd, priority=-1)

visidata/mouse.py

@@ -0,0 +1,137 @@
+import curses
+
+from visidata import vd, VisiData, BaseSheet, Sheet, AttrDict
+
+
+# registry of mouse events.  cleared before every draw cycle.
+vd.mousereg = []  # list of AttrDict(y=, x=, h=, w=, buttonfuncs=dict)
+
+# sheet mouse position for current mouse event
+BaseSheet.init('mouseX', int)
+BaseSheet.init('mouseY', int)
+
+
+@VisiData.after
+def initCurses(vd):
+    curses.MOUSE_ALL = 0xffffffff
+    curses.mousemask(curses.MOUSE_ALL if vd.options.mouse_interval else 0)
+    curses.mouseinterval(vd.options.mouse_interval)
+    curses.mouseEvents = {}
+
+    for k in dir(curses):
+        if k.startswith('BUTTON') or k in ('REPORT_MOUSE_POSITION', '2097152'):
+            curses.mouseEvents[getattr(curses, k)] = k
+
+
+@VisiData.after
+def clearCaches(vd):
+    vd.mousereg = []
+
+
+@VisiData.api
+def onMouse(vd, scr, x, y, w, h, **kwargs):
+    px, py = vd.getrootxy(scr)
+    e = AttrDict(x=x+px, y=y+py, w=w, h=h, buttonfuncs=kwargs)
+    vd.mousereg.append(e)
+
+
+@VisiData.api
+def getMouse(vd, _x, _y, button):
+    for reg in vd.mousereg[::-1]:
+        if reg.x <= _x < reg.x+reg.w and reg.y <= _y < reg.y+reg.h and button in reg.buttonfuncs:
+            return reg.buttonfuncs[button]
+
+
+@VisiData.api
+def parseMouse(vd, **kwargs):
+    'Return list of mouse interactions (clicktype, y, x, name, scr) for curses screens given in kwargs as name:scr.'
+
+    devid, x, y, z, bstate = curses.getmouse()
+
+    clicktype = ''
+    if bstate & curses.BUTTON_CTRL:
+        clicktype += "Ctrl+"
+        bstate &= ~curses.BUTTON_CTRL
+    if bstate & curses.BUTTON_ALT:
+        clicktype += "Alt+"
+        bstate &= ~curses.BUTTON_ALT
+    if bstate & curses.BUTTON_SHIFT:
+        clicktype += "Shift+"
+        bstate &= ~curses.BUTTON_SHIFT
+
+    keystroke = clicktype + curses.mouseEvents.get(bstate, str(bstate))
+    ret = AttrDict(keystroke=keystroke, y=y, x=x, found=[])
+    for winname, winscr in kwargs.items():
+        px, py = vd.getrootxy(winscr)
+        mh, mw = winscr.getmaxyx()
+        if py <= y < py+mh and px <= x < px+mw:
+            ret.found.append(winname)
+#            vd.debug(f'{keystroke} at ({x-px}, {y-py}) in window {winname} {winscr}')
+
+    return ret
+
+
+@VisiData.api
+def handleMouse(vd, sheet):
+    try:
+        vd.keystrokes = ''
+        pct = vd.windowConfig['pct']
+        topPaneActive = ((vd.activePane == 2 and pct < 0)  or (vd.activePane == 1 and pct > 0))
+        bottomPaneActive = ((vd.activePane == 1 and pct < 0)  or (vd.activePane == 2 and pct > 0))
+        r = None
+        r = vd.parseMouse(top=vd.winTop, bot=vd.winBottom, menu=vd.scrMenu)
+        if (bottomPaneActive and 'top' in r.found) or (topPaneActive and 'bot' in r.found):
+            vd.activePane = 1 if vd.activePane == 2 else 2
+            sheet = vd.activeSheet
+
+        f = vd.getMouse(r.x, r.y, r.keystroke)
+        winx, winy = vd.getrootxy(sheet._scr)
+        sheet.mouseX, sheet.mouseY = r.x-winx, r.y-winy
+        if f:
+            if isinstance(f, str):
+                if f.startswith('onclick'):
+                    if '://' in f:
+                        vd.launchBrowser(f[8:])
+                    else:
+                        sheet.execCommand(f[8:])
+                else:
+                    for cmd in f.split():
+                        sheet.execCommand(cmd)
+            else:
+                f(r.y, r.x, r.keystroke)
+
+            vd.keystrokes = vd.prettykeys(r.keystroke)
+            return ''  #  handled
+    except curses.error:
+        pass
+
+    return r.keystroke if r else ''
+
+
+@Sheet.api
+def visibleColAtX(sheet, x):
+    for vcolidx, (colx, w) in sheet._visibleColLayout.items():
+        if colx <= x <= colx+w:
+            return vcolidx
+
+
+@Sheet.api
+def visibleRowAtY(sheet, y):
+    for rowidx, (rowy, h) in sheet._rowLayout.items():
+        if rowy <= y <= rowy+h-1:
+            return rowidx
+
+
+@Sheet.command('BUTTON1_PRESSED', 'go-mouse', 'set cursor to row and column where mouse was clicked')
+def go_mouse(sheet):
+    ridx = sheet.visibleRowAtY(sheet.mouseY)
+    if ridx is not None:
+        sheet.cursorRowIndex = ridx
+    cidx = sheet.visibleColAtX(sheet.mouseX)
+    if cidx is not None:
+        sheet.cursorVisibleColIndex = cidx
+
+Sheet.addCommand(None, 'scroll-mouse', 'sheet.topRowIndex=cursorRowIndex-mouseY+1', 'scroll to mouse cursor location')
+
+Sheet.addCommand('ScrollUp', 'scroll-up', 'cursorDown(options.scroll_incr); sheet.topRowIndex += options.scroll_incr', 'scroll one row up')
+Sheet.addCommand('ScrollDown', 'scroll-down', 'cursorDown(-options.scroll_incr); sheet.topRowIndex -= options.scroll_incr', 'scroll one row down')