Skip to content

Commit 53ab0a5

Browse files
authored
DOCSP-30630 Navigate Diagrams and Entities Drawer (#13)
* DOCSP-30630 Navigate Diagrams and Entities Drawer
1 parent c5513f9 commit 53ab0a5

File tree

3 files changed

+123
-3
lines changed

3 files changed

+123
-3
lines changed
Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,55 @@
1+
.. _rm-apply-layout:
2+
13
===========================
24
Apply a Layout to a Diagram
3-
===========================
5+
===========================
6+
7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 1
11+
:class: singlecol
12+
13+
You can apply a preset layout to your diagram to organize its entities.
14+
Use diagram layouts to neatly arrange entities without needing to
15+
manually click and drag them.
16+
17+
About this Task
18+
---------------
19+
20+
When you apply a layout to a diagram, Relational Migrator applies the
21+
layout to both the Relational and MongoDB views. The zoom level is
22+
automatically adjusted to display your chosen layout.
23+
24+
Steps
25+
-----
26+
27+
#. Click the tree diagram icon at the top-left of the :guilabel:`diagram` view.
28+
29+
#. Choose your layout.
30+
31+
Layout Options
32+
--------------
33+
34+
Relational Migrator offers three layout options.
35+
Examples of each layout option are shown in the following tabs:
36+
37+
.. tabs::
38+
39+
.. tab:: Left to Right Layout
40+
:tabid: left-to-right
41+
42+
.. image:: /img/diagrams/layouts/left-to-right.png
43+
:alt: Left to Right Layout
44+
45+
.. tab:: Top to Bottom Layout
46+
:tabid: top-to-bottom
47+
48+
.. image:: /img/diagrams/layouts/top-to-bottom.png
49+
:alt: Top to Bottom Layout
50+
51+
.. tab:: Star Layout
52+
:tabid: star
53+
54+
.. image:: /img/diagrams/layouts/star.png
55+
:alt: Star Layout

source/diagrams/navigate-diagrams/navigate-diagrams.txt

Lines changed: 68 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,75 @@
22
Navigate Diagrams and Entities
33
==============================
44

5+
This page describes how to navigate your project's diagrams and
6+
entities.
7+
8+
After you :ref:`create a project<rm-create-project-live>`, Relational
9+
Migrator creates an initial diagram containing the entities and
10+
relationships in the Relational and MongoDB models.
11+
12+
If you have a large data model, you can create additional diagrams to
13+
separate the model into smaller subsets. When you have multiple diagrams
14+
in your project, Relational Migrator lists the diagram names in tabs at
15+
the top of the workspace.
16+
17+
.. note::
18+
19+
Diagram tabs appear in the order that the diagrams were created. You
20+
cannot reorder diagram tabs.
21+
22+
Change the Active Diagram
23+
-------------------------
24+
25+
The active diagram is the diagram currently displayed by Relational
26+
Migrator.
27+
28+
To change the active diagram, click the tab for the diagram you want to
29+
view.
30+
31+
Navigate Diagram Entities
32+
-------------------------
33+
34+
Diagrams are made up of entities. An entity is either a Relational or
35+
MongoDB database object.
36+
37+
Relational Migrator provides these modes for navigating entities in a
38+
diagram:
39+
40+
- Pan Mode
41+
- Multi-Select Mode
42+
43+
Pan Mode
44+
~~~~~~~~
45+
46+
In Pan Mode, you can click and drag the diagram to navigate to different
47+
areas. When you click a diagram entity, Relational Migrator shows
48+
mapping details for that entity in the right pane.
49+
50+
Pan Mode is the default view mode. When you are in Pan Mode, Relational
51+
Migrator highlights the arrow icon at the top of the diagram.
52+
53+
Multi-Select Mode
54+
~~~~~~~~~~~~~~~~~
55+
56+
In Multi-Select Mode, you can select multiple diagram entities by
57+
clicking and dragging the diagram to create a select box. When you
58+
select multiple entities, Relational Migrator shows the selected
59+
entities in the right pane. When multiple entities are selected, you
60+
cannot see any mapping details.
61+
62+
To enter Multi-Select Mode, press and hold :guilabel:`Shift`. When you are in
63+
Multi-Select Mode, Relational Migrator highlights the box icon at the
64+
top of the diagram. When you release the shift key, Relational Migrator
65+
returns to Pan Mode.
66+
67+
Learn More
68+
----------
69+
70+
:ref:`rm-apply-layout`
71+
572
.. toctree::
673
:hidden:
774
:titlesonly:
875

9-
/diagrams/navigate-diagrams/apply-layout
10-
/diagrams/navigate-diagrams/working-with-entities/working-with-entities
76+
/diagrams/navigate-diagrams/apply-layout
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _rm-create-project-live:
2+
13
=================================================
24
Create a Project By Connecting to a Live Database
35
=================================================

0 commit comments

Comments
 (0)