-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathgrid.html
12889 lines (10812 loc) · 752 KB
/
grid.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title>Package 'grid' reference manual</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<!-- styling for math. katex.min.css expects fonts in same dir so use CDN -->
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.9/katex.min.css">
<link rel="stylesheet" type="text/css" href="https://r-universe.dev/static/R.css">
<link rel="stylesheet" type="text/css" href="https://r-universe.dev/static/prism.css">
<!-- for (future) customizations -->
<script src="https://r-universe.dev/static/manual.js"></script>
<link rel="stylesheet" type="text/css" href="https://r-universe.dev/static/manual.css?nocache=1">
</head>
<body class="postdoc macintosh">
<h1 class="manual-title">Package 'grid'</h1>
<table class="description-table">
<tr>
<th>Title:</th>
<td class="description-title">The Grid Graphics Package</td>
</tr>
<tr>
<th>Description:</th>
<td class="description-description">A rewrite of the graphics layout capabilities, plus some
support for interaction.</td>
</tr>
<tr>
<th>Authors:</th>
<td class="description-author"><span>Paul Murrell <[email protected]></span></td>
</tr>
<tr>
<th>Maintainer:</th>
<td class="description-maintainer">R Core Team <[email protected]></td>
</tr>
<tr>
<th>License:</th>
<td class="description-license">Part of R 4.4.1</td>
</tr>
<tr>
<th>Version:</th>
<td class="description-version">4.4.1</td>
</tr>
<tr>
<th>Built:</th>
<td class="description-date">2024-06-15 17:27:43 UTC</td>
</tr>
<tr>
<th>Source:</th>
<td class="description-source">base</td>
</tr>
</table>
<a href="#help-index" style="color:black;"><h2 id="help-index">Help Index</h2></a>
<ul id="help-index-list">
<li class="help-index-item"><a href="#grid-package">
The Grid Graphics Package
</a></li>
<li class="help-index-item"><a href="#absolute.size"> Absolute Size of a Grob </a></li>
<li class="help-index-item"><a href="#arrow"> Describe arrows to add to a line </a></li>
<li class="help-index-item"><a href="#as.mask"> Define a Soft Mask </a></li>
<li class="help-index-item"><a href="#calcStringMetric"> Calculate Metric Information for Text </a></li>
<li class="help-index-item"><a href="#dataViewport"> Create a Viewport with Scales based on Data </a></li>
<li class="help-index-item"><a href="#depth">
Determine the number of levels in an object
</a></li>
<li class="help-index-item"><a href="#deviceLoc"> Convert Viewport Location to Device Location </a></li>
<li class="help-index-item"><a href="#drawDetails"> Customising grid Drawing </a></li>
<li class="help-index-item"><a href="#editDetails"> Customising grid Editing </a></li>
<li class="help-index-item"><a href="#editViewport"> Modify a Viewport </a></li>
<li class="help-index-item"><a href="#explode">
Explode a path into its components
</a></li>
<li class="help-index-item"><a href="#gEdit"> Create and Apply Edit Objects </a></li>
<li class="help-index-item"><a href="#getNames"> List the names of grobs on the display list </a></li>
<li class="help-index-item"><a href="#gpar">Handling Grid Graphical Parameters</a></li>
<li class="help-index-item"><a href="#gPath"> Concatenate Grob Names </a></li>
<li class="help-index-item"><a href="#Grid">Grid Graphics</a></li>
<li class="help-index-item"><a href="#viewport">Create a Grid Viewport</a></li>
<li class="help-index-item"><a href="#grid.add">Add a Grid Graphical Object</a></li>
<li class="help-index-item"><a href="#grid.bezier"> Draw a Bezier Curve </a></li>
<li class="help-index-item"><a href="#grid.cap">
Capture a raster image
</a></li>
<li class="help-index-item"><a href="#grid.circle"> Draw a Circle </a></li>
<li class="help-index-item"><a href="#grid.clip">Set the Clipping Region</a></li>
<li class="help-index-item"><a href="#grid.convert"> Convert Between Different grid Coordinate Systems </a></li>
<li class="help-index-item"><a href="#grid.copy">Make a Copy of a Grid Graphical Object</a></li>
<li class="help-index-item"><a href="#grid.curve"> Draw a Curve Between Locations </a></li>
<li class="help-index-item"><a href="#grid.delay"> Encapsulate calculations and generating a grob </a></li>
<li class="help-index-item"><a href="#grid.display.list">Control the Grid Display List</a></li>
<li class="help-index-item"><a href="#grid.DLapply"> Modify the Grid Display List </a></li>
<li class="help-index-item"><a href="#grid.draw">Draw a grid grob</a></li>
<li class="help-index-item"><a href="#grid.edit">Edit the Description of a Grid Graphical Object</a></li>
<li class="help-index-item"><a href="#grid.force"> Force a grob into its components </a></li>
<li class="help-index-item"><a href="#grid.frame"> Create a Frame for Packing Objects </a></li>
<li class="help-index-item"><a href="#grid.function">Draw a curve representing a function</a></li>
<li class="help-index-item"><a href="#grid.get">Get a Grid Graphical Object</a></li>
<li class="help-index-item"><a href="#grid.glyph">Draw Typeset Glyphs</a></li>
<li class="help-index-item"><a href="#grid.grab"> Grab the current grid output </a></li>
<li class="help-index-item"><a href="#grid.grep">
Search for Grobs and/or Viewports
</a></li>
<li class="help-index-item"><a href="#grid.grill">Draw a Grill</a></li>
<li class="help-index-item"><a href="#grid.grob">Create Grid Graphical Objects, aka "Grob"s</a></li>
<li class="help-index-item"><a href="#grid.group"> Draw a Group </a></li>
<li class="help-index-item"><a href="#grid.layout">Create a Grid Layout</a></li>
<li class="help-index-item"><a href="#grid.lines">Draw Lines in a Grid Viewport</a></li>
<li class="help-index-item"><a href="#grid.locator"> Capture a Mouse Click </a></li>
<li class="help-index-item"><a href="#grid.ls"> List the names of grobs or viewports </a></li>
<li class="help-index-item"><a href="#grid.move.to"> Move or Draw to a Specified Position </a></li>
<li class="help-index-item"><a href="#grid.newpage">Move to a New Page on a Grid Device</a></li>
<li class="help-index-item"><a href="#grid.null"> Null Graphical Object </a></li>
<li class="help-index-item"><a href="#grid.pack"> Pack an Object within a Frame </a></li>
<li class="help-index-item"><a href="#grid.path"> Draw a Path </a></li>
<li class="help-index-item"><a href="#grid.place"> Place an Object within a Frame </a></li>
<li class="help-index-item"><a href="#grid.plot.and.legend"> A Simple Plot and Legend Demo </a></li>
<li class="help-index-item"><a href="#grid.points">Draw Data Symbols</a></li>
<li class="help-index-item"><a href="#grid.polygon"> Draw a Polygon </a></li>
<li class="help-index-item"><a href="#grid.pretty"> Generate a Sensible ("Pretty") Set of Breakpoints </a></li>
<li class="help-index-item"><a href="#grid.raster">
Render a raster object
</a></li>
<li class="help-index-item"><a href="#grid.record"> Encapsulate calculations and drawing </a></li>
<li class="help-index-item"><a href="#grid.rect">Draw rectangles </a></li>
<li class="help-index-item"><a href="#grid.refresh"> Refresh the current grid scene </a></li>
<li class="help-index-item"><a href="#grid.remove">Remove a Grid Graphical Object</a></li>
<li class="help-index-item"><a href="#grid.reorder"> Reorder the children of a gTree </a></li>
<li class="help-index-item"><a href="#grid.segments"> Draw Line Segments </a></li>
<li class="help-index-item"><a href="#grid.set">Set a Grid Graphical Object</a></li>
<li class="help-index-item"><a href="#grid.show.layout">Draw a Diagram of a Grid Layout</a></li>
<li class="help-index-item"><a href="#grid.show.viewport">Draw a Diagram of a Grid Viewport</a></li>
<li class="help-index-item"><a href="#grid.stroke"> Stroke or Fill a Path </a></li>
<li class="help-index-item"><a href="#grid.text">Draw Text</a></li>
<li class="help-index-item"><a href="#grid.xaxis">Draw an X-Axis</a></li>
<li class="help-index-item"><a href="#grid.xspline"> Draw an Xspline </a></li>
<li class="help-index-item"><a href="#grid.yaxis">Draw a Y-Axis</a></li>
<li class="help-index-item"><a href="#gridCoords">Create Sets of Coordinates for Grid Grobs</a></li>
<li class="help-index-item"><a href="#grobCoords">Calculate Points on the Perimeter of a Grob</a></li>
<li class="help-index-item"><a href="#grobName">Generate a Name for a Grob</a></li>
<li class="help-index-item"><a href="#grobWidth">Create a Unit Describing the Width of a Grob</a></li>
<li class="help-index-item"><a href="#grobX">Create a Unit Describing a Grob Boundary Location</a></li>
<li class="help-index-item"><a href="#legendGrob">Constructing a Legend Grob</a></li>
<li class="help-index-item"><a href="#makeContent"> Customised grid Grobs </a></li>
<li class="help-index-item"><a href="#patterns"> Define Gradient and Pattern Fills </a></li>
<li class="help-index-item"><a href="#plotViewport"> Create a Viewport with a Standard Plot Layout </a></li>
<li class="help-index-item"><a href="#current.viewport">Get the Current Grid Viewport (Tree)</a></li>
<li class="help-index-item"><a href="#resolveRasterSize">
Utility function to resolve the size of a raster grob
</a></li>
<li class="help-index-item"><a href="#grid.roundrect">Draw a rectangle with rounded corners</a></li>
<li class="help-index-item"><a href="#showGrob">
Label grid grobs
</a></li>
<li class="help-index-item"><a href="#showViewport">
Display grid viewports
</a></li>
<li class="help-index-item"><a href="#stringWidth">Create a Unit Describing the Width and Height of a String or Math
Expression</a></li>
<li class="help-index-item"><a href="#unit">Function to Create a Unit Object</a></li>
<li class="help-index-item"><a href="#unit.c">Combine Unit Objects</a></li>
<li class="help-index-item"><a href="#unit.length">Length of a Unit Object</a></li>
<li class="help-index-item"><a href="#unit.pmin"> Parallel Unit Minima and Maxima </a></li>
<li class="help-index-item"><a href="#unit.rep"> Replicate Elements of Unit Objects </a></li>
<li class="help-index-item"><a href="#unitType">Return the Units of a Unit Object</a></li>
<li class="help-index-item"><a href="#valid.just">Validate a Justification</a></li>
<li class="help-index-item"><a href="#validDetails"> Customising grid grob Validation </a></li>
<li class="help-index-item"><a href="#viewportTransform"> Define a Group Transformation </a></li>
<li class="help-index-item"><a href="#vpPath"> Concatenate Viewport Names </a></li>
<li class="help-index-item"><a href="#widthDetails"> Width and Height of a grid grob </a></li>
<li class="help-index-item"><a href="#viewports">Maintaining and Navigating the Grid Viewport Tree</a></li>
<li class="help-index-item"><a href="#xDetails"> Boundary of a grid grob </a></li>
<li class="help-index-item"><a href="#xsplinePoints">
Return the points that would be used to draw an xspline
(or a Bezier curve)
</a></li>
</ul>
<hr>
<div class="manual-pages-content">
<div class="container manual-page" id="grid-package"><div class="page-main">
<a href="#grid-package" class="help-page-title"><h2>
The Grid Graphics Package
</h2></a>
<h3>Description</h3>
<p>A rewrite of the graphics layout capabilities, plus some
support for interaction.
</p>
<h3>Details</h3>
<p>This package contains a graphics system which supplements
S-style graphics (see the <span class="pkg">graphics</span> package).
</p>
<p>Further information is available in the following
<a href="https://r-universe.dev/manuals/utils.html#vignette">vignettes</a>:
</p>
<table>
<tr>
<td style="text-align: left;">
<code>grid</code> </td>
<td style="text-align: left;"> Introduction to <code>grid</code> (<a href="../doc/grid.pdf">../doc/grid.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>displaylist</code> </td>
<td style="text-align: left;"> Display Lists in <code>grid</code> (<a href="../doc/displaylist.pdf">../doc/displaylist.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>frame</code> </td>
<td style="text-align: left;"> Frames and packing grobs (<a href="../doc/frame.pdf">../doc/frame.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>grobs</code> </td>
<td style="text-align: left;"> Working with <code>grid</code> grobs (<a href="../doc/grobs.pdf">../doc/grobs.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>interactive</code> </td>
<td style="text-align: left;"> Editing <code>grid</code> Graphics (<a href="../doc/interactive.pdf">../doc/interactive.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>locndimn</code> </td>
<td style="text-align: left;"> Locations versus Dimensions (<a href="../doc/locndimn.pdf">../doc/locndimn.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>moveline</code> </td>
<td style="text-align: left;"> Demonstrating move-to and line-to (<a href="../doc/moveline.pdf">../doc/moveline.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>nonfinite</code> </td>
<td style="text-align: left;"> How <code>grid</code> responds to non-finite values (<a href="../doc/nonfinite.pdf">../doc/nonfinite.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>plotexample</code> </td>
<td style="text-align: left;"> Writing <code>grid</code> Code (<a href="../doc/plotexample.pdf">../doc/plotexample.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>rotated</code> </td>
<td style="text-align: left;"> Rotated Viewports (<a href="../doc/rotated.pdf">../doc/rotated.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>saveload</code> </td>
<td style="text-align: left;"> Persistent representations (<a href="../doc/saveload.pdf">../doc/saveload.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>sharing</code> </td>
<td style="text-align: left;"> Modifying multiple grobs simultaneously (<a href="../doc/sharing.pdf">../doc/sharing.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
<code>viewports</code> </td>
<td style="text-align: left;"> Working with <code>grid</code> viewports (<a href="../doc/viewports.pdf">../doc/viewports.pdf</a>)</td>
</tr>
<tr>
<td style="text-align: left;">
</td>
</tr>
</table>
<p>For a complete list of functions with individual help pages,
use <code>library(help="grid")</code>.
</p>
<h3>Author(s)</h3>
<p>Paul Murrell <a href="mailto:[email protected]">[email protected]</a>
</p>
<p>Maintainer: R Core Team <a href="mailto:[email protected]">[email protected]</a>
</p>
<h3>References</h3>
<p>Murrell, P. (2005).
<em>R Graphics</em>.
Chapman & Hall/CRC Press.
</p>
<hr>
</div></div>
<div class="container manual-page" id="absolute.size"><div class="page-main">
<a href="#absolute.size" class="help-page-title"><h2> Absolute Size of a Grob </h2></a>
<h3>Description</h3>
<p>This function converts a unit object into absolute units.
Absolute units are unaffected, but non-absolute units are
converted into <code>"null"</code> units.
</p>
<h3>Usage</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">absolute.size(unit)
</code><code class="language-r">absolute.size<span class="token punctuation">(</span>unit<span class="token punctuation">)</span></code></pre>
<h3 class="r-arguments-title">Arguments</h3>
<table><tr>
<td><code id="unit">unit</code></td>
<td>
<p> An object of class <code>"unit"</code>. </p>
</td>
</tr></table>
<h3>Details</h3>
<p>Absolute units are things like <code>"inches"</code>, <code>"cm"</code>,
and <code>"lines"</code>. Non-absolute units are <code>"npc"</code>
and <code>"native"</code>.
</p>
<p>This function is designed to be used in <code>widthDetails</code>
and <code>heightDetails</code> methods.
</p>
<h3>Value</h3>
<p>An object of class <code>"unit"</code>.
</p>
<h3>Author(s)</h3>
<p> Paul Murrell </p>
<h3>See Also</h3>
<p><code><a href="#widthDetails">widthDetails</a></code>
and <code><a href="#widthDetails">heightDetails</a></code> methods.
</p>
<hr>
</div></div>
<div class="container manual-page" id="arrow"><div class="page-main">
<a href="#arrow" class="help-page-title"><h2> Describe arrows to add to a line </h2></a>
<h3>Description</h3>
<p>Produces a description of what arrows to add to a line.
The result can be passed to a function that draws a line,
e.g., <code><a href="#grid.lines">grid.lines</a></code>.
</p>
<h3>Usage</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">arrow(angle = 30, length = unit(0.25, "inches"),
ends = "last", type = "open")
</code><code class="language-r">arrow<span class="token punctuation">(</span>angle <span class="token operator">=</span> <span class="token number">30</span><span class="token punctuation">,</span> length <span class="token operator">=</span> unit<span class="token punctuation">(</span><span class="token number">0.25</span><span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
ends <span class="token operator">=</span> <span class="token string">"last"</span><span class="token punctuation">,</span> type <span class="token operator">=</span> <span class="token string">"open"</span><span class="token punctuation">)</span></code></pre>
<h3 class="r-arguments-title">Arguments</h3>
<table>
<tr>
<td><code id="angle">angle</code></td>
<td>
<p>The angle of the arrow head in degrees (smaller numbers
produce narrower, pointier arrows). Essentially describes
the width of the arrow head.</p>
</td>
</tr>
<tr>
<td><code id="length">length</code></td>
<td>
<p>A unit specifying the length of the arrow head (from tip
to base).</p>
</td>
</tr>
<tr>
<td><code id="ends">ends</code></td>
<td>
<p>One of <code>"last"</code>, <code>"first"</code>, or <code>"both"</code>,
indicating which ends of the line to draw arrow heads.</p>
</td>
</tr>
<tr>
<td><code id="type">type</code></td>
<td>
<p>One of <code>"open"</code> or <code>"closed"</code> indicating
whether the arrow head should be a closed triangle.</p>
</td>
</tr>
</table>
<h3>Examples</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">arrow()
str(arrow(type = "closed"), give.attr=FALSE)
</code><code class="language-r">arrow<span class="token punctuation">(</span><span class="token punctuation">)</span>
str<span class="token punctuation">(</span>arrow<span class="token punctuation">(</span>type <span class="token operator">=</span> <span class="token string">"closed"</span><span class="token punctuation">)</span><span class="token punctuation">,</span> give.attr<span class="token operator">=</span><span class="token boolean">FALSE</span><span class="token punctuation">)</span></code></pre>
<hr>
</div></div>
<div class="container manual-page" id="as.mask"><div class="page-main">
<a href="#as.mask" class="help-page-title"><h2> Define a Soft Mask </h2></a>
<h3>Description</h3>
<p>Define either an alpha mask or a luminance mask,
based on a grob.
</p>
<h3>Usage</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">as.mask(x, type=c("alpha", "luminance"))
</code><code class="language-r">as.mask<span class="token punctuation">(</span>x<span class="token punctuation">,</span> type<span class="token operator">=</span>c<span class="token punctuation">(</span><span class="token string">"alpha"</span><span class="token punctuation">,</span> <span class="token string">"luminance"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code></pre>
<h3 class="r-arguments-title">Arguments</h3>
<table>
<tr>
<td><code id="x">x</code></td>
<td>
<p>A grob.</p>
</td>
</tr>
<tr>
<td><code id="type">type</code></td>
<td>
<p>The type of mask.</p>
</td>
</tr>
</table>
<h3>Details</h3>
<p>A mask may be specified for a viewport either directly as
a grob or using this function. In the former case, the result
is an alpha mask. This function allows the user to define
a luminance mask instead.
</p>
<p>Not all graphics devices support masks and those that do
may only support one type of mask: for example
<code>xfig</code> and <code>pictex</code> do not support masks and
Cairo-based devices only support alpha masks.
</p>
<h3>Value</h3>
<p>A <code>"GridMask"</code> object.
</p>
<h3>Author(s)</h3>
<p>Paul Murrell</p>
<h3>See Also</h3>
<p><code><a href="#viewport">viewport</a></code>
</p>
<h3>Examples</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">## NOTE: on devices without support for masks normal line segments
## will be drawn
grid.newpage()
## Alpha mask
grid.segments(y0=1, y1=0, gp=gpar(col=2, lwd=100))
pushViewport(viewport(mask=circleGrob(gp=gpar(fill=rgb(0,0,0,.5)))))
grid.segments(gp=gpar(col=3, lwd=100))
grid.newpage()
## Luminance mask
grid.segments(y0=1, y1=0, gp=gpar(col=2, lwd=100))
pushViewport(viewport(mask=as.mask(circleGrob(gp=gpar(fill="grey50")),
"luminance")))
grid.segments(gp=gpar(col=3, lwd=100))
</code><code class="language-r"><span class="token comment">## NOTE: on devices without support for masks normal line segments </span>
<span class="token comment">## will be drawn</span>
grid.newpage<span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token comment">## Alpha mask</span>
grid.segments<span class="token punctuation">(</span>y0<span class="token operator">=</span><span class="token number">1</span><span class="token punctuation">,</span> y1<span class="token operator">=</span><span class="token number">0</span><span class="token punctuation">,</span> gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span><span class="token number">2</span><span class="token punctuation">,</span> lwd<span class="token operator">=</span><span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
pushViewport<span class="token punctuation">(</span>viewport<span class="token punctuation">(</span>mask<span class="token operator">=</span>circleGrob<span class="token punctuation">(</span>gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>fill<span class="token operator">=</span>rgb<span class="token punctuation">(</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">.5</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.segments<span class="token punctuation">(</span>gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span><span class="token number">3</span><span class="token punctuation">,</span> lwd<span class="token operator">=</span><span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.newpage<span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token comment">## Luminance mask</span>
grid.segments<span class="token punctuation">(</span>y0<span class="token operator">=</span><span class="token number">1</span><span class="token punctuation">,</span> y1<span class="token operator">=</span><span class="token number">0</span><span class="token punctuation">,</span> gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span><span class="token number">2</span><span class="token punctuation">,</span> lwd<span class="token operator">=</span><span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
pushViewport<span class="token punctuation">(</span>viewport<span class="token punctuation">(</span>mask<span class="token operator">=</span>as.mask<span class="token punctuation">(</span>circleGrob<span class="token punctuation">(</span>gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>fill<span class="token operator">=</span><span class="token string">"grey50"</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
<span class="token string">"luminance"</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.segments<span class="token punctuation">(</span>gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span><span class="token number">3</span><span class="token punctuation">,</span> lwd<span class="token operator">=</span><span class="token number">100</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code></pre>
<hr>
</div></div>
<div class="container manual-page" id="calcStringMetric"><div class="page-main">
<a href="#calcStringMetric" class="help-page-title"><h2> Calculate Metric Information for Text </h2></a>
<h3>Description</h3>
<p>This function returns the ascent, descent, and width metric
information for a character or expression vector.
</p>
<h3>Usage</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">calcStringMetric(text)
</code><code class="language-r">calcStringMetric<span class="token punctuation">(</span>text<span class="token punctuation">)</span></code></pre>
<h3 class="r-arguments-title">Arguments</h3>
<table><tr>
<td><code id="text">text</code></td>
<td>
<p> A character or expression vector. </p>
</td>
</tr></table>
<h3>Value</h3>
<p>A list with three numeric components named ascent, descent, and width.
All values are in inches.
</p>
<h3>WARNING </h3>
<p> The metric information from this function is based
on the font settings that are in effect when this function is called.
It will not necessarily correspond to the metric information of any
text that is drawn on the page.
</p>
<h3>Author(s)</h3>
<p> Paul Murrell </p>
<h3>See Also</h3>
<p><code><a href="#stringWidth">stringAscent</a></code>, <code><a href="#stringWidth">stringDescent</a></code>,
<code><a href="#grobWidth">grobAscent</a></code>, and <code><a href="#grobWidth">grobDescent</a></code>.</p>
<h3>Examples</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">grid.newpage()
grid.segments(.01, .5, .99, .5, gp=gpar(col="grey"))
metrics <- calcStringMetric(letters)
grid.rect(x=1:26/27,
width=unit(metrics$width, "inches"),
height=unit(metrics$ascent, "inches"),
just="bottom",
gp=gpar(col="red"))
grid.rect(x=1:26/27,
width=unit(metrics$width, "inches"),
height=unit(metrics$descent, "inches"),
just="top",
gp=gpar(col="red"))
grid.text(letters, x=1:26/27, just="bottom")
test <- function(x) {
grid.text(x, just="bottom")
metric <- calcStringMetric(x)
if (is.character(x)) {
grid.rect(width=unit(metric$width, "inches"),
height=unit(metric$ascent, "inches"),
just="bottom",
gp=gpar(col=rgb(1,0,0,.5)))
grid.rect(width=unit(metric$width, "inches"),
height=unit(metric$descent, "inches"),
just="top",
gp=gpar(col=rgb(1,0,0,.5)))
} else {
grid.rect(width=unit(metric$width, "inches"),
y=unit(.5, "npc") + unit(metric[2], "inches"),
height=unit(metric$ascent, "inches"),
just="bottom",
gp=gpar(col=rgb(1,0,0,.5)))
grid.rect(width=unit(metric$width, "inches"),
height=unit(metric$descent, "inches"),
just="bottom",
gp=gpar(col=rgb(1,0,0,.5)))
}
}
tests <- list("t",
"test",
"testy",
"test\ntwo",
expression(x),
expression(y),
expression(x + y),
expression(a + b),
expression(atop(x + y, 2)))
grid.newpage()
nrowcol <- n2mfrow(length(tests))
pushViewport(viewport(layout=grid.layout(nrowcol[1], nrowcol[2]),
gp=gpar(cex=5, lwd=.5)))
for (i in 1:length(tests)) {
col <- (i - 1) %% nrowcol[2] + 1
row <- (i - 1) %/% nrowcol[2] + 1
pushViewport(viewport(layout.pos.row=row, layout.pos.col=col))
test(tests[[i]])
popViewport()
}
</code><code class="language-r">grid.newpage<span class="token punctuation">(</span><span class="token punctuation">)</span>
grid.segments<span class="token punctuation">(</span><span class="token number">.01</span><span class="token punctuation">,</span> <span class="token number">.5</span><span class="token punctuation">,</span> <span class="token number">.99</span><span class="token punctuation">,</span> <span class="token number">.5</span><span class="token punctuation">,</span> gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span><span class="token string">"grey"</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
metrics <span class="token operator"><-</span> calcStringMetric<span class="token punctuation">(</span>letters<span class="token punctuation">)</span>
grid.rect<span class="token punctuation">(</span>x<span class="token operator">=</span><span class="token number">1</span><span class="token operator">:</span><span class="token number">26</span><span class="token operator">/</span><span class="token number">27</span><span class="token punctuation">,</span>
width<span class="token operator">=</span>unit<span class="token punctuation">(</span>metrics<span class="token operator">$</span>width<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
height<span class="token operator">=</span>unit<span class="token punctuation">(</span>metrics<span class="token operator">$</span>ascent<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
just<span class="token operator">=</span><span class="token string">"bottom"</span><span class="token punctuation">,</span>
gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span><span class="token string">"red"</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.rect<span class="token punctuation">(</span>x<span class="token operator">=</span><span class="token number">1</span><span class="token operator">:</span><span class="token number">26</span><span class="token operator">/</span><span class="token number">27</span><span class="token punctuation">,</span>
width<span class="token operator">=</span>unit<span class="token punctuation">(</span>metrics<span class="token operator">$</span>width<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
height<span class="token operator">=</span>unit<span class="token punctuation">(</span>metrics<span class="token operator">$</span>descent<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
just<span class="token operator">=</span><span class="token string">"top"</span><span class="token punctuation">,</span>
gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span><span class="token string">"red"</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.text<span class="token punctuation">(</span>letters<span class="token punctuation">,</span> x<span class="token operator">=</span><span class="token number">1</span><span class="token operator">:</span><span class="token number">26</span><span class="token operator">/</span><span class="token number">27</span><span class="token punctuation">,</span> just<span class="token operator">=</span><span class="token string">"bottom"</span><span class="token punctuation">)</span>
test <span class="token operator"><-</span> <span class="token keyword">function</span><span class="token punctuation">(</span>x<span class="token punctuation">)</span> <span class="token punctuation">{</span>
grid.text<span class="token punctuation">(</span>x<span class="token punctuation">,</span> just<span class="token operator">=</span><span class="token string">"bottom"</span><span class="token punctuation">)</span>
metric <span class="token operator"><-</span> calcStringMetric<span class="token punctuation">(</span>x<span class="token punctuation">)</span>
<span class="token keyword">if</span> <span class="token punctuation">(</span>is.character<span class="token punctuation">(</span>x<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
grid.rect<span class="token punctuation">(</span>width<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>width<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
height<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>ascent<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
just<span class="token operator">=</span><span class="token string">"bottom"</span><span class="token punctuation">,</span>
gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span>rgb<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">.5</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.rect<span class="token punctuation">(</span>width<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>width<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
height<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>descent<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
just<span class="token operator">=</span><span class="token string">"top"</span><span class="token punctuation">,</span>
gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span>rgb<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">.5</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span> <span class="token keyword">else</span> <span class="token punctuation">{</span>
grid.rect<span class="token punctuation">(</span>width<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>width<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
y<span class="token operator">=</span>unit<span class="token punctuation">(</span><span class="token number">.5</span><span class="token punctuation">,</span> <span class="token string">"npc"</span><span class="token punctuation">)</span> <span class="token operator">+</span> unit<span class="token punctuation">(</span>metric<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
height<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>ascent<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
just<span class="token operator">=</span><span class="token string">"bottom"</span><span class="token punctuation">,</span>
gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span>rgb<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">.5</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.rect<span class="token punctuation">(</span>width<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>width<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
height<span class="token operator">=</span>unit<span class="token punctuation">(</span>metric<span class="token operator">$</span>descent<span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
just<span class="token operator">=</span><span class="token string">"bottom"</span><span class="token punctuation">,</span>
gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>col<span class="token operator">=</span>rgb<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">0</span><span class="token punctuation">,</span><span class="token number">.5</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span>
<span class="token punctuation">}</span>
tests <span class="token operator"><-</span> list<span class="token punctuation">(</span><span class="token string">"t"</span><span class="token punctuation">,</span>
<span class="token string">"test"</span><span class="token punctuation">,</span>
<span class="token string">"testy"</span><span class="token punctuation">,</span>
<span class="token string">"test\ntwo"</span><span class="token punctuation">,</span>
expression<span class="token punctuation">(</span>x<span class="token punctuation">)</span><span class="token punctuation">,</span>
expression<span class="token punctuation">(</span>y<span class="token punctuation">)</span><span class="token punctuation">,</span>
expression<span class="token punctuation">(</span>x <span class="token operator">+</span> y<span class="token punctuation">)</span><span class="token punctuation">,</span>
expression<span class="token punctuation">(</span>a <span class="token operator">+</span> b<span class="token punctuation">)</span><span class="token punctuation">,</span>
expression<span class="token punctuation">(</span>atop<span class="token punctuation">(</span>x <span class="token operator">+</span> y<span class="token punctuation">,</span> <span class="token number">2</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.newpage<span class="token punctuation">(</span><span class="token punctuation">)</span>
nrowcol <span class="token operator"><-</span> n2mfrow<span class="token punctuation">(</span>length<span class="token punctuation">(</span>tests<span class="token punctuation">)</span><span class="token punctuation">)</span>
pushViewport<span class="token punctuation">(</span>viewport<span class="token punctuation">(</span>layout<span class="token operator">=</span>grid.layout<span class="token punctuation">(</span>nrowcol<span class="token punctuation">[</span><span class="token number">1</span><span class="token punctuation">]</span><span class="token punctuation">,</span> nrowcol<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">,</span>
gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>cex<span class="token operator">=</span><span class="token number">5</span><span class="token punctuation">,</span> lwd<span class="token operator">=</span><span class="token number">.5</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
<span class="token keyword">for</span> <span class="token punctuation">(</span>i <span class="token keyword">in</span> <span class="token number">1</span><span class="token operator">:</span>length<span class="token punctuation">(</span>tests<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">{</span>
col <span class="token operator"><-</span> <span class="token punctuation">(</span>i <span class="token operator">-</span> <span class="token number">1</span><span class="token punctuation">)</span> <span class="token percent-operator operator">%%</span> nrowcol<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span> <span class="token operator">+</span> <span class="token number">1</span>
row <span class="token operator"><-</span> <span class="token punctuation">(</span>i <span class="token operator">-</span> <span class="token number">1</span><span class="token punctuation">)</span> <span class="token percent-operator operator">%/%</span> nrowcol<span class="token punctuation">[</span><span class="token number">2</span><span class="token punctuation">]</span> <span class="token operator">+</span> <span class="token number">1</span>
pushViewport<span class="token punctuation">(</span>viewport<span class="token punctuation">(</span>layout.pos.row<span class="token operator">=</span>row<span class="token punctuation">,</span> layout.pos.col<span class="token operator">=</span>col<span class="token punctuation">)</span><span class="token punctuation">)</span>
test<span class="token punctuation">(</span>tests<span class="token punctuation">[</span><span class="token punctuation">[</span>i<span class="token punctuation">]</span><span class="token punctuation">]</span><span class="token punctuation">)</span>
popViewport<span class="token punctuation">(</span><span class="token punctuation">)</span>
<span class="token punctuation">}</span></code></pre>
<hr>
</div></div>
<div class="container manual-page" id="dataViewport"><div class="page-main">
<a href="#dataViewport" class="help-page-title"><h2> Create a Viewport with Scales based on Data </h2></a>
<h3>Description</h3>
<p>This is a convenience function for producing a viewport with
x- and/or y-scales based on numeric values passed to the function.
</p>
<h3>Usage</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">dataViewport(xData = NULL, yData = NULL, xscale = NULL,
yscale = NULL, extension = 0.05, ...)
</code><code class="language-r">dataViewport<span class="token punctuation">(</span>xData <span class="token operator">=</span> <span class="token keyword">NULL</span><span class="token punctuation">,</span> yData <span class="token operator">=</span> <span class="token keyword">NULL</span><span class="token punctuation">,</span> xscale <span class="token operator">=</span> <span class="token keyword">NULL</span><span class="token punctuation">,</span>
yscale <span class="token operator">=</span> <span class="token keyword">NULL</span><span class="token punctuation">,</span> extension <span class="token operator">=</span> <span class="token number">0.05</span><span class="token punctuation">,</span> <span class="token ellipsis">...</span><span class="token punctuation">)</span></code></pre>
<h3 class="r-arguments-title">Arguments</h3>
<table>
<tr>
<td><code id="xData">xData</code></td>
<td>
<p> A numeric vector of data. </p>
</td>
</tr>
<tr>
<td><code id="yData">yData</code></td>
<td>
<p> A numeric vector of data. </p>
</td>
</tr>
<tr>
<td><code id="xscale">xscale</code></td>
<td>
<p> A numeric vector (length 2). </p>
</td>
</tr>
<tr>
<td><code id="yscale">yscale</code></td>
<td>
<p> A numeric vector (length 2). </p>
</td>
</tr>
<tr>
<td><code id="extension">extension</code></td>
<td>
<p> A numeric. If length greater than 1, then
first value is used to extend the xscale and second value
is used to extend the yscale.
</p>
</td>
</tr>
<tr>
<td><code id="...">...</code></td>
<td>
<p> All other arguments will be passed to a call to
the <code>viewport()</code> function. </p>
</td>
</tr>
</table>
<h3>Details</h3>
<p>If <code>xscale</code> is not specified then the values in <code>x</code> are
used to generate an x-scale based on the range of <code>x</code>, extended
by the proportion specified in <code>extension</code>. Similarly for the
y-scale.
</p>
<h3>Value</h3>
<p>A grid viewport object.
</p>
<h3>Author(s)</h3>
<p> Paul Murrell </p>
<h3>See Also</h3>
<p><code><a href="#viewport">viewport</a></code> and
<code><a href="#plotViewport">plotViewport</a></code>.
</p>
<hr>
</div></div>
<div class="container manual-page" id="depth"><div class="page-main">
<a href="#depth" class="help-page-title"><h2>
Determine the number of levels in an object
</h2></a>
<h3>Description</h3>
<p>Determine the number of levels in a viewport stack or tree,
in a viewport path, or in a grob path.
</p>
<h3>Usage</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">depth(x, ...)
## S3 method for class 'viewport'
depth(x, ...)
## S3 method for class 'path'
depth(x, ...)
</code><code class="language-r">depth<span class="token punctuation">(</span>x<span class="token punctuation">,</span> <span class="token ellipsis">...</span><span class="token punctuation">)</span>
<span class="token comment">## S3 method for class 'viewport'</span>
depth<span class="token punctuation">(</span>x<span class="token punctuation">,</span> <span class="token ellipsis">...</span><span class="token punctuation">)</span>
<span class="token comment">## S3 method for class 'path'</span>
depth<span class="token punctuation">(</span>x<span class="token punctuation">,</span> <span class="token ellipsis">...</span><span class="token punctuation">)</span></code></pre>
<h3 class="r-arguments-title">Arguments</h3>
<table>
<tr>
<td><code id="x">x</code></td>
<td>
<p>Typically a viewport or viewport stack or viewport tree or viewport
list, or a viewport path, or a grob path.
</p>
</td>
</tr>
<tr>
<td><code id="...">...</code></td>
<td>
<p> Arguments used by other methods. </p>
</td>
</tr>
</table>
<h3>Details</h3>
<p>Depths of paths are pretty straightforward because they contain
no branchings. The depth of a viewport stack is the sum of the depths
of the components of the stack. The depth of a viewport tree is
the depth of the parent plus the depth of the children.
The depth of a viewport list is the depth of the last component
of the list.
</p>
<h3>Value</h3>
<p>An integer value.
</p>
<h3>See Also</h3>
<p><code><a href="#viewport">viewport</a></code>, <code><a href="#vpPath">vpPath</a></code>, <code><a href="#gPath">gPath</a></code>.
</p>
<h3>Examples</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">vp <- viewport()
depth(vp)
depth(vpStack(vp, vp))
depth(vpList(vpStack(vp, vp), vp))
depth(vpPath("vp"))
depth(vpPath("vp1", "vp2"))
</code><code class="language-r">vp <span class="token operator"><-</span> viewport<span class="token punctuation">(</span><span class="token punctuation">)</span>
depth<span class="token punctuation">(</span>vp<span class="token punctuation">)</span>
depth<span class="token punctuation">(</span>vpStack<span class="token punctuation">(</span>vp<span class="token punctuation">,</span> vp<span class="token punctuation">)</span><span class="token punctuation">)</span>
depth<span class="token punctuation">(</span>vpList<span class="token punctuation">(</span>vpStack<span class="token punctuation">(</span>vp<span class="token punctuation">,</span> vp<span class="token punctuation">)</span><span class="token punctuation">,</span> vp<span class="token punctuation">)</span><span class="token punctuation">)</span>
depth<span class="token punctuation">(</span>vpPath<span class="token punctuation">(</span><span class="token string">"vp"</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
depth<span class="token punctuation">(</span>vpPath<span class="token punctuation">(</span><span class="token string">"vp1"</span><span class="token punctuation">,</span> <span class="token string">"vp2"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code></pre>
<hr>
</div></div>
<div class="container manual-page" id="deviceLoc"><div class="page-main">
<a href="#deviceLoc" class="help-page-title"><h2> Convert Viewport Location to Device Location </h2></a>
<h3>Description</h3>
<p>These functions take a pair of unit objects and convert
them to a pair of device locations (or dimensions) in inches
(or native device coordinates).
</p>
<h3>Usage</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">deviceLoc(x, y, valueOnly = FALSE, device = FALSE)
deviceDim(w, h, valueOnly = FALSE, device = FALSE)
</code><code class="language-r">deviceLoc<span class="token punctuation">(</span>x<span class="token punctuation">,</span> y<span class="token punctuation">,</span> valueOnly <span class="token operator">=</span> <span class="token boolean">FALSE</span><span class="token punctuation">,</span> device <span class="token operator">=</span> <span class="token boolean">FALSE</span><span class="token punctuation">)</span>
deviceDim<span class="token punctuation">(</span>w<span class="token punctuation">,</span> h<span class="token punctuation">,</span> valueOnly <span class="token operator">=</span> <span class="token boolean">FALSE</span><span class="token punctuation">,</span> device <span class="token operator">=</span> <span class="token boolean">FALSE</span><span class="token punctuation">)</span></code></pre>
<h3 class="r-arguments-title">Arguments</h3>
<table>
<tr>
<td>
<code id="x">x</code>, <code id="y">y</code>, <code id="w">w</code>, <code id="h">h</code>
</td>
<td>
<p> A unit object. </p>
</td>
</tr>
<tr>
<td><code id="valueOnly">valueOnly</code></td>
<td>
<p> A logical indicating. If <code>TRUE</code> then
the function does not return a unit object, but rather only the
converted numeric values. </p>
</td>
</tr>
<tr>
<td><code id="device">device</code></td>
<td>
<p> A logical indicating whether the returned values should
be in inches or native device units. </p>
</td>
</tr>
</table>
<h3>Details</h3>
<p>These functions differ from the functions like <code>convertX()</code>
because they convert from the coordinate systems within a viewport
to inches on the device (i.e., from one viewport to another) and
because they only deal with pairs of values (locations or dimensions).
</p>
<p>The functions like <code>convertX()</code> convert between different units within
the same viewport and convert along a single dimension.
</p>
<h3>Value</h3>
<p>A list with two components, both of which are unit object in inches
(unless <code>valueOnly</code> is <code>TRUE</code> in which case
both components are numeric).
</p>
<h3>Warning</h3>
<p>The conversion is only valid for the current device size.
If the device is resized then at least some conversions will
become invalid.
</p>
<p>Furthermore, the returned value only makes sense with respect to
the entire device (i.e., within the context of the root viewport).
</p>
<h3>Author(s)</h3>
<p> Paul Murrell </p>
<h3>See Also</h3>
<p><code><a href="#unit">unit</a></code> </p>
<h3>Examples</h3>
<pre class="language-r"><code class="language-r-input" hidden="hidden">## A tautology
grid.newpage()
pushViewport(viewport())
deviceLoc(unit(1, "inches"), unit(1, "inches"))
## Something less obvious
grid.newpage()
pushViewport(viewport(width=.5, height=.5))
grid.rect()
x <- unit(1, "in")
y <- unit(1, "in")
grid.circle(x, y, r=unit(2, "mm"))
loc <- deviceLoc(x, y)
loc
upViewport()
grid.circle(loc$x, loc$y, r=unit(1, "mm"), gp=gpar(fill="black"))
## Something even less obvious
grid.newpage()
pushViewport(viewport(width=.5, height=.5, angle=30))
grid.rect()
x <- unit(.2, "npc")
y <- unit(2, "in")
grid.circle(x, y, r=unit(2, "mm"))
loc <- deviceLoc(x, y)
loc
upViewport()
grid.circle(loc$x, loc$y, r=unit(1, "mm"), gp=gpar(fill="black"))
</code><code class="language-r"><span class="token comment">## A tautology</span>
grid.newpage<span class="token punctuation">(</span><span class="token punctuation">)</span>
pushViewport<span class="token punctuation">(</span>viewport<span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
deviceLoc<span class="token punctuation">(</span>unit<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">,</span> unit<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">"inches"</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
<span class="token comment">## Something less obvious</span>
grid.newpage<span class="token punctuation">(</span><span class="token punctuation">)</span>
pushViewport<span class="token punctuation">(</span>viewport<span class="token punctuation">(</span>width<span class="token operator">=</span><span class="token number">.5</span><span class="token punctuation">,</span> height<span class="token operator">=</span><span class="token number">.5</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.rect<span class="token punctuation">(</span><span class="token punctuation">)</span>
x <span class="token operator"><-</span> unit<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">"in"</span><span class="token punctuation">)</span>
y <span class="token operator"><-</span> unit<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">"in"</span><span class="token punctuation">)</span>
grid.circle<span class="token punctuation">(</span>x<span class="token punctuation">,</span> y<span class="token punctuation">,</span> r<span class="token operator">=</span>unit<span class="token punctuation">(</span><span class="token number">2</span><span class="token punctuation">,</span> <span class="token string">"mm"</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
loc <span class="token operator"><-</span> deviceLoc<span class="token punctuation">(</span>x<span class="token punctuation">,</span> y<span class="token punctuation">)</span>
loc
upViewport<span class="token punctuation">(</span><span class="token punctuation">)</span>
grid.circle<span class="token punctuation">(</span>loc<span class="token operator">$</span>x<span class="token punctuation">,</span> loc<span class="token operator">$</span>y<span class="token punctuation">,</span> r<span class="token operator">=</span>unit<span class="token punctuation">(</span><span class="token number">1</span><span class="token punctuation">,</span> <span class="token string">"mm"</span><span class="token punctuation">)</span><span class="token punctuation">,</span> gp<span class="token operator">=</span>gpar<span class="token punctuation">(</span>fill<span class="token operator">=</span><span class="token string">"black"</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
<span class="token comment">## Something even less obvious</span>
grid.newpage<span class="token punctuation">(</span><span class="token punctuation">)</span>
pushViewport<span class="token punctuation">(</span>viewport<span class="token punctuation">(</span>width<span class="token operator">=</span><span class="token number">.5</span><span class="token punctuation">,</span> height<span class="token operator">=</span><span class="token number">.5</span><span class="token punctuation">,</span> angle<span class="token operator">=</span><span class="token number">30</span><span class="token punctuation">)</span><span class="token punctuation">)</span>
grid.rect<span class="token punctuation">(</span><span class="token punctuation">)</span>
x <span class="token operator"><-</span> unit<span class="token punctuation">(</span><span class="token number">.2</span><span class="token punctuation">,</span> <span class="token string">"npc"</span><span class="token punctuation">)</span>