Interface

Workbench

You can access the Tutorial API by including rstudio.js within your host page. This will enable you to instantiate an RStudio object that has a connection to the RStudio Pro IDE within an iframe. For example, if the IDE were hosted in an iframe as follows:

<iframe id="rstudio" src="http://localhost:8787"></iframe>

Then you would instantiate an RStudio object as follows:

var RStudio = new RStudio(document.getElementById("rstudio"), 
   "http://localhost:8787",
   function() { // onReady callback
      console.log("API is ready!");
   },
   function(responseJSON) { // parent-notify callback
      console.log(responseJSON);
});

The third argument is a callback that will be invoked once the RStudio Pro API is ready to be called (i.e., once the IDE has loaded). Note that you should be sure to instantiate this object before the iframe containing the IDE is fully loaded (if you don’t then you might miss the onReady callback). The best way to do this is to either:

  1. Create the object immediately after defining the iframe within the host page; or

  2. More conservatively, create the iframe, then create the object, then provide the src to the iframe (this is however almost certainly not necessary and step 1 should suffice).

The fourth argument is a callback that will be invoked when certain events described in Tutorial API Callbacks are emitted by the IDE. These are only emitted if tutorial-api-parent-notify-enabled=1 was set as described earlier. The response will be a text string in JSON format, also described in Tutorial API Callbacks.

Back to top