NamedItemCollection
Excel.NamedItemCollection: the workbook’s names, or one worksheet’s.
Import from @reductoai/xlsx/officejs.
NamedItemCollection properties
| Name | Type | Description |
|---|---|---|
items | NamedItem[] | read-only |
NamedItemCollection.add()
add(name: string, reference: string | ExcelRange, comment?: string): NamedItem
reference is a range or a formula such as “=Sheet1!A1:B2” or “=0.2”.
NamedItemCollection.addFormulaLocal()
addFormulaLocal(name: string, formula: string, comment?: string): NamedItem
formula is a formula with or without its ”=”.
NamedItemCollection.getCount()
getCount(): { value: number }
NamedItemCollection.getItem()
getItem(name: string): NamedItem
NamedItemCollection.getItemOrNullObject()
getItemOrNullObject(name: string): NamedItem & { isNullObject: boolean }
NamedItem
Excel.NamedItem.
Import from @reductoai/xlsx/officejs.
NamedItem properties
| Name | Type | Description |
|---|---|---|
arrayValues | NamedItemArrayValues | read-only The cells or array the formula computes; a single value is one row of one. |
comment | string | |
formula | string | |
name | string | read-only |
scope | ”Workbook” | “Worksheet” | read-only |
type | NamedItemType | read-only |
value | string | number | boolean | read-only The address for a range, else what the formula computes. |
valueAsJson | string | BasicCellValue | read-only |
valueAsJsonLocal | string | BasicCellValue | read-only |
visible | boolean | |
worksheet | ExcelWorksheet | read-only The worksheet the name is scoped to; throws for a workbook name. |
worksheetOrNullObject | ExcelWorksheet & { isNullObject: boolean } | read-only |
NamedItem.delete()
delete(): void
NamedItem.getRange()
getRange(): ExcelRange
NamedItem.getRangeOrNullObject()
getRangeOrNullObject(): ExcelRange & { isNullObject: boolean }
NamedItem.set()
set(properties: NamedItem | UpdateData<NamedItem>, options?: UpdateOptions): void
Functions
Excel.Functions: each worksheet function, computed against the workbook as it stands.
Import from @reductoai/xlsx/officejs.
Functions properties
| Name | Type | Description |
|---|---|---|
abs | Fn | read-only |
accrInt | Fn | read-only |
accrIntM | Fn | read-only |
acos | Fn | read-only |
acosh | Fn | read-only |
acot | Fn | read-only |
acoth | Fn | read-only |
amorDegrc | Fn | read-only |
amorLinc | Fn | read-only |
and | Fn | read-only |
arabic | Fn | read-only |
areas | Fn | read-only |
asc | Fn | read-only |
asin | Fn | read-only |
asinh | Fn | read-only |
atan | Fn | read-only |
atan2 | Fn | read-only |
atanh | Fn | read-only |
aveDev | Fn | read-only |
average | Fn | read-only |
averageA | Fn | read-only |
averageIf | Fn | read-only |
averageIfs | Fn | read-only |
bahtText | Fn | read-only |
base | Fn | read-only |
besselI | Fn | read-only |
besselJ | Fn | read-only |
besselK | Fn | read-only |
besselY | Fn | read-only |
beta_Dist | Fn | read-only |
beta_Inv | Fn | read-only |
bin2Dec | Fn | read-only |
bin2Hex | Fn | read-only |
bin2Oct | Fn | read-only |
binom_Dist | Fn | read-only |
binom_Dist_Range | Fn | read-only |
binom_Inv | Fn | read-only |
bitand | Fn | read-only |
bitlshift | Fn | read-only |
bitor | Fn | read-only |
bitrshift | Fn | read-only |
bitxor | Fn | read-only |
ceiling_Math | Fn | read-only |
ceiling_Precise | Fn | read-only |
char | Fn | read-only |
chiSq_Dist | Fn | read-only |
chiSq_Dist_RT | Fn | read-only |
chiSq_Inv | Fn | read-only |
chiSq_Inv_RT | Fn | read-only |
choose | Fn | read-only |
clean | Fn | read-only |
code | Fn | read-only |
columns | Fn | read-only |
combin | Fn | read-only |
combina | Fn | read-only |
complex | Fn | read-only |
concatenate | Fn | read-only |
confidence_Norm | Fn | read-only |
confidence_T | Fn | read-only |
convert | Fn | read-only |
cos | Fn | read-only |
cosh | Fn | read-only |
cot | Fn | read-only |
coth | Fn | read-only |
count | Fn | read-only |
countA | Fn | read-only |
countBlank | Fn | read-only |
countIf | Fn | read-only |
countIfs | Fn | read-only |
coupDayBs | Fn | read-only |
coupDays | Fn | read-only |
coupDaysNc | Fn | read-only |
coupNcd | Fn | read-only |
coupNum | Fn | read-only |
coupPcd | Fn | read-only |
csc | Fn | read-only |
csch | Fn | read-only |
cumIPmt | Fn | read-only |
cumPrinc | Fn | read-only |
date | Fn | read-only |
datevalue | Fn | read-only |
daverage | Fn | read-only |
day | Fn | read-only |
days | Fn | read-only |
days360 | Fn | read-only |
db | Fn | read-only |
dbcs | Fn | read-only |
dcount | Fn | read-only |
dcountA | Fn | read-only |
ddb | Fn | read-only |
dec2Bin | Fn | read-only |
dec2Hex | Fn | read-only |
dec2Oct | Fn | read-only |
decimal | Fn | read-only |
degrees | Fn | read-only |
delta | Fn | read-only |
devSq | Fn | read-only |
dget | Fn | read-only |
disc | Fn | read-only |
dmax | Fn | read-only |
dmin | Fn | read-only |
dollar | Fn | read-only |
dollarDe | Fn | read-only |
dollarFr | Fn | read-only |
dproduct | Fn | read-only |
dstDev | Fn | read-only |
dstDevP | Fn | read-only |
dsum | Fn | read-only |
duration | Fn | read-only |
dvar | Fn | read-only |
dvarP | Fn | read-only |
ecma_Ceiling | Fn | read-only |
edate | Fn | read-only |
effect | Fn | read-only |
eoMonth | Fn | read-only |
erf | Fn | read-only |
erf_Precise | Fn | read-only |
erfC | Fn | read-only |
erfC_Precise | Fn | read-only |
error_Type | Fn | read-only |
even | Fn | read-only |
exact | Fn | read-only |
exp | Fn | read-only |
expon_Dist | Fn | read-only |
f_Dist | Fn | read-only |
f_Dist_RT | Fn | read-only |
f_Inv | Fn | read-only |
f_Inv_RT | Fn | read-only |
fact | Fn | read-only |
factDouble | Fn | read-only |
false | Fn | read-only |
find | Fn | read-only |
findB | Fn | read-only |
fisher | Fn | read-only |
fisherInv | Fn | read-only |
fixed | Fn | read-only |
floor_Math | Fn | read-only |
floor_Precise | Fn | read-only |
fv | Fn | read-only |
fvschedule | Fn | read-only |
gamma | Fn | read-only |
gamma_Dist | Fn | read-only |
gamma_Inv | Fn | read-only |
gammaLn | Fn | read-only |
gammaLn_Precise | Fn | read-only |
gauss | Fn | read-only |
gcd | Fn | read-only |
geoMean | Fn | read-only |
geStep | Fn | read-only |
harMean | Fn | read-only |
hex2Bin | Fn | read-only |
hex2Dec | Fn | read-only |
hex2Oct | Fn | read-only |
hlookup | Fn | read-only |
hour | Fn | read-only |
hyperlink | Fn | read-only |
hypGeom_Dist | Fn | read-only |
if | Fn | read-only |
imAbs | Fn | read-only |
imaginary | Fn | read-only |
imArgument | Fn | read-only |
imConjugate | Fn | read-only |
imCos | Fn | read-only |
imCosh | Fn | read-only |
imCot | Fn | read-only |
imCsc | Fn | read-only |
imCsch | Fn | read-only |
imDiv | Fn | read-only |
imExp | Fn | read-only |
imLn | Fn | read-only |
imLog10 | Fn | read-only |
imLog2 | Fn | read-only |
imPower | Fn | read-only |
imProduct | Fn | read-only |
imReal | Fn | read-only |
imSec | Fn | read-only |
imSech | Fn | read-only |
imSin | Fn | read-only |
imSinh | Fn | read-only |
imSqrt | Fn | read-only |
imSub | Fn | read-only |
imSum | Fn | read-only |
imTan | Fn | read-only |
int | Fn | read-only |
intRate | Fn | read-only |
ipmt | Fn | read-only |
irr | Fn | read-only |
isErr | Fn | read-only |
isError | Fn | read-only |
isEven | Fn | read-only |
isFormula | Fn | read-only |
isLogical | Fn | read-only |
isNA | Fn | read-only |
isNonText | Fn | read-only |
isNumber | Fn | read-only |
iso_Ceiling | Fn | read-only |
isOdd | Fn | read-only |
isoWeekNum | Fn | read-only |
ispmt | Fn | read-only |
isref | Fn | read-only |
isText | Fn | read-only |
kurt | Fn | read-only |
large | Fn | read-only |
lcm | Fn | read-only |
left | Fn | read-only |
leftb | Fn | read-only |
len | Fn | read-only |
lenb | Fn | read-only |
ln | Fn | read-only |
log | Fn | read-only |
log10 | Fn | read-only |
logNorm_Dist | Fn | read-only |
logNorm_Inv | Fn | read-only |
lookup | Fn | read-only |
lower | Fn | read-only |
match | Fn | read-only |
max | Fn | read-only |
maxA | Fn | read-only |
mduration | Fn | read-only |
median | Fn | read-only |
mid | Fn | read-only |
midb | Fn | read-only |
min | Fn | read-only |
minA | Fn | read-only |
minute | Fn | read-only |
mirr | Fn | read-only |
mod | Fn | read-only |
month | Fn | read-only |
mround | Fn | read-only |
multiNomial | Fn | read-only |
n | Fn | read-only |
na | Fn | read-only |
negBinom_Dist | Fn | read-only |
networkDays | Fn | read-only |
networkDays_Intl | Fn | read-only |
nominal | Fn | read-only |
norm_Dist | Fn | read-only |
norm_Inv | Fn | read-only |
norm_S_Dist | Fn | read-only |
norm_S_Inv | Fn | read-only |
not | Fn | read-only |
now | Fn | read-only |
nper | Fn | read-only |
npv | Fn | read-only |
numberValue | Fn | read-only |
oct2Bin | Fn | read-only |
oct2Dec | Fn | read-only |
oct2Hex | Fn | read-only |
odd | Fn | read-only |
oddFPrice | Fn | read-only |
oddFYield | Fn | read-only |
oddLPrice | Fn | read-only |
oddLYield | Fn | read-only |
or | Fn | read-only |
pduration | Fn | read-only |
percentile_Exc | Fn | read-only |
percentile_Inc | Fn | read-only |
percentRank_Exc | Fn | read-only |
percentRank_Inc | Fn | read-only |
permut | Fn | read-only |
permutationa | Fn | read-only |
phi | Fn | read-only |
pi | Fn | read-only |
pmt | Fn | read-only |
poisson_Dist | Fn | read-only |
power | Fn | read-only |
ppmt | Fn | read-only |
price | Fn | read-only |
priceDisc | Fn | read-only |
priceMat | Fn | read-only |
product | Fn | read-only |
proper | Fn | read-only |
pv | Fn | read-only |
quartile_Exc | Fn | read-only |
quartile_Inc | Fn | read-only |
quotient | Fn | read-only |
radians | Fn | read-only |
rand | Fn | read-only |
randBetween | Fn | read-only |
rank_Avg | Fn | read-only |
rank_Eq | Fn | read-only |
rate | Fn | read-only |
received | Fn | read-only |
replace | Fn | read-only |
replaceB | Fn | read-only |
rept | Fn | read-only |
right | Fn | read-only |
rightb | Fn | read-only |
roman | Fn | read-only |
round | Fn | read-only |
roundDown | Fn | read-only |
roundUp | Fn | read-only |
rows | Fn | read-only |
rri | Fn | read-only |
sec | Fn | read-only |
sech | Fn | read-only |
second | Fn | read-only |
seriesSum | Fn | read-only |
sheet | Fn | read-only |
sheets | Fn | read-only |
sign | Fn | read-only |
sin | Fn | read-only |
sinh | Fn | read-only |
skew | Fn | read-only |
skew_p | Fn | read-only |
sln | Fn | read-only |
small | Fn | read-only |
sqrt | Fn | read-only |
sqrtPi | Fn | read-only |
standardize | Fn | read-only |
stDev_P | Fn | read-only |
stDev_S | Fn | read-only |
stDevA | Fn | read-only |
stDevPA | Fn | read-only |
substitute | Fn | read-only |
subtotal | Fn | read-only |
sum | Fn | read-only |
sumIf | Fn | read-only |
sumIfs | Fn | read-only |
sumSq | Fn | read-only |
syd | Fn | read-only |
t | Fn | read-only |
t_Dist | Fn | read-only |
t_Dist_2T | Fn | read-only |
t_Dist_RT | Fn | read-only |
t_Inv | Fn | read-only |
t_Inv_2T | Fn | read-only |
tan | Fn | read-only |
tanh | Fn | read-only |
tbillEq | Fn | read-only |
tbillPrice | Fn | read-only |
tbillYield | Fn | read-only |
text | Fn | read-only |
time | Fn | read-only |
timevalue | Fn | read-only |
today | Fn | read-only |
trim | Fn | read-only |
trimMean | Fn | read-only |
true | Fn | read-only |
trunc | Fn | read-only |
type | Fn | read-only |
unichar | Fn | read-only |
unicode | Fn | read-only |
upper | Fn | read-only |
usdollar | Fn | read-only |
value | Fn | read-only |
var_P | Fn | read-only |
var_S | Fn | read-only |
varA | Fn | read-only |
varPA | Fn | read-only |
vdb | Fn | read-only |
vlookup | Fn | read-only |
weekday | Fn | read-only |
weekNum | Fn | read-only |
weibull_Dist | Fn | read-only |
workDay | Fn | read-only |
workDay_Intl | Fn | read-only |
xirr | Fn | read-only |
xnpv | Fn | read-only |
xor | Fn | read-only |
year | Fn | read-only |
yearFrac | Fn | read-only |
yield | Fn | read-only |
yieldDisc | Fn | read-only |
yieldMat | Fn | read-only |
z_Test | Fn | read-only |
Functions.call()
call(name: string, args: FunctionArg[]): FunctionResult
name(args) on the active sheet; a function the engine lacks gives #NAME?.
FunctionResult
Excel.FunctionResult: error holds the error code, such as “#DIV/0!”, when the call fails.
Import from @reductoai/xlsx/officejs.