| Title: | Create Native 'Excel' Charts and Work with Microsoft 'Excel' Files |
| Version: | 0.0.2 |
| Maintainer: | Felix Luginbuhl <felix.luginbuhl@protonmail.ch> |
| Description: | An R interface to the 'OpenPyXL' 'Python' library to create native 'Excel' charts and work with Microsoft 'Excel' files. |
| URL: | https://felixluginbuhl.com/xlcharts/ |
| License: | MIT + file LICENSE |
| SystemRequirements: | Python (>= 2.7.0), Conda |
| BugReports: | https://github.com/lgnbhl/xlcharts/issues |
| Config/reticulate: | list( packages = list( list(package = "openpyxl") ) ) |
| Depends: | R (≥ 3.5) |
| Imports: | reticulate, writexl |
| Suggests: | testthat (≥ 3.0.0) |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.2.3 |
| Config/testthat/edition: | 3 |
| NeedsCompilation: | no |
| Packaged: | 2024-04-22 13:54:27 UTC; felix |
| Author: | Felix Luginbuhl 
[aut, cre, cph],
Eric Gazoni [ctb, cph] (Author of openpyxl (see AUTHORS and COPYRIGHT
files for details)),
Charlie Clark [ctb, cph] (Author of openpyxl (see AUTHORS and COPYRIGHT
files for details)),
openpyxl authors [ctb, cph] (Authors of openpyxl (see AUTHORS and
COPYRIGHT files for details)) |
| Repository: | CRAN |
| Date/Publication: | 2024-04-22 16:00:02 UTC |
AbsoluteAnchor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.spreadsheet_drawing.html
Usage
AbsoluteAnchor(pos = NULL, ext = NULL, ...)
Arguments
pos |
pos |
ext |
ext |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AbsoluteAnchor()
## End(Not run)
AdjPoint2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
AdjPoint2D(x = NULL, y = NULL, ...)
Arguments
x |
x |
y |
y |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AdjPoint2D(x = 1L, y = 2L)
## End(Not run)
AdjustHandleList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
AdjustHandleList(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AdjustHandleList()
## End(Not run)
Alignment
Description
Alignment options for use in styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.alignment.html
Usage
Alignment(
horizontal = NULL,
vertical = NULL,
textRotation = 0L,
wrapText = NULL,
shrinkToFit = NULL,
indent = 0L,
relativeIndent = 0L,
justifyLastLine = NULL,
readingOrder = 0L,
text_rotation = NULL,
wrap_text = NULL,
shrink_to_fit = NULL,
mergeCell = NULL,
...
)
Arguments
horizontal |
horizontal |
vertical |
vertical |
textRotation |
textRotation |
wrapText |
wrapText |
shrinkToFit |
shrinkToFit |
indent |
indent |
relativeIndent |
relativeIndent |
justifyLastLine |
justifyLastLine |
readingOrder |
readingOrder |
text_rotation |
text_rotation |
wrap_text |
wrap_text |
shrink_to_fit |
shrink_to_fit |
mergeCell |
mergeCell |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Alignment()
## End(Not run)
AlphaBiLevelEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
AlphaBiLevelEffect(thresh = NULL, ...)
Arguments
thresh |
thresh |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AlphaBiLevelEffect(thresh = 1L)
## End(Not run)
AlphaCeilingEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
AlphaCeilingEffect(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AlphaCeilingEffect()
## End(Not run)
AlphaFloorEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
AlphaFloorEffect(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AlphaFloorEffect()
## End(Not run)
AlphaInverseEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
AlphaInverseEffect(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AlphaInverseEffect()
## End(Not run)
AlphaModulateEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
AlphaModulateEffect(cont = NULL, ...)
Arguments
cont |
cont |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AlphaModulateEffect(cont = EffectContainer(type = "tree"))
## End(Not run)
AlphaModulateFixedEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
AlphaModulateFixedEffect(amt = NULL, ...)
Arguments
amt |
amt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AlphaModulateFixedEffect(amt = 1L)
## End(Not run)
AlphaReplaceEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
AlphaReplaceEffect(a = NULL, ...)
Arguments
a |
a |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AlphaReplaceEffect(a = 1L)
## End(Not run)
AnchorClientData
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.spreadsheet_drawing.html
Usage
AnchorClientData(fLocksWithSheet = NULL, fPrintsWithSheet = NULL, ...)
Arguments
fLocksWithSheet |
fLocksWithSheet |
fPrintsWithSheet |
fPrintsWithSheet |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AnchorClientData()
## End(Not run)
AnchorMarker
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.spreadsheet_drawing.html
Usage
AnchorMarker(col = 0L, colOff = 0L, row = 0L, rowOff = 0L, ...)
Arguments
col |
col |
colOff |
colOff |
row |
row |
rowOff |
rowOff |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AnchorMarker()
## End(Not run)
AreaChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.area_chart.html
Usage
AreaChart(axId = NULL, extLst = NULL, ...)
Arguments
axId |
axId |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AreaChart()
## End(Not run)
AreaChart3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.area_chart.html
Usage
AreaChart3D(gapDepth = NULL, ...)
Arguments
gapDepth |
gapDepth |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AreaChart3D()
## End(Not run)
ArrayDescriptor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.cell_style.html
Usage
ArrayDescriptor(key = NULL, ...)
Arguments
key |
key |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ArrayDescriptor()
## End(Not run)
ArrayFormula
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.formula.html
Usage
ArrayFormula(ref, text = NULL, ...)
Arguments
ref |
ref |
text |
text |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ArrayFormula(ref = "A1")
## End(Not run)
AuthorList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.comments.author.html
Usage
AuthorList(author = list(), ...)
Arguments
author |
author |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AuthorList(author = c("author1", "author2"))
## End(Not run)
AutoFilter
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
AutoFilter(
ref = NULL,
filterColumn = list(),
sortState = NULL,
extLst = NULL,
...
)
Arguments
ref |
ref |
filterColumn |
filterColumn |
sortState |
sortState |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AutoFilter()
## End(Not run)
AutonumberBullet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
AutonumberBullet(type = NULL, startAt = NULL, ...)
Arguments
type |
type |
startAt |
startAt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AutonumberBullet(type = "hindiNumPeriod", startAt = 1L)
## End(Not run)
AxDataSource
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
AxDataSource(
numRef = NULL,
numLit = NULL,
strRef = NULL,
strLit = NULL,
multiLvlStrRef = NULL,
...
)
Arguments
numRef |
numRef |
numLit |
numLit |
strRef |
strRef |
strLit |
strLit |
multiLvlStrRef |
multiLvlStrRef |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
AxDataSource(numRef = NumRef())
## End(Not run)
Backdrop
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Backdrop(anchor = NULL, norm = NULL, up = NULL, extLst = NULL, ...)
Arguments
anchor |
anchor |
norm |
norm |
up |
up |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Backdrop(
anchor = Point3D(x = 1L, y = 2L, z = 3L),
norm = Vector3D(dx = 1L, dy = 2L, dz = 3L),
up = Vector3D(dx = 1L, dy = 2L, dz = 3L)
)
## End(Not run)
BandFormat
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.surface_chart.html
Usage
BandFormat(idx = 0L, spPr = NULL, ...)
Arguments
idx |
idx |
spPr |
spPr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BandFormat()
## End(Not run)
BandFormatList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.surface_chart.html
Usage
BandFormatList(bandFmt = list(), ...)
Arguments
bandFmt |
bandFmt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BandFormatList()
## End(Not run)
BarChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.bar_chart.html
Usage
BarChart(gapWidth = 150L, overlap = NULL, serLines = NULL, extLst = NULL, ...)
Arguments
gapWidth |
gapWidth |
overlap |
overlap |
serLines |
serLines |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BarChart()
## End(Not run)
BarChart3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.bar_chart.html
Usage
BarChart3D(
gapWidth = 150L,
gapDepth = 150L,
shape = NULL,
serLines = NULL,
extLst = NULL,
...
)
Arguments
gapWidth |
gapWidth |
gapDepth |
gapDepth |
shape |
shape |
serLines |
serLines |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BarChart3D()
## End(Not run)
Bevel
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Bevel(w = NULL, h = NULL, prst = NULL, ...)
Arguments
w |
w integer |
h |
h integer |
prst |
prst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Bevel(w = 1L, h = 1L)
## End(Not run)
BiLevelEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
BiLevelEffect(thresh = NULL, ...)
Arguments
thresh |
thresh |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BiLevelEffect(thresh = 1L)
## End(Not run)
Blip
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
Blip(
cstate = NULL,
embed = NULL,
link = NULL,
noGrp = NULL,
noSelect = NULL,
noRot = NULL,
noChangeAspect = NULL,
noMove = NULL,
noResize = NULL,
noEditPoints = NULL,
noAdjustHandles = NULL,
noChangeArrowheads = NULL,
noChangeShapeType = NULL,
extLst = NULL,
alphaBiLevel = NULL,
alphaCeiling = NULL,
alphaFloor = NULL,
alphaInv = NULL,
alphaMod = NULL,
alphaModFix = NULL,
alphaRepl = NULL,
biLevel = NULL,
blur = NULL,
clrChange = NULL,
clrRepl = NULL,
duotone = NULL,
fillOverlay = NULL,
grayscl = NULL,
hsl = NULL,
lum = NULL,
tint = NULL,
...
)
Arguments
cstate |
cstate |
embed |
embed |
link |
link |
noGrp |
noGrp |
noSelect |
noSelect |
noRot |
noRot |
noChangeAspect |
noChangeAspect |
noMove |
noMove |
noResize |
noResize |
noEditPoints |
noEditPoints |
noAdjustHandles |
noAdjustHandles |
noChangeArrowheads |
noChangeArrowheads |
noChangeShapeType |
noChangeShapeType |
extLst |
extLst |
alphaBiLevel |
alphaBiLevel |
alphaCeiling |
alphaCeiling |
alphaFloor |
alphaFloor |
alphaInv |
alphaInv |
alphaMod |
alphaMod |
alphaModFix |
alphaModFix |
alphaRepl |
alphaRepl |
biLevel |
biLevel |
blur |
blur |
clrChange |
clrChange |
clrRepl |
clrRepl |
duotone |
duotone |
fillOverlay |
fillOverlay |
grayscl |
grayscl |
hsl |
hsl |
lum |
lum |
tint |
tint |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Blip()
## End(Not run)
BlipFillProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
BlipFillProperties(
dpi = NULL,
rotWithShape = NULL,
blip = NULL,
tile = NULL,
srcRect = NULL,
...
)
Arguments
dpi |
dpi |
rotWithShape |
rotWithShape |
blip |
blip |
tile |
tile |
srcRect |
srcRect |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BlipFillProperties()
## End(Not run)
BlurEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
BlurEffect(rad = NULL, grow = NULL, ...)
Arguments
rad |
rad |
grow |
grow |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BlurEffect(rad = 0.5)
## End(Not run)
BookView
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.views.html
Usage
BookView(
visibility = "visible",
minimized = FALSE,
showHorizontalScroll = TRUE,
showVerticalScroll = TRUE,
showSheetTabs = TRUE,
xWindow = NULL,
yWindow = NULL,
windowWidth = NULL,
windowHeight = NULL,
tabRatio = 600L,
firstSheet = 0L,
activeTab = 0L,
autoFilterDateGrouping = TRUE,
extLst = NULL,
...
)
Arguments
visibility |
visibility |
minimized |
minimized |
showHorizontalScroll |
showHorizontalScroll |
showVerticalScroll |
showVerticalScroll |
showSheetTabs |
showSheetTabs |
xWindow |
xWindow |
yWindow |
yWindow |
windowWidth |
windowWidth |
windowHeight |
windowHeight |
tabRatio |
tabRatio |
firstSheet |
firstSheet |
activeTab |
activeTab |
autoFilterDateGrouping |
autoFilterDateGrouping |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BookView()
## End(Not run)
Border
Description
Border positioning for use in styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.borders.html
Usage
Border(
left = NULL,
right = NULL,
top = NULL,
bottom = NULL,
diagonal = NULL,
diagonal_direction = NULL,
vertical = NULL,
horizontal = NULL,
diagonalUp = FALSE,
diagonalDown = FALSE,
outline = TRUE,
start = NULL,
end = NULL,
...
)
Arguments
left |
left |
right |
right |
top |
top |
bottom |
bottom |
diagonal |
diagonal |
diagonal_direction |
diagonal_direction |
vertical |
vertical |
horizontal |
horizontal |
diagonalUp |
diagonalUp |
diagonalDown |
diagonalDown |
outline |
outline |
start |
start |
end |
end |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Border()
## End(Not run)
Break
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.pagebreak.html
Usage
Break(id = 0L, min = 0L, max = 16383L, man = TRUE, pt = NULL, ...)
Arguments
id |
id |
min |
min |
max |
max |
man |
man |
pt |
pt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Break()
## End(Not run)
BubbleChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.bubble_chart.html
Usage
BubbleChart(
varyColors = NULL,
ser = list(),
dLbls = NULL,
bubble3D = NULL,
bubbleScale = NULL,
showNegBubbles = NULL,
sizeRepresents = NULL,
extLst = NULL,
...
)
Arguments
varyColors |
varyColors |
ser |
ser |
dLbls |
dLbls |
bubble3D |
bubble3D |
bubbleScale |
bubbleScale |
showNegBubbles |
showNegBubbles |
sizeRepresents |
sizeRepresents |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BubbleChart()
## End(Not run)
CalcProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.properties.html
Usage
CalcProperties(
calcId = 124519L,
calcMode = NULL,
fullCalcOnLoad = TRUE,
refMode = NULL,
iterate = NULL,
iterateCount = NULL,
iterateDelta = NULL,
fullPrecision = NULL,
calcCompleted = NULL,
calcOnSave = NULL,
concurrentCalc = NULL,
concurrentManualCount = NULL,
forceFullCalc = NULL,
...
)
Arguments
calcId |
calcId |
calcMode |
calcMode |
fullCalcOnLoad |
fullCalcOnLoad |
refMode |
refMode |
iterate |
iterate |
iterateCount |
iterateCount |
iterateDelta |
iterateDelta |
fullPrecision |
fullPrecision |
calcCompleted |
calcCompleted |
calcOnSave |
calcOnSave |
concurrentCalc |
concurrentCalc |
concurrentManualCount |
concurrentManualCount |
forceFullCalc |
forceFullCalc |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CalcProperties()
## End(Not run)
Camera
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Camera(prst = NULL, fov = NULL, zoom = NULL, rot = NULL, ...)
Arguments
prst |
prst |
fov |
fov |
zoom |
zoom |
rot |
rot |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Camera(prst = "perspectiveLeft")
## End(Not run)
Cell
Description
Describes cell associated properties.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.cell.html
Usage
Cell(
worksheet,
row = NULL,
column = NULL,
value = NULL,
style_array = NULL,
...
)
Arguments
worksheet |
worksheet |
row |
row |
column |
column |
value |
value |
style_array |
style_array |
... |
Additional arguments, i.e. kwargs. |
Details
Properties of interest include style, type, value, and address.
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- ws$active
Cell(worksheet = ws, row = 1L, column = 1L)
## End(Not run)
CellIsRule
Description
Conditional formatting rule based on cell contents.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
CellIsRule(
operator = NULL,
formula = list(),
stopIfTrue = NULL,
font = NULL,
border = NULL,
fill = NULL,
...
)
Arguments
operator |
operator |
formula |
formula as list |
stopIfTrue |
stopIfTrue |
font |
font |
border |
border |
fill |
fill |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellIsRule(operator = "equal")
## End(Not run)
CellRange
Description
Represents a range in a sheet: title and coordinates.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.cell_range.html
Usage
CellRange(
range_string = NULL,
min_col = NULL,
min_row = NULL,
max_col = NULL,
max_row = NULL,
title = NULL,
...
)
Arguments
range_string |
range_string |
min_col |
min_col |
min_row |
min_row |
max_col |
max_col |
max_row |
max_row |
title |
title |
... |
Additional arguments, i.e. kwargs. |
Details
This object is used to perform operations on ranges, like: - shift, expand or shrink - union/intersection with another sheet range, We can check whether a range is: - equal or not equal to another, - disjoint of another, - contained in another. We can get: - the size of a range. - the range bounds (vertices) - the coordinates, - the string representation,
Value
An openpyxl Python object.
Examples
## Not run:
CellRange(range_string = "A1")
## End(Not run)
CellSmartTag
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.smart_tag.html
Usage
CellSmartTag(
cellSmartTagPr = list(),
type = NULL,
deleted = FALSE,
xmlBased = FALSE,
...
)
Arguments
cellSmartTagPr |
cellSmartTagPr |
type |
type |
deleted |
deleted |
xmlBased |
xmlBased |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellSmartTag(type = 1L)
## End(Not run)
CellSmartTagPr
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.smart_tag.html
Usage
CellSmartTagPr(key = NULL, val = NULL, ...)
Arguments
key |
key |
val |
val |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellSmartTagPr(key = "key", val = "val")
## End(Not run)
CellSmartTags
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.smart_tag.html
Usage
CellSmartTags(cellSmartTag = list(), r = NULL, ...)
Arguments
cellSmartTag |
cellSmartTag |
r |
r |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellSmartTags(cellSmartTag = list(), r = "r")
## End(Not run)
CellStyle
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.cell_style.html
Usage
CellStyle(
numFmtId = 0L,
fontId = 0L,
fillId = 0L,
borderId = 0L,
xfId = NULL,
quotePrefix = NULL,
pivotButton = NULL,
applyNumberFormat = NULL,
applyFont = NULL,
applyFill = NULL,
applyBorder = NULL,
applyAlignment = NULL,
applyProtection = NULL,
alignment = NULL,
protection = NULL,
extLst = NULL,
...
)
Arguments
numFmtId |
numFmtId |
fontId |
fontId |
fillId |
fillId |
borderId |
borderId |
xfId |
xfId |
quotePrefix |
quotePrefix |
pivotButton |
pivotButton |
applyNumberFormat |
applyNumberFormat |
applyFont |
applyFont |
applyFill |
applyFill |
applyBorder |
applyBorder |
applyAlignment |
applyAlignment |
applyProtection |
applyProtection |
alignment |
alignment |
protection |
protection |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellStyle()
## End(Not run)
CellStyleList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.cell_style.html
Usage
CellStyleList(count = NULL, xf = list(), ...)
Arguments
count |
count |
xf |
xf |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellStyleList()
## End(Not run)
CellWatch
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.cell_watch.html
Usage
CellWatch(r = NULL, ...)
Arguments
r |
r |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellWatch(r = "r")
## End(Not run)
CellWatches
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.cell_watch.html
Usage
CellWatches(cellWatch = list(), ...)
Arguments
cellWatch |
cellWatch |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CellWatches()
## End(Not run)
CharacterProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
CharacterProperties(
kumimoji = NULL,
lang = NULL,
altLang = NULL,
sz = NULL,
b = NULL,
i = NULL,
u = NULL,
strike = NULL,
kern = NULL,
cap = NULL,
spc = NULL,
normalizeH = NULL,
baseline = NULL,
noProof = NULL,
dirty = NULL,
err = NULL,
smtClean = NULL,
smtId = NULL,
bmk = NULL,
ln = NULL,
highlight = NULL,
latin = NULL,
ea = NULL,
cs = NULL,
sym = NULL,
hlinkClick = NULL,
hlinkMouseOver = NULL,
rtl = NULL,
extLst = NULL,
noFill = NULL,
solidFill = NULL,
gradFill = NULL,
blipFill = NULL,
pattFill = NULL,
grpFill = NULL,
effectLst = NULL,
effectDag = NULL,
uLnTx = NULL,
uLn = NULL,
uFillTx = NULL,
uFill = NULL,
...
)
Arguments
kumimoji |
kumimoji |
lang |
lang |
altLang |
altLang |
sz |
sz |
b |
b |
i |
i |
u |
u |
strike |
strike |
kern |
kern |
cap |
cap |
spc |
spc |
normalizeH |
normalizeH |
baseline |
baseline |
noProof |
noProof |
dirty |
dirty |
err |
err |
smtClean |
smtClean |
smtId |
smtId |
bmk |
bmk |
ln |
ln |
highlight |
highlight |
latin |
latin |
ea |
ea |
cs |
cs |
sym |
sym |
hlinkClick |
hlinkClick |
hlinkMouseOver |
hlinkMouseOver |
rtl |
rtl |
extLst |
extLst |
noFill |
noFill |
solidFill |
solidFill |
gradFill |
gradFill |
blipFill |
blipFill |
pattFill |
pattFill |
grpFill |
grpFill |
effectLst |
effectLst |
effectDag |
effectDag |
uLnTx |
uLnTx |
uLn |
uLn |
uFillTx |
uFillTx |
uFill |
uFill |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CharacterProperties()
## End(Not run)
ChartContainer
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.chartspace.html
Usage
ChartContainer(
title = NULL,
autoTitleDeleted = NULL,
pivotFmts = list(),
view3D = NULL,
floor = NULL,
sideWall = NULL,
backWall = NULL,
plotArea = NULL,
legend = NULL,
plotVisOnly = TRUE,
dispBlanksAs = "gap",
showDLblsOverMax = NULL,
extLst = NULL,
...
)
Arguments
title |
title |
autoTitleDeleted |
autoTitleDeleted |
pivotFmts |
pivotFmts |
view3D |
view3D |
floor |
floor |
sideWall |
sideWall |
backWall |
backWall |
plotArea |
plotArea |
legend |
legend |
plotVisOnly |
plotVisOnly |
dispBlanksAs |
dispBlanksAs |
showDLblsOverMax |
showDLblsOverMax |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartContainer()
## End(Not run)
ChartLines
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
ChartLines(spPr = NULL, ...)
Arguments
spPr |
spPr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartLines()
## End(Not run)
ChartRelation
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.relation.html
Usage
ChartRelation(id, ...)
Arguments
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartRelation(id = "id")
## End(Not run)
ChartSpace
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.chartspace.html
Usage
ChartSpace(
date1904 = NULL,
lang = NULL,
roundedCorners = NULL,
style = NULL,
clrMapOvr = NULL,
pivotSource = NULL,
protection = NULL,
chart = NULL,
spPr = NULL,
txPr = NULL,
externalData = NULL,
printSettings = NULL,
userShapes = NULL,
extLst = NULL,
...
)
Arguments
date1904 |
date1904 |
lang |
lang |
roundedCorners |
roundedCorners |
style |
style |
clrMapOvr |
clrMapOvr |
pivotSource |
pivotSource |
protection |
protection |
chart |
chart |
spPr |
spPr |
txPr |
txPr |
externalData |
externalData |
printSettings |
printSettings |
userShapes |
userShapes |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartSpace(chart = ChartContainer())
## End(Not run)
Chartsheet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chartsheet.chartsheet.html
Usage
Chartsheet(
sheetPr = NULL,
sheetViews = NULL,
sheetProtection = NULL,
customSheetViews = NULL,
pageMargins = NULL,
pageSetup = NULL,
headerFooter = NULL,
drawing = NULL,
drawingHF = NULL,
picture = NULL,
webPublishItems = NULL,
extLst = NULL,
parent = NULL,
title = "",
sheet_state = "visible",
...
)
Arguments
sheetPr |
sheetPr |
sheetViews |
sheetViews |
sheetProtection |
sheetProtection |
customSheetViews |
customSheetViews |
pageMargins |
pageMargins |
pageSetup |
pageSetup |
headerFooter |
headerFooter |
drawing |
drawing |
drawingHF |
drawingHF |
picture |
picture |
webPublishItems |
webPublishItems |
extLst |
extLst |
parent |
parent |
title |
title |
sheet_state |
sheet_state |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Chartsheet()
## End(Not run)
ChartsheetProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chartsheet.properties.html
Usage
ChartsheetProperties(published = NULL, codeName = NULL, tabColor = NULL, ...)
Arguments
published |
published |
codeName |
codeName |
tabColor |
tabColor |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartsheetProperties()
## End(Not run)
ChartsheetProtection
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chartsheet.protection.html
Usage
ChartsheetProtection(
content = NULL,
objects = NULL,
hashValue = NULL,
spinCount = NULL,
saltValue = NULL,
algorithmName = NULL,
password = NULL,
...
)
Arguments
content |
content |
objects |
objects |
hashValue |
hashValue |
spinCount |
spinCount |
saltValue |
saltValue |
algorithmName |
algorithmName |
password |
password |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartsheetProtection()
## End(Not run)
ChartsheetView
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chartsheet.views.html
Usage
ChartsheetView(
tabSelected = NULL,
zoomScale = NULL,
workbookViewId = 0L,
zoomToFit = TRUE,
extLst = NULL,
...
)
Arguments
tabSelected |
tabSelected |
zoomScale |
zoomScale |
workbookViewId |
workbookViewId |
zoomToFit |
zoomToFit |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartsheetView()
## End(Not run)
ChartsheetViewList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chartsheet.views.html
Usage
ChartsheetViewList(sheetView = NULL, extLst = NULL, ...)
Arguments
sheetView |
sheetView |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ChartsheetViewList()
## End(Not run)
ColBreak
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.pagebreak.html
Usage
ColBreak(count = NULL, manualBreakCount = NULL, brk = list(), ...)
Arguments
count |
count |
manualBreakCount |
manualBreakCount |
brk |
brk |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColBreak()
## End(Not run)
ColRange
Description
Represent a range of at least one column
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.print_settings.html
Usage
ColRange(range_string = NULL, min_col = NULL, max_col = NULL, ...)
Arguments
range_string |
range_string |
min_col |
min_col |
max_col |
max_col |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColRange(range_string = "A:B")
## End(Not run)
Color
Description
Named colors for use in styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.colors.html
Usage
Color(
rgb = "00000000",
indexed = NULL,
auto = NULL,
theme = NULL,
tint = 0,
index = NULL,
type = "rgb",
...
)
Arguments
rgb |
rgb |
indexed |
indexed |
auto |
auto |
theme |
theme |
tint |
tint |
index |
index |
type |
type |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Color()
## End(Not run)
ColorChangeEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
ColorChangeEffect(useA = NULL, clrFrom = NULL, clrTo = NULL, ...)
Arguments
useA |
useA |
clrFrom |
clrFrom |
clrTo |
clrTo |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
# issue using xlcharts::Color() function as built from
# class 'openpyxl.styles.colors.Color' while
# ColorChangeEffect() arguments require 'openpyxl.drawing.effect.Color'
openpyxl <- reticulate::import("openpyxl")
ColorChangeEffect(
clrFrom = openpyxl$drawing$effect$Color(),
clrTo = openpyxl$drawing$effect$Color()
)
## End(Not run)
ColorChoice
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.colors.html
Usage
ColorChoice(
scrgbClr = NULL,
srgbClr = NULL,
hslClr = NULL,
sysClr = NULL,
schemeClr = NULL,
prstClr = NULL,
...
)
Arguments
scrgbClr |
scrgbClr |
srgbClr |
srgbClr |
hslClr |
hslClr |
sysClr |
sysClr |
schemeClr |
schemeClr |
prstClr |
prstClr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColorChoice()
## End(Not run)
ColorFilter
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
ColorFilter(dxfId = NULL, cellColor = NULL, ...)
Arguments
dxfId |
dxfId |
cellColor |
cellColor |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColorFilter()
## End(Not run)
ColorList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.colors.html
Usage
ColorList(indexedColors = list(), mruColors = list(), ...)
Arguments
indexedColors |
indexedColors |
mruColors |
mruColors |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColorList()
## End(Not run)
ColorMapping
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.colors.html
Usage
ColorMapping(
bg1 = "lt1",
tx1 = "dk1",
bg2 = "lt2",
tx2 = "dk2",
accent1 = "accent1",
accent2 = "accent2",
accent3 = "accent3",
accent4 = "accent4",
accent5 = "accent5",
accent6 = "accent6",
hlink = "hlink",
folHlink = "folHlink",
extLst = NULL,
...
)
Arguments
bg1 |
bg1 |
tx1 |
tx1 |
bg2 |
bg2 |
tx2 |
tx2 |
accent1 |
accent1 |
accent2 |
accent2 |
accent3 |
accent3 |
accent4 |
accent4 |
accent5 |
accent5 |
accent6 |
accent6 |
hlink |
hlink |
folHlink |
folHlink |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColorMapping()
## End(Not run)
ColorReplaceEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
ColorReplaceEffect(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColorReplaceEffect()
## End(Not run)
ColorScale
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
ColorScale(cfvo = NULL, color = NULL, ...)
Arguments
cfvo |
cfvo |
color |
color |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
first <- FormatObject(type = 'min')
last <- FormatObject(type = 'max')
# colors match the format objects:
colors <- list(Color('AA0000'), Color('00AA00'))
cs2 <- ColorScale(cfvo = list(first, last), color = colors)
## End(Not run)
ColorScaleRule
Description
Backwards compatibility
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
ColorScaleRule(
start_type = NULL,
start_value = NULL,
start_color = NULL,
mid_type = NULL,
mid_value = NULL,
mid_color = NULL,
end_type = NULL,
end_value = NULL,
end_color = NULL,
...
)
Arguments
start_type |
start_type |
start_value |
start_value |
start_color |
start_color |
mid_type |
mid_type |
mid_value |
mid_value |
mid_color |
mid_color |
end_type |
end_type |
end_value |
end_value |
end_color |
end_color |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ColorScaleRule(
start_type='percentile', start_value=10, start_color='FFAA0000',
mid_type='percentile', mid_value=50, mid_color='FF0000AA',
end_type='percentile', end_value=90, end_color='FF00AA00')
## End(Not run)
ColumnDimension
Description
Information about the display properties of a column.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.dimensions.html
Usage
ColumnDimension(
worksheet,
index = "A",
width = 13L,
bestFit = FALSE,
hidden = FALSE,
outlineLevel = 0L,
outline_level = NULL,
collapsed = FALSE,
style = NULL,
min = NULL,
max = NULL,
customWidth = FALSE,
visible = NULL,
auto_size = NULL,
...
)
Arguments
worksheet |
worksheet |
index |
index |
width |
width |
bestFit |
bestFit |
|
hidden | |
outlineLevel |
outlineLevel |
outline_level |
outline_level |
collapsed |
collapsed |
style |
style |
min |
min |
max |
max |
customWidth |
customWidth |
visible |
visible |
auto_size |
auto_size |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- wb$active
ColumnDimension(worksheet = ws)
## End(Not run)
Comment
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.comments.comments.html
Usage
Comment(text, author, height = 79L, width = 144L, ...)
Arguments
text |
text |
author |
author |
height |
height |
width |
width |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Comment(text = "text", author = "author")
## End(Not run)
CommentRecord
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.comments.comment_sheet.html
Usage
CommentRecord(
ref = "",
authorId = 0L,
guid = NULL,
shapeId = 0L,
text = NULL,
commentPr = NULL,
author = NULL,
height = 79L,
width = 144L,
...
)
Arguments
ref |
ref |
authorId |
authorId |
guid |
guid |
shapeId |
shapeId |
text |
text |
commentPr |
commentPr |
author |
author |
height |
height |
width |
width |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CommentRecord()
## End(Not run)
CommentSheet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.comments.comment_sheet.html
Usage
CommentSheet(authors = NULL, commentList = list(), extLst = NULL, ...)
Arguments
authors |
authors |
commentList |
commentList |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CommentSheet(
authors = AuthorList(author = c("author1", "author2"))
)
## End(Not run)
ConditionalFormatting
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.formatting.html
Usage
ConditionalFormatting(
sqref = list(),
pivot = NULL,
cfRule = list(),
extLst = NULL,
...
)
Arguments
sqref |
sqref |
pivot |
pivot |
cfRule |
cfRule |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ConditionalFormatting()
## End(Not run)
ConditionalFormattingList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.formatting.html
Usage
ConditionalFormattingList(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ConditionalFormattingList()
## End(Not run)
Connection
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.connector.html
Usage
Connection(id = NULL, idx = NULL, ...)
Arguments
id |
id |
idx |
idx |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Connection(id = 1L, idx = 1L)
## End(Not run)
ConnectionSite
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
ConnectionSite(ang = NULL, pos = NULL, ...)
Arguments
ang |
ang |
pos |
pos |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ConnectionSite(ang = 1.5, pos = AdjPoint2D(x = 1L, y = 2L))
## End(Not run)
ConnectionSiteList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
ConnectionSiteList(cxn = NULL, ...)
Arguments
cxn |
cxn |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ConnectionSiteList()
## End(Not run)
ConnectorLocking
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.connector.html
Usage
ConnectorLocking(extLst = NULL, ...)
Arguments
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ConnectorLocking()
## End(Not run)
Control
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.controls.html
Usage
Control(controlPr = NULL, shapeId = NULL, name = NULL, ...)
Arguments
controlPr |
controlPr |
shapeId |
shapeId |
name |
name |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
An openpyxl Python object.
Examples
## Not run:
Control(
controlPr = ControlProperty(
anchor = ObjectAnchor(from = AnchorMarker(), to = AnchorMarker())
),
shapeId = 1L
)
## End(Not run)
ControlProperty
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.controls.html
Usage
ControlProperty(
anchor = NULL,
locked = TRUE,
defaultSize = TRUE,
print = TRUE,
disabled = FALSE,
recalcAlways = FALSE,
uiObject = FALSE,
autoFill = TRUE,
autoLine = TRUE,
autoPict = TRUE,
macro = NULL,
altText = NULL,
linkedCell = NULL,
listFillRange = NULL,
cf = "pict",
id = NULL,
...
)
Arguments
anchor |
anchor |
locked |
locked |
defaultSize |
defaultSize |
print |
_print |
disabled |
disabled |
recalcAlways |
recalcAlways |
uiObject |
uiObject |
autoFill |
autoFill |
autoLine |
autoLine |
autoPict |
autoPict |
macro |
macro |
altText |
altText |
linkedCell |
linkedCell |
listFillRange |
listFillRange |
cf |
cf |
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ControlProperty(
anchor = ObjectAnchor(from = AnchorMarker(), to = AnchorMarker())
)
## End(Not run)
Controls
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.controls.html
Usage
Controls(control = list(), ...)
Arguments
control |
control |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Controls()
## End(Not run)
CustomFilter
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
CustomFilter(operator = NULL, val = NULL, ...)
Arguments
operator |
operator |
val |
val |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CustomFilter(operator = "equal", val = 1L)
## End(Not run)
CustomFilters
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
CustomFilters(and = FALSE, customFilter = list(), ...)
Arguments
and |
_and |
customFilter |
customFilter |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CustomFilters()
## End(Not run)
CustomGeometry2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
CustomGeometry2D(
avLst = NULL,
gdLst = NULL,
ahLst = NULL,
cxnLst = NULL,
rect = NULL,
pathLst = NULL,
...
)
Arguments
avLst |
avLst |
gdLst |
gdLst |
ahLst |
ahLst |
cxnLst |
cxnLst |
rect |
rect |
pathLst |
pathLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CustomGeometry2D(pathLst = Path2DList())
## End(Not run)
CustomProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.custom.html
Usage
CustomProperties(customPr = list(), ...)
Arguments
customPr |
customPr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CustomProperties()
## End(Not run)
CustomProperty
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.custom.html
Usage
CustomProperty(name = NULL, ...)
Arguments
name |
name |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CustomProperty(name = "name")
## End(Not run)
CustomSplit
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.pie_chart.html
Usage
CustomSplit(secondPiePt = list(), ...)
Arguments
secondPiePt |
secondPiePt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
CustomSplit()
## End(Not run)
DashStop
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.line.html
Usage
DashStop(d = 0L, sp = 0L, ...)
Arguments
d |
d |
sp |
sp |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DashStop()
## End(Not run)
DashStopList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.line.html
Usage
DashStopList(ds = list(), ...)
Arguments
ds |
ds |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DashStopList()
## End(Not run)
DataBar
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
DataBar(
minLength = NULL,
maxLength = NULL,
showValue = NULL,
cfvo = NULL,
color = NULL,
...
)
Arguments
minLength |
minLength |
maxLength |
maxLength |
showValue |
showValue |
cfvo |
cfvo |
color |
color |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
first <- FormatObject(type='min')
second <- FormatObject(type='max')
DataBar(cfvo = list(first, second), color = "638EC6")
## End(Not run)
DataBarRule
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
DataBarRule(
start_type = NULL,
start_value = NULL,
end_type = NULL,
end_value = NULL,
color = NULL,
showValue = NULL,
minLength = NULL,
maxLength = NULL,
...
)
Arguments
start_type |
start_type |
start_value |
start_value |
end_type |
end_type |
end_value |
end_value |
color |
color |
showValue |
showValue |
minLength |
minLength |
maxLength |
maxLength |
... |
Additional arguments, i.e. kwargs |
Value
An openpyxl Python object.
Examples
## Not run:
DataBarRule(start_type='percentile', start_value=10, end_type='percentile', end_value='90',
color="FF638EC6", showValue= NULL, minLength=NULL, maxLength=NULL)
## End(Not run)
DataLabel
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.label.html
Usage
DataLabel(idx = 0L, ...)
Arguments
idx |
idx |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DataLabel()
## End(Not run)
DataLabelList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.label.html
Usage
DataLabelList(dLbl = list(), delete = NULL, ...)
Arguments
dLbl |
dLbl |
delete |
delete |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DataLabelList()
## End(Not run)
DataPoint
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.marker.html
Usage
DataPoint(
idx = NULL,
invertIfNegative = NULL,
marker = NULL,
bubble3D = NULL,
explosion = NULL,
spPr = NULL,
pictureOptions = NULL,
extLst = NULL,
...
)
Arguments
idx |
idx |
invertIfNegative |
invertIfNegative |
marker |
marker |
bubble3D |
bubble3D |
explosion |
explosion |
spPr |
spPr |
pictureOptions |
pictureOptions |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DataPoint(idx = 1L)
## End(Not run)
DataTable
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.plotarea.html
Usage
DataTable(
showHorzBorder = NULL,
showVertBorder = NULL,
showOutline = NULL,
showKeys = NULL,
spPr = NULL,
txPr = NULL,
extLst = NULL,
...
)
Arguments
showHorzBorder |
showHorzBorder |
showVertBorder |
showVertBorder |
showOutline |
showOutline |
showKeys |
showKeys |
spPr |
spPr |
txPr |
txPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DataTable()
## End(Not run)
DataTableFormula
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.formula.html
Usage
DataTableFormula(
ref,
ca = FALSE,
dt2D = FALSE,
dtr = FALSE,
r1 = NULL,
r2 = NULL,
del1 = FALSE,
del2 = FALSE,
...
)
Arguments
ref |
ref |
ca |
ca |
dt2D |
dt2D |
dtr |
dtr |
r1 |
r1 |
r2 |
r2 |
del1 |
del1 |
del2 |
del2 |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DataTableFormula(ref = "A1")
## End(Not run)
DataValidation
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.datavalidation.html
Usage
DataValidation(
type = NULL,
formula1 = NULL,
formula2 = NULL,
showErrorMessage = FALSE,
showInputMessage = FALSE,
showDropDown = FALSE,
allowBlank = FALSE,
sqref = list(),
promptTitle = NULL,
errorStyle = NULL,
error = NULL,
prompt = NULL,
errorTitle = NULL,
imeMode = NULL,
operator = NULL,
allow_blank = FALSE,
...
)
Arguments
type |
type |
formula1 |
formula1 |
formula2 |
formula2 |
showErrorMessage |
showErrorMessage |
showInputMessage |
showInputMessage |
showDropDown |
showDropDown |
allowBlank |
allowBlank |
sqref |
sqref |
promptTitle |
promptTitle |
errorStyle |
errorStyle |
error |
error |
prompt |
prompt |
errorTitle |
errorTitle |
imeMode |
imeMode |
operator |
operator |
allow_blank |
allow_blank |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DataValidation()
## End(Not run)
DataValidationList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.datavalidation.html
Usage
DataValidationList(
disablePrompts = NULL,
xWindow = NULL,
yWindow = NULL,
count = NULL,
dataValidation = list(),
...
)
Arguments
disablePrompts |
disablePrompts |
xWindow |
xWindow |
yWindow |
yWindow |
count |
count |
dataValidation |
dataValidation |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DataValidationList()
## End(Not run)
DateAxis
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
DateAxis(
auto = NULL,
lblOffset = NULL,
baseTimeUnit = NULL,
majorUnit = NULL,
majorTimeUnit = NULL,
minorUnit = NULL,
minorTimeUnit = NULL,
extLst = NULL,
...
)
Arguments
auto |
auto |
lblOffset |
lblOffset |
baseTimeUnit |
baseTimeUnit |
majorUnit |
majorUnit |
majorTimeUnit |
majorTimeUnit |
minorUnit |
minorUnit |
minorTimeUnit |
minorTimeUnit |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DateAxis()
## End(Not run)
DateGroupItem
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
DateGroupItem(
year = NULL,
month = NULL,
day = NULL,
hour = NULL,
minute = NULL,
second = NULL,
dateTimeGrouping = NULL,
...
)
Arguments
year |
year |
month |
month |
day |
day |
hour |
hour |
minute |
minute |
second |
second |
dateTimeGrouping |
dateTimeGrouping |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DateGroupItem(year = 2024, dateTimeGrouping = "year")
## End(Not run)
DefinedName
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.defined_name.html
Usage
DefinedName(
name = NULL,
comment = NULL,
customMenu = NULL,
description = NULL,
help = NULL,
statusBar = NULL,
localSheetId = NULL,
hidden = NULL,
vbProcedure = NULL,
xlm = NULL,
functionGroupId = NULL,
shortcutKey = NULL,
publishToServer = NULL,
workbookParameter = NULL,
attr_text = NULL,
...
)
Arguments
name |
name |
comment |
comment |
customMenu |
customMenu |
description |
description |
help |
help |
statusBar |
statusBar |
localSheetId |
localSheetId |
|
hidden | |
vbProcedure |
vbProcedure |
xlm |
xlm |
functionGroupId |
functionGroupId |
shortcutKey |
shortcutKey |
publishToServer |
publishToServer |
workbookParameter |
workbookParameter |
attr_text |
attr_text |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DefinedName(name = "name")
## End(Not run)
DefinedNameList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.defined_name.html
Usage
DefinedNameList(definedName = list(), ...)
Arguments
definedName |
definedName |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DefinedNameList()
## End(Not run)
DifferentialStyle
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.differential.html
Usage
DifferentialStyle(
font = NULL,
numFmt = NULL,
fill = NULL,
alignment = NULL,
border = NULL,
protection = NULL,
extLst = NULL,
...
)
Arguments
font |
font |
numFmt |
numFmt |
fill |
fill |
alignment |
alignment |
border |
border |
protection |
protection |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DifferentialStyle()
## End(Not run)
DifferentialStyleList
Description
Dedupable container for differential styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.differential.html
Usage
DifferentialStyleList(dxf = list(), count = NULL, ...)
Arguments
dxf |
dxf |
count |
count |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DifferentialStyleList()
## End(Not run)
Dimension
Description
Information about the display properties of a row or column.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.dimensions.html
Usage
Dimension(
index,
hidden,
outlineLevel,
collapsed,
worksheet,
visible = TRUE,
style = NULL,
...
)
Arguments
index |
index |
|
hidden | |
outlineLevel |
outlineLevel |
collapsed |
collapsed |
worksheet |
worksheet |
visible |
visible |
style |
style |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Dimension(index = 1L, hidden = NULL,
outlineLevel = NULL, collapsed = NULL, worksheet = NULL)
## End(Not run)
DimensionHolder
Description
Allow columns to be grouped
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.dimensions.html
Usage
DimensionHolder(worksheet, reference = "index", default_factory = NULL, ...)
Arguments
worksheet |
worksheet |
reference |
reference |
default_factory |
default_factory |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- wb$active
DimensionHolder(worksheet = ws)
## End(Not run)
DisplayUnitsLabel
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
DisplayUnitsLabel(layout = NULL, tx = NULL, spPr = NULL, txPr = NULL, ...)
Arguments
layout |
layout |
tx |
tx |
spPr |
spPr |
txPr |
txPr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DisplayUnitsLabel()
## End(Not run)
DisplayUnitsLabelList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
DisplayUnitsLabelList(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DisplayUnitsLabelList()
## End(Not run)
DocumentProperties
Description
High-level properties of the document.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.packaging.core.html
Usage
DocumentProperties(
category = NULL,
contentStatus = NULL,
keywords = NULL,
lastModifiedBy = NULL,
lastPrinted = NULL,
revision = NULL,
version = NULL,
created = NULL,
creator = "openpyxl",
description = NULL,
identifier = NULL,
language = NULL,
modified = NULL,
subject = NULL,
title = NULL,
...
)
Arguments
category |
category |
contentStatus |
contentStatus |
keywords |
keywords |
lastModifiedBy |
lastModifiedBy |
lastPrinted |
lastPrinted |
revision |
revision |
version |
version |
created |
created |
creator |
creator |
description |
description |
identifier |
identifier |
language |
language |
modified |
modified |
subject |
subject |
title |
title |
... |
Additional arguments, i.e. kwargs. |
Details
Defined in ECMA-376 Par2 Annex D
Value
An openpyxl Python object.
Examples
## Not run:
DocumentProperties()
## End(Not run)
DocumentSecurity
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.protection.html
Usage
DocumentSecurity(
workbookPassword = NULL,
workbookPasswordCharacterSet = NULL,
revisionsPassword = NULL,
revisionsPasswordCharacterSet = NULL,
lockStructure = NULL,
lockWindows = NULL,
lockRevision = NULL,
revisionsAlgorithmName = NULL,
revisionsHashValue = NULL,
revisionsSaltValue = NULL,
revisionsSpinCount = NULL,
workbookAlgorithmName = NULL,
workbookHashValue = NULL,
workbookSaltValue = NULL,
workbookSpinCount = NULL,
...
)
Arguments
workbookPassword |
workbookPassword |
workbookPasswordCharacterSet |
workbookPasswordCharacterSet |
revisionsPassword |
revisionsPassword |
revisionsPasswordCharacterSet |
revisionsPasswordCharacterSet |
lockStructure |
lockStructure |
lockWindows |
lockWindows |
lockRevision |
lockRevision |
revisionsAlgorithmName |
revisionsAlgorithmName |
revisionsHashValue |
revisionsHashValue |
revisionsSaltValue |
revisionsSaltValue |
revisionsSpinCount |
revisionsSpinCount |
workbookAlgorithmName |
workbookAlgorithmName |
workbookHashValue |
workbookHashValue |
workbookSaltValue |
workbookSaltValue |
workbookSpinCount |
workbookSpinCount |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DocumentSecurity()
## End(Not run)
DoughnutChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.pie_chart.html
Usage
DoughnutChart(firstSliceAng = 0L, holeSize = 10L, extLst = NULL, ...)
Arguments
firstSliceAng |
firstSliceAng |
holeSize |
holeSize |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DoughnutChart()
## End(Not run)
Drawing
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.drawing.html
Usage
Drawing(id = NULL, ...)
Arguments
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Drawing()
## End(Not run)
DrawingHF
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chartsheet.relation.html
Usage
DrawingHF(
id = NULL,
lho = NULL,
lhe = NULL,
lhf = NULL,
cho = NULL,
che = NULL,
chf = NULL,
rho = NULL,
rhe = NULL,
rhf = NULL,
lfo = NULL,
lfe = NULL,
lff = NULL,
cfo = NULL,
cfe = NULL,
cff = NULL,
rfo = NULL,
rfe = NULL,
rff = NULL,
...
)
Arguments
id |
id |
lho |
lho |
lhe |
lhe |
lhf |
lhf |
cho |
cho |
che |
che |
chf |
chf |
rho |
rho |
rhe |
rhe |
rhf |
rhf |
lfo |
lfo |
lfe |
lfe |
lff |
lff |
cfo |
cfo |
cfe |
cfe |
cff |
cff |
rfo |
rfo |
rfe |
rfe |
rff |
rff |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DrawingHF()
## End(Not run)
DummyWorksheet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.reference.html
Usage
DummyWorksheet(title, ...)
Arguments
title |
title |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DummyWorksheet(title = "title")
## End(Not run)
DuotoneEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
DuotoneEffect(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DuotoneEffect()
## End(Not run)
DynamicFilter
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
DynamicFilter(
type = NULL,
val = NULL,
valIso = NULL,
maxVal = NULL,
maxValIso = NULL,
...
)
Arguments
type |
type |
val |
val |
valIso |
valIso |
maxVal |
maxVal |
maxValIso |
maxValIso |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
DynamicFilter(type = "thisWeek")
## End(Not run)
EMU_to_cm
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
EMU_to_cm(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
EMU_to_cm(value = 100L)
## End(Not run)
EMU_to_inch
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
EMU_to_inch(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
EMU_to_inch(value = 100L)
## End(Not run)
EMU_to_pixels
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
EMU_to_pixels(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
EMU_to_pixels(value = 10000L)
## End(Not run)
EffectContainer
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
EffectContainer(type = NULL, name = NULL, ...)
Arguments
type |
type |
name |
name |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
EffectContainer(type = "sib")
## End(Not run)
EffectList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
EffectList(
blur = NULL,
fillOverlay = NULL,
glow = NULL,
innerShdw = NULL,
outerShdw = NULL,
prstShdw = NULL,
reflection = NULL,
softEdge = NULL,
...
)
Arguments
blur |
blur |
fillOverlay |
fillOverlay |
glow |
glow |
innerShdw |
innerShdw |
outerShdw |
outerShdw |
prstShdw |
prstShdw |
reflection |
reflection |
softEdge |
softEdge |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
EffectList()
## End(Not run)
EmbeddedWAVAudioFile
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
EmbeddedWAVAudioFile(name = NULL, ...)
Arguments
name |
name |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
EmbeddedWAVAudioFile()
## End(Not run)
EmptyCell
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.read_only.html
Usage
EmptyCell(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
EmptyCell()
## End(Not run)
ErrorBars
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.error_bar.html
Usage
ErrorBars(
errDir = NULL,
errBarType = "both",
errValType = "fixedVal",
noEndCap = NULL,
plus = NULL,
minus = NULL,
val = NULL,
spPr = NULL,
extLst = NULL,
...
)
Arguments
errDir |
errDir |
errBarType |
errBarType |
errValType |
errValType |
noEndCap |
noEndCap |
plus |
plus |
minus |
minus |
val |
val |
spPr |
spPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ErrorBars()
## End(Not run)
ExcelReader
Description
Read an Excel package and dispatch the contents to the relevant modules
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.reader.excel.html
Usage
ExcelReader(
fn,
read_only = FALSE,
keep_vba = FALSE,
data_only = FALSE,
keep_links = TRUE,
rich_text = FALSE,
...
)
Arguments
fn |
fn |
read_only |
read_only |
keep_vba |
keep_vba |
data_only |
data_only |
keep_links |
keep_links |
rich_text |
rich_text |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
tmp <- write_xlsx(list(mysheet = iris))
ExcelReader(fn = tmp)
## End(Not run)
ExcelWriter
Description
Write a workbook object to an Excel file.
https://openpyxl.readthedocs.io/en/latest/api/openpyxl.writer.excel.html
Usage
ExcelWriter(workbook, archive, ...)
Arguments
workbook |
workbook |
archive |
archive |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ExcelWriter(workbook = wb, archive = wb)
## End(Not run)
Extension
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.errors.html
Usage
Extension(uri = NULL, ...)
Arguments
uri |
uri |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Extension()
## End(Not run)
ExtensionList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.descriptors.excel.html
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.errors.html
Usage
ExtensionList(ext = list(), ...)
Arguments
ext |
ext |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExtensionList()
## End(Not run)
ExternalBook
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.external_link.external.html
Usage
ExternalBook(
sheetNames = NULL,
definedNames = list(),
sheetDataSet = NULL,
id = NULL,
...
)
Arguments
sheetNames |
sheetNames |
definedNames |
definedNames |
sheetDataSet |
sheetDataSet |
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalBook()
## End(Not run)
ExternalCell
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.external_link.external.html
Usage
ExternalCell(r = NULL, t = NULL, vm = NULL, v = NULL, ...)
Arguments
r |
r |
t |
t |
vm |
vm |
v |
v |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalCell(r = "r")
## End(Not run)
ExternalData
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.chartspace.html
Usage
ExternalData(autoUpdate = NULL, id = NULL, ...)
Arguments
autoUpdate |
autoUpdate |
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalData(id = "id")
## End(Not run)
ExternalDefinedName
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.external_link.external.html
Usage
ExternalDefinedName(name = NULL, refersTo = NULL, sheetId = NULL, ...)
Arguments
name |
name |
refersTo |
refersTo |
sheetId |
sheetId |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalDefinedName(name = "name")
## End(Not run)
ExternalLink
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.external_link.external.html
Usage
ExternalLink(
externalBook = NULL,
ddeLink = NULL,
oleLink = NULL,
extLst = NULL,
...
)
Arguments
externalBook |
externalBook |
ddeLink |
ddeLink |
oleLink |
oleLink |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalLink()
## End(Not run)
ExternalReference
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.external_reference.html
Usage
ExternalReference(id, ...)
Arguments
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalReference(id = "id")
## End(Not run)
ExternalSheetDataSet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.external_link.external.html
Usage
ExternalSheetDataSet(sheetData = NULL, ...)
Arguments
sheetData |
sheetData |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalSheetDataSet(sheetData = list())
## End(Not run)
ExternalSheetNames
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.external_link.external.html
Usage
ExternalSheetNames(sheetName = list(), ...)
Arguments
sheetName |
sheetName |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ExternalSheetNames()
## End(Not run)
FileSharing
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.protection.html
Usage
FileSharing(
readOnlyRecommended = NULL,
userName = NULL,
reservationPassword = NULL,
algorithmName = NULL,
hashValue = NULL,
saltValue = NULL,
spinCount = NULL,
...
)
Arguments
readOnlyRecommended |
readOnlyRecommended |
userName |
userName |
reservationPassword |
reservationPassword |
algorithmName |
algorithmName |
hashValue |
hashValue |
saltValue |
saltValue |
spinCount |
spinCount |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
FileSharing()
## End(Not run)
FileVersion
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.properties.html
Usage
FileVersion(
appName = NULL,
lastEdited = NULL,
lowestEdited = NULL,
rupBuild = NULL,
codeName = NULL,
...
)
Arguments
appName |
appName |
lastEdited |
lastEdited |
lowestEdited |
lowestEdited |
rupBuild |
rupBuild |
codeName |
codeName |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
FileVersion()
## End(Not run)
Fill
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.fills.html
Usage
Fill(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Fill()
## End(Not run)
FillOverlayEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
FillOverlayEffect(blend = NULL, ...)
Arguments
blend |
blend |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
FillOverlayEffect(blend = "darken")
## End(Not run)
FilterColumn
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
FilterColumn(
colId = NULL,
hiddenButton = FALSE,
showButton = TRUE,
filters = NULL,
top10 = NULL,
customFilters = NULL,
dynamicFilter = NULL,
colorFilter = NULL,
iconFilter = NULL,
extLst = NULL,
blank = NULL,
vals = NULL,
...
)
Arguments
colId |
colId |
|
hiddenButton | |
showButton |
showButton |
filters |
filters |
top10 |
top10 |
customFilters |
customFilters |
dynamicFilter |
dynamicFilter |
colorFilter |
colorFilter |
iconFilter |
iconFilter |
extLst |
extLst |
blank |
blank |
vals |
vals |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
FilterColumn(colId = 1L)
## End(Not run)
Filters
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
Filters(
blank = NULL,
calendarType = NULL,
filter = list(),
dateGroupItem = list(),
...
)
Arguments
blank |
blank |
calendarType |
calendarType |
filter |
filter |
dateGroupItem |
dateGroupItem |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Filters()
## End(Not run)
Font
Description
Font options used in styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.fonts.html
Usage
Font(
name = NULL,
sz = NULL,
b = NULL,
i = NULL,
charset = NULL,
u = NULL,
strike = NULL,
color = NULL,
scheme = NULL,
family = NULL,
size = NULL,
bold = NULL,
italic = NULL,
strikethrough = NULL,
underline = NULL,
vertAlign = NULL,
outline = NULL,
shadow = NULL,
condense = NULL,
extend = NULL,
...
)
Arguments
name |
name |
sz |
sz |
b |
b |
i |
i |
charset |
charset |
u |
u |
strike |
strike |
color |
color |
scheme |
scheme |
family |
family |
size |
size |
bold |
bold |
italic |
italic |
strikethrough |
strikethrough |
underline |
underline |
vertAlign |
vertAlign |
outline |
outline |
shadow |
shadow |
condense |
condense |
extend |
extend |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Font()
## End(Not run)
FontReference
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
FontReference(idx = NULL, ...)
Arguments
idx |
idx |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
FontReference()
## End(Not run)
FormatObject
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
FormatObject(type, val = NULL, gte = NULL, extLst = NULL, ...)
Arguments
type |
type |
val |
val |
gte |
gte |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs |
Value
An openpyxl Python object.
Examples
## Not run:
FormatObject(type = "num")
## End(Not run)
FormulaRule
Description
Conditional formatting with custom differential style
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
FormulaRule(
formula = NULL,
stopIfTrue = NULL,
font = NULL,
border = NULL,
fill = NULL,
...
)
Arguments
formula |
formula |
stopIfTrue |
stopIfTrue |
font |
font |
border |
border |
fill |
fill |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- wb$active
ws$conditional_formatting$add('E1:E10',
FormulaRule(
formula = list('ISBLANK(A1)'),
stopIfTrue=TRUE
)
)
## End(Not run)
FunctionGroup
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.function_group.html
Usage
FunctionGroup(name = NULL, ...)
Arguments
name |
name |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
FunctionGroup(name = "name")
## End(Not run)
FunctionGroupList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.function_group.html
Usage
FunctionGroupList(builtInGroupCount = 16L, functionGroup = list(), ...)
Arguments
builtInGroupCount |
builtInGroupCount |
functionGroup |
functionGroup |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
FunctionGroupList()
## End(Not run)
GeomGuide
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
GeomGuide(name = NULL, fmla = NULL, ...)
Arguments
name |
name |
fmla |
fmla |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GeomGuide(name = "name", fmla = "fmla")
## End(Not run)
GeomGuideList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
GeomGuideList(gd = NULL, ...)
Arguments
gd |
gd |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GeomGuideList()
## End(Not run)
GeomRect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
GeomRect(l = NULL, t = NULL, r = NULL, b = NULL, ...)
Arguments
l |
l |
t |
t |
r |
r |
b |
b |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GeomRect(l = 1L, t = 1L, 1L, 1L)
## End(Not run)
GlowEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
GlowEffect(rad = NULL, ...)
Arguments
rad |
rad |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GlowEffect(rad = 1.5)
## End(Not run)
GradientFill
Description
Fill areas with gradient
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.fills.html
Usage
GradientFill(
type = "linear",
degree = 0L,
left = 0L,
right = 0L,
top = 0L,
bottom = 0L,
stop = list(),
...
)
Arguments
type |
type |
degree |
degree |
left |
left |
right |
right |
top |
top |
bottom |
bottom |
stop |
stop |
... |
Additional arguments, i.e. kwargs. |
Details
Two types of gradient fill are supported: - A type='linear' gradient interpolates colours between a set of specified Stops, across the length of an area. The gradient is left-to-right by default, but this orientation can be modified with the degree attribute. A list of Colors can be provided instead and they will be positioned with equal distance between them. - A type='path' gradient applies a linear gradient from each edge of the area. Attributes top, right, bottom, left specify the extent of fill from the respective borders. Thus top="0.2" will fill the top 20
Value
An openpyxl Python object.
Examples
## Not run:
GradientFill()
## End(Not run)
GradientFillProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
GradientFillProperties(
flip = NULL,
rotWithShape = NULL,
gsLst = list(),
lin = NULL,
path = NULL,
tileRect = NULL,
...
)
Arguments
flip |
flip |
rotWithShape |
rotWithShape |
gsLst |
gsLst |
lin |
lin |
path |
path |
tileRect |
tileRect |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GradientFillProperties()
## End(Not run)
GradientStop
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
GradientStop(
pos = NULL,
scrgbClr = NULL,
srgbClr = NULL,
hslClr = NULL,
sysClr = NULL,
schemeClr = NULL,
prstClr = NULL,
...
)
Arguments
pos |
pos |
scrgbClr |
scrgbClr |
srgbClr |
srgbClr |
hslClr |
hslClr |
sysClr |
sysClr |
schemeClr |
schemeClr |
prstClr |
prstClr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GradientStop()
## End(Not run)
GraphicData
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.graphic.html
Usage
GraphicData(
uri = "http://schemas.openxmlformats.org/drawingml/2006/chart",
chart = NULL,
...
)
Arguments
uri |
uri |
chart |
chart |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GraphicData()
## End(Not run)
GraphicFrameLocking
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.graphic.html
Usage
GraphicFrameLocking(
noGrp = NULL,
noDrilldown = NULL,
noSelect = NULL,
noChangeAspect = NULL,
noMove = NULL,
noResize = NULL,
extLst = NULL,
...
)
Arguments
noGrp |
noGrp |
noDrilldown |
noDrilldown |
noSelect |
noSelect |
noChangeAspect |
noChangeAspect |
noMove |
noMove |
noResize |
noResize |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GraphicFrameLocking()
## End(Not run)
GraphicObject
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.graphic.html
Usage
GraphicObject(graphicData = NULL, ...)
Arguments
graphicData |
graphicData |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GraphicObject()
## End(Not run)
GraphicalProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.shapes.html
Usage
GraphicalProperties(
bwMode = NULL,
xfrm = NULL,
noFill = NULL,
solidFill = NULL,
gradFill = NULL,
pattFill = NULL,
ln = NULL,
scene3d = NULL,
custGeom = NULL,
prstGeom = NULL,
sp3d = NULL,
extLst = NULL,
...
)
Arguments
bwMode |
bwMode |
xfrm |
xfrm |
noFill |
noFill |
solidFill |
solidFill |
gradFill |
gradFill |
pattFill |
pattFill |
ln |
ln |
scene3d |
scene3d |
custGeom |
custGeom |
prstGeom |
prstGeom |
sp3d |
sp3d |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Details
This element specifies the formatting for the parent chart element. The custGeom, prstGeom, scene3d, and xfrm elements are not supported. The bwMode attribute is not supported. This doesn't leave much. And the element is used in different places.
Value
An openpyxl Python object.
Examples
## Not run:
GraphicalProperties()
## End(Not run)
GrayscaleEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
GrayscaleEffect(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GrayscaleEffect()
## End(Not run)
GroupLocking
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.properties.html
Usage
GroupLocking(
noGrp = NULL,
noUngrp = NULL,
noSelect = NULL,
noRot = NULL,
noChangeAspect = NULL,
noChangeArrowheads = NULL,
noMove = NULL,
noResize = NULL,
noEditPoints = NULL,
noAdjustHandles = NULL,
noChangeShapeType = NULL,
extLst = NULL,
...
)
Arguments
noGrp |
noGrp |
noUngrp |
noUngrp |
noSelect |
noSelect |
noRot |
noRot |
noChangeAspect |
noChangeAspect |
noChangeArrowheads |
noChangeArrowheads |
noMove |
noMove |
noResize |
noResize |
noEditPoints |
noEditPoints |
noAdjustHandles |
noAdjustHandles |
noChangeShapeType |
noChangeShapeType |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GroupLocking()
## End(Not run)
GroupShapeProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.properties.html
Usage
GroupShapeProperties(
bwMode = NULL,
xfrm = NULL,
scene3d = NULL,
extLst = NULL,
...
)
Arguments
bwMode |
bwMode |
xfrm |
xfrm |
scene3d |
scene3d |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GroupShapeProperties()
## End(Not run)
GroupTransform2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
GroupTransform2D(
rot = 0L,
flipH = NULL,
flipV = NULL,
off = NULL,
ext = NULL,
chOff = NULL,
chExt = NULL,
...
)
Arguments
rot |
rot |
flipH |
flipH |
flipV |
flipV |
off |
off |
ext |
ext |
chOff |
chOff |
chExt |
chExt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
GroupTransform2D()
## End(Not run)
HSLColor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.colors.html
Usage
HSLColor(hue = NULL, sat = NULL, lum = NULL, ...)
Arguments
hue |
hue |
sat |
sat |
lum |
lum |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
HSLColor(hue = 1L, sat = 1L, lum = 1L)
## End(Not run)
HSLEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
HSLEffect(hue = NULL, sat = NULL, lum = NULL, ...)
Arguments
hue |
hue |
sat |
sat |
lum |
lum |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
HSLEffect(hue = 1L, sat = 1L, lum = 1L)
## End(Not run)
HeaderFooter
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.header_footer.html
Usage
HeaderFooter(
differentOddEven = NULL,
differentFirst = NULL,
scaleWithDoc = NULL,
alignWithMargins = NULL,
oddHeader = NULL,
oddFooter = NULL,
evenHeader = NULL,
evenFooter = NULL,
firstHeader = NULL,
firstFooter = NULL,
...
)
Arguments
differentOddEven |
differentOddEven |
differentFirst |
differentFirst |
scaleWithDoc |
scaleWithDoc |
alignWithMargins |
alignWithMargins |
oddHeader |
oddHeader |
oddFooter |
oddFooter |
evenHeader |
evenHeader |
evenFooter |
evenFooter |
firstHeader |
firstHeader |
firstFooter |
firstFooter |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
HeaderFooter()
## End(Not run)
HeaderFooterItem
Description
Header or footer item
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.header_footer.html
Usage
HeaderFooterItem(left = NULL, right = NULL, center = NULL, ...)
Arguments
left |
left |
right |
right |
center |
center |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
HeaderFooterItem()
## End(Not run)
Hyperlink
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.hyperlink.html
Usage
Hyperlink(
ref = NULL,
location = NULL,
tooltip = NULL,
display = NULL,
id = NULL,
target = NULL,
...
)
Arguments
ref |
ref |
location |
location |
tooltip |
tooltip |
display |
display |
id |
id |
target |
target |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Hyperlink(ref = "ref")
## End(Not run)
HyperlinkList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.hyperlink.html
Usage
HyperlinkList(hyperlink = list(), ...)
Arguments
hyperlink |
hyperlink |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
HyperlinkList()
## End(Not run)
IconFilter
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
IconFilter(iconSet = NULL, iconId = NULL, ...)
Arguments
iconSet |
iconSet |
iconId |
iconId |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
IconFilter(iconSet = "3TrafficLights1")
## End(Not run)
IconSet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
IconSet(
iconSet = NULL,
showValue = NULL,
percent = NULL,
reverse = NULL,
cfvo = NULL,
...
)
Arguments
iconSet |
iconSet |
showValue |
showValue |
percent |
percent |
reverse |
reverse |
cfvo |
cfvo |
... |
Additional arguments, i.e. kwargs |
Value
An openpyxl Python object.
Examples
## Not run:
first <- FormatObject(type='percent', val=0)
second <- FormatObject(type='percent', val=33)
third <- FormatObject(type='percent', val=67)
iconset <- IconSet(
iconSet = '3TrafficLights1',
cfvo = list(first, second, third)
)
## End(Not run)
IconSetRule
Description
Convenience function for creating icon set rules
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
IconSetRule(
icon_style = NULL,
type = NULL,
values = NULL,
showValue = NULL,
percent = NULL,
reverse = NULL,
...
)
Arguments
icon_style |
icon_style |
type |
type |
values |
values |
showValue |
showValue |
percent |
percent |
reverse |
reverse |
... |
Additional arguments, i.e. kwargs |
Value
An openpyxl Python object.
Examples
## Not run:
IconSetRule('5Arrows', 'percent', list(10, 20, 30, 40, 50),
showValue=NULL, percent=NULL, reverse=NULL)
## End(Not run)
IgnoredError
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.errors.html
Usage
IgnoredError(
sqref = NULL,
evalError = FALSE,
twoDigitTextYear = FALSE,
numberStoredAsText = FALSE,
formula = FALSE,
formulaRange = FALSE,
unlockedFormula = FALSE,
emptyCellReference = FALSE,
listDataValidation = FALSE,
calculatedColumn = FALSE,
...
)
Arguments
sqref |
sqref |
evalError |
evalError |
twoDigitTextYear |
twoDigitTextYear |
numberStoredAsText |
numberStoredAsText |
formula |
formula |
formulaRange |
formulaRange |
unlockedFormula |
unlockedFormula |
emptyCellReference |
emptyCellReference |
listDataValidation |
listDataValidation |
calculatedColumn |
calculatedColumn |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
IgnoredError()
## End(Not run)
IgnoredErrors
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.errors.html
Usage
IgnoredErrors(ignoredError = list(), extLst = NULL, ...)
Arguments
ignoredError |
ignoredError |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
IgnoredErrors()
## End(Not run)
Image
Description
Image in a spreadsheet. You must have the Pillow Python library installed, which can be installed using 'install_pillow()'.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.image.html
Usage
Image(img, ...)
Arguments
img |
img |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
install_pillow()
image_path <- system.file('extdata/logo.png',package='xlcharts')
Image(img = image_path)
## End(Not run)
InlineFont
Description
Font for inline text because, yes what you need are different objects with the same elements but different constraints.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.text.html
Usage
InlineFont(
rFont = NULL,
charset = NULL,
family = NULL,
b = NULL,
i = NULL,
strike = NULL,
outline = NULL,
shadow = NULL,
condense = NULL,
extend = NULL,
color = NULL,
sz = NULL,
u = NULL,
vertAlign = NULL,
scheme = NULL,
...
)
Arguments
rFont |
rFont |
charset |
charset |
family |
family |
b |
b |
i |
i |
strike |
strike |
outline |
outline |
shadow |
shadow |
condense |
condense |
extend |
extend |
color |
color |
sz |
sz |
u |
u |
vertAlign |
vertAlign |
scheme |
scheme |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
InlineFont()
## End(Not run)
InnerShadowEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
InnerShadowEffect(blurRad = NULL, dist = NULL, dir = NULL, ...)
Arguments
blurRad |
blurRad |
dist |
dist |
dir |
dir |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
InnerShadowEffect(blurRad = 1, dist = 1, dir = 1)
## End(Not run)
InputCells
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.scenario.html
Usage
InputCells(
r = NULL,
deleted = FALSE,
undone = FALSE,
val = NULL,
numFmtId = NULL,
...
)
Arguments
r |
r |
deleted |
deleted |
undone |
undone |
val |
val |
numFmtId |
numFmtId |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
InputCells(r = "r", val = "val")
## End(Not run)
Layout
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.layout.html
Usage
Layout(manualLayout = NULL, extLst = NULL, ...)
Arguments
manualLayout |
manualLayout |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Layout()
## End(Not run)
Legend
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.legend.html
Usage
Legend(
legendPos = "r",
legendEntry = list(),
layout = NULL,
overlay = NULL,
spPr = NULL,
txPr = NULL,
extLst = NULL,
...
)
Arguments
legendPos |
legendPos |
legendEntry |
legendEntry |
layout |
layout |
overlay |
overlay |
spPr |
spPr |
txPr |
txPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Legend()
## End(Not run)
LegendEntry
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.legend.html
Usage
LegendEntry(idx = 0, delete = NULL, txPr = NULL, extLst = NULL, ...)
Arguments
idx |
idx |
delete |
delete |
txPr |
txPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LegendEntry()
## End(Not run)
Level
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
Level(pt = list(), ...)
Arguments
pt |
pt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Level()
## End(Not run)
LightRig
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
LightRig(rig = NULL, dir = NULL, rot = NULL, ...)
Arguments
rig |
rig |
dir |
dir |
rot |
rot |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LightRig(rig = "morning", dir = "t")
## End(Not run)
LineBreak
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
LineBreak(rPr = NULL, ...)
Arguments
rPr |
rPr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LineBreak()
## End(Not run)
LineChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.line_chart.html
Usage
LineChart(
hiLowLines = NULL,
upDownBars = NULL,
marker = NULL,
smooth = NULL,
extLst = NULL,
...
)
Arguments
hiLowLines |
hiLowLines |
upDownBars |
upDownBars |
marker |
marker |
smooth |
smooth |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LineChart()
## End(Not run)
LineChart3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.line_chart.html
Usage
LineChart3D(
gapDepth = NULL,
hiLowLines = NULL,
upDownBars = NULL,
marker = NULL,
smooth = NULL,
...
)
Arguments
gapDepth |
gapDepth |
hiLowLines |
hiLowLines |
upDownBars |
upDownBars |
marker |
marker |
smooth |
smooth |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LineChart3D()
## End(Not run)
LineEndProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.line.html
Usage
LineEndProperties(type = NULL, w = NULL, len = NULL, ...)
Arguments
type |
type |
w |
w |
len |
len |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LineEndProperties()
## End(Not run)
LineProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.line.html
Usage
LineProperties(
w = NULL,
cap = NULL,
cmpd = NULL,
algn = NULL,
noFill = NULL,
solidFill = NULL,
gradFill = NULL,
pattFill = NULL,
prstDash = NULL,
custDash = NULL,
round = NULL,
bevel = NULL,
miter = NULL,
headEnd = NULL,
tailEnd = NULL,
extLst = NULL,
...
)
Arguments
w |
w |
cap |
cap |
cmpd |
cmpd |
algn |
algn |
noFill |
noFill |
solidFill |
solidFill |
gradFill |
gradFill |
pattFill |
pattFill |
prstDash |
prstDash |
custDash |
custDash |
round |
round |
bevel |
bevel |
miter |
miter |
headEnd |
headEnd |
tailEnd |
tailEnd |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LineProperties()
## End(Not run)
LinearShadeProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
LinearShadeProperties(ang = NULL, scaled = NULL, ...)
Arguments
ang |
ang |
scaled |
scaled |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LinearShadeProperties(ang = 30)
## End(Not run)
ListStyle
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
ListStyle(
defPPr = NULL,
lvl1pPr = NULL,
lvl2pPr = NULL,
lvl3pPr = NULL,
lvl4pPr = NULL,
lvl5pPr = NULL,
lvl6pPr = NULL,
lvl7pPr = NULL,
lvl8pPr = NULL,
lvl9pPr = NULL,
extLst = NULL,
...
)
Arguments
defPPr |
defPPr |
lvl1pPr |
lvl1pPr |
lvl2pPr |
lvl2pPr |
lvl3pPr |
lvl3pPr |
lvl4pPr |
lvl4pPr |
lvl5pPr |
lvl5pPr |
lvl6pPr |
lvl6pPr |
lvl7pPr |
lvl7pPr |
lvl8pPr |
lvl8pPr |
lvl9pPr |
lvl9pPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ListStyle()
## End(Not run)
LuminanceEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
LuminanceEffect(bright = 0L, contrast = 0L, ...)
Arguments
bright |
bright |
contrast |
contrast |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
LuminanceEffect()
## End(Not run)
ManualLayout
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.layout.html
Usage
ManualLayout(
layoutTarget = NULL,
xMode = NULL,
yMode = NULL,
wMode = "factor",
hMode = "factor",
x = NULL,
y = NULL,
w = NULL,
h = NULL,
extLst = NULL,
...
)
Arguments
layoutTarget |
layoutTarget |
xMode |
xMode |
yMode |
yMode |
wMode |
wMode |
hMode |
hMode |
x |
x |
y |
y |
w |
w |
h |
h |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ManualLayout()
## End(Not run)
Marker
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.marker.html
Usage
Marker(symbol = NULL, size = NULL, spPr = NULL, extLst = NULL, ...)
Arguments
symbol |
symbol |
size |
size |
spPr |
spPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Marker()
## End(Not run)
MergeCell
Description
Represents a range in a sheet: title and coordinates.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.merge.html
Usage
MergeCell(ref = NULL, ...)
Arguments
ref |
ref |
... |
Additional arguments, i.e. kwargs. |
Details
This object is used to perform operations on ranges, like: - shift, expand or shrink - union/intersection with another sheet range, We can check whether a range is: - equal or not equal to another, - disjoint of another, - contained in another. We can get: - the size of a range. - the range bounds (vertices) - the coordinates, - the string representation,
Value
An openpyxl Python object.
Examples
## Not run:
MergeCell(ref = "A1")
## End(Not run)
MergeCells
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.merge.html
Usage
MergeCells(count = NULL, mergeCell = list(), ...)
Arguments
count |
count |
mergeCell |
mergeCell |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
MergeCells()
## End(Not run)
MergedCell
Description
Describes the properties of a cell in a merged cell and helps to display the borders of the merged cell.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.cell.html
Usage
MergedCell(worksheet, row = NULL, column = NULL, ...)
Arguments
worksheet |
worksheet |
row |
row |
column |
column |
... |
Additional arguments, i.e. kwargs. |
Details
The value of a MergedCell is always NULL.
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
MergedCell(worksheet = wb$active, row = 1L, column = 1L)
## End(Not run)
MergedCellRange
Description
MergedCellRange stores the border information of a merged cell in the top
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.merge.html
Usage
MergedCellRange(worksheet, coord, ...)
Arguments
worksheet |
worksheet |
coord |
coord |
... |
Additional arguments, i.e. kwargs. |
Details
left cell of the merged cell. The remaining cells in the merged cell are stored as MergedCell objects and get their border information from the upper left cell.
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
MergedCellRange(worksheet = wb$active, coord = "A1")
## End(Not run)
MultiCellRange
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.cell_range.html
Usage
MultiCellRange(ranges = list(), ...)
Arguments
ranges |
ranges |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
MultiCellRange()
## End(Not run)
MultiLevelStrData
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
MultiLevelStrData(ptCount = NULL, lvl = list(), extLst = NULL, ...)
Arguments
ptCount |
ptCount |
lvl |
lvl |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
MultiLevelStrData()
## End(Not run)
MultiLevelStrRef
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
MultiLevelStrRef(f = NULL, multiLvlStrCache = NULL, extLst = NULL, ...)
Arguments
f |
f |
multiLvlStrCache |
multiLvlStrCache |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
MultiLevelStrRef()
## End(Not run)
NamedStyle
Description
Named and editable styles
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.named_styles.html
Usage
NamedStyle(
name = "Normal",
font = NULL,
fill = NULL,
border = NULL,
alignment = NULL,
number_format = NULL,
protection = NULL,
builtinId = NULL,
hidden = FALSE,
xfId = NULL,
...
)
Arguments
name |
name |
font |
font |
fill |
fill |
border |
border |
alignment |
alignment |
number_format |
number_format |
protection |
protection |
builtinId |
builtinId |
|
hidden | |
xfId |
xfId |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NamedStyle()
## End(Not run)
NamedStyleList
Description
Named styles are editable and can be applied to multiple objects
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.named_styles.html
Usage
NamedStyleList(iterable = list(), ...)
Arguments
iterable |
iterable |
... |
Additional arguments, i.e. kwargs. |
Details
As only the index is stored in referencing objects the order mus be preserved.
Value
An openpyxl Python object.
Examples
## Not run:
NamedStyleList()
## End(Not run)
NestedGapAmount
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.descriptors.html
Usage
NestedGapAmount(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NestedGapAmount()
## End(Not run)
NestedOverlap
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.descriptors.html
Usage
NestedOverlap(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NestedOverlap()
## End(Not run)
NonVisualConnectorProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.connector.html
Usage
NonVisualConnectorProperties(
cxnSpLocks = NULL,
stCxn = NULL,
endCxn = NULL,
extLst = NULL,
...
)
Arguments
cxnSpLocks |
cxnSpLocks |
stCxn |
stCxn |
endCxn |
endCxn |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NonVisualConnectorProperties()
## End(Not run)
NonVisualDrawingShapeProps
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.properties.html
Usage
NonVisualDrawingShapeProps(spLocks = NULL, txBox = NULL, extLst = NULL, ...)
Arguments
spLocks |
spLocks |
txBox |
txBox |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NonVisualDrawingShapeProps()
## End(Not run)
NonVisualGraphicFrameProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.graphic.html
Usage
NonVisualGraphicFrameProperties(graphicFrameLocks = NULL, extLst = NULL, ...)
Arguments
graphicFrameLocks |
graphicFrameLocks |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NonVisualGraphicFrameProperties()
## End(Not run)
NonVisualPictureProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.picture.html
Usage
NonVisualPictureProperties(
preferRelativeResize = NULL,
picLocks = NULL,
extLst = NULL,
...
)
Arguments
preferRelativeResize |
preferRelativeResize |
picLocks |
picLocks |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NonVisualPictureProperties()
## End(Not run)
NumData
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
NumData(formatCode = NULL, ptCount = NULL, pt = list(), extLst = NULL, ...)
Arguments
formatCode |
formatCode |
ptCount |
ptCount |
pt |
pt |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NumData()
## End(Not run)
NumDataSource
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
NumDataSource(numRef = NULL, numLit = NULL, ...)
Arguments
numRef |
numRef |
numLit |
numLit |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NumDataSource()
## End(Not run)
NumFmt
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
NumFmt(formatCode = NULL, sourceLinked = FALSE, ...)
Arguments
formatCode |
formatCode |
sourceLinked |
sourceLinked |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NumFmt(formatCode = "formatCode")
## End(Not run)
NumRef
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
NumRef(f = NULL, numCache = NULL, extLst = NULL, ...)
Arguments
f |
f |
numCache |
numCache |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NumRef()
## End(Not run)
NumVal
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
NumVal(idx = NULL, formatCode = NULL, v = NULL)
Arguments
idx |
idx |
formatCode |
formatCode |
v |
v |
Value
An openpyxl Python object.
Examples
## Not run:
NumVal(idx = 1L)
## End(Not run)
NumericAxis
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
NumericAxis(
crossBetween = NULL,
majorUnit = NULL,
minorUnit = NULL,
dispUnits = NULL,
extLst = NULL,
...
)
Arguments
crossBetween |
crossBetween |
majorUnit |
majorUnit |
minorUnit |
minorUnit |
dispUnits |
dispUnits |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
NumericAxis()
## End(Not run)
ObjectAnchor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.ole.html
Usage
ObjectAnchor(
from = NULL,
to = NULL,
moveWithCells = FALSE,
sizeWithCells = FALSE,
z_order = NULL,
...
)
Arguments
from |
_from |
to |
to |
moveWithCells |
moveWithCells |
sizeWithCells |
sizeWithCells |
z_order |
z_order |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ObjectAnchor(from = AnchorMarker(), to = AnchorMarker())
## End(Not run)
OneCellAnchor
Description
Note that the argument '_from' has been transformed to 'from'.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.spreadsheet_drawing.html
Usage
OneCellAnchor(from = NULL, ext = NULL, ...)
Arguments
from |
from |
ext |
ext |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
OneCellAnchor()
## End(Not run)
Outline
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.properties.html
Usage
Outline(
applyStyles = NULL,
summaryBelow = NULL,
summaryRight = NULL,
showOutlineSymbols = NULL,
...
)
Arguments
applyStyles |
applyStyles |
summaryBelow |
summaryBelow |
summaryRight |
summaryRight |
showOutlineSymbols |
showOutlineSymbols |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Outline()
## End(Not run)
PageBreak
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.pagebreak.html
Usage
PageBreak(count = NULL, manualBreakCount = NULL, brk = list(), ...)
Arguments
count |
count |
manualBreakCount |
manualBreakCount |
brk |
brk |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PageBreak()
## End(Not run)
PageMargins
Description
Information about page margins for view/print layouts.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.page.html
Usage
PageMargins(
left = 0.75,
right = 0.75,
top = 1L,
bottom = 1L,
header = 0.5,
footer = 0.5,
...
)
Arguments
left |
left |
right |
right |
top |
top |
bottom |
bottom |
header |
header |
footer |
footer |
... |
Additional arguments, i.e. kwargs. |
Details
Standard values (in inches) left, right = 0.75 top, bottom = 1 header, footer = 0.5
Value
An openpyxl Python object.
Examples
## Not run:
PageMargins()
## End(Not run)
PageSetupProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.properties.html
Usage
PageSetupProperties(autoPageBreaks = NULL, fitToPage = NULL, ...)
Arguments
autoPageBreaks |
autoPageBreaks |
fitToPage |
fitToPage |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PageSetupProperties()
## End(Not run)
Pane
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.views.html
Usage
Pane(
xSplit = NULL,
ySplit = NULL,
topLeftCell = NULL,
activePane = "topLeft",
state = "split",
...
)
Arguments
xSplit |
xSplit |
ySplit |
ySplit |
topLeftCell |
topLeftCell |
activePane |
activePane |
state |
state |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Pane()
## End(Not run)
Paragraph
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
Paragraph(pPr = NULL, endParaRPr = NULL, r = NULL, br = NULL, fld = NULL, ...)
Arguments
pPr |
pPr |
endParaRPr |
endParaRPr |
r |
r |
br |
br |
fld |
fld |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Paragraph()
## End(Not run)
ParagraphProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
ParagraphProperties(
marL = NULL,
marR = NULL,
lvl = NULL,
indent = NULL,
algn = NULL,
defTabSz = NULL,
rtl = NULL,
eaLnBrk = NULL,
fontAlgn = NULL,
latinLnBrk = NULL,
hangingPunct = NULL,
lnSpc = NULL,
spcBef = NULL,
spcAft = NULL,
tabLst = NULL,
defRPr = NULL,
extLst = NULL,
buClrTx = NULL,
buClr = NULL,
buSzTx = NULL,
buSzPct = NULL,
buSzPts = NULL,
buFontTx = NULL,
buFont = NULL,
buNone = NULL,
buAutoNum = NULL,
buChar = NULL,
buBlip = NULL,
...
)
Arguments
marL |
marL |
marR |
marR |
lvl |
lvl |
indent |
indent |
algn |
algn |
defTabSz |
defTabSz |
rtl |
rtl |
eaLnBrk |
eaLnBrk |
fontAlgn |
fontAlgn |
latinLnBrk |
latinLnBrk |
hangingPunct |
hangingPunct |
lnSpc |
lnSpc |
spcBef |
spcBef |
spcAft |
spcAft |
tabLst |
tabLst |
defRPr |
defRPr |
extLst |
extLst |
buClrTx |
buClrTx |
buClr |
buClr |
buSzTx |
buSzTx |
buSzPct |
buSzPct |
buSzPts |
buSzPts |
buFontTx |
buFontTx |
buFont |
buFont |
buNone |
buNone |
buAutoNum |
buAutoNum |
buChar |
buChar |
buBlip |
buBlip |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ParagraphProperties()
## End(Not run)
Path2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Path2D(w = NULL, h = NULL, fill = NULL, stroke = NULL, extrusionOk = NULL, ...)
Arguments
w |
w |
h |
h |
fill |
fill |
stroke |
stroke |
extrusionOk |
extrusionOk |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Path2D(w = 1L, h = 1L)
## End(Not run)
Path2DList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Path2DList(path = NULL, ...)
Arguments
path |
path |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Path2DList()
## End(Not run)
PathShadeProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
PathShadeProperties(path = NULL, fillToRect = NULL, ...)
Arguments
path |
path |
fillToRect |
fillToRect |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PathShadeProperties(path = "circle")
## End(Not run)
PatternFill
Description
Area fill patterns for use in styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.fills.html
Usage
PatternFill(
patternType = NULL,
fill_type = NULL,
start_color = NULL,
end_color = NULL,
...
)
Arguments
patternType |
patternType |
fill_type |
fill_type |
start_color |
start_color |
end_color |
end_color |
... |
Additional arguments, i.e. kwargs. |
Details
Caution: if you do not specify a fill_type, other attributes will have no effect !
Value
An openpyxl Python object.
Caution
if you do not specify a fill_type, other attributes will have: no effect !
Examples
## Not run:
PatternFill()
## End(Not run)
PatternFillProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
PatternFillProperties(prst = NULL, fgClr = NULL, bgClr = NULL, ...)
Arguments
prst |
prst |
fgClr |
fgClr |
bgClr |
bgClr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PatternFillProperties()
## End(Not run)
PhoneticProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.text.html
Usage
PhoneticProperties(fontId = NULL, type = NULL, alignment = NULL, ...)
Arguments
fontId |
fontId |
type |
type |
alignment |
alignment |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PhoneticProperties(fontId = 1L)
## End(Not run)
PhoneticText
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.text.html
Usage
PhoneticText(sb = NULL, eb = NULL, t = NULL, ...)
Arguments
sb |
sb |
eb |
eb |
t |
t |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PhoneticText(sb = 1L, eb = 1L)
## End(Not run)
PieChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.pie_chart.html
Usage
PieChart(firstSliceAng = 0L, extLst = NULL, ...)
Arguments
firstSliceAng |
firstSliceAng |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PieChart()
## End(Not run)
PieChart3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.pie_chart.html
Usage
PieChart3D(varyColors = TRUE, ser = list(), dLbls = NULL, ...)
Arguments
varyColors |
varyColors |
ser |
ser |
dLbls |
dLbls |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PieChart3D()
## End(Not run)
PivotFormat
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.pivot.html
Usage
PivotFormat(
idx = 0L,
spPr = NULL,
txPr = NULL,
marker = NULL,
dLbl = NULL,
extLst = NULL,
...
)
Arguments
idx |
idx |
spPr |
spPr |
txPr |
txPr |
marker |
marker |
dLbl |
dLbl |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PivotFormat()
## End(Not run)
PivotSource
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.pivot.html
Usage
PivotSource(name = NULL, fmtId = NULL, extLst = NULL, ...)
Arguments
name |
name |
fmtId |
fmtId |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PivotSource(fmtId = 1L)
## End(Not run)
PlotArea
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.plotarea.html
Usage
PlotArea(
layout = NULL,
dTable = NULL,
spPr = NULL,
charts = list(),
axes = list(),
extLst = NULL,
...
)
Arguments
layout |
layout |
dTable |
dTable |
spPr |
spPr |
charts |
_charts |
axes |
_axes |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PlotArea()
## End(Not run)
Point2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Point2D(x = NULL, y = NULL, ...)
Arguments
x |
x |
y |
y |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Point2D(x = 1L, y = 1L)
## End(Not run)
Point3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Point3D(x = NULL, y = NULL, z = NULL, ...)
Arguments
x |
x |
y |
y |
z |
z |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Point3D(x = 1L, y = 1L, z = 1L)
## End(Not run)
PositiveSize2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
PositiveSize2D(cx = NULL, cy = NULL, ...)
Arguments
cx |
cx |
cy |
cy |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PositiveSize2D(cx = 1L, cy = 1L)
## End(Not run)
PresetGeometry2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
PresetGeometry2D(prst = NULL, avLst = NULL, ...)
Arguments
prst |
prst |
avLst |
avLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PresetGeometry2D(prst = "diamond")
## End(Not run)
PresetShadowEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
PresetShadowEffect(prst = NULL, dist = NULL, dir = NULL, ...)
Arguments
prst |
prst |
dist |
dist |
dir |
dir |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PresetShadowEffect(prst = "shdw20", dist = 1L, dir = 1L)
## End(Not run)
PrintArea
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.print_settings.html
Usage
PrintArea(ranges = list(), title = "", ...)
Arguments
ranges |
ranges |
title |
title |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PrintArea()
## End(Not run)
PrintOptions
Description
Worksheet print options
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.page.html
Usage
PrintOptions(
horizontalCentered = NULL,
verticalCentered = NULL,
headings = NULL,
gridLines = NULL,
gridLinesSet = NULL,
...
)
Arguments
horizontalCentered |
horizontalCentered |
verticalCentered |
verticalCentered |
headings |
headings |
gridLines |
gridLines |
gridLinesSet |
gridLinesSet |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PrintOptions()
## End(Not run)
PrintPageSetup
Description
Worksheet print page setup
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.page.html
Usage
PrintPageSetup(
worksheet = NULL,
orientation = NULL,
paperSize = NULL,
scale = NULL,
fitToHeight = NULL,
fitToWidth = NULL,
firstPageNumber = NULL,
useFirstPageNumber = NULL,
paperHeight = NULL,
paperWidth = NULL,
pageOrder = NULL,
usePrinterDefaults = NULL,
blackAndWhite = NULL,
draft = NULL,
cellComments = NULL,
errors = NULL,
horizontalDpi = NULL,
verticalDpi = NULL,
copies = NULL,
id = NULL,
...
)
Arguments
worksheet |
worksheet |
orientation |
orientation |
paperSize |
paperSize |
scale |
scale |
fitToHeight |
fitToHeight |
fitToWidth |
fitToWidth |
firstPageNumber |
firstPageNumber |
useFirstPageNumber |
useFirstPageNumber |
paperHeight |
paperHeight |
paperWidth |
paperWidth |
pageOrder |
pageOrder |
usePrinterDefaults |
usePrinterDefaults |
blackAndWhite |
blackAndWhite |
draft |
draft |
cellComments |
cellComments |
errors |
errors |
horizontalDpi |
horizontalDpi |
verticalDpi |
verticalDpi |
copies |
copies |
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PrintPageSetup()
## End(Not run)
PrintSettings
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.print_settings.html
Usage
PrintSettings(headerFooter = NULL, pageMargins = NULL, pageSetup = NULL, ...)
Arguments
headerFooter |
headerFooter |
pageMargins |
pageMargins |
pageSetup |
pageSetup |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PrintSettings()
## End(Not run)
PrintTitles
Description
Contains at least either a range of rows or columns
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.print_settings.html
Usage
PrintTitles(cols = NULL, rows = NULL, title = "", ...)
Arguments
cols |
cols |
rows |
rows |
title |
title |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
PrintTitles()
## End(Not run)
ProjectedPieChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.pie_chart.html
Usage
ProjectedPieChart(
ofPieType = "pie",
gapWidth = NULL,
splitType = "auto",
splitPos = NULL,
custSplit = NULL,
secondPieSize = 75L,
serLines = NULL,
extLst = NULL,
...
)
Arguments
ofPieType |
ofPieType |
gapWidth |
gapWidth |
splitType |
splitType |
splitPos |
splitPos |
custSplit |
custSplit |
secondPieSize |
secondPieSize |
serLines |
serLines |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Details
This element contains the pie of pie or bar of pie series on this chart. Only the first series shall be displayed. The splitType element shall determine whether the splitPos and custSplit elements apply.
Value
An openpyxl Python object.
Examples
## Not run:
ProjectedPieChart()
## End(Not run)
Protection
Description
Protection options for use in styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.protection.html
Usage
Protection(locked = TRUE, hidden = FALSE, ...)
Arguments
locked |
locked |
|
hidden | |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Protection()
## End(Not run)
RadarChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.radar_chart.html
Usage
RadarChart(
radarStyle = "standard",
varyColors = NULL,
ser = list(),
dLbls = NULL,
extLst = NULL,
...
)
Arguments
radarStyle |
radarStyle |
varyColors |
varyColors |
ser |
ser |
dLbls |
dLbls |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
RadarChart()
## End(Not run)
ReadOnlyCell
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.read_only.html
Usage
ReadOnlyCell(sheet, row, column, value, data_type = "n", style_id = 0L, ...)
Arguments
sheet |
sheet |
row |
row |
column |
column |
value |
value |
data_type |
data_type |
style_id |
style_id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ReadOnlyCell(sheet = "sheet", row = 1L, column = 1L, value = 1L)
## End(Not run)
Reference
Description
Normalise cell range references
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.reference.html
Usage
Reference(
worksheet = NULL,
min_col = NULL,
min_row = NULL,
max_col = NULL,
max_row = NULL,
range_string = NULL,
...
)
Arguments
worksheet |
worksheet |
min_col |
min_col |
min_row |
min_row |
max_col |
max_col |
max_row |
max_row |
range_string |
range_string |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
Reference(worksheet = wb$active, min_col = 1L, min_row = 1L, max_col = 1L, max_row = 1L)
## End(Not run)
RegularTextRun
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
RegularTextRun(rPr = NULL, t = "", ...)
Arguments
rPr |
rPr |
t |
t |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
RegularTextRun()
## End(Not run)
Related
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.related.html
Usage
Related(id = NULL, ...)
Arguments
id |
id |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Related()
## End(Not run)
RelativeRect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
RelativeRect(l = NULL, t = NULL, r = NULL, b = NULL, ...)
Arguments
l |
l |
t |
t |
r |
r |
b |
b |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
RelativeRect()
## End(Not run)
RichTextProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
RichTextProperties(
rot = NULL,
spcFirstLastPara = NULL,
vertOverflow = NULL,
horzOverflow = NULL,
vert = NULL,
wrap = NULL,
lIns = NULL,
tIns = NULL,
rIns = NULL,
bIns = NULL,
numCol = NULL,
spcCol = NULL,
rtlCol = NULL,
fromWordArt = NULL,
anchor = NULL,
anchorCtr = NULL,
forceAA = NULL,
upright = NULL,
compatLnSpc = NULL,
prstTxWarp = NULL,
scene3d = NULL,
extLst = NULL,
noAutofit = NULL,
normAutofit = NULL,
spAutoFit = NULL,
flatTx = NULL,
...
)
Arguments
rot |
rot |
spcFirstLastPara |
spcFirstLastPara |
vertOverflow |
vertOverflow |
horzOverflow |
horzOverflow |
vert |
vert |
wrap |
wrap |
lIns |
lIns |
tIns |
tIns |
rIns |
rIns |
bIns |
bIns |
numCol |
numCol |
spcCol |
spcCol |
rtlCol |
rtlCol |
fromWordArt |
fromWordArt |
anchor |
anchor |
anchorCtr |
anchorCtr |
forceAA |
forceAA |
upright |
upright |
compatLnSpc |
compatLnSpc |
prstTxWarp |
prstTxWarp |
scene3d |
scene3d |
extLst |
extLst |
noAutofit |
noAutofit |
normAutofit |
normAutofit |
spAutoFit |
spAutoFit |
flatTx |
flatTx |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
RichTextProperties()
## End(Not run)
RowBreak
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.pagebreak.html
Usage
RowBreak(count = NULL, manualBreakCount = NULL, brk = list(), ...)
Arguments
count |
count |
manualBreakCount |
manualBreakCount |
brk |
brk |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
RowBreak()
## End(Not run)
RowDimension
Description
Information about the display properties of a row.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.dimensions.html
Usage
RowDimension(
worksheet,
index = 0L,
ht = NULL,
customHeight = NULL,
s = NULL,
customFormat = NULL,
hidden = FALSE,
outlineLevel = 0L,
outline_level = NULL,
collapsed = FALSE,
visible = NULL,
height = NULL,
r = NULL,
spans = NULL,
thickBot = NULL,
thickTop = NULL,
...
)
Arguments
worksheet |
worksheet |
index |
index |
ht |
ht |
customHeight |
customHeight |
s |
s |
customFormat |
customFormat |
|
hidden | |
outlineLevel |
outlineLevel |
outline_level |
outline_level |
collapsed |
collapsed |
visible |
visible |
height |
height |
r |
r |
spans |
spans |
thickBot |
thickBot |
thickTop |
thickTop |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
RowDimension(wb$active)
## End(Not run)
RowRange
Description
Represent a range of at least one row
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.print_settings.html
Usage
RowRange(range_string = NULL, min_row = NULL, max_row = NULL, ...)
Arguments
range_string |
range_string |
min_row |
min_row |
max_row |
max_row |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
RowRange(min_row = 1L, max_row = 2L)
## End(Not run)
Rule
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
Rule(
type,
dxfId = NULL,
priority = 0L,
stopIfTrue = NULL,
aboveAverage = NULL,
percent = NULL,
bottom = NULL,
operator = NULL,
text = NULL,
timePeriod = NULL,
rank = NULL,
stdDev = NULL,
equalAverage = NULL,
formula = list(),
colorScale = NULL,
dataBar = NULL,
iconSet = NULL,
extLst = NULL,
dxf = NULL,
...
)
Arguments
type |
type |
dxfId |
dxfId |
priority |
priority |
stopIfTrue |
stopIfTrue |
aboveAverage |
aboveAverage |
percent |
percent |
bottom |
bottom |
operator |
operator |
text |
text |
timePeriod |
timePeriod |
rank |
rank |
stdDev |
stdDev |
equalAverage |
equalAverage |
formula |
formula |
colorScale |
colorScale |
dataBar |
dataBar |
iconSet |
iconSet |
extLst |
extLst |
dxf |
dxf |
... |
Additional arguments, i.e. kwargs |
Value
An openpyxl Python object.
Examples
## Not run:
Rule(type = "colorScale")
## End(Not run)
RuleType
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Usage
RuleType(...)
Arguments
... |
Additional arguments, i.e. kwargs |
Value
An openpyxl Python object.
Examples
## Not run:
RuleType()
## End(Not run)
Scaling
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
Scaling(
logBase = NULL,
orientation = "minMax",
max = NULL,
min = NULL,
extLst = NULL,
...
)
Arguments
logBase |
logBase |
orientation |
orientation |
max |
max |
min |
min |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Scaling()
## End(Not run)
ScatterChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.scatter_chart.html
Usage
ScatterChart(
scatterStyle = NULL,
varyColors = NULL,
ser = list(),
dLbls = NULL,
extLst = NULL,
...
)
Arguments
scatterStyle |
scatterStyle |
varyColors |
varyColors |
ser |
ser |
dLbls |
dLbls |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ScatterChart()
## End(Not run)
Scenario
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.scenario.html
Usage
Scenario(
inputCells = list(),
name = NULL,
locked = FALSE,
hidden = FALSE,
count = NULL,
user = NULL,
comment = NULL,
...
)
Arguments
inputCells |
inputCells |
name |
name |
locked |
locked |
|
hidden | |
count |
count |
user |
user |
comment |
comment |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Scenario(name = "name")
## End(Not run)
ScenarioList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.scenario.html
Usage
ScenarioList(scenario = list(), current = NULL, show = NULL, sqref = NULL, ...)
Arguments
scenario |
scenario |
current |
current |
show |
show |
sqref |
sqref |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ScenarioList()
## End(Not run)
Scene3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Scene3D(camera = NULL, lightRig = NULL, backdrop = NULL, extLst = NULL, ...)
Arguments
camera |
camera |
lightRig |
lightRig |
backdrop |
backdrop |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Scene3D(
camera = Camera(prst = "perspectiveLeft"),
lightRig = LightRig(rig = "morning", dir = "t")
)
## End(Not run)
SchemeColor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.colors.html
Usage
SchemeColor(
tint = NULL,
shade = NULL,
comp = NULL,
inv = NULL,
gray = NULL,
alpha = NULL,
alphaOff = NULL,
alphaMod = NULL,
hue = NULL,
hueOff = NULL,
hueMod = NULL,
sat = NULL,
satOff = NULL,
satMod = NULL,
lum = NULL,
lumOff = NULL,
lumMod = NULL,
red = NULL,
redOff = NULL,
redMod = NULL,
green = NULL,
greenOff = NULL,
greenMod = NULL,
blue = NULL,
blueOff = NULL,
blueMod = NULL,
gamma = NULL,
invGamma = NULL,
val = NULL,
...
)
Arguments
tint |
tint |
shade |
shade |
comp |
comp |
inv |
inv |
gray |
gray |
alpha |
alpha |
alphaOff |
alphaOff |
alphaMod |
alphaMod |
hue |
hue |
hueOff |
hueOff |
hueMod |
hueMod |
sat |
sat |
satOff |
satOff |
satMod |
satMod |
lum |
lum |
lumOff |
lumOff |
lumMod |
lumMod |
red |
red |
redOff |
redOff |
redMod |
redMod |
green |
green |
greenOff |
greenOff |
greenMod |
greenMod |
blue |
blue |
blueOff |
blueOff |
blueMod |
blueMod |
gamma |
gamma |
invGamma |
invGamma |
val |
val |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
# from Gradient Pie Charts example
slice <- DataPoint(
idx = 0,
explosion = 20,
spPr = GraphicalProperties(
gradFill = GradientFillProperties(
gsLst = list(
pos=0,
prstClr='blue'
),
GradientStop(
pos=100000,
schemeClr=SchemeColor(
val='accent1',
lumMod=30000,
lumOff=70000
)
)
)
)
)
## End(Not run)
Selection
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.views.html
Usage
Selection(
pane = NULL,
activeCell = "A1",
activeCellId = NULL,
sqref = "A1",
...
)
Arguments
pane |
pane |
activeCell |
activeCell |
activeCellId |
activeCellId |
sqref |
sqref |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Selection()
## End(Not run)
Series
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.series.html
Usage
Series(
values,
xvalues = NULL,
zvalues = NULL,
title = NULL,
title_from_data = FALSE,
...
)
Arguments
values |
values |
xvalues |
xvalues |
zvalues |
zvalues |
title |
title |
title_from_data |
title_from_data |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Series(values = "sheetname!A1:E4")
## End(Not run)
SeriesAxis
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
SeriesAxis(tickLblSkip = NULL, tickMarkSkip = NULL, extLst = NULL, ...)
Arguments
tickLblSkip |
tickLblSkip |
tickMarkSkip |
tickMarkSkip |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SeriesAxis()
## End(Not run)
SeriesFactory
Description
Convenience Factory for creating chart data series.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.series_factory.html
Usage
SeriesFactory(
values,
xvalues = NULL,
zvalues = NULL,
title = NULL,
title_from_data = FALSE,
...
)
Arguments
values |
values |
xvalues |
xvalues |
zvalues |
zvalues |
title |
title |
title_from_data |
title_from_data |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SeriesFactory(values = "sheetname!A1:E4")
## End(Not run)
SeriesLabel
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.series.html
Usage
SeriesLabel(strRef = NULL, v = NULL, ...)
Arguments
strRef |
strRef |
v |
v |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SeriesLabel()
## End(Not run)
Shape
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.connector.html
Usage
Shape(
macro = NULL,
textlink = NULL,
fPublished = NULL,
fLocksText = NULL,
nvSpPr = NULL,
spPr = NULL,
style = NULL,
txBody = NULL,
...
)
Arguments
macro |
macro |
textlink |
textlink |
fPublished |
fPublished |
fLocksText |
fLocksText |
nvSpPr |
nvSpPr |
spPr |
spPr |
style |
style |
txBody |
txBody |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Shape(spPr = GraphicalProperties())
## End(Not run)
Shape3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Shape3D(
z = NULL,
extrusionH = NULL,
contourW = NULL,
prstMaterial = NULL,
bevelT = NULL,
bevelB = NULL,
extrusionClr = NULL,
contourClr = NULL,
extLst = NULL,
...
)
Arguments
z |
z |
extrusionH |
extrusionH |
contourW |
contourW |
prstMaterial |
prstMaterial |
bevelT |
bevelT |
bevelB |
bevelB |
extrusionClr |
extrusionClr |
contourClr |
contourClr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Shape3D()
## End(Not run)
ShapeStyle
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
ShapeStyle(lnRef = NULL, fillRef = NULL, effectRef = NULL, fontRef = NULL, ...)
Arguments
lnRef |
lnRef |
fillRef |
fillRef |
effectRef |
effectRef |
fontRef |
fontRef |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
ShapeStyle(
lnRef = StyleMatrixReference(idx = 1L),
fillRef = StyleMatrixReference(idx = 1L),
effectRef = StyleMatrixReference(idx = 1L),
fontRef = FontReference()
)
## End(Not run)
SheetBackgroundPicture
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.picture.html
Usage
SheetBackgroundPicture(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SheetBackgroundPicture()
## End(Not run)
SheetDimension
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.dimensions.html
Usage
SheetDimension(ref = NULL, ...)
Arguments
ref |
ref |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SheetDimension(ref = "ref")
## End(Not run)
SheetFormatProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.dimensions.html
Usage
SheetFormatProperties(
baseColWidth = 8L,
defaultColWidth = NULL,
defaultRowHeight = 15L,
customHeight = NULL,
zeroHeight = NULL,
thickTop = NULL,
thickBottom = NULL,
outlineLevelRow = NULL,
outlineLevelCol = NULL,
...
)
Arguments
baseColWidth |
baseColWidth |
defaultColWidth |
defaultColWidth |
defaultRowHeight |
defaultRowHeight |
customHeight |
customHeight |
zeroHeight |
zeroHeight |
thickTop |
thickTop |
thickBottom |
thickBottom |
outlineLevelRow |
outlineLevelRow |
outlineLevelCol |
outlineLevelCol |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SheetFormatProperties()
## End(Not run)
SheetProtection
Description
Information about protection of various aspects of a sheet. TRUE values
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.protection.html
Usage
SheetProtection(
sheet = FALSE,
objects = FALSE,
scenarios = FALSE,
formatCells = TRUE,
formatRows = TRUE,
formatColumns = TRUE,
insertColumns = TRUE,
insertRows = TRUE,
insertHyperlinks = TRUE,
deleteColumns = TRUE,
deleteRows = TRUE,
selectLockedCells = FALSE,
selectUnlockedCells = FALSE,
sort = TRUE,
autoFilter = TRUE,
pivotTables = TRUE,
password = NULL,
algorithmName = NULL,
saltValue = NULL,
spinCount = NULL,
hashValue = NULL,
...
)
Arguments
sheet |
sheet |
objects |
objects |
scenarios |
scenarios |
formatCells |
formatCells |
formatRows |
formatRows |
formatColumns |
formatColumns |
insertColumns |
insertColumns |
insertRows |
insertRows |
insertHyperlinks |
insertHyperlinks |
deleteColumns |
deleteColumns |
deleteRows |
deleteRows |
selectLockedCells |
selectLockedCells |
selectUnlockedCells |
selectUnlockedCells |
sort |
sort |
autoFilter |
autoFilter |
pivotTables |
pivotTables |
password |
password |
algorithmName |
algorithmName |
saltValue |
saltValue |
spinCount |
spinCount |
hashValue |
hashValue |
... |
Additional arguments, i.e. kwargs. |
Details
mean that protection for the object or action is active This is the **default** when protection is active, ie. users cannot do something
Value
An openpyxl Python object.
Examples
## Not run:
SheetProtection()
## End(Not run)
SheetView
Description
Information about the visible portions of this sheet.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.views.html
Usage
SheetView(
windowProtection = NULL,
showFormulas = NULL,
showGridLines = NULL,
showRowColHeaders = NULL,
showZeros = NULL,
rightToLeft = NULL,
tabSelected = NULL,
showRuler = NULL,
showOutlineSymbols = NULL,
defaultGridColor = NULL,
showWhiteSpace = NULL,
view = NULL,
topLeftCell = NULL,
colorId = NULL,
zoomScale = NULL,
zoomScaleNormal = NULL,
zoomScaleSheetLayoutView = NULL,
zoomScalePageLayoutView = NULL,
zoomToFit = NULL,
workbookViewId = 0L,
selection = NULL,
pane = NULL,
...
)
Arguments
windowProtection |
windowProtection |
showFormulas |
showFormulas |
showGridLines |
showGridLines |
showRowColHeaders |
showRowColHeaders |
showZeros |
showZeros |
rightToLeft |
rightToLeft |
tabSelected |
tabSelected |
showRuler |
showRuler |
showOutlineSymbols |
showOutlineSymbols |
defaultGridColor |
defaultGridColor |
showWhiteSpace |
showWhiteSpace |
view |
view |
topLeftCell |
topLeftCell |
colorId |
colorId |
zoomScale |
zoomScale |
zoomScaleNormal |
zoomScaleNormal |
zoomScaleSheetLayoutView |
zoomScaleSheetLayoutView |
zoomScalePageLayoutView |
zoomScalePageLayoutView |
zoomToFit |
zoomToFit |
workbookViewId |
workbookViewId |
selection |
selection |
pane |
pane |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SheetView()
## End(Not run)
SheetViewList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.views.html
Usage
SheetViewList(sheetView = NULL, extLst = NULL, ...)
Arguments
sheetView |
sheetView |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SheetViewList()
## End(Not run)
Side
Description
Border options for use in styles.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.borders.html
Usage
Side(style = NULL, color = NULL, border_style = NULL, ...)
Arguments
style |
style |
color |
color |
border_style |
border_style |
... |
Additional arguments, i.e. kwargs. |
Details
Caution: if you do not specify a border_style, other attributes will have no effect !
Value
An openpyxl Python object.
Caution
if you do not specify a border_style, other attributes will: have no effect !
Examples
## Not run:
Side()
## End(Not run)
SmartTag
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.smart_tags.html
Usage
SmartTag(namespaceUri = NULL, name = NULL, url = NULL, ...)
Arguments
namespaceUri |
namespaceUri |
name |
name |
url |
url |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SmartTag()
## End(Not run)
SmartTagList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.smart_tags.html
Usage
SmartTagList(smartTagType = list(), ...)
Arguments
smartTagType |
smartTagType |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SmartTagList()
## End(Not run)
SmartTagProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.smart_tags.html
Usage
SmartTagProperties(embed = NULL, show = NULL, ...)
Arguments
embed |
embed |
show |
show |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SmartTagProperties()
## End(Not run)
SmartTags
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.smart_tag.html
Usage
SmartTags(cellSmartTags = list(), ...)
Arguments
cellSmartTags |
cellSmartTags |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SmartTags()
## End(Not run)
SoftEdgesEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
SoftEdgesEffect(rad = NULL, ...)
Arguments
rad |
rad |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SoftEdgesEffect(rad = 1L)
## End(Not run)
SolidColorFillProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
SolidColorFillProperties(
scrgbClr = NULL,
srgbClr = NULL,
hslClr = NULL,
sysClr = NULL,
schemeClr = NULL,
prstClr = NULL,
...
)
Arguments
scrgbClr |
scrgbClr |
srgbClr |
srgbClr |
hslClr |
hslClr |
sysClr |
sysClr |
schemeClr |
schemeClr |
prstClr |
prstClr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SolidColorFillProperties()
## End(Not run)
SortCondition
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
SortCondition(
ref = NULL,
descending = NULL,
sortBy = NULL,
customList = NULL,
dxfId = NULL,
iconSet = NULL,
iconId = NULL,
...
)
Arguments
ref |
ref |
descending |
descending |
sortBy |
sortBy |
customList |
customList |
dxfId |
dxfId |
iconSet |
iconSet |
iconId |
iconId |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SortCondition()
## End(Not run)
SortState
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.filters.html
Usage
SortState(
columnSort = NULL,
caseSensitive = NULL,
sortMethod = NULL,
ref = NULL,
sortCondition = list(),
extLst = NULL,
...
)
Arguments
columnSort |
columnSort |
caseSensitive |
caseSensitive |
sortMethod |
sortMethod |
ref |
ref |
sortCondition |
sortCondition |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SortState()
## End(Not run)
Spacing
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
Spacing(spcPct = NULL, spcPts = NULL, ...)
Arguments
spcPct |
spcPct |
spcPts |
spcPts |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Spacing()
## End(Not run)
SphereCoords
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
SphereCoords(lat = NULL, lon = NULL, rev = NULL, ...)
Arguments
lat |
lat |
lon |
lon |
rev |
rev |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SphereCoords(lat = 1L, lon = 1L, rev = 1L)
## End(Not run)
SpreadsheetDrawing
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.spreadsheet_drawing.html
Usage
SpreadsheetDrawing(
twoCellAnchor = list(),
oneCellAnchor = list(),
absoluteAnchor = list(),
...
)
Arguments
twoCellAnchor |
twoCellAnchor |
oneCellAnchor |
oneCellAnchor |
absoluteAnchor |
absoluteAnchor |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SpreadsheetDrawing()
## End(Not run)
StockChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.stock_chart.html
Usage
StockChart(
ser = list(),
dLbls = NULL,
dropLines = NULL,
hiLowLines = NULL,
upDownBars = NULL,
extLst = NULL,
...
)
Arguments
ser |
ser |
dLbls |
dLbls |
dropLines |
dropLines |
hiLowLines |
hiLowLines |
upDownBars |
upDownBars |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
StockChart()
## End(Not run)
Stop
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.fills.html
Usage
Stop(color, position, ...)
Arguments
color |
color |
position |
position |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Stop(color = Color(), position = 1L)
## End(Not run)
StopList
Description
A sequence (list or list) that may only contain objects of the declared
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.fills.html
Usage
StopList(name = NULL, ...)
Arguments
name |
name |
... |
Additional arguments, i.e. kwargs. |
Details
type
Value
An openpyxl Python object.
Examples
## Not run:
StopList()
## End(Not run)
StrData
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
StrData(ptCount = NULL, pt = list(), extLst = NULL, ...)
Arguments
ptCount |
ptCount |
pt |
pt |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
StrData()
## End(Not run)
StrRef
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
StrRef(f = NULL, strCache = NULL, extLst = NULL, ...)
Arguments
f |
f |
strCache |
strCache |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
StrRef()
## End(Not run)
StrVal
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.data_source.html
Usage
StrVal(idx = 0L, v = NULL, ...)
Arguments
idx |
idx |
v |
v |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
StrVal()
## End(Not run)
StretchInfoProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.fill.html
Usage
StretchInfoProperties(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
StretchInfoProperties()
## End(Not run)
StyleArray
Description
Simplified named list with an array
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.cell_style.html
Usage
StyleArray(args = c(0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L), ...)
Arguments
args |
args |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
StyleArray()
## End(Not run)
StyleMatrixReference
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
StyleMatrixReference(idx = NULL, ...)
Arguments
idx |
idx |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
StyleMatrixReference(idx = 1L)
## End(Not run)
Stylesheet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.stylesheet.html
Usage
Stylesheet(
numFmts = NULL,
fonts = list(),
fills = list(),
borders = list(),
cellStyleXfs = NULL,
cellXfs = NULL,
cellStyles = NULL,
dxfs = list(),
tableStyles = NULL,
colors = NULL,
extLst = NULL,
...
)
Arguments
numFmts |
numFmts |
fonts |
fonts |
fills |
fills |
borders |
borders |
cellStyleXfs |
cellStyleXfs |
cellXfs |
cellXfs |
cellStyles |
cellStyles |
dxfs |
dxfs |
tableStyles |
tableStyles |
colors |
colors |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Stylesheet()
## End(Not run)
SurfaceChart
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.surface_chart.html
Usage
SurfaceChart(wireframe = NULL, ser = list(), bandFmts = NULL, ...)
Arguments
wireframe |
wireframe |
ser |
ser |
bandFmts |
bandFmts |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SurfaceChart()
## End(Not run)
SurfaceChart3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.surface_chart.html
Usage
SurfaceChart3D(wireframe = NULL, ser = list(), bandFmts = NULL, ...)
Arguments
wireframe |
wireframe |
ser |
ser |
bandFmts |
bandFmts |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SurfaceChart3D()
## End(Not run)
SystemColor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.colors.html
Usage
SystemColor(
val = "windowText",
lastClr = NULL,
tint = NULL,
shade = NULL,
comp = NULL,
inv = NULL,
gray = NULL,
alpha = NULL,
alphaOff = NULL,
alphaMod = NULL,
hue = NULL,
hueOff = NULL,
hueMod = NULL,
sat = NULL,
satOff = NULL,
satMod = NULL,
lum = NULL,
lumOff = NULL,
lumMod = NULL,
red = NULL,
redOff = NULL,
redMod = NULL,
green = NULL,
greenOff = NULL,
greenMod = NULL,
blue = NULL,
blueOff = NULL,
blueMod = NULL,
gamma = NULL,
invGamma = NULL,
...
)
Arguments
val |
val |
lastClr |
lastClr |
tint |
tint |
shade |
shade |
comp |
comp |
inv |
inv |
gray |
gray |
alpha |
alpha |
alphaOff |
alphaOff |
alphaMod |
alphaMod |
hue |
hue |
hueOff |
hueOff |
hueMod |
hueMod |
sat |
sat |
satOff |
satOff |
satMod |
satMod |
lum |
lum |
lumOff |
lumOff |
lumMod |
lumMod |
red |
red |
redOff |
redOff |
redMod |
redMod |
green |
green |
greenOff |
greenOff |
greenMod |
greenMod |
blue |
blue |
blueOff |
blueOff |
blueMod |
blueMod |
gamma |
gamma |
invGamma |
invGamma |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
SystemColor()
## End(Not run)
Table
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.table.html
Usage
Table(
id = 1L,
displayName,
ref = NULL,
name = NULL,
comment = NULL,
tableType = NULL,
headerRowCount = 1L,
insertRow = NULL,
insertRowShift = NULL,
totalsRowCount = NULL,
totalsRowShown = NULL,
published = NULL,
headerRowDxfId = NULL,
dataDxfId = NULL,
totalsRowDxfId = NULL,
headerRowBorderDxfId = NULL,
tableBorderDxfId = NULL,
totalsRowBorderDxfId = NULL,
headerRowCellStyle = NULL,
dataCellStyle = NULL,
totalsRowCellStyle = NULL,
connectionId = NULL,
autoFilter = NULL,
sortState = NULL,
tableColumns = list(),
tableStyleInfo = NULL,
extLst = NULL,
...
)
Arguments
id |
id |
displayName |
displayName |
ref |
ref |
name |
name |
comment |
comment |
tableType |
tableType |
headerRowCount |
headerRowCount |
insertRow |
insertRow |
insertRowShift |
insertRowShift |
totalsRowCount |
totalsRowCount |
totalsRowShown |
totalsRowShown |
published |
published |
headerRowDxfId |
headerRowDxfId |
dataDxfId |
dataDxfId |
totalsRowDxfId |
totalsRowDxfId |
headerRowBorderDxfId |
headerRowBorderDxfId |
tableBorderDxfId |
tableBorderDxfId |
totalsRowBorderDxfId |
totalsRowBorderDxfId |
headerRowCellStyle |
headerRowCellStyle |
dataCellStyle |
dataCellStyle |
totalsRowCellStyle |
totalsRowCellStyle |
connectionId |
connectionId |
autoFilter |
autoFilter |
sortState |
sortState |
tableColumns |
tableColumns |
tableStyleInfo |
tableStyleInfo |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Table(displayName = "displayName")
## End(Not run)
TableColumn
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.table.html
Usage
TableColumn(
id = NULL,
uniqueName = NULL,
name = NULL,
totalsRowFunction = NULL,
totalsRowLabel = NULL,
queryTableFieldId = NULL,
headerRowDxfId = NULL,
dataDxfId = NULL,
totalsRowDxfId = NULL,
headerRowCellStyle = NULL,
dataCellStyle = NULL,
totalsRowCellStyle = NULL,
calculatedColumnFormula = NULL,
totalsRowFormula = NULL,
xmlColumnPr = NULL,
extLst = NULL,
...
)
Arguments
id |
id |
uniqueName |
uniqueName |
name |
name |
totalsRowFunction |
totalsRowFunction |
totalsRowLabel |
totalsRowLabel |
queryTableFieldId |
queryTableFieldId |
headerRowDxfId |
headerRowDxfId |
dataDxfId |
dataDxfId |
totalsRowDxfId |
totalsRowDxfId |
headerRowCellStyle |
headerRowCellStyle |
dataCellStyle |
dataCellStyle |
totalsRowCellStyle |
totalsRowCellStyle |
calculatedColumnFormula |
calculatedColumnFormula |
totalsRowFormula |
totalsRowFormula |
xmlColumnPr |
xmlColumnPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TableColumn(id = 1L, name = "name")
## End(Not run)
TableFormula
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.table.html
Usage
TableFormula(array = NULL, attr_text = NULL, ...)
Arguments
array |
array |
attr_text |
attr_text |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TableFormula()
## End(Not run)
TableNameDescriptor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.table.html
Usage
TableNameDescriptor(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TableNameDescriptor()
## End(Not run)
TablePartList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.table.html
Usage
TablePartList(count = NULL, tablePart = list(), ...)
Arguments
count |
count |
tablePart |
tablePart |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TablePartList()
## End(Not run)
TableStyle
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.table.html
Usage
TableStyle(
name = NULL,
pivot = NULL,
table = NULL,
count = NULL,
tableStyleElement = list(),
...
)
Arguments
name |
name |
pivot |
pivot |
table |
table |
count |
count |
tableStyleElement |
tableStyleElement |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TableStyle(name = "name")
## End(Not run)
TableStyleElement
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.table.html
Usage
TableStyleElement(type = NULL, size = NULL, dxfId = NULL, ...)
Arguments
type |
type |
size |
size |
dxfId |
dxfId |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TableStyleElement(type = "secondSubtotalRow")
## End(Not run)
TableStyleInfo
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.table.html
Usage
TableStyleInfo(
name = NULL,
showFirstColumn = NULL,
showLastColumn = NULL,
showRowStripes = NULL,
showColumnStripes = NULL,
...
)
Arguments
name |
name |
showFirstColumn |
showFirstColumn |
showLastColumn |
showLastColumn |
showRowStripes |
showRowStripes |
showColumnStripes |
showColumnStripes |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TableStyleInfo()
## End(Not run)
TableStyleList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.table.html
Usage
TableStyleList(
count = NULL,
defaultTableStyle = "TableStyleMedium9",
defaultPivotStyle = "PivotStyleLight16",
tableStyle = list(),
...
)
Arguments
count |
count |
defaultTableStyle |
defaultTableStyle |
defaultPivotStyle |
defaultPivotStyle |
tableStyle |
tableStyle |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TableStyleList()
## End(Not run)
TextAxis
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.axis.html
Usage
TextAxis(
auto = NULL,
lblAlgn = NULL,
lblOffset = 100L,
tickLblSkip = NULL,
tickMarkSkip = NULL,
noMultiLvlLbl = NULL,
extLst = NULL,
...
)
Arguments
auto |
auto |
lblAlgn |
lblAlgn |
lblOffset |
lblOffset |
tickLblSkip |
tickLblSkip |
tickMarkSkip |
tickMarkSkip |
noMultiLvlLbl |
noMultiLvlLbl |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TextAxis()
## End(Not run)
TextBlock
Description
Represents text string in a specific format
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.rich_text.html
Usage
TextBlock(font, text, ...)
Arguments
font |
font |
text |
text |
... |
Additional arguments, i.e. kwargs. |
Details
This class is used as part of constructing a rich text strings.
Value
An openpyxl Python object.
Examples
## Not run:
TextBlock(font = InlineFont(), text = "text")
## End(Not run)
TextField
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
TextField(id = NULL, type = NULL, rPr = NULL, pPr = NULL, t = NULL, ...)
Arguments
id |
id |
type |
type |
rPr |
rPr |
pPr |
pPr |
t |
t |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TextField(id = "id")
## End(Not run)
TextNormalAutofit
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.text.html
Usage
TextNormalAutofit(fontScale = NULL, lnSpcReduction = NULL, ...)
Arguments
fontScale |
fontScale |
lnSpcReduction |
lnSpcReduction |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TextNormalAutofit(fontScale = 1L, lnSpcReduction = 1L)
## End(Not run)
TintEffect
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.effect.html
Usage
TintEffect(hue = 0L, amt = 0L, ...)
Arguments
hue |
hue |
amt |
amt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TintEffect()
## End(Not run)
Title
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.title.html
Usage
Title(
tx = NULL,
layout = NULL,
overlay = NULL,
spPr = NULL,
txPr = NULL,
extLst = NULL,
...
)
Arguments
tx |
tx |
layout |
layout |
overlay |
overlay |
spPr |
spPr |
txPr |
txPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Title()
## End(Not run)
TitleDescriptor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.title.html
Usage
TitleDescriptor(...)
Arguments
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TitleDescriptor()
## End(Not run)
Transform2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Transform2D(
rot = NULL,
flipH = NULL,
flipV = NULL,
off = NULL,
ext = NULL,
chOff = NULL,
chExt = NULL,
...
)
Arguments
rot |
rot |
flipH |
flipH |
flipV |
flipV |
off |
off |
ext |
ext |
chOff |
chOff |
chExt |
chExt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Transform2D()
## End(Not run)
Trendline
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.trendline.html
Usage
Trendline(
name = NULL,
spPr = NULL,
trendlineType = "linear",
order = NULL,
period = NULL,
forward = NULL,
backward = NULL,
intercept = NULL,
dispRSqr = NULL,
dispEq = NULL,
trendlineLbl = NULL,
extLst = NULL,
...
)
Arguments
name |
name |
spPr |
spPr |
trendlineType |
trendlineType |
order |
order |
period |
period |
forward |
forward |
backward |
backward |
intercept |
intercept |
dispRSqr |
dispRSqr |
dispEq |
dispEq |
trendlineLbl |
trendlineLbl |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Trendline()
## End(Not run)
TrendlineLabel
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.trendline.html
Usage
TrendlineLabel(
layout = NULL,
tx = NULL,
numFmt = NULL,
spPr = NULL,
txPr = NULL,
extLst = NULL,
...
)
Arguments
layout |
layout |
tx |
tx |
numFmt |
numFmt |
spPr |
spPr |
txPr |
txPr |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TrendlineLabel()
## End(Not run)
TwoCellAnchor
Description
Note that the argument '_from' has been transformed to 'from'.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.spreadsheet_drawing.html
Usage
TwoCellAnchor(editAs = NULL, from = NULL, to = NULL, ...)
Arguments
editAs |
editAs |
from |
_from |
to |
to |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
TwoCellAnchor()
## End(Not run)
UpDownBars
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.updown_bars.html
Usage
UpDownBars(gapWidth = 150L, upBars = NULL, downBars = NULL, extLst = NULL, ...)
Arguments
gapWidth |
gapWidth |
upBars |
upBars |
downBars |
downBars |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
UpDownBars()
## End(Not run)
ValueDescriptor
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.formatting.rule.html
Expected type depends upon type attribute of parent :-(
Most values should be numeric BUT they can also be cell references
Usage
ValueDescriptor(...)
Arguments
... |
Additional arguments, i.e. kwargs |
Value
An openpyxl Python object.
Examples
## Not run:
ValueDescriptor()
## End(Not run)
Vector3D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.geometry.html
Usage
Vector3D(dx = NULL, dy = NULL, dz = NULL, ...)
Arguments
dx |
dx |
dy |
dy |
dz |
dz |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Vector3D(dx = 1L, dy = 1L, dz = 1L)
## End(Not run)
WebPublishItem
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chartsheet.publish.html
Usage
WebPublishItem(
id = NULL,
divId = NULL,
sourceType = NULL,
sourceRef = NULL,
sourceObject = NULL,
destinationFile = NULL,
title = NULL,
autoRepublish = NULL,
...
)
Arguments
id |
id |
divId |
divId |
sourceType |
sourceType |
sourceRef |
sourceRef |
sourceObject |
sourceObject |
destinationFile |
destinationFile |
title |
title |
autoRepublish |
autoRepublish |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WebPublishItem(
id = 1L,
divId = "divId",
sourceType = "chart",
sourceRef = "sourceRef",
destinationFile = "destinationFile"
)
## End(Not run)
WebPublishObject
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.web.html
Usage
WebPublishObject(
id = NULL,
divId = NULL,
sourceObject = NULL,
destinationFile = NULL,
title = NULL,
autoRepublish = NULL,
...
)
Arguments
id |
id |
divId |
divId |
sourceObject |
sourceObject |
destinationFile |
destinationFile |
title |
title |
autoRepublish |
autoRepublish |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WebPublishObject(
id = 1L,
divId = "divId",
destinationFile = "destinationFile"
)
## End(Not run)
WebPublishObjectList
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.web.html
Usage
WebPublishObjectList(count = NULL, webPublishObject = list(), ...)
Arguments
count |
count |
webPublishObject |
webPublishObject |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WebPublishObjectList()
## End(Not run)
WebPublishing
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.web.html
Usage
WebPublishing(
css = NULL,
thicket = NULL,
longFileNames = NULL,
vml = NULL,
allowPng = NULL,
targetScreenSize = "800x600",
dpi = NULL,
codePage = NULL,
characterSet = NULL,
...
)
Arguments
css |
css |
thicket |
thicket |
longFileNames |
longFileNames |
vml |
vml |
allowPng |
allowPng |
targetScreenSize |
targetScreenSize |
dpi |
dpi |
codePage |
codePage |
characterSet |
characterSet |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WebPublishing()
## End(Not run)
Workbook
Description
Usage
Workbook(write_only = FALSE, iso_dates = FALSE, ...)
Arguments
write_only |
write_only |
iso_dates |
iso_dates |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
Workbook()
## End(Not run)
WorkbookParser
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.reader.workbook.html
Usage
WorkbookParser(archive, workbook_part_name, keep_links = TRUE, ...)
Arguments
archive |
archive |
workbook_part_name |
workbook_part_name |
keep_links |
keep_links |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WorkbookParser(
archive = "archive",
workbook_part_name = "workbook_part_name"
)
## End(Not run)
WorkbookProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.properties.html
Usage
WorkbookProperties(
date1904 = NULL,
dateCompatibility = NULL,
showObjects = NULL,
showBorderUnselectedTables = NULL,
filterPrivacy = NULL,
promptedSolutions = NULL,
showInkAnnotation = NULL,
backupFile = NULL,
saveExternalLinkValues = NULL,
updateLinks = NULL,
codeName = NULL,
hidePivotFieldList = NULL,
showPivotChartFilter = NULL,
allowRefreshQuery = NULL,
publishItems = NULL,
checkCompatibility = NULL,
autoCompressPictures = NULL,
refreshAllConnections = NULL,
defaultThemeVersion = NULL,
...
)
Arguments
date1904 |
date1904 |
dateCompatibility |
dateCompatibility |
showObjects |
showObjects |
showBorderUnselectedTables |
showBorderUnselectedTables |
filterPrivacy |
filterPrivacy |
promptedSolutions |
promptedSolutions |
showInkAnnotation |
showInkAnnotation |
backupFile |
backupFile |
saveExternalLinkValues |
saveExternalLinkValues |
updateLinks |
updateLinks |
codeName |
codeName |
hidePivotFieldList |
hidePivotFieldList |
showPivotChartFilter |
showPivotChartFilter |
allowRefreshQuery |
allowRefreshQuery |
publishItems |
publishItems |
checkCompatibility |
checkCompatibility |
autoCompressPictures |
autoCompressPictures |
refreshAllConnections |
refreshAllConnections |
defaultThemeVersion |
defaultThemeVersion |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WorkbookProperties()
## End(Not run)
WorkbookProtection
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.protection.html
Usage
WorkbookProtection(
workbookPassword = NULL,
workbookPasswordCharacterSet = NULL,
revisionsPassword = NULL,
revisionsPasswordCharacterSet = NULL,
lockStructure = NULL,
lockWindows = NULL,
lockRevision = NULL,
revisionsAlgorithmName = NULL,
revisionsHashValue = NULL,
revisionsSaltValue = NULL,
revisionsSpinCount = NULL,
workbookAlgorithmName = NULL,
workbookHashValue = NULL,
workbookSaltValue = NULL,
workbookSpinCount = NULL,
...
)
Arguments
workbookPassword |
workbookPassword |
workbookPasswordCharacterSet |
workbookPasswordCharacterSet |
revisionsPassword |
revisionsPassword |
revisionsPasswordCharacterSet |
revisionsPasswordCharacterSet |
lockStructure |
lockStructure |
lockWindows |
lockWindows |
lockRevision |
lockRevision |
revisionsAlgorithmName |
revisionsAlgorithmName |
revisionsHashValue |
revisionsHashValue |
revisionsSaltValue |
revisionsSaltValue |
revisionsSpinCount |
revisionsSpinCount |
workbookAlgorithmName |
workbookAlgorithmName |
workbookHashValue |
workbookHashValue |
workbookSaltValue |
workbookSaltValue |
workbookSpinCount |
workbookSpinCount |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WorkbookProtection()
## End(Not run)
WorksheetCopy
Description
Copy the values, styles, dimensions, merged cells, margins, and
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.copier.html
Usage
WorksheetCopy(source_worksheet, target_worksheet, ...)
Arguments
source_worksheet |
source_worksheet |
target_worksheet |
target_worksheet |
... |
Additional arguments, i.e. kwargs. |
Details
print/page setup from one worksheet to another within the same workbook.
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws1 <- wb$active
ws2 <- wb$create_sheet("Mysheet")
WorksheetCopy(source_worksheet = ws1, target_worksheet = ws2)
## End(Not run)
WorksheetProperties
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.properties.html
Usage
WorksheetProperties(
codeName = NULL,
enableFormatConditionsCalculation = NULL,
filterMode = NULL,
published = NULL,
syncHorizontal = NULL,
syncRef = NULL,
syncVertical = NULL,
transitionEvaluation = NULL,
transitionEntry = NULL,
tabColor = NULL,
outlinePr = NULL,
pageSetUpPr = NULL,
...
)
Arguments
codeName |
codeName |
enableFormatConditionsCalculation |
enableFormatConditionsCalculation |
filterMode |
filterMode |
published |
published |
syncHorizontal |
syncHorizontal |
syncRef |
syncRef |
syncVertical |
syncVertical |
transitionEvaluation |
transitionEvaluation |
transitionEntry |
transitionEntry |
tabColor |
tabColor |
outlinePr |
outlinePr |
pageSetUpPr |
pageSetUpPr |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
WorksheetProperties()
## End(Not run)
WriteOnlyCell
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.cell.html
Usage
WriteOnlyCell(ws = NULL, value = NULL, ...)
Arguments
ws |
ws |
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
WriteOnlyCell(ws = wb$active)
## End(Not run)
XDRPoint2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.xdr.html
Usage
XDRPoint2D(x = NULL, y = NULL, ...)
Arguments
x |
x |
y |
y |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
XDRPoint2D(x = 1L, y = 1L)
## End(Not run)
XDRPositiveSize2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.xdr.html
Usage
XDRPositiveSize2D(cx = NULL, cy = NULL, ...)
Arguments
cx |
cx |
cy |
cy |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
XDRPositiveSize2D(cx = 1L, cy = 1L)
## End(Not run)
XDRTransform2D
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.drawing.xdr.html
Usage
XDRTransform2D(
rot = NULL,
flipH = NULL,
flipV = NULL,
off = NULL,
ext = NULL,
chOff = NULL,
chExt = NULL,
...
)
Arguments
rot |
rot |
flipH |
flipH |
flipV |
flipV |
off |
off |
ext |
ext |
chOff |
chOff |
chExt |
chExt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
XDRTransform2D()
## End(Not run)
XMLColumnProps
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.table.html
Usage
XMLColumnProps(
mapId = NULL,
xpath = NULL,
denormalized = NULL,
xmlDataType = NULL,
extLst = NULL,
...
)
Arguments
mapId |
mapId |
xpath |
xpath |
denormalized |
denormalized |
xmlDataType |
xmlDataType |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
XMLColumnProps(mapId = 1L, xpath = "xpath", xmlDataType = "xmlDataType")
## End(Not run)
XYSeries
Description
Dedicated series for charts that have x and y series
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.series.html
Usage
XYSeries(
idx = 0L,
order = 0L,
tx = NULL,
spPr = NULL,
pictureOptions = NULL,
dPt = list(),
dLbls = NULL,
trendline = NULL,
errBars = NULL,
cat = NULL,
val = NULL,
invertIfNegative = NULL,
shape = NULL,
xVal = NULL,
yVal = NULL,
bubbleSize = NULL,
bubble3D = NULL,
marker = NULL,
smooth = NULL,
explosion = NULL,
extLst = NULL,
...
)
Arguments
idx |
idx |
order |
order |
tx |
tx |
spPr |
spPr |
pictureOptions |
pictureOptions |
dPt |
dPt |
dLbls |
dLbls |
trendline |
trendline |
errBars |
errBars |
cat |
cat |
val |
val |
invertIfNegative |
invertIfNegative |
shape |
shape |
xVal |
xVal |
yVal |
yVal |
bubbleSize |
bubbleSize |
bubble3D |
bubble3D |
marker |
marker |
smooth |
smooth |
explosion |
explosion |
extLst |
extLst |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
XYSeries()
## End(Not run)
absolute_coordinate
Description
Convert a coordinate to an absolute coordinate string (B12 -> $B$12)
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
absolute_coordinate(coord_string, ...)
Arguments
coord_string |
coord_string |
... |
Additional arguments, i.e. kwargs. |
Value
An string.
Examples
## Not run:
absolute_coordinate("A1")
## End(Not run)
active
Description
Get the currently active sheet or NULL.
Usage
active(py_obj)
Arguments
py_obj |
py_obj |
Details
:type: :class:'openpyxl.worksheet.worksheet.Worksheet'
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
wb |> active() #equivalent to wb$active
## End(Not run)
Add a chart to the sheet
Description
Optionally provide a cell for the top-left anchor
Usage
add_chart(py_obj, chart, anchor = NULL, ...)
Arguments
py_obj |
py_obj |
chart |
chart |
anchor |
anchor |
... |
Additional arguments, i.e. kwargs. |
Details
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- wb$active
chart <- BarChart(type = "col")
data <- Reference(ws, min_col=2, min_row=1, max_row=7, max_col=3)
cats <- Reference(ws, min_col=1, min_row=2, max_row=7)
chart |>
add_data(data = data, titles_from_data = TRUE) |>
set_categories(cats)
ws |> add_chart(chart, "A10")
## End(Not run)
Add a range of data in a single pass.
Description
The default is to treat each column as a data series.
Usage
add_data(py_obj, data, from_rows = FALSE, titles_from_data = FALSE)
Arguments
py_obj |
py_obj |
data |
data |
from_rows |
from_rows |
titles_from_data |
titles_from_data |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- active(wb)
chart1 <- BarChart(
type = "col",
style = 10,
title = "Bar Chart",
shape = 4
) |>
y_axis(title = "Test number") |>
x_axis(title = "Sample length (mm)")
data <- Reference(ws, min_col=2, min_row=1, max_row=7, max_col=3)
cats <- Reference(ws, min_col=1, min_row=2, max_row=7)
chart1 |>
add_data(data = data, titles_from_data = TRUE) |>
set_categories(cats)
## End(Not run)
Check for duplicate name in definedNames and other worksheet tables before adding table.
Description
Check for duplicate name in definedNames and other worksheet tables before adding table.
Usage
add_table(py_obj, table)
Arguments
py_obj |
py_obj |
table |
table |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- wb$active
tab = Table(displayName="Table1", ref="A1:E5")
ws |> add_table(tab)
ws$tables
## End(Not run)
angle_to_degrees
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
angle_to_degrees(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
A numeric value.
Examples
## Not run:
angle_to_degrees(value = 1000L)
## End(Not run)
avoid_duplicate_name
Description
Naive check to see whether name already exists.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.workbook.child.html
Usage
avoid_duplicate_name(names, value, ...)
Arguments
names |
names |
value |
value |
... |
Additional arguments, i.e. kwargs. |
Details
If name does exist suggest a name using an incrementer Duplicates are case insensitive
Value
An character string.
Examples
## Not run:
avoid_duplicate_name(names = "name", value = "name")
## End(Not run)
builtin_format_code
Description
Return one of the standard format codes by index.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.numbers.html
Usage
builtin_format_code(index, ...)
Arguments
index |
index |
... |
Additional arguments, i.e. kwargs. |
Value
An character string.
Examples
## Not run:
builtin_format_code(index = 2L)
## End(Not run)
builtin_format_id
Description
Return the id of a standard style.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.numbers.html
Usage
builtin_format_id(fmt, ...)
Arguments
fmt |
fmt |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
builtin_format_id(fmt = NULL)
## End(Not run)
cast_numeric
Description
Explicitly convert a string to a numeric value
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.inference.html
Usage
cast_numeric(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An numeric value.
Examples
## Not run:
cast_numeric(value = "1")
## End(Not run)
cast_percentage
Description
Explicitly convert a string to numeric value and format as a percentage
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.inference.html
Usage
cast_percentage(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An numeric value.
Examples
## Not run:
cast_percentage(value = "50%")
## End(Not run)
cast_time
Description
Explicitly convert a string to a number and format as datetime or time
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.inference.html
Usage
cast_time(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An Python "datetime.time" object.
Examples
## Not run:
cast_time(value = "00:00:01")
## End(Not run)
cm_to_EMU
Description
1 cm = 360000 EMUs
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
cm_to_EMU(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
A numeric value.
Examples
## Not run:
cm_to_EMU(value = 1L)
## End(Not run)
cm_to_dxa
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
cm_to_dxa(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
A numeric value.
Examples
## Not run:
cm_to_dxa(value = 1L)
## End(Not run)
column_index_from_string
Description
Convert a column name into a numerical index
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
column_index_from_string(str_col, ...)
Arguments
str_col |
str_col |
... |
Additional arguments, i.e. kwargs. |
Details
('A' -> 1)
Value
A numeric value.
Examples
## Not run:
column_index_from_string(str_col = "A")
## End(Not run)
coordinate_from_string
Description
Convert a coordinate string like 'B12' to a list ('B', 12)
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
coordinate_from_string(coord_string, ...)
Arguments
coord_string |
coord_string |
... |
Additional arguments, i.e. kwargs. |
Value
A list.
Examples
## Not run:
coordinate_from_string(coord_string = "A1")
## End(Not run)
coordinate_to_tuple
Description
Convert an Excel style coordinate to (row, column) list
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
coordinate_to_tuple(coordinate, ...)
Arguments
coordinate |
coordinate |
... |
Additional arguments, i.e. kwargs. |
Value
A list.
Examples
## Not run:
coordinate_to_tuple(coordinate = "A1")
## End(Not run)
Deep copy operation from deepcopy Python module
Description
https://docs.python.org/3/library/copy.html
Usage
deepcopy(x, memo = NULL, nil = c())
Arguments
x |
x |
memo |
memo |
nil |
_nil |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
deepcopy(wb)
## End(Not run)
degrees_to_angle
Description
1 degree = 60000 angles
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
degrees_to_angle(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
A numeric value.
Examples
## Not run:
degrees_to_angle(value = 1)
## End(Not run)
dxa_to_cm
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
dxa_to_cm(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
dxa_to_cm(value = 1L)
## End(Not run)
expand_cell_ranges
Description
Expand cell ranges to a sequence of addresses.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.worksheet.datavalidation.html
Usage
expand_cell_ranges(range_string, ...)
Arguments
range_string |
range_string |
... |
Additional arguments, i.e. kwargs. |
Details
Reverse of collapse_cell_addresses Eg. converts "A1:A2 B1:B2" to (A1, A2, B1, B2)
Value
An Python builtin object.
Examples
## Not run:
expand_cell_ranges(range_string = "A1:A2")
## End(Not run)
get_column_interval
Description
Given the start and end columns, return all the columns in the series.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
get_column_interval(start, end, ...)
Arguments
start |
start |
end |
end |
... |
Additional arguments, i.e. kwargs. |
Details
The start and end columns can be either column letters or 1-based indexes.
Value
An openpyxl Python object.
Examples
## Not run:
get_column_interval(start = "A", end = 3L)
## End(Not run)
get_column_letter
Description
Convert a column index into a column letter
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
get_column_letter(idx, ...)
Arguments
idx |
idx |
... |
Additional arguments, i.e. kwargs. |
Details
(3 -> 'C')
Value
An openpyxl Python object.
Examples
## Not run:
get_column_letter(idx = 3L)
## End(Not run)
get_type
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.cell.cell.html
Usage
get_type(t, value, ...)
Arguments
t |
t |
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
get_type(t = "t", value = "value")
## End(Not run)
hash_password
Description
Create a password hash from a given string for protecting a worksheet
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.protection.html
Usage
hash_password(plaintext_password = "", ...)
Arguments
plaintext_password |
plaintext_password |
... |
Additional arguments, i.e. kwargs. |
Details
only. This will not work for encrypting a workbook. This method is based on the algorithm provided by Daniel Rentz of OpenOffice and the PEAR package Spreadsheet_Excel_Writer by Xavier Noguer <xnoguer@rezebra.com>. See also http://blogs.msdn.com/b/ericwhite/archive/2008/02/23/the-legacy-hashing-algorithm-in-open-xml.aspx
Value
An openpyxl Python object.
Examples
## Not run:
hash_password(plaintext_password = "password")
## End(Not run)
iadd from operator Python module
Description
https://docs.python.org/3/library/operator.html#in-place-operators
Usage
iadd(a, b)
Arguments
a |
a |
b |
b |
Value
A Python object.
Examples
## Not run:
a <- "hello"
iadd(a = a, b = " world")
## End(Not run)
inch_to_EMU
Description
1 inch = 914400 EMUs
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
inch_to_EMU(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An numeric value.
Examples
## Not run:
inch_to_EMU(value = 1)
## End(Not run)
inch_to_dxa
Description
1 inch = 72 * 20 dxa
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
inch_to_dxa(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
An numeric value.
Examples
## Not run:
inch_to_dxa(value = 1)
## End(Not run)
Install openpyxl Python module
Description
Install openpyxl Python module
Usage
install_openpyxl(method = "auto", conda = "auto")
Arguments
method |
method |
conda |
conda |
Value
(Invisible) 'TRUE' if the Conda environment was created successfully.
Install pillow Python module
Description
Module needed to include images in an Excel file.
Usage
install_pillow(method = "auto", conda = "auto")
Arguments
method |
method |
conda |
conda |
Value
(Invisible) 'TRUE' if the Conda environment was created successfully.
load_workbook
Description
Open the given filename and return the workbook
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.reader.excel.html
Usage
load_workbook(
filename,
read_only = FALSE,
keep_vba = FALSE,
data_only = FALSE,
keep_links = TRUE,
rich_text = FALSE,
...
)
Arguments
filename |
filename string or a file-like object open in binary mode c.f., :class:'zipfile.ZipFile' :param read_only: optimised for reading, content cannot be edited |
read_only |
read_only bool |
keep_vba |
keep_vba preserve vba content (this does NOT mean you can use it) |
data_only |
data_only bool |
keep_links |
keep_links whether links to external workbooks should be preserved. The default is TRUE |
rich_text |
rich_text bool :rtype: :class:'openpyxl.workbook.Workbook' .. note:: When using lazy load, all worksheets will be :class:'openpyxl.worksheet.iter_worksheet.IterableWorksheet' and the returned workbook will be read-only. |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
tmp <- write_xlsx(list(mysheet = iris))
load_workbook(filename = tmp)
## End(Not run)
pixels_to_EMU
Description
1 pixel = 9525 EMUs
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
pixels_to_EMU(value, ...)
Arguments
value |
value |
... |
Additional arguments, i.e. kwargs. |
Value
A numeric value.
Examples
## Not run:
pixels_to_EMU(value = 1L)
## End(Not run)
pixels_to_points
Description
96 dpi, 72i
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
pixels_to_points(value, dpi = 96L, ...)
Arguments
value |
value |
dpi |
dpi |
... |
Additional arguments, i.e. kwargs. |
Value
A numeric value.
Examples
## Not run:
pixels_to_points(value = 1L)
## End(Not run)
points_to_pixels
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
points_to_pixels(value, dpi = 96L, ...)
Arguments
value |
value |
dpi |
dpi |
... |
Additional arguments, i.e. kwargs. |
Value
A numeric value.
Examples
## Not run:
points_to_pixels(value = 1L)
## End(Not run)
quote_sheetname
Description
Add quotes around sheetnames if they contain spaces.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
quote_sheetname(sheetname, ...)
Arguments
sheetname |
sheetname |
... |
Additional arguments, i.e. kwargs. |
Value
An string.
Examples
## Not run:
wb <- Workbook()
quote_sheetname(wb$sheetnames)
## End(Not run)
range_boundaries
Description
Convert a range string into a list of boundaries:
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
range_boundaries(range_string, ...)
Arguments
range_string |
range_string |
... |
Additional arguments, i.e. kwargs. |
Details
(min_col, min_row, max_col, max_row) Cell coordinates will be converted into a range with the cell at both end
Value
An list.
Convert a range string into a tuple of boundaries
(min_col, min_row, max_col, max_row) Cell coordinates will be converted into a range with the cell at both end
Examples
## Not run:
range_boundaries(range_string = "A")
## End(Not run)
range_to_tuple
Description
Convert a worksheet range to the sheetname and maximum and minimum coordinate indices
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
range_to_tuple(range_string, ...)
Arguments
range_string |
range_string |
... |
Additional arguments, i.e. kwargs. |
Value
An list.
Examples
## Not run:
range_to_tuple(range_string = "sheetname!A1:E4")
## End(Not run)
rows_from_range
Description
Get individual addresses for every cell in a range.
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.cell.html
Usage
rows_from_range(range_string, ...)
Arguments
range_string |
range_string |
... |
Additional arguments, i.e. kwargs. |
Details
Yields one row at a time.
Value
An openpyxl Python object.
Examples
## Not run:
rows_from_range(range_string = "A")
## End(Not run)
save_workbook
Description
Save the given workbook on the filesystem under the name filename.
https://openpyxl.readthedocs.io/en/latest/api/openpyxl.writer.excel.html
Usage
save_workbook(workbook, filename, ...)
Arguments
workbook |
workbook |
filename |
filename |
... |
Additional arguments, i.e. kwargs. |
Details
:param workbook: the workbook to save :type workbook: :class:'openpyxl.workbook.Workbook' :param filename: the path to which save the workbook :type filename: string :rtype: bool
Value
An openpyxl Python object.
Examples
## Not run:
save_workbook(workbook = wb, filename = tempfile())
## End(Not run)
set_categories
Description
Set the categories / x-axis values
Usage
set_categories(py_obj, labels)
Arguments
py_obj |
py_obj |
labels |
labels |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
ws <- active(wb)
chart1 <- BarChart(
type = "col",
style = 10,
title = "Bar Chart",
shape = 4
) |>
y_axis(title = "Test number") |>
x_axis(title = "Sample length (mm)")
data <- Reference(ws, min_col=2, min_row=1, max_row=7, max_col=3)
cats <- Reference(ws, min_col=1, min_row=2, max_row=7)
chart1 |>
add_data(data = data, titles_from_data = TRUE) |>
set_categories(cats)
## End(Not run)
short_color
Description
format a color to its short size
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.utils.units.html
Usage
short_color(color, ...)
Arguments
color |
color |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
short_color(color = "color")
## End(Not run)
title_maker
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.chart.title.html
Usage
title_maker(text, ...)
Arguments
text |
text |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
title_maker(text = "text")
## End(Not run)
write_stylesheet
Description
https://openpyxl.readthedocs.io/en/stable/api/openpyxl.styles.stylesheet.html
Usage
write_stylesheet(wb, ...)
Arguments
wb |
wb |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
wb <- Workbook()
write_stylesheet(wb = wb)
## End(Not run)
Export to xlsx
Description
See writexl::write_xlsx for details.
Arguments
x |
data frame or named list of data frames that will be sheets in the xlsx |
path |
A function call using the magrittr semantics. |
col_names |
write column names at the top of the file? |
format_headers |
make the col_names in the xlsx centered and bold |
use_zip64 |
use zip64 to enable support for 4GB+ xlsx files. Not all platforms can read this. |
Value
'write_xlsx()' returns the input invisibly.
x_axis
Description
Values must be of type <class 'openpyxl.chart.axis.TextAxis'>
Usage
x_axis(py_obj, ...)
Arguments
py_obj |
py_obj |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BarChart(type = "col") |>
x_axis(title = "X axis title")
## End(Not run)
y_axis
Description
Values must be of type <class 'openpyxl.chart.axis.NumericAxis'>
Usage
y_axis(py_obj, ...)
Arguments
py_obj |
py_obj |
... |
Additional arguments, i.e. kwargs. |
Value
An openpyxl Python object.
Examples
## Not run:
BarChart(type = "col") |>
y_axis(title = "Y axis title")
## End(Not run)