Reference index in R

<!DOCTYPE html> <html> <head>  <meta charset="utf-8" /> <link rel="canonical" href="https://plotly.com/r/reference/index/" /> <link rel="preconnect" href="https://fonts.googleapis.com" /> <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin /> <link href="https://fonts.googleapis.com/css2?family=Roboto:ital,wght@1,500&display=swap" rel="stylesheet" />  <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <script src="/all_static/javascripts/algolia/instantsearch.js"></script> <script src="/all_static/javascripts/algolia/polyfill.min.js"></script> <script src="//ajax.googleapis.com/ajax/libs/jquery/2.2.0/jquery.min.js"></script> <script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script> <script> const theme = localStorage.getItem('theme'); if (theme === "dark-mode") { var root = document.getElementsByTagName('html')[0]; // '0' to assign the first (and only `HTML` tag) root.setAttribute('class', 'dark-mode'); } </script> <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" crossorigin="anonymous"> <script src="https://stackpath.bootstrapcdn.com/bootstrap/3.3.6/js/bootstrap.min.js" crossorigin="anonymous"></script> <link href="https://esm.sh/@markprompt/css@0.18.0?css" rel="stylesheet" /> <link href="/all_static/css/markprompt.css" rel="stylesheet" />   <link href="//fonts.googleapis.com/css?family=Open+Sans:400,300,300italic,400italic,600,600italic,700,700italic,800,800italic|Ubuntu+Mono:400,700|Asap" rel="stylesheet" type="text/css" /> <link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css" />  <link rel="stylesheet" type="text/css" href="/all_static/css/main.css?version=false" /> <link rel="stylesheet" type="text/css" href="/all_static/css/improve.css?version=2025-03-21-13-38">    <link rel="shortcut icon" href="https://dash.plotly.com/assets/favicon.ico" />   <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-N6T2RXG');</script>      <title> Reference index in R </title> <meta name="description" content=Figure attribute reference for Plotly's R open-source graphing library.>  <meta name="msvalidate.01" content="D319859A832F9F1D15A7646E2A42150A" />  <meta property="og:title" content= Reference index in R /> <meta property="og:type" content="website"/> <meta property="og:image" content="https://help.plot.ly/images/twitter-default.png"> <meta property="og:description" content=Figure attribute reference for Plotly's R open-source graphing library./> <meta property="og:url" /> <meta property="fb:admins" content="1123751525"/> <meta property="fb:admins" content="22418"/>  <meta name="twitter:card" content="photo" /> <meta name="twitter:title" content= Reference index in R /> <meta name="twitter:url" content="https://plotly.com//r/reference/index/"/> <meta name="twitter:description" content=Figure attribute reference for Plotly's R open-source graphing library./> <meta name="twitter:image" content="https://help.plot.ly/images/twitter-default.png"> <meta name="twitter:site" content="@plotlygraphs"/> </head> <body class="darkmode">  <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-N6T2RXG" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>  <div class="menu-mobile"> <div class="switch-mode"> <div class="icon-dark"></div> <div class="switch"></div> <div class="icon-light"></div> </div> <div class="close-menu"></div> <ul> <li><a style="font-weight: bold;" href="https://community.plotly.com/c/plotly-r-matlab-julia-net/29">Forum</a> </li> <li><a style="font-weight: bold;" href="https://plotly.com/get-pricing/">Pricing</a></li> <li><a style="font-weight: bold;" href="https://dash.plotly.com">Dash</a></li>  </ul> </div> <div class="header-container"> <header class="header-main --default"> <div class="--wrap"> <div class="--wrap-left"> <div class="-identity"> <a href="https://plotly.com/"><img src="/all_static/images/graphing_library_dark.svg" style="height: 30px;" class="logo-dark"></a> <a href="/graphing-libraries/"><img src="/all_static/images/graphing_library.svg" style="height: 30px;" class="logo-white"></a> </div> </div> <div class="--wrap-right"> <nav class="--nav-meta" role="navigation"> <ul> <li class="languages"> <a class="r"> <div class="icon"></div> R </a> <ul> <li> <a href="https://plotly.com/python/" class="python"> <div class="icon"></div>Python (v6.0.1) </a> </li> <li> <a href="https://plotly.com/r/" class="r"> <div class="icon"></div>R </a> </li> <li> <a href="https://plotly.com/julia/" class="julia"> <div class="icon"></div>Julia </a> </li> <li> <a href="https://plotly.com/javascript/" class="plotly_js"> <div class="icon"></div>Javascript (v3.0.1) </a> </li> <li> <a href="https://plotly.com/ggplot2/" class="ggplot2"> <div class="icon"></div>ggplot2 </a> </li> <li> <a href="https://plotly.com/matlab/" class="matlab"> <div class="icon"></div>MATLAB </a> </li> <li> <a href="https://plotly.com/fsharp/" class="fsharp"> <div class="icon"></div>F# </a> </li> <li> <a href="https://dash.plotly.com/" class="dash"> <div class="icon"></div>Dash </a> </li> </ul> </li> <li><a style="font-weight: bold;" href="https://community.plotly.com/c/plotly-r-matlab-julia-net/29">Forum</a> </li> <li><a style="font-weight: bold;" href="https://plotly.com/get-pricing/">Pricing</a></li> <li><a style="font-weight: bold;" href="https://dash.plotly.com">Dash</a></li>  <iframe src="https://ghbtns.com/github-btn.html?user=plotly&repo=plotly.R&type=star&count=true&size=large" style="padding-top: 5px;" frameborder="0" scrolling="0" width="160px" height="40px"></iframe> </ul> <div class="switch-mode"> <div class="icon-dark"></div> <div class="switch"></div> <div class="icon-light"></div> </div> </nav> </div> <div class="menu-icon"> <span></span><span></span><span></span> </div> </div> </header> </div> <main class="--page page--single --index"> <div class="--wrap">   <aside class="--sidebar-container"> <div class="--sidebar-fixed reference" data-spy="affix" id="where"> <div class="brand"> <a href="/graphing-libraries/"><img src="/all_static/images/graphing_library.svg" style="height: 30px;"></a> </div> <button id="modal-button" type="button" data-toggle="modal" data-target="#myModal"> <input id="modal-input" style="border-radius: 5px; width: 100%;" type="text" placeholder=" Search..." readonly /> </button> <details style="color: white; margin-top: 20px"> <summary>Simple Traces</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/scatter">Scatter</a> </li> <li class="--sidebar-item"> <a href="/r/reference/scattergl">Scatter GL</a> </li> <li class="--sidebar-item"> <a href="/r/reference/bar">Bar</a> </li> <li class="--sidebar-item"> <a href="/r/reference/pie">Pie</a> </li> <li class="--sidebar-item"> <a href="/r/reference/heatmap">Heatmap</a> </li> <li class="--sidebar-item"> <a href="/r/reference/heatmapgl">Heatmap GL</a> </li> <li class="--sidebar-item"> <a href="/r/reference/image">Image</a> </li> <li class="--sidebar-item"> <a href="/r/reference/contour">Contour</a> </li> <li class="--sidebar-item"> <a href="/r/reference/table">Table</a> </li> </ul> </nav> </details> <details style="color: white; margin-top: 20px"> <summary>Distribution Traces</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/box">Box</a> </li> <li class="--sidebar-item"> <a href="/r/reference/violin">Violin</a> </li> <li class="--sidebar-item"> <a href="/r/reference/histogram">Histogram</a> </li> <li class="--sidebar-item"> <a href="/r/reference/histogram2d">Histogram 2D</a> </li> <li class="--sidebar-item"> <a href="/r/reference/histogram2dcontour" >Histogram 2D Contour</a > </li> </ul> </nav> </details> <details style="color: white; margin-top: 20px"> <summary>Finance Traces</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/ohlc">OHLC</a> </li> <li class="--sidebar-item"> <a href="/r/reference/candlestick">Candlestick</a> </li> <li class="--sidebar-item"> <a href="/r/reference/waterfall">Waterfall</a> </li> <li class="--sidebar-item"> <a href="/r/reference/funnel">Funnel</a> </li> <li class="--sidebar-item"> <a href="/r/reference/funnelarea">Funnel Area</a> </li> <li class="--sidebar-item"> <a href="/r/reference/indicator">Indicator</a> </li> </ul> </nav> </details> <details style="color: white; margin-top: 20px"> <summary>3D Traces</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/scatter3d">Scatter 3D</a> </li> <li class="--sidebar-item"> <a href="/r/reference/surface">Surface</a> </li> <li class="--sidebar-item"> <a href="/r/reference/mesh3d">Mesh</a> </li> <li class="--sidebar-item"> <a href="/r/reference/cone">Cone</a> </li> <li class="--sidebar-item"> <a href="/r/reference/streamtube">Streamtube</a> </li> <li class="--sidebar-item"> <a href="/r/reference/volume">Volume</a> </li> <li class="--sidebar-item"> <a href="/r/reference/isosurface">Isosurface</a> </li> </ul> </nav> </details> <details style="color: white; margin-top: 20px"> <summary>Map Traces</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/scattergeo">Scatter Geo</a> </li> <li class="--sidebar-item"> <a href="/r/reference/choropleth">Choropleth</a> </li> <li class="--sidebar-item"> <a href="/r/reference/scattermap">Scatter Map</a> </li> <li class="--sidebar-item"> <a href="/r/reference/scattermapbox">Scatter Mapbox</a> </li> <li class="--sidebar-item"> <a href="/r/reference/choroplethmap">Choropleth Map</a> </li> <li class="--sidebar-item"> <a href="/r/reference/choroplethmapbox">Choropleth Mapbox</a> </li> <li class="--sidebar-item"> <a href="/r/reference/densitymap">Density Map</a> </li> <li class="--sidebar-item"> <a href="/r/reference/densitymapbox">Density Mapbox</a> </li> </ul> </nav> </details> <details style="color: white; margin-top: 20px"> <summary>Specialized Traces</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/scatterpolar">Scatter Polar</a> </li> <li class="--sidebar-item"> <a href="/r/reference/scatterpolargl">Scatter Polar GL</a> </li> <li class="--sidebar-item"> <a href="/r/reference/barpolar">Bar Polar</a> </li> <li class="--sidebar-item"> <a href="/r/reference/scatterternary">Scatter Ternary</a> </li> <li class="--sidebar-item"> <a href="/r/reference/scattersmith">Scatter Smith</a> </li> <li class="--sidebar-item"> <a href="/r/reference/sunburst">Sunburst</a> </li> <li class="--sidebar-item"> <a href="/r/reference/treemap">Treemap</a> </li> <li class="--sidebar-item"> <a href="/r/reference/icicle">Icicle</a> </li> <li class="--sidebar-item"> <a href="/r/reference/sankey">Sankey</a> </li> <li class="--sidebar-item"> <a href="/r/reference/splom">SPLOM</a> </li> <li class="--sidebar-item"> <a href="/r/reference/parcoords">Parallel Coordinates</a> </li> <li class="--sidebar-item"> <a href="/r/reference/parcats">Parallel Categories</a> </li> <li class="--sidebar-item"> <a href="/r/reference/carpet">Carpet</a> </li> <li class="--sidebar-item"> <a href="/r/reference/scattercarpet">Scatter Carpet</a> </li> <li class="--sidebar-item"> <a href="/r/reference/contourcarpet">Contour Carpet</a> </li> </ul> </nav> </details> <hr /> <details style="color: white; margin-top: 20px"> <summary>Layout</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/layout/">Title</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/#layout-showlegend">Legend</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/#layout-margin">Margins</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/#layout-autosize">Size</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/#layout-font">Fonts</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/#layout-paper_bgcolor" >Colors</a > </li> </ul> </nav> </details> <details style="color: white; margin-top: 20px"> <summary>Axes and Subplots</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/layout/xaxis/">X Axis</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/yaxis/">Y Axis</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/ternary/">Ternary</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/smith/">Smith</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/scene/">3D Scene</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/geo/">Geo</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/mapbox/">Mapbox</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/polar/">Polar</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/coloraxis/">Color Axis</a> </li> </ul> </nav> </details> <details style="color: white; margin-top: 20px"> <summary>Layers</summary> <nav class="--sidebar-body watch" id="where"> <ul class="--sidebar-list --ref"> <li class="--sidebar-item"> <a href="/r/reference/layout/annotations/">Annotations</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/shapes/">Shapes</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/selections/">Selections</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/images/">Images</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/sliders/">Sliders</a> </li> <li class="--sidebar-item"> <a href="/r/reference/layout/updatemenus/">Update Menus</a> </li> </ul> </nav> </details> </div> <a href="https://go.plotly.com/elevate-your-analytics?utm_source=Webinar:%20Dash%20Enterprise%205.7&utm_medium=graphing_libraries&utm_content=sidebar" target="_blank"> <img src="https://images.prismic.io/plotly-marketing-website-2/Z9mL0DiBA97Gimoh_Square_ads.jpg?auto=format,compress" style="width: 200px; height: 200px; position: fixed; bottom: 10px; left: 50px" alt="Sign up for the upcoming webinar: Elevate Your Analytics with Plotly Dash Enterprise 5.7"> </a> </aside>  <section class="--page-body --tutorial-index"> <div class="nav-breadcrumb-container"> <div> <div class="breadcrumb-nav"> <a href="/r"> R </a> > <a href="/r/reference/index/">Figure Reference</a> > <span>Reference Index</span> </div> </div> </div>  <h2>R Figure Reference</h2> <br /> <p>The pages linked in the sidebar together form the exhaustive reference for all of the attributes in the core figure data structure that the <code>plotly</code> library operates on. They are automatically-generated from the <a href="https://raw.githubusercontent.com/plotly/plotly.js/master/dist/plot-schema.json">machine-readable Plotly.js schema reference</a>.</p> <h3>How are Plotly attributes organized?</h3> <div class="row"> <p> <code>plotly</code> charts are described <i>declaratively</i> in the call signature of <code>plotly::plot_ly</code>, <code>plotly::add_trace</code>, and <code>plotly::layout</code>. Every aspect of a plotly chart (the colors, the grid-lines, the data, and so on) has a corresponding key in these call signatures. This page contains an extensive list of these attributes.<br><br> Plotly's graph description places attributes into two categories: traces (which describe a single series of data in a graph) and <code>layout</code> attributes that apply to the rest of the chart, like the <code>title</code>, <code>xaxis</code>, or <code>annotations</code>).<br><br> Here is a simple example of a plotly chart inlined with links to each attribute's reference section. <pre>library(plotly) p <- plot_ly(economics, type = "scatter", # all "scatter" attributes: https://plotly.com/r/reference/#scatter x = ~date, # more about scatter's "x": /r/reference/#scatter-x y = ~uempmed, # more about scatter's "y": /r/reference/#scatter-y name = "unemployment", # more about scatter's "name": /r/reference/#scatter-name marker = list( # marker is a named list, valid keys: /r/reference/#scatter-marker color="#264E86" # more about marker's "color" attribute: /r/reference/#scatter-marker-color )) %>% add_trace(x = ~date, # scatter's "x": /r/reference/#scatter-x y = ~fitted((loess(uempmed ~ as.numeric(date)))), # scatter's "y": /r/reference/#scatter-y mode = 'lines', # scatter's "y": /r/reference/#scatter-mode line = list( # line is a named list, valid keys: /r/reference/#scatter-line color = "#5E88FC", # line's "color": /r/reference/#scatter-line-color dash = "dashed" # line's "dash" property: /r/reference/#scatter-line-dash ) ) %>% layout( # all of layout's properties: /r/reference/#layout title = "Unemployment", # layout's title: /r/reference/#layout-title xaxis = list( # layout's xaxis is a named list. List of valid keys: /r/reference/#layout-xaxis title = "Time", # xaxis's title: /r/reference/#layout-xaxis-title showgrid = F), # xaxis's showgrid: /r/reference/#layout-xaxis-showgrid yaxis = list( # layout's yaxis is a named list. List of valid keys: /r/reference/#layout-yaxis title = "uidx") # yaxis's title: /r/reference/#layout-yaxis-title )</pre> </p> <hr> </div>  </section> </div> </main> <footer class="--footer-main"> <section class="--footer-top"> <div class="--wrap"> <ul class="--footer-body"> <li class="--footer-column"> <h6 style="color:#119dff" class="--footer-heading">JOIN OUR MAILING LIST</h6>			 <ul> 				 <li> <p class="subscribe-text"> Sign up to stay in the loop with all things Plotly — from Dash Club to product updates, webinars, and more!</p> <a href="https://go.plot.ly/subscription" class="subscribe-button" target="_blank"> Subscribe </a> </li> </ul> </li> 		 <li class="--footer-column"> <h6 style="color:#e763fa" class="--footer-heading">Products</h6>			 <ul> <li><a href="https://plotly.com/dash/" target="_self">Dash</a></li> 				 				 <li><a href="https://plotly.com/consulting-and-oem/" target="_self">Consulting and Training</a></li> </ul> </li> 		 <li class="--footer-column"> <h6 style="color:#636efa" class="--footer-heading">Pricing</h6>			 <ul> <li><a href="https://plotly.com/get-pricing/" target="_self">Enterprise Pricing</a></li> 				 </ul> </li> 		 <li class="--footer-column"> <h6 style="color:#00cc96" class="--footer-heading">About Us</h6>			 <ul> <li><a href="https://plotly.com/careers" target="_self">Careers</a></li> 				 <li><a href="https://plotly.com/resources/" target="_self">Resources</a></li> 				 <li><a href="https://medium.com/@plotlygraphs" target="_self">Blog</a></li> 				 </ul> </li> 		 <li class="--footer-column"> <h6 style="color:#EF553B" class="--footer-heading">Support</h6>			 <ul> <li><a href="https://community.plot.ly/" target="_self">Community Support</a></li> 				 <li><a href="https://plotly.com/graphing-libraries" target="_self">Documentation</a></li> 				 </ul> </li> </ul> </div> </section> <section class="--footer-meta"> <div class="--wrap"> <div class="left"> <article class="--copyright">Copyright © 2025 Plotly. All rights reserved.</article> </div> <div class="right"> <article class="--tos"><a href="https://community.plotly.com/tos" target="_blank">Terms of Service</a> </article> <article class="--privacy"><a href="https://plotly.com/privacy/" target="_blank">Privacy Policy</a> </article> </div> </div> <div id="markprompt" /> </section> </footer> <div class="modal" id="myModal" tabindex="-1" role="dialog" aria-labelledby="myModalLabel"> <div class="modal-dialog" role="document"> <div class="modal-content" id="modal-content"> <div class="modal-header"> <button type="button" class="close" data-dismiss="modal" aria-label="Close"><span aria-hidden="true">×</span></button> <span style="float: left; padding-top:13px; padding-right:10px;"><i class="fa fa-search fa-lg"></i></span> <input id="search-input" class="search-input" type="text" placeholder="" /> </div> <div class="modal-body" id="modal-body"> <div id="search-results" class="search-results"> <div id="primary-search-results" class="primary-search-results"></div> <div id="schema-search-results" class="schema-search-results"></div> </div> </div> </div> </div> </div> <script> window.plotly_doc_language = "r"; </script>  <script> window.ALGOLIA_CONFIG = { 'applicationId': '7EK9KHJW8M', 'indexName': 'r_docs', 'apiKey': '4dae07ded6a721de73bde7356eec9280', 'baseurl': '/' } </script> <script id="algolia__template" type="text/template"> <div class="algolia__result"> <a class="algolia__result-link" onClick="$('#myModal').modal('toggle')" href="/{{ permalink }}">{{{ _highlightResult.name.value }}}</a> <div class="algolia__result-text">{{{ _highlightResult.description.value }}}</div> </div> </script> <script id="algolia__secondary-template" type="text/template"> <div class="algolia__secondary-result"> <a class="algolia__result-link" onClick="$('#myModal').modal('toggle')" href="/{{ permalink }}">{{{ _highlightResult.name.value }}}</a> <div class="algolia__result-text">{{{ _highlightResult.description.value }}}</div> </div> </script> <script id="algolia__template--no-results" type="text/template">No results found.</script> <script src="//cdn.jsdelivr.net/hogan.js/3.0.2/hogan.min.js"></script> <script src="/all_static/javascripts/algolia/algolia.js"></script>  <script src="/all_static//javascripts/hash_offset.js"></script>  <script src="/all_static/javascripts/imghover.js"></script> <script src="/all_static/javascripts/improve.js?version=2025-03-21-13-38"></script>   <script src="/all_static/javascripts/highlight/highlight.min.js"></script> <script src="/all_static/javascripts/highlight/julia.min.js"></script> <script src="/all_static/javascripts/highlight.line-numbers.js"></script> </body> </html>

CINXE.COM

Reference index in R