rstudio-editors: Retrieve Information about an RStudio Editor
In rstudioapi: Safely Access the RStudio API

rstudio-editors

R Documentation

Retrieve Information about an RStudio Editor

Description

Returns information about an RStudio editor.

Usage

getActiveDocumentContext()

getSourceEditorContext(id = NULL)

getConsoleEditorContext()

Arguments

`id`	The ID of a particular document, as retrieved by `documentId()` or similar. Supported in RStudio 2022.06.0 or newer.

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.

rstudioapi documentation built on Oct. 23, 2024, 1:07 a.m.