rstudio-editors: Retrieve Information about an RStudio Editor

Description Usage Details Value Note

Description

Returns information about an RStudio editor.

Usage

1
2
3
4
5

Details

The selection field returned is a list of document selection objects. A document selection is just a pairing of a document range, and the text within that range.

Value

A list with elements:

id The document ID.
path The path to the document on disk.
contents The contents of the document.
selection A list of selections. See Details for more information.

Note

The getActiveDocumentContext function was added with version 0.99.796 of RStudio, while the getSourceEditorContext and the getConsoleEditorContext functions were added with version 0.99.1111.


rstudio/rstudioapi documentation built on June 7, 2019, 3:43 p.m.