stageParameters: Set stage parameters

In NGLVieweR: Interactive 3D Visualization of Molecular Structures

Set stage parameters

Description

Set stage parameters.

Usage

stageParameters(NGLVieweR, ...)

Arguments

NGLVieweR	A NGLVieweR object.
...	Options controlling the stage. Most common options are backgroundColor, rotateSpeed, zoomSpeed, hoverTimeout and lightIntensity. For a full list of options, see the "stageParameters" method in the official NGL.js manual.

Value

Returns list of stage parameters to NGLVieweR htmlwidgets object.

See Also

• updateStage()

• NGLVieweR_example() See example "basic".

Examples

NGLVieweR("7CID") %>%
 stageParameters(backgroundColor = "white", zoomSpeed = 1) %>%
 addRepresentation("cartoon", param = list(name = "cartoon", colorScheme="residueindex"))

if (interactive()) {
  library(shiny)
  ui <- fluidPage(NGLVieweROutput("structure"))
  server <- function(input, output) {
    output$structure <- renderNGLVieweR({
      NGLVieweR("7CID") %>%
        stageParameters(backgroundColor = "white", zoomSpeed = 1) %>%
        addRepresentation("cartoon",
          param = list(name = "cartoon", colorScheme = "residueindex")
        )
    })
  }
  shinyApp(ui, server)
}

NGLVieweR documentation built on April 4, 2025, 4:33 a.m.