😎 Give your xaringan slides some style
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

321 satır
14KB

  1. <!-- Generated by pkgdown: do not edit by hand -->
  2. <!DOCTYPE html>
  3. <html lang="en">
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge">
  7. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  8. <title>Get the Value of xaringanthemer Style Setting — theme_xaringan_get_value • xaringanthemer</title>
  9. <!-- favicons -->
  10. <link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png">
  11. <link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png">
  12. <link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png" />
  13. <link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png" />
  14. <link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png" />
  15. <link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png" />
  16. <!-- jquery -->
  17. <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.min.js" integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin="anonymous"></script>
  18. <!-- Bootstrap -->
  19. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/css/bootstrap.min.css" integrity="sha256-bZLfwXAP04zRMK2BjiO8iu9pf4FbLqX6zitd+tIvLhE=" crossorigin="anonymous" />
  20. <script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.4.1/js/bootstrap.min.js" integrity="sha256-nuL8/2cJ5NDSSwnKD8VqreErSWHtnEP9E7AySL+1ev4=" crossorigin="anonymous"></script>
  21. <!-- bootstrap-toc -->
  22. <link rel="stylesheet" href="../bootstrap-toc.css">
  23. <script src="../bootstrap-toc.js"></script>
  24. <!-- Font Awesome icons -->
  25. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css" integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk=" crossorigin="anonymous" />
  26. <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/v4-shims.min.css" integrity="sha256-wZjR52fzng1pJHwx4aV2AO3yyTOXrcDW7jBpJtTwVxw=" crossorigin="anonymous" />
  27. <!-- clipboard.js -->
  28. <script src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.6/clipboard.min.js" integrity="sha256-inc5kl9MA1hkeYUt+EC3BhlIgyp/2jDIyBLS6k3UxPI=" crossorigin="anonymous"></script>
  29. <!-- headroom.js -->
  30. <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/headroom.min.js" integrity="sha256-AsUX4SJE1+yuDu5+mAVzJbuYNPHj/WroHuZ8Ir/CkE0=" crossorigin="anonymous"></script>
  31. <script src="https://cdnjs.cloudflare.com/ajax/libs/headroom/0.11.0/jQuery.headroom.min.js" integrity="sha256-ZX/yNShbjqsohH1k95liqY9Gd8uOiE1S4vZc+9KQ1K4=" crossorigin="anonymous"></script>
  32. <!-- pkgdown -->
  33. <link href="../pkgdown.css" rel="stylesheet">
  34. <script src="../pkgdown.js"></script>
  35. <link href="../extra.css" rel="stylesheet">
  36. <meta property="og:title" content="Get the Value of xaringanthemer Style Setting — theme_xaringan_get_value" />
  37. <meta property="og:description" content="A helper function to retrieve the value of style settings as set by a
  38. xaringanthemer style function, for use in plotting and other circumstances." />
  39. <meta property="og:image" content="https://pkg.garrickadenbuie.com/xaringanthemer/logo.png" />
  40. <meta name="twitter:card" content="summary" />
  41. <meta name="twitter:creator" content="@grrrck" />
  42. <meta name="twitter:site" content="@grrrck" />
  43. <meta name="robots" content="noindex">
  44. <!-- mathjax -->
  45. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js" integrity="sha256-nvJJv9wWKEm88qvoQl9ekL2J+k/RWIsaSScxxlsrv8k=" crossorigin="anonymous"></script>
  46. <script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/config/TeX-AMS-MML_HTMLorMML.js" integrity="sha256-84DKXVJXs0/F8OTMzX4UR909+jtl4G7SPypPavF+GfA=" crossorigin="anonymous"></script>
  47. <!--[if lt IE 9]>
  48. <script src="https://oss.maxcdn.com/html5shiv/3.7.3/html5shiv.min.js"></script>
  49. <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  50. <![endif]-->
  51. </head>
  52. <body data-spy="scroll" data-target="#toc">
  53. <div class="container template-reference-topic">
  54. <header>
  55. <div class="navbar navbar-default navbar-fixed-top" role="navigation">
  56. <div class="container">
  57. <div class="navbar-header">
  58. <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false">
  59. <span class="sr-only">Toggle navigation</span>
  60. <span class="icon-bar"></span>
  61. <span class="icon-bar"></span>
  62. <span class="icon-bar"></span>
  63. </button>
  64. <span class="navbar-brand">
  65. <a class="navbar-link" href="../index.html">xaringanthemer</a>
  66. <span class="version label label-danger" data-toggle="tooltip" data-placement="bottom" title="In-development version">0.4.0.9000</span>
  67. </span>
  68. </div>
  69. <div id="navbar" class="navbar-collapse collapse">
  70. <ul class="nav navbar-nav">
  71. <li>
  72. <a href="../articles/xaringanthemer.html">Features</a>
  73. </li>
  74. <li>
  75. <a href="../reference/index.html">Reference</a>
  76. </li>
  77. <li>
  78. <a href="../articles/themes.html">Themes</a>
  79. </li>
  80. <li>
  81. <a href="../articles/ggplot2-themes.html">ggplot2 Themes</a>
  82. </li>
  83. <li class="dropdown">
  84. <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
  85. More
  86. <span class="caret"></span>
  87. </a>
  88. <ul class="dropdown-menu" role="menu">
  89. <li>
  90. <a href="../articles/fonts.html">Fonts</a>
  91. </li>
  92. <li>
  93. <a href="../articles/template-variables.html">Template Variables</a>
  94. </li>
  95. </ul>
  96. </li>
  97. </ul>
  98. <ul class="nav navbar-nav navbar-right">
  99. <li class="dropdown">
  100. <a href="#" class="dropdown-toggle" data-toggle="dropdown" role="button" aria-expanded="false">
  101. <span class="far fa-newspaper fa-lg"></span>
  102. <span class="caret"></span>
  103. </a>
  104. <ul class="dropdown-menu" role="menu">
  105. <li>
  106. <a href="https://garrickadenbuie.com/blog/xaringanthemer-v0-3-0/">xaringanthemer 0.3.0</a>
  107. </li>
  108. <li class="divider"></li>
  109. <li>
  110. <a href="../news/index.html">Changelog</a>
  111. </li>
  112. </ul>
  113. </li>
  114. <li>
  115. <a href="https://github.com/gadenbuie/xaringanthemer">
  116. <span class="fab fa-github fa-lg"></span>
  117. </a>
  118. </li>
  119. <li>
  120. <a href="https://twitter.com/grrrck">
  121. <span class="fab fa-twitter fa-lg"></span>
  122. </a>
  123. </li>
  124. <li>
  125. <a href="https://www.garrickadenbuie.com">
  126. <span class="fas fa-home fa-lg"></span>
  127. </a>
  128. </li>
  129. </ul>
  130. </div><!--/.nav-collapse -->
  131. </div><!--/.container -->
  132. </div><!--/.navbar -->
  133. </header>
  134. <div class="row">
  135. <div class="col-md-9 contents">
  136. <div class="page-header">
  137. <h1>Get the Value of xaringanthemer Style Setting</h1>
  138. <small class="dont-index">Source: <a href='https://github.com/gadenbuie/xaringanthemer/blob/master/R/ggplot2.R'><code>R/ggplot2.R</code></a></small>
  139. <div class="hidden name"><code>theme_xaringan_get_value.Rd</code></div>
  140. </div>
  141. <div class="ref-description">
  142. <p>A helper function to retrieve the value of style settings as set by a
  143. xaringanthemer style function, for use in plotting and other circumstances.</p>
  144. </div>
  145. <pre class="usage"><span class='fu'>theme_xaringan_get_value</span><span class='op'>(</span><span class='va'>setting</span>, css_file <span class='op'>=</span> <span class='cn'>NULL</span><span class='op'>)</span></pre>
  146. <h2 class="hasAnchor" id="arguments"><a class="anchor" href="#arguments"></a>Arguments</h2>
  147. <table class="ref-arguments">
  148. <colgroup><col class="name" /><col class="desc" /></colgroup>
  149. <tr>
  150. <th>setting</th>
  151. <td><p>A xaringanthemer style setting</p></td>
  152. </tr>
  153. <tr>
  154. <th>css_file</th>
  155. <td><p>Path to a <span class="pkg">xaringanthemer</span> CSS file, from which the
  156. theme variables and values will be inferred. In general, if you use the
  157. <span class="pkg">xaringathemer</span> defaults, you will not need to set this. This feature
  158. lets you create a <span class="pkg">ggplot2</span> theme for your <span class="pkg">xaringan</span> slides, even
  159. if you have only saved your theme CSS file and you aren't creating your
  160. CSS theme with <span class="pkg">xaringanthemer</span> in your slides' source file.</p></td>
  161. </tr>
  162. </table>
  163. <h2 class="hasAnchor" id="value"><a class="anchor" href="#value"></a>Value</h2>
  164. <p>The value of the xaringanthemer style parameter.</p>
  165. <h2 class="hasAnchor" id="style-settings"><a class="anchor" href="#style-settings"></a>Style Settings</h2>
  166. <p>Style settings used by xaringanthemer include:</p><ul>
  167. <li><p><code>background_color</code></p></li>
  168. <li><p><code>background_image</code></p></li>
  169. <li><p><code>background_position</code></p></li>
  170. <li><p><code>background_size</code></p></li>
  171. <li><p><code>blockquote_left_border_color</code></p></li>
  172. <li><p><code>code_font_family</code></p></li>
  173. <li><p><code>code_font_family_fallback</code></p></li>
  174. <li><p><code>code_font_google</code></p></li>
  175. <li><p><code>code_font_is_google</code></p></li>
  176. <li><p><code>code_font_size</code></p></li>
  177. <li><p><code>code_font_url</code></p></li>
  178. <li><p><code>code_highlight_color</code></p></li>
  179. <li><p><code>code_inline_background_color</code></p></li>
  180. <li><p><code>code_inline_color</code></p></li>
  181. <li><p><code>code_inline_font_size</code></p></li>
  182. <li><p><code>extra_css</code></p></li>
  183. <li><p><code>extra_fonts</code></p></li>
  184. <li><p><code>footnote_color</code></p></li>
  185. <li><p><code>footnote_font_size</code></p></li>
  186. <li><p><code>footnote_position_bottom</code></p></li>
  187. <li><p><code>header_background_auto</code></p></li>
  188. <li><p><code>header_background_color</code></p></li>
  189. <li><p><code>header_background_content_padding_top</code></p></li>
  190. <li><p><code>header_background_ignore_classes</code></p></li>
  191. <li><p><code>header_background_padding</code></p></li>
  192. <li><p><code>header_background_text_color</code></p></li>
  193. <li><p><code>header_color</code></p></li>
  194. <li><p><code>header_font_family</code></p></li>
  195. <li><p><code>header_font_google</code></p></li>
  196. <li><p><code>header_font_is_google</code></p></li>
  197. <li><p><code>header_font_url</code></p></li>
  198. <li><p><code>header_font_weight</code></p></li>
  199. <li><p><code>header_h1_font_size</code></p></li>
  200. <li><p><code>header_h2_font_size</code></p></li>
  201. <li><p><code>header_h3_font_size</code></p></li>
  202. <li><p><code>inverse_background_color</code></p></li>
  203. <li><p><code>inverse_header_color</code></p></li>
  204. <li><p><code>inverse_text_color</code></p></li>
  205. <li><p><code>inverse_text_shadow</code></p></li>
  206. <li><p><code>left_column_selected_color</code></p></li>
  207. <li><p><code>left_column_subtle_color</code></p></li>
  208. <li><p><code>link_color</code></p></li>
  209. <li><p><code>padding</code></p></li>
  210. <li><p><code>table_border_color</code></p></li>
  211. <li><p><code>table_row_border_color</code></p></li>
  212. <li><p><code>table_row_even_background_color</code></p></li>
  213. <li><p><code>text_bold_color</code></p></li>
  214. <li><p><code>text_color</code></p></li>
  215. <li><p><code>text_font_base</code></p></li>
  216. <li><p><code>text_font_family</code></p></li>
  217. <li><p><code>text_font_family_fallback</code></p></li>
  218. <li><p><code>text_font_google</code></p></li>
  219. <li><p><code>text_font_is_google</code></p></li>
  220. <li><p><code>text_font_size</code></p></li>
  221. <li><p><code>text_font_url</code></p></li>
  222. <li><p><code>text_font_weight</code></p></li>
  223. <li><p><code>text_slide_number_color</code></p></li>
  224. <li><p><code>text_slide_number_font_size</code></p></li>
  225. <li><p><code>title_slide_background_color</code></p></li>
  226. <li><p><code>title_slide_background_image</code></p></li>
  227. <li><p><code>title_slide_background_position</code></p></li>
  228. <li><p><code>title_slide_background_size</code></p></li>
  229. <li><p><code>title_slide_text_color</code></p></li>
  230. </ul>
  231. <h2 class="hasAnchor" id="examples"><a class="anchor" href="#examples"></a>Examples</h2>
  232. <pre class="examples"><span class='r-in'><span class='co'># Create a xaringanthemer style in a temporary file for this example</span></span>
  233. <span class='r-in'><span class='va'>xaringan_themer_css</span> <span class='op'>&lt;-</span> <span class='fu'><a href='https://rdrr.io/r/base/tempfile.html'>tempfile</a></span><span class='op'>(</span><span class='st'>"xaringan-themer"</span>, fileext <span class='op'>=</span> <span class='st'>".css"</span><span class='op'>)</span></span>
  234. <span class='r-in'></span>
  235. <span class='r-in'><span class='fu'><a href='style_solarized_light.html'>style_solarized_light</a></span><span class='op'>(</span>outfile <span class='op'>=</span> <span class='va'>xaringan_themer_css</span><span class='op'>)</span></span>
  236. <span class='r-in'></span>
  237. <span class='r-in'><span class='fu'>theme_xaringan_get_value</span><span class='op'>(</span><span class='st'>"text_color"</span><span class='op'>)</span></span>
  238. <span class='r-out co'><span class='r-pr'>#&gt;</span> [1] "#657b83"</span>
  239. <span class='r-in'><span class='fu'>theme_xaringan_get_value</span><span class='op'>(</span><span class='st'>"background_color"</span><span class='op'>)</span></span>
  240. <span class='r-out co'><span class='r-pr'>#&gt;</span> [1] "#fdf6e3"</span>
  241. <span class='r-in'><span class='fu'>theme_xaringan_get_value</span><span class='op'>(</span><span class='st'>"header_color"</span><span class='op'>)</span></span>
  242. <span class='r-out co'><span class='r-pr'>#&gt;</span> [1] "#dc322f"</span>
  243. <span class='r-in'><span class='fu'>theme_xaringan_get_value</span><span class='op'>(</span><span class='st'>"text_bold_color"</span><span class='op'>)</span></span>
  244. <span class='r-out co'><span class='r-pr'>#&gt;</span> [1] "#d33682"</span>
  245. <span class='r-in'></span>
  246. </pre>
  247. </div>
  248. <div class="col-md-3 hidden-xs hidden-sm" id="pkgdown-sidebar">
  249. <nav id="toc" data-toggle="toc" class="sticky-top">
  250. <h2 data-toc-skip>Contents</h2>
  251. </nav>
  252. </div>
  253. </div>
  254. <footer>
  255. <div class="copyright">
  256. <p>Developed by <a href='https://www.garrickadenbuie.com'>Garrick Aden-Buie</a>.</p>
  257. </div>
  258. <div class="pkgdown">
  259. <p>Site built with <a href="https://pkgdown.r-lib.org/">pkgdown</a> 1.6.1.</p>
  260. </div>
  261. </footer>
  262. </div>
  263. </body>
  264. </html>