feat: Synced tables (#2592)

* fix (mvTable): Allow creation of synced tables.

* feat (tables): Added mvSyncedTables for easier creation of synced tables.

---------

Co-authored-by: Jonathan Hoffstadt <[email protected]>

Author: v-ein

dearpygui/_dearpygui.pyi

@@ -565,6 +565,7 @@ CanItemTypeBeVisible(mvAppItemType type)
     case mvAppItemType::mvTable:
     case mvAppItemType::mvTableColumn:
     case mvAppItemType::mvTableRow:
+    case mvAppItemType::mvSyncedTables:
     case mvAppItemType::mvButton: return true;
     default: return false;
     }
@@ -1008,6 +1009,7 @@ DearPyGui::GetEntityDesciptionFlags(mvAppItemType type)
     case mvAppItemType::mvTable:
     case mvAppItemType::mvTableCell:
     case mvAppItemType::mvTableRow:
+    case mvAppItemType::mvSyncedTables:
     case mvAppItemType::mv2dHistogramSeries:
     case mvAppItemType::mvAreaSeries:
     case mvAppItemType::mvBarSeries:
@@ -3350,6 +3352,24 @@ DearPyGui::GetEntityParser(mvAppItemType type)
         setup.createContextManager = true;
         break;
     }
+    case mvAppItemType::mvSyncedTables:                    
+    {
+        AddCommonArgs(args, (CommonParserArgs)(
+            MV_PARSER_ARG_ID |
+            MV_PARSER_ARG_PARENT |
+            MV_PARSER_ARG_BEFORE |
+            MV_PARSER_ARG_FILTER |
+            MV_PARSER_ARG_SHOW)
+        );
+
+        setup.about = 
+                "Links all tables that are immediate children of this container so that they share "
+                "their state (mostly column sizes).  Other children are rendered as is.  This is "
+                "an experimental feature, use with caution.";
+        setup.category = { "Tables", "Containers", "Widgets" };
+        setup.createContextManager = true;
+        break;
+    }
     case mvAppItemType::mvDrawLine:                    
     {
         AddCommonArgs(args, (CommonParserArgs)(

dearpygui/_dearpygui_RTD.py

@@ -336,6 +336,7 @@ GetEntityCommand(mvAppItemType type)
     case mvAppItemType::mvTable:                       return "add_table";
     case mvAppItemType::mvTableColumn:                 return "add_table_column";
     case mvAppItemType::mvTableRow:                    return "add_table_row";
+    case mvAppItemType::mvSyncedTables:                return "add_synced_tables";
     case mvAppItemType::mvDrawLine:                    return "draw_line";
     case mvAppItemType::mvDrawArrow:                   return "draw_arrow";
     case mvAppItemType::mvDrawTriangle:                return "draw_triangle";

dearpygui/dearpygui.py

@@ -51,6 +51,7 @@
     X( mvTable ) \
     X( mvTableColumn ) \
     X( mvTableRow ) \
+    X( mvSyncedTables ) \
     X( mvDrawLine ) \
     X( mvDrawArrow ) \
     X( mvDrawTriangle ) \

src/mvAppItem.cpp

@@ -168,8 +168,6 @@ void mvTable::draw(ImDrawList* drawlist, float x, float y)
 	apply_local_theming(this);
 
 	{
-		ScopedID id(uuid);
-
 		auto row_renderer = [&](mvAppItem* row, mvAppItem* prev_visible_row=nullptr)
 		{
 			//TableNextRow() ends the previous row, if any, and determines background color for it.
@@ -241,7 +239,14 @@ void mvTable::draw(ImDrawList* drawlist, float x, float y)
 
 		handleImmediateScroll();
 
-		if (ImGui::BeginTable(info.internalLabel.c_str(), _columns, _flags,
+		const char* table_id = info.internalLabel.c_str();
+		// If this table is a part of a synced group, use that group's internalLabel
+		// instead.  In most cases, it will contain UUID so that all groups are distinct
+		// but tables within the group are synced.
+		if (info.parentPtr && info.parentPtr->type == mvAppItemType::mvSyncedTables)
+			table_id = info.parentPtr->info.internalLabel.c_str();
+
+		if (ImGui::BeginTable(table_id, _columns, _flags,
 			ImVec2((float)config.width, (float)config.height), (float)_inner_width))
 		{
 			state.lastFrameUpdate = GContext->frame;
@@ -670,3 +675,51 @@ void mvTable::setPyValue(PyObject* value)
 	_imguiFilter.InputBuf[i] = 0;
 	_imguiFilter.Build();
 }
+
+void mvSyncedTables::draw(ImDrawList* drawlist, float x, float y)
+{
+    //-----------------------------------------------------------------------------
+    // pre draw
+    //-----------------------------------------------------------------------------
+
+    // show/hide
+    if (!config.show)
+        return;
+
+    // push font if a font object is attached
+    if (font)
+    {
+        ImFont* fontptr = static_cast<mvFont*>(font.get())->getFontPtr();
+        ImGui::PushFont(fontptr);
+    }
+
+    // themes
+    apply_local_theming(this);
+
+    //-----------------------------------------------------------------------------
+    // draw
+    //-----------------------------------------------------------------------------
+    {
+		ScopedID id(uuid);
+
+        for (auto& child : childslots[1])
+        {
+            child->draw(drawlist, ImGui::GetCursorPosX(), ImGui::GetCursorPosY());
+        }
+        UpdateAppItemState(state);
+    }
+
+    //-----------------------------------------------------------------------------
+    // post draw
+    //-----------------------------------------------------------------------------
+
+    // handle popping themes
+    cleanup_local_theming(this);
+
+    // pop font off stack
+    if (font)
+        ImGui::PopFont();
+
+    if (handlerRegistry)
+        handlerRegistry->checkEvents(&state);
+}

src/mvAppItem.h

@@ -92,4 +92,11 @@ class mvTable : public mvAppItem
         int direction;
     };
 
-};
+};
+
+class mvSyncedTables : public mvAppItem
+{
+public:
+    explicit mvSyncedTables(mvUUID uuid) : mvAppItem(uuid) {}
+    void draw(ImDrawList* drawlist, float x, float y) override;
+};