Skip to content

Free, simple, and intuitive online database diagram editor and SQL generator.

Auto-arrage tables (#1097)

1ilitf15453be0b9a
diff --git a/package-lock.json b/package-lock.json
index 50fd88cd..ed218abe 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -8,6 +8,7 @@
"name": "drawdb",
"version": "0.0.0",
"dependencies": {
+ "@dagrejs/dagre": "^3.1.1",
"@dbml/core": "^3.13.9",
"@dnd-kit/core": "^6.3.1",
"@dnd-kit/sortable": "^10.0.0",
@@ -80,6 +81,21 @@
"node": ">=6.9.0"
}
},
+ "node_modules/@dagrejs/dagre": {
+ "version": "3.1.1",
+ "resolved": "https://registry.npmjs.org/@dagrejs/dagre/-/dagre-3.1.1.tgz",
+ "integrity": "sha512-zroZB1dFOFiGgv4Xcrn1DckB1o4aOikPqD2NDQPV0WM//CXGcS6xiD0rNkqHmw6FEg4tabt4nxPLwgCWT+Vb2A==",
+ "license": "MIT",
+ "dependencies": {
+ "@dagrejs/graphlib": "4.0.5"
+ }
+ },
+ "node_modules/@dagrejs/graphlib": {
+ "version": "4.0.5",
+ "resolved": "https://registry.npmjs.org/@dagrejs/graphlib/-/graphlib-4.0.5.tgz",
+ "integrity": "sha512-7xrBTqIts3o+PMUZX97wSc+7TUbW+/rULzGNCTP6yooNVDXbzw4Wutg/H/xOutTB/c/k0YqOAavgPh4/Zk9PFA==",
+ "license": "MIT"
+ },
"node_modules/@dbml/core": {
"version": "3.13.9",
"resolved": "https://registry.npmjs.org/@dbml/core/-/core-3.13.9.tgz",
diff --git a/package.json b/package.json
index 828d03b7..84810476 100644
--- a/package.json
+++ b/package.json
@@ -10,6 +10,7 @@
"preview": "vite preview"
},
"dependencies": {
+ "@dagrejs/dagre": "^3.1.1",
"@dbml/core": "^3.13.9",
"@dnd-kit/core": "^6.3.1",
"@dnd-kit/sortable": "^10.0.0",
diff --git a/src/components/EditorHeader/ControlPanel.jsx b/src/components/EditorHeader/ControlPanel.jsx
index d1a5548d..c42a947c 100644
--- a/src/components/EditorHeader/ControlPanel.jsx
+++ b/src/components/EditorHeader/ControlPanel.jsx
@@ -87,6 +87,7 @@ import { diffDiagram } from "../../utils/dbml/diff";
import { exportSavedData } from "../../utils/exportSavedData";
import { nanoid } from "nanoid";
import { getTableHeight } from "../../utils/utils";
+import { autoArrange } from "../../utils/autoArrange";
import { deleteFromCache, STORAGE_KEY } from "../../utils/cache";
import { DateTime } from "luxon";
import ConfigureCustomTypes from "./ConfigureCustomTypes";
@@ -617,7 +618,8 @@ export default function ControlPanel({
};
const resetView = () =>
setTransform((prev) => ({ ...prev, zoom: 1, pan: { x: 0, y: 0 } }));
- const fitWindow = () => {
+ const fitWindow = () => fitToView(tables);
+ const fitToView = (tablesToFit) => {
const canvas = document.getElementById("canvas").getBoundingClientRect();
const minMaxXY = {
@@ -627,7 +629,7 @@ export default function ControlPanel({
maxY: -Infinity,
};
- tables.forEach((table) => {
+ tablesToFit.forEach((table) => {
minMaxXY.minX = Math.min(minMaxXY.minX, table.x);
minMaxXY.minY = Math.min(minMaxXY.minY, table.y);
minMaxXY.maxX = Math.max(minMaxXY.maxX, table.x + settings.tableWidth);
@@ -678,6 +680,40 @@ export default function ControlPanel({
pan: { x: centerX, y: centerY },
}));
};
+ const autoArrangeTables = () => {
+ const positions = autoArrange(tables, relationships, settings);
+ const positionById = new Map(positions.map((p) => [p.id, p]));
+
+ const elements = [];
+ const arrangedTables = tables.map((table) => {
+ const pos = positionById.get(table.id);
+ if (!pos || (pos.x === table.x && pos.y === table.y)) return table;
+ elements.push({
+ id: table.id,
+ type: ObjectType.TABLE,
+ undo: { x: table.x, y: table.y },
+ redo: { x: pos.x, y: pos.y },
+ });
+ return { ...table, x: pos.x, y: pos.y };
+ });
+
+ if (elements.length === 0) return;
+
+ for (const element of elements) {
+ updateTable(element.id, element.redo);
+ }
+ setUndoStack((prev) => [
+ ...prev,
+ {
+ action: Action.MOVE,
+ bulk: true,
+ message: t("auto_arrange"),
+ elements,
+ },
+ ]);
+ setRedoStack([]);
+ fitToView(arrangedTables);
+ };
const edit = () => {
if (selectedElement.element === ObjectType.TABLE) {
if (!layout.sidebar) {
@@ -1522,6 +1558,10 @@ export default function ControlPanel({
shortcut: "Del",
disabled: layout.readOnly,
},
+ auto_arrange: {
+ function: autoArrangeTables,
+ disabled: layout.readOnly,
+ },
copy_as_image: {
function: copyAsImage,
shortcut: "Ctrl+Alt+C",
@@ -1980,6 +2020,16 @@ export default function ControlPanel({
</button>
</Tooltip>
<Divider layout="vertical" margin="8px" />
+ <Tooltip content={t("auto_arrange")} position="bottom">
+ <button
+ className="py-1 px-2 hover-2 rounded-sm text-xl -mt-0.5 disabled:opacity-50"
+ onClick={autoArrangeTables}
+ disabled={layout.readOnly}
+ >
+ <i className="fa-solid fa-wand-magic-sparkles" />
+ </button>
+ </Tooltip>
+ <Divider layout="vertical" margin="8px" />
<Tooltip content={t("save")} position="bottom">
<button
className="py-1 px-2 hover-2 rounded-sm flex items-center disabled:opacity-50"
diff --git a/src/i18n/locales/en.js b/src/i18n/locales/en.js
index b20438a0..7aaaea3f 100644
--- a/src/i18n/locales/en.js
+++ b/src/i18n/locales/en.js
@@ -253,6 +253,7 @@ const en = {
docs: "Docs",
supported_types: "Supported file types:",
bulk_update: "Bulk update",
+ auto_arrange: "Auto arrange",
multiselect: "Multiselect",
export_saved_data: "Export saved data",
dbml_view: "DBML view",
diff --git a/src/utils/autoArrange.js b/src/utils/autoArrange.js
new file mode 100644
index 00000000..149cf0b1
--- /dev/null
+++ b/src/utils/autoArrange.js
@@ -0,0 +1,87 @@
+import { graphlib, layout } from "@dagrejs/dagre";
+import { getTableHeight } from "./utils";
+
+const nodeSep = 60;
+const rankSep = 110;
+const isolatedGap = 60;
+
+export function autoArrange(tables, relationships, settings) {
+ const movable = tables.filter((table) => !table.locked);
+ const movableIds = new Set(movable.map((table) => table.id));
+
+ const connectedIds = new Set();
+ for (const r of relationships) {
+ if (
+ r.startTableId !== r.endTableId &&
+ movableIds.has(r.startTableId) &&
+ movableIds.has(r.endTableId)
+ ) {
+ connectedIds.add(r.startTableId);
+ connectedIds.add(r.endTableId);
+ }
+ }
+
+ const sizeOf = (table) => ({
+ width: settings.tableWidth,
+ height: getTableHeight(
+ table,
+ settings.tableWidth,
+ settings.showComments,
+ relationships,
+ ),
+ });
+
+ const connected = movable.filter((table) => connectedIds.has(table.id));
+ const isolated = movable.filter((table) => !connectedIds.has(table.id));
+
+ const graph = new graphlib.Graph();
+ graph.setGraph({ rankdir: "LR", nodesep: nodeSep, ranksep: rankSep });
+ graph.setDefaultEdgeLabel(() => ({}));
+
+ for (const table of connected) {
+ graph.setNode(String(table.id), sizeOf(table));
+ }
+ for (const r of relationships) {
+ if (
+ r.startTableId !== r.endTableId &&
+ connectedIds.has(r.startTableId) &&
+ connectedIds.has(r.endTableId)
+ ) {
+ graph.setEdge(String(r.startTableId), String(r.endTableId));
+ }
+ }
+
+ layout(graph);
+
+ const positions = [];
+ let maxX = 0;
+ let maxY = 0;
+ for (const table of connected) {
+ const node = graph.node(String(table.id));
+ const x = node.x - node.width / 2;
+ const y = node.y - node.height / 2;
+ positions.push({ id: table.id, x, y });
+ maxX = Math.max(maxX, x + node.width);
+ maxY = Math.max(maxY, y + node.height);
+ }
+
+ if (isolated.length > 0) {
+ const rowWidth = Math.max(maxX, 4 * settings.tableWidth + 3 * isolatedGap);
+ let x = 0;
+ let y = connected.length > 0 ? maxY + rankSep : 0;
+ let rowHeight = 0;
+ for (const table of isolated) {
+ const { width, height } = sizeOf(table);
+ if (x > 0 && x + width > rowWidth) {
+ x = 0;
+ y += rowHeight + isolatedGap;
+ rowHeight = 0;
+ }
+ positions.push({ id: table.id, x, y });
+ x += width + isolatedGap;
+ rowHeight = Math.max(rowHeight, height);
+ }
+ }
+
+ return positions;
+}