4
4
5
5
Manage modern mode figure subplot configuration and selection
6
6
7
- The **subplot** module is used to split the current figure into a matrix of subplots
7
+ The **subplot** module is used to split the current figure into a rectangular layout of subplots
8
8
that each may contain a single panel figure. A subplot setup is started with the **begin**
9
- mode that defines the layout of the subplots, while positioning to a particular panel for
10
- plotting is done via the **set** mode . The subplot is completed via the **end** mode .
9
+ directive that defines the layout of the subplots, while positioning to a particular panel for
10
+ plotting is done via the **set** directive . The subplot is completed via the **end** directive .
11
11
12
12
Synopsis (begin mode)
13
13
---------------------
@@ -32,8 +32,8 @@ Synopsis (begin mode)
32
32
Description
33
33
-----------
34
34
35
- The **begin** mode of subplot defines the layout of the entire multi-panel illustration. Several
36
- options are available to specify the systematic layout, labeling, dimensions, and more.
35
+ The **begin** directive of subplot defines the layout of the entire multi-panel illustration. Several
36
+ options are available to specify the systematic layout, labeling, dimensions, and more for the panels .
37
37
38
38
Required Arguments
39
39
------------------
@@ -52,7 +52,7 @@ Required Arguments
52
52
a single panel.
53
53
54
54
**-Ff**
55
- Specify the final figure dimensions. The subplot dimensions are then calculated from the figure
55
+ Specify the final **f**igure dimensions. The subplot dimensions are then calculated from the figure
56
56
dimensions after accounting for the space that optional tick marks, annotations, labels, and margins occupy between panels.
57
57
The annotations, ticks, and labels along the outside perimeter are not counted as part of the figure dimensions.
58
58
To specify different subplot dimensions for each row (or column), append **+f** followed by a comma-separated list of width
@@ -61,7 +61,7 @@ Required Arguments
61
61
A single number means constant widths (or heights) [Default].
62
62
63
63
**-Fs**
64
- Specify the dimensions of each subplot directly. Then, the figure dimensions are computed from the
64
+ Specify the dimensions of each **s**ubplot directly. Then, the figure dimensions are computed from the
65
65
subplot dimensions after adding the space that optional tick marks, annotations, labels, and margins occupy between panels.
66
66
The annotations, ticks, and labels along the outside perimeter are not counted as part of the figure dimensions.
67
67
To specify different subplot dimensions for each row (or column), append a colon followed by a comma-separated list of widths,
@@ -87,7 +87,7 @@ Optional Arguments
87
87
Note: **+j** sets the justification of the tag to *refpoint* (suitable for interior tags)
88
88
while **+J** instead selects the mirror opposite (suitable for exterior tags).
89
89
Append **+c**\ *dx*\ [/*dy*] to set the clearance between the tag and a surrounding text box
90
- requested via **+g** or **p** [3pt/3pt, i.e., 15% of the :ref:`FONT_TAG size <FONT_TAG>` size ].
90
+ requested via **+g** or **+ p** [3pt/3pt, i.e., 15% of the :ref:`FONT_TAG size <FONT_TAG>` dimension ].
91
91
Append **+g**\ *fill* to paint the tag's text box with *fill* [no painting].
92
92
Append **+o**\ *dx*\ [/*dy*] to offset the tag's reference point in the direction implied
93
93
by the justification [4pt/4pt, i.e., 20% of the :ref:`FONT_TAG size <FONT_TAG>`].
@@ -104,7 +104,7 @@ Optional Arguments
104
104
Reserve a space of dimension *clearance* between the margin and the subplot on the specified
105
105
side, using *side* values from **w**, **e**, **s**, or **n**. The option is repeatable to set aside space
106
106
on more than one side. Such space will be left untouched by the main map plotting but can
107
- be accessed by modules that plot scales, bars, text, etc. Settings specified under **begin** mode apply to all panels.
107
+ be accessed by modules that plot scales, bars, text, etc. Settings specified under **begin** directive apply to all panels.
108
108
109
109
.. _-J:
110
110
@@ -114,7 +114,7 @@ Optional Arguments
114
114
.. _subplot_begin-M:
115
115
116
116
**-M**\ *margins*
117
- This is clearance that is added around each subplot beyond the automatic space allocated for tick marks,
117
+ This is margin space that is added around each subplot beyond the automatic space allocated for tick marks,
118
118
annotations, and labels. The margins can be a single value, a pair of values separated by slashes
119
119
(for setting separate horizontal and vertical margins), or the full set of four margins (for setting
120
120
separate left, right, bottom, and top margins) [0.5c].
@@ -123,20 +123,21 @@ Optional Arguments
123
123
124
124
.. |Add_-R| unicode:: 0x20 .. just an invisible code
125
125
.. include:: explain_-R.rst_
126
+ This is useful when all subplots share a common plot domain.
126
127
127
128
.. _subplot_begin-S:
128
129
129
130
**-S**\ *layout*
130
131
Set subplot layout for shared axes. May be set separately for rows (**-SR**) and columns (**-SC**).
131
- **-SC**: Use when all subplots in a **C**\ olumn share a common *x*-range. The first (i.e., **t**\ op) and the last
132
+ Considerations for **-SC**: Use when all subplots in a **C**\ olumn share a common *x*-range. The first (i.e., **t**\ op) and the last
132
133
(i.e., **b**\ ottom) rows will have *x* annotations; append **t** or **b** to select only one of those two rows [both].
133
134
Append **+l** if annotated *x*-axes should have a label [none]; optionally append the label if it is the same
134
135
for the entire subplot.
135
- **-SR**: Use when all subplots in a **R**\ ow share a common *y*-range. The first (i.e., **l**\ eft) and the last
136
+ Considerations for **-SR**: Use when all subplots in a **R**\ ow share a common *y*-range. The first (i.e., **l**\ eft) and the last
136
137
(i.e., **r**\ ight) columns will have *y*-annotations; append **l** or **r** to select only one of those two columns [both].
137
138
Append **+l** if annotated *y*-axes will have a label [none]; optionally, append the label if it is the same
138
139
for the entire subplot.
139
- Append **+p** to make all annotations axis-parallel [horizontal]; if used you may have to set **-C** to secure
140
+ Append **+p** to make all annotations axis-parallel [horizontal]; if not used you may have to set **-C** to secure
140
141
extra space for long horizontal annotations.
141
142
Append **+t** to make space for subplot titles for each row; use **+tc** for top row titles only [no subplot titles].
142
143
Labels and titles that depends on which row or column are specified as usual via a panel's **-B** setting.
@@ -213,7 +214,7 @@ Synopsis (end mode)
213
214
214
215
This command finalizes the current subplot, including any placement of tags, and updates the
215
216
dimensions of the last plot to that of the entire subplot. This allows **-X** and **-Y** to
216
- use *w* and *h* in setting the current point relative to the entire subplot. We also reset
217
+ use the codes *w* and *h* in setting the current point relative to the entire subplot. We also reset
217
218
the current plot location to where it was prior to the subplot.
218
219
219
220
Optional Arguments
0 commit comments