File: sheetVisible.Rd

package info (click to toggle)
r-cran-openxlsx 4.2.8-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,328 kB
  • sloc: cpp: 1,867; makefile: 2
file content (38 lines) | stat: -rw-r--r-- 842 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/wrappers.R
\name{sheetVisible}
\alias{sheetVisible}
\alias{sheetVisible<-}
\title{Get worksheet visible state.}
\usage{
sheetVisible(wb)

sheetVisible(wb) <- value
}
\arguments{
\item{wb}{A workbook object}

\item{value}{a logical vector the same length as sheetVisible(wb)}
}
\value{
Character vector of worksheet names.

TRUE if sheet is visible, FALSE if sheet is hidden
}
\description{
DEPRECATED - Use function 'sheetVisibility()
}
\examples{

wb <- createWorkbook()
addWorksheet(wb, sheetName = "S1", visible = FALSE)
addWorksheet(wb, sheetName = "S2", visible = TRUE)
addWorksheet(wb, sheetName = "S3", visible = FALSE)

sheetVisible(wb)
sheetVisible(wb)[1] <- TRUE ## show sheet 1
sheetVisible(wb)[2] <- FALSE ## hide sheet 2
}
\author{
Alexander Walker
}