# {py:mod}`arelle.UITkTable` ```{py:module} arelle.UITkTable ``` ```{autodoc2-docstring} arelle.UITkTable :allowtitles: ``` ## Module Contents ### Classes ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`Coordinate ` - ```{autodoc2-docstring} arelle.UITkTable.Coordinate :summary: ``` * - {py:obj}`MyToolTip ` - ```{autodoc2-docstring} arelle.UITkTable.MyToolTip :summary: ``` * - {py:obj}`TableCombobox ` - * - {py:obj}`XbrlTable ` - ```{autodoc2-docstring} arelle.UITkTable.XbrlTable :summary: ``` * - {py:obj}`ScrolledTkTableFrame ` - ```` ### Data ````{list-table} :class: autosummary longtable :align: left * - {py:obj}`USE_resizeTableCells ` - ```{autodoc2-docstring} arelle.UITkTable.USE_resizeTableCells :summary: ``` ```` ### API ````{py:data} USE_resizeTableCells :canonical: arelle.UITkTable.USE_resizeTableCells :value: > False ```{autodoc2-docstring} arelle.UITkTable.USE_resizeTableCells ``` ```` `````{py:class} Coordinate(row, column) :canonical: arelle.UITkTable.Coordinate Bases: {py:obj}`object` ```{autodoc2-docstring} arelle.UITkTable.Coordinate ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.UITkTable.Coordinate.__init__ ``` ````{py:method} __str__() :canonical: arelle.UITkTable.Coordinate.__str__ ```` ````{py:method} __repr__() :canonical: arelle.UITkTable.Coordinate.__repr__ ```` ````{py:method} __eq__(other) :canonical: arelle.UITkTable.Coordinate.__eq__ ```` ````{py:method} __ne__(other) :canonical: arelle.UITkTable.Coordinate.__ne__ ```` ````{py:method} __lt__(other) :canonical: arelle.UITkTable.Coordinate.__lt__ ```` ````{py:method} __gt__(other) :canonical: arelle.UITkTable.Coordinate.__gt__ ```` ````{py:method} __hash__() :canonical: arelle.UITkTable.Coordinate.__hash__ ```` ````` `````{py:class} MyToolTip(master, text='', delay=500, **opts) :canonical: arelle.UITkTable.MyToolTip Bases: {py:obj}`arelle.CntlrWinTooltip.ToolTip` ```{autodoc2-docstring} arelle.UITkTable.MyToolTip ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.UITkTable.MyToolTip.__init__ ``` ````{py:method} motion(event=None) :canonical: arelle.UITkTable.MyToolTip.motion ```{autodoc2-docstring} arelle.UITkTable.MyToolTip.motion ``` ```` ````` `````{py:class} TableCombobox(master=None, **kw) :canonical: arelle.UITkTable.TableCombobox Bases: {py:obj}`tkinter.ttk.Combobox` ````{py:property} valueIndex :canonical: arelle.UITkTable.TableCombobox.valueIndex ```{autodoc2-docstring} arelle.UITkTable.TableCombobox.valueIndex ``` ```` ````` `````{py:class} XbrlTable(parentWidget, rows, columns, titleRows, titleColumns, tableName=None, browsecmd=None) :canonical: arelle.UITkTable.XbrlTable Bases: {py:obj}`arelle.TkTableWrapper.Table` ```{autodoc2-docstring} arelle.UITkTable.XbrlTable ``` ```{rubric} Initialization ``` ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.__init__ ``` ````{py:attribute} TG_PREFIX :canonical: arelle.UITkTable.XbrlTable.TG_PREFIX :value: > 'cFmt' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_PREFIX ``` ```` ````{py:attribute} TG_TOP_LEFT :canonical: arelle.UITkTable.XbrlTable.TG_TOP_LEFT :value: > 'top-left-cell' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_TOP_LEFT ``` ```` ````{py:attribute} TG_LEFT_JUSTIFIED :canonical: arelle.UITkTable.XbrlTable.TG_LEFT_JUSTIFIED :value: > 'left' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_LEFT_JUSTIFIED ``` ```` ````{py:attribute} TG_RIGHT_JUSTIFIED :canonical: arelle.UITkTable.XbrlTable.TG_RIGHT_JUSTIFIED :value: > 'right' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_RIGHT_JUSTIFIED ``` ```` ````{py:attribute} TG_CENTERED :canonical: arelle.UITkTable.XbrlTable.TG_CENTERED :value: > 'center' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_CENTERED ``` ```` ````{py:attribute} TG_TOP_LEFT_JUSTIFIED :canonical: arelle.UITkTable.XbrlTable.TG_TOP_LEFT_JUSTIFIED :value: > 'top-left' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_TOP_LEFT_JUSTIFIED ``` ```` ````{py:attribute} ANCHOR_POSITIONS :canonical: arelle.UITkTable.XbrlTable.ANCHOR_POSITIONS :value: > None ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.ANCHOR_POSITIONS ``` ```` ````{py:attribute} JUSTIFICATIONS :canonical: arelle.UITkTable.XbrlTable.JUSTIFICATIONS :value: > None ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.JUSTIFICATIONS ``` ```` ````{py:attribute} TG_BG_WHITE :canonical: arelle.UITkTable.XbrlTable.TG_BG_WHITE :value: > 'bg-white' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BG_WHITE ``` ```` ````{py:attribute} TG_BG_DEFAULT :canonical: arelle.UITkTable.XbrlTable.TG_BG_DEFAULT :value: > None ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BG_DEFAULT ``` ```` ````{py:attribute} TG_BG_YELLOW :canonical: arelle.UITkTable.XbrlTable.TG_BG_YELLOW :value: > 'bg-yellow' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BG_YELLOW ``` ```` ````{py:attribute} TG_BG_ORANGE :canonical: arelle.UITkTable.XbrlTable.TG_BG_ORANGE :value: > 'bg-orange' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BG_ORANGE ``` ```` ````{py:attribute} TG_BG_VIOLET :canonical: arelle.UITkTable.XbrlTable.TG_BG_VIOLET :value: > 'bg-violet' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BG_VIOLET ``` ```` ````{py:attribute} TG_BG_GREEN :canonical: arelle.UITkTable.XbrlTable.TG_BG_GREEN :value: > 'bg-green' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BG_GREEN ``` ```` ````{py:attribute} COLOURS :canonical: arelle.UITkTable.XbrlTable.COLOURS :value: > None ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.COLOURS ``` ```` ````{py:attribute} TG_DISABLED :canonical: arelle.UITkTable.XbrlTable.TG_DISABLED :value: > 'disabled-cells' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_DISABLED ``` ```` ````{py:attribute} TG_NO_BORDER :canonical: arelle.UITkTable.XbrlTable.TG_NO_BORDER :value: > 'no-border' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_NO_BORDER ``` ```` ````{py:attribute} TG_BORDER_ALL :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_ALL :value: > 'border-all' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_ALL ``` ```` ````{py:attribute} TG_BORDER_LEFT :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_LEFT :value: > 'border-left' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_LEFT ``` ```` ````{py:attribute} TG_BORDER_TOP :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_TOP :value: > 'border-top' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_TOP ``` ```` ````{py:attribute} TG_BORDER_RIGHT :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_RIGHT :value: > 'border-right' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_RIGHT ``` ```` ````{py:attribute} TG_BORDER_BOTTOM :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_BOTTOM :value: > 'border-bottom' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_BOTTOM ``` ```` ````{py:attribute} TG_BORDER_LEFT_TOP :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_TOP :value: > 'border-left-top' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_TOP ``` ```` ````{py:attribute} TG_BORDER_LEFT_RIGHT :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_RIGHT :value: > 'border-left-right' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_RIGHT ``` ```` ````{py:attribute} TG_BORDER_LEFT_BOTTOM :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_BOTTOM :value: > 'border-left-bottom' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_BOTTOM ``` ```` ````{py:attribute} TG_BORDER_TOP_RIGHT :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_TOP_RIGHT :value: > 'border-top-right' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_TOP_RIGHT ``` ```` ````{py:attribute} TG_BORDER_TOP_BOTTOM :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_TOP_BOTTOM :value: > 'border-top-bottom' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_TOP_BOTTOM ``` ```` ````{py:attribute} TG_BORDER_RIGHT_BOTTOM :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_RIGHT_BOTTOM :value: > 'border-right-bottom' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_RIGHT_BOTTOM ``` ```` ````{py:attribute} TG_BORDER_TOP_RIGHT_BOTTOM :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_TOP_RIGHT_BOTTOM :value: > 'border-top-right-bottom' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_TOP_RIGHT_BOTTOM ``` ```` ````{py:attribute} TG_BORDER_RIGHT_BOTTOM_LEFT :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_RIGHT_BOTTOM_LEFT :value: > 'border-right-bottom-left' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_RIGHT_BOTTOM_LEFT ``` ```` ````{py:attribute} TG_BORDER_BOTTOM_LEFT_TOP :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_BOTTOM_LEFT_TOP :value: > 'border-bottom-left-top' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_BOTTOM_LEFT_TOP ``` ```` ````{py:attribute} TG_BORDER_LEFT_TOP_RIGHT :canonical: arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_TOP_RIGHT :value: > 'border-left-top-right' ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.TG_BORDER_LEFT_TOP_RIGHT ``` ```` ````{py:attribute} BORDERWIDTHS :canonical: arelle.UITkTable.XbrlTable.BORDERWIDTHS :value: > None ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.BORDERWIDTHS ``` ```` ````{py:attribute} BORDER_NAMES :canonical: arelle.UITkTable.XbrlTable.BORDER_NAMES :value: > None ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.BORDER_NAMES ``` ```` ````{py:attribute} MAX_COLUMN_WIDTH :canonical: arelle.UITkTable.XbrlTable.MAX_COLUMN_WIDTH :value: > 20 ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.MAX_COLUMN_WIDTH ``` ```` ````{py:attribute} MAX_ROW_HEIGHT :canonical: arelle.UITkTable.XbrlTable.MAX_ROW_HEIGHT :value: > 50 ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.MAX_ROW_HEIGHT ``` ```` ````{py:attribute} MAX_COLUMN_WIDTH_PLUS_1 :canonical: arelle.UITkTable.XbrlTable.MAX_COLUMN_WIDTH_PLUS_1 :value: > None ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.MAX_COLUMN_WIDTH_PLUS_1 ``` ```` ````{py:attribute} DEFAULT_COLUMN_WIDTH :canonical: arelle.UITkTable.XbrlTable.DEFAULT_COLUMN_WIDTH :value: > 6 ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.DEFAULT_COLUMN_WIDTH ``` ```` ````{py:attribute} DEFAULT_ROW_HEIGHT :canonical: arelle.UITkTable.XbrlTable.DEFAULT_ROW_HEIGHT :value: > 2 ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.DEFAULT_ROW_HEIGHT ``` ```` ````{py:method} mouseMotion(event) :canonical: arelle.UITkTable.XbrlTable.mouseMotion ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.mouseMotion ``` ```` ````{py:method} getCoordinatesFromEventXY(event) :canonical: arelle.UITkTable.XbrlTable.getCoordinatesFromEventXY ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.getCoordinatesFromEventXY ``` ```` ````{py:method} cellRight(event, *args) :canonical: arelle.UITkTable.XbrlTable.cellRight ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.cellRight ``` ```` ````{py:method} cellDown(event, *args) :canonical: arelle.UITkTable.XbrlTable.cellDown ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.cellDown ``` ```` ````{py:method} _valueCommand(event) :canonical: arelle.UITkTable.XbrlTable._valueCommand ```{autodoc2-docstring} arelle.UITkTable.XbrlTable._valueCommand ``` ```` ````{py:method} _applyFormat(tagname, option) :canonical: arelle.UITkTable.XbrlTable._applyFormat ```{autodoc2-docstring} arelle.UITkTable.XbrlTable._applyFormat ``` ```` ````{py:method} format_cell(option, index) :canonical: arelle.UITkTable.XbrlTable.format_cell ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.format_cell ``` ```` ````{py:method} set(rc=None, index=None, objectId=None, *args, **kwargs) :canonical: arelle.UITkTable.XbrlTable.set ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.set ``` ```` ````{py:method} clearModificationStatus() :canonical: arelle.UITkTable.XbrlTable.clearModificationStatus ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.clearModificationStatus ``` ```` ````{py:method} getObjectId(coordinate) :canonical: arelle.UITkTable.XbrlTable.getObjectId ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.getObjectId ``` ```` ````{py:method} setObjectId(coordinate, objectId) :canonical: arelle.UITkTable.XbrlTable.setObjectId ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.setObjectId ``` ```` ````{py:method} getTableValue(coordinate) :canonical: arelle.UITkTable.XbrlTable.getTableValue ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.getTableValue ``` ```` ````{py:method} isHeaderCell(coordinate) :canonical: arelle.UITkTable.XbrlTable.isHeaderCell ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.isHeaderCell ``` ```` ````{py:method} getCoordinatesOfModifiedCells() :canonical: arelle.UITkTable.XbrlTable.getCoordinatesOfModifiedCells ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.getCoordinatesOfModifiedCells ``` ```` ````{py:method} getCurrentCellCoordinates() :canonical: arelle.UITkTable.XbrlTable.getCurrentCellCoordinates ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.getCurrentCellCoordinates ``` ```` ````{py:method} initCellValue(value, x, y, backgroundColourTag='bg-white', justification='left', objectId=None) :canonical: arelle.UITkTable.XbrlTable.initCellValue ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.initCellValue ``` ```` ````{py:method} _setValueFromCombobox(event) :canonical: arelle.UITkTable.XbrlTable._setValueFromCombobox ```{autodoc2-docstring} arelle.UITkTable.XbrlTable._setValueFromCombobox ``` ```` ````{py:method} initCellCombobox(value, values, x, y, isOpen=False, objectId=None, selectindex=None, comboboxselected=None, codes=dict()) :canonical: arelle.UITkTable.XbrlTable.initCellCombobox ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.initCellCombobox ``` ```` ````{py:method} initReadonlyCell(x, y) :canonical: arelle.UITkTable.XbrlTable.initReadonlyCell ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.initReadonlyCell ``` ```` ````{py:method} _updateMaxSizes(value, x, y, colspan, rowspan, minWidth=0) :canonical: arelle.UITkTable.XbrlTable._updateMaxSizes ```{autodoc2-docstring} arelle.UITkTable.XbrlTable._updateMaxSizes ``` ```` ````{py:method} _updateMaxComboboxSizes(codes, x, y, colspan, rowspan) :canonical: arelle.UITkTable.XbrlTable._updateMaxComboboxSizes ```{autodoc2-docstring} arelle.UITkTable.XbrlTable._updateMaxComboboxSizes ``` ```` ````{py:method} initHeaderCellValue(value, x, y, colspan, rowspan, justification, objectId=None, hasLeftBorder=True, hasTopBorder=True, hasRightBorder=True, hasBottomBorder=True, width=None) :canonical: arelle.UITkTable.XbrlTable.initHeaderCellValue ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.initHeaderCellValue ``` ```` ````{py:method} initCellSpan(x, y, colspan, rowspan) :canonical: arelle.UITkTable.XbrlTable.initCellSpan ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.initCellSpan ``` ```` ````{py:method} initHeaderCombobox(x, y, value='', values=(), colspan=0, rowspan=0, isOpen=True, objectId=None, selectindex=None, comboboxselected=None, codes=dict(), isRollUp=False) :canonical: arelle.UITkTable.XbrlTable.initHeaderCombobox ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.initHeaderCombobox ``` ```` ````{py:method} drawBordersAroundCell(x, y, borders) :canonical: arelle.UITkTable.XbrlTable.drawBordersAroundCell ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.drawBordersAroundCell ``` ```` ````{py:method} initHeaderBorder(x, y, cellsToTheRight=0, cellsBelow=0, hasLeftBorder=False, hasTopBorder=False, hasRightBorder=False, hasBottomBorder=False) :canonical: arelle.UITkTable.XbrlTable.initHeaderBorder ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.initHeaderBorder ``` ```` ````{py:method} resizeTable(rows, columns, titleRows=-1, titleColumns=-1, clearData=True) :canonical: arelle.UITkTable.XbrlTable.resizeTable ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.resizeTable ``` ```` ````{py:method} clearSpans() :canonical: arelle.UITkTable.XbrlTable.clearSpans ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.clearSpans ``` ```` ````{py:method} clearTags() :canonical: arelle.UITkTable.XbrlTable.clearTags ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.clearTags ``` ```` ````{py:method} disableUnusedCells() :canonical: arelle.UITkTable.XbrlTable.disableUnusedCells ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.disableUnusedCells ``` ```` ````{py:method} resizeTableCells() :canonical: arelle.UITkTable.XbrlTable.resizeTableCells ```{autodoc2-docstring} arelle.UITkTable.XbrlTable.resizeTableCells ``` ```` ````` `````{py:class} ScrolledTkTableFrame(parent, browseCmd, *args, **kw) :canonical: arelle.UITkTable.ScrolledTkTableFrame Bases: {py:obj}`tkinter.Frame` ````{py:method} clearGrid() :canonical: arelle.UITkTable.ScrolledTkTableFrame.clearGrid ```{autodoc2-docstring} arelle.UITkTable.ScrolledTkTableFrame.clearGrid ``` ```` `````